Commit e44baa06 authored by Jorge Moratinos's avatar Jorge Moratinos
Browse files

How to deploy using helm updated

parent e2415391
Loading
Loading
Loading
Loading
+32 −17
Changes for doc/gettingstarted/howtodeploy.md: 32 added lines, 17 removed lines.
Original line number Diff line number Diff line
@@ -26,32 +26,47 @@ OCF SDG created a set of scripts to deploy/undeploy OpenCAPIF at k8s environment

All scripts are stored at [Helm Scripts].

Just we need to keep in mind, all scripts use configurations defined under **variables.sh** and environments if them are defined.
All scripts use configurations defined under **variables.sh** and environment files if they are defined.

There are different types of scripts:

### Step-by-step Installation (granular control)

These scripts install individual groups of helm charts in order:

- ***00_install_capif_monitoring.sh***: Deploy monitoring namespace (Grafana, Prometheus, Tempo, Loki, FluentBit, OpenTelemetry).
- ***01_install_capif_db.sh***: Deploy MongoDB instances (CAPIF DB and Register DB).
- ***02_install_capif_db_express.sh***: Deploy Mongo Express for both CAPIF and Register databases.
- ***03_install_capif_commons.sh***: Deploy common services (Redis, Celery, mock server).
- ***04_install_capif_services.sh***: Deploy all OpenCAPIF core services (CAPIF APIs, NGINX, Helper).
- ***05_install_capif_register.sh***: Deploy the Register service.

### Deployment Management
- ***install_vault.sh***: Deploy Vault component from k8s cluster, only needed if vault is not previously deployed. If it’s deployed you can setup vault token on variables.sh.

All-in-one scripts that combine the step-by-step scripts above:

- ***install_vault.sh***: Deploy Vault component on k8s cluster, only needed if vault is not previously deployed. If already deployed you can set the vault token in variables.sh.
- ***install_monitoring.sh***: Deploy monitoring on k8s cluster.
- ***install_capif.sh***: Deploy OpenCAPIF on k8s cluster. It will be deployed on configured namespace with domain and hostnames configured under variables.sh.
- ***install_capif.sh***: Deploy OpenCAPIF on k8s cluster. Executes all six step-by-step scripts in order.
- ***deploy_interconnection_environment.sh***: Deploy two OpenCAPIF environments locally with interconnection enabled.
- ***uninstall_vault.sh***: Rollback Vault component from k8s cluster.
- ***uninstall_monitoring.sh***: Rollback monitoring components from k8s cluster.
- ***uninstall_capif.sh***: Rollback OpenCAPIF from k8s cluster.

### Manage remote users
- ***create_remote_users.sh***: This script create users setup by parameters on deployed OpenCAPIF. Those users are created by administrator.
- ***remove_remote_users.sh***: This script removes user from deployed OpenCAPIF.
- ***remove_remote_users_by_prefix.sh***:: This script removes users by prefix.
### Manage Remote Users
- ***create_remote_users.sh***: Create users on deployed OpenCAPIF using configured parameters. Users are created by administrator.
- ***remove_remote_users.sh***: Remove a user from deployed OpenCAPIF.
- ***remove_remote_users_by_prefix.sh***: Remove users by prefix.

### Obtain DNS resolution
- ***get_ingress.sh***: This create a configuration for dns fixed resolution for ingress configured in namespace passed by parameters.
- ***set_ingress.sh***: This scripts adds to /etc/hosts the fixed DNS resolution for ingress setup for  namespace passed by parameters.
### DNS Resolution
- ***get_ingress.sh***: Generate a fixed DNS resolution configuration for ingress in the namespace passed by parameters.
- ***set_ingress.sh***: Add the fixed DNS resolution for ingress to /etc/hosts for the namespace passed by parameters.

### Run Robot Tests Suites
- ***run_remote_capif_tests.sh***: This scripts launch Robot Test docker image on current machine to reach deployed OpenCAPIF. Is useful to launch with “--include smoke” in order to ensure all is deployed properly.
### Run Robot Test Suites
- ***run_remote_capif_tests.sh***: Launch Robot Test Docker image on current machine to reach deployed OpenCAPIF. Useful to launch with “--include smoke” to verify everything is deployed properly.

### Create Testing Dummy Info
- ***populate_create_remote_dummy_users.sh***: : Create Dummy providers and invokers, publish service APIs and creates security context for invokers.
### Create Testing Dummy Data
- ***populate_create_remote_dummy_users.sh***: Create dummy providers and invokers, publish service APIs and create security contexts for invokers.
- ***populate_remove_remote_dummy_users.sh***: Remove dummy information created.

### How to Run Scripts
@@ -122,8 +137,8 @@ Or run any other task related, for example, creation of users at new environment



[Test Plan Directory]: .././testplan/README.md  "Test Plan"
[Testing with Robot Framework]: .././testing/robotframework/README.md  "Robot Framework"
[Testing with Postman]: .././testing/postman/README.md  "Postman"
[Test Plan Directory]: ../testplan/README.md  "Test Plan"
[Testing with Robot Framework]: ../testing/robotframework/README.md  "Robot Framework"
[Testing with Postman]: ../testing/postman/README.md  "Postman"
[Helm Main]: https://labs.etsi.org/rep/ocf/capif/-/tree/staging/helm/  "Helm main directory"
[Helm Scripts]: https://labs.etsi.org/rep/ocf/capif/-/tree/staging/helm/scripts  "Helm scripts"
 No newline at end of file