diff options
4 files changed, 202 insertions, 2 deletions
diff --git a/docs/sections/services/datalake-handler/index.rst b/docs/sections/services/datalake-handler/index.rst index 7fee00cb..3fade9c6 100644 --- a/docs/sections/services/datalake-handler/index.rst +++ b/docs/sections/services/datalake-handler/index.rst @@ -28,6 +28,7 @@ DataLake-Handler MS Installation Steps and Configurations :maxdepth: 1 ./installation.rst + ./installation-helm.rst DataLake-Handler MS Admin UI User Guide --------------------------------------- @@ -35,4 +36,4 @@ DataLake-Handler MS Admin UI User Guide .. toctree:: :maxdepth: 1 - ./userguide.rst + ./userguide.rst diff --git a/docs/sections/services/datalake-handler/installation-helm.rst b/docs/sections/services/datalake-handler/installation-helm.rst new file mode 100644 index 00000000..015094cf --- /dev/null +++ b/docs/sections/services/datalake-handler/installation-helm.rst @@ -0,0 +1,107 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. _dl-installation-helm: + +Helm Installation +================= + +DL-handler consists of three pods- the feeder, admin UI and des. It can be deployed by using helm charts. The following steps guides you launch datalake though helm. + + +Pre-requisites +~~~~~~~~~~~~~~ +- Datalake postgres should be properly deployed and functional. + +- Presto service should be deployed for des deployment.Here is a sample how presto is deployed in the environment. + + Deploying presto service: + The package of presto version we are using is v0.0.2:presto-v0.0.2.tar.gz + + #docker build -t presto:v0.0.2 . + #docker tag presto:v0.0.2 registry.baidubce.com/onap/presto:v0.0.2 + #docker push registry.baidubce.com/onap/presto:v0.0.2 + + Note: Replace the repository path with your own repository. + + #kubectl -n onap run dl-presto --image=registry.baidubce.com/onap/presto:v0.0.2 --env="MongoDB_IP=192.168.235.11" --env="MongoDB_PORT=27017" + #kubectl -n onap expose deployment dl-presto --port=9000 --target-port=9000 --type=NodePort + + Note: MonoDB_IP and Mongo_PORT you can replace this two values with your own configuration. + +- The environment should have helm and kubernetes installed. + +- Check whether all the charts mentioned in the requirements.yaml file are present in the charts/ folder. If not present, package the respective chart and put it in the charts/ folder. + + For example: + .. code-block:: bash + + helm package <dcaegen2-services-common> + + +Deployment steps +~~~~~~~~~~~~~~~~ +Validate the charts using below commands + .. code-block:: bash + + helm lint <dcae-datalake-admin-ui> + helm lint <dcae-datalake-feeder> + helm lint <dcae-datalake-des> + +Deploy the charts using below commands + .. code-block:: bash + + helm install <datalake-admin-ui> <dcae-datalake-admin-ui> --namespace onap --set global.masterPassword=<password> + helm install <datalake-feeder> <dcae-datalake-feeder> --namespace onap --set global.masterPassword=<password> + helm install <datalake-des> <dcae-datalake-des> --namespace onap --set global.masterPassword=<password> + +For checking logs of the containers + .. code-block:: bash + + kubectl logs -f -n onap <dev-dcae-datalake-admin-ui-843bfsk4f4-btd7s> -c <dcae-datalake-admin-ui> + kubectl logs -f -n onap <dev-dcae-datalake-feeder-758bbf547b-ctf6s> -c <dcae-datalake-feeder> + kubectl logs -f -n onap <dev-dcae-datalake-des-56465d86fd-2w56c> -c <dcae-datalake-des> + +To un-deploy + .. code-block:: bash + + helm uninstall <datalake-admin-ui> + helm uninstall <datalake-feeder> + helm uninstall <datalake-des> + + +Application configurations +~~~~~~~~~~~~~~~~~~~~~~~~~~ +Datalake-admin-ui: + ++-------------------------------+------------------------------------------------+ +|Configuration | Description | ++===============================+================================================+ +|FEEDER_ADDR | Host where dl-feeder is running | ++-------------------------------+------------------------------------------------+ + +Datalake-feeder: + ++-------------------------------+------------------------------------------------+ +|Configuration | Description | ++===============================+================================================+ +|PRESTO_HOST | Host where the presto application is running | ++-------------------------------+------------------------------------------------+ +|PG_HOST | Host where the postgres application is running | ++-------------------------------+------------------------------------------------+ +|CONSUL_HOST | Host where counsul loader container is running | ++-------------------------------+------------------------------------------------+ +|PG_DB | Postgress database name | ++-------------------------------+------------------------------------------------+ + +Datalake-Des: + ++-------------------------------+------------------------------------------------+ +|Configuration | Description | ++===============================+================================================+ +|PRESTO_HOST | Host where the presto application is running | ++-------------------------------+------------------------------------------------+ +|PG_HOST | Host where the postgres application is running | ++-------------------------------+------------------------------------------------+ +|PG_DB | Postgress database name | ++-------------------------------+------------------------------------------------+ + diff --git a/docs/sections/services/slice-analysis-ms/index.rst b/docs/sections/services/slice-analysis-ms/index.rst index 252a2f34..a035555b 100644 --- a/docs/sections/services/slice-analysis-ms/index.rst +++ b/docs/sections/services/slice-analysis-ms/index.rst @@ -40,6 +40,7 @@ Slice Analysis MS Installation Steps :maxdepth: 1
./installation.rst
+ ./installation-helm.rst
Slice Analysis MS Troubleshooting Steps
@@ -48,4 +49,4 @@ Slice Analysis MS Troubleshooting Steps .. toctree::
:maxdepth: 1
- ./slice_analysis_ms_troubleshooting.rst
\ No newline at end of file + ./slice_analysis_ms_troubleshooting.rst
diff --git a/docs/sections/services/slice-analysis-ms/installation-helm.rst b/docs/sections/services/slice-analysis-ms/installation-helm.rst new file mode 100644 index 00000000..b8542d24 --- /dev/null +++ b/docs/sections/services/slice-analysis-ms/installation-helm.rst @@ -0,0 +1,91 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. _sliceanalysis-installation-helm: + + +Helm Installation +================= + +Slice Analysis MS can be deployed using helm charts as kubernetes applications. + +Deployment Pre-requisites +~~~~~~~~~~~~~~~~~~~~~~~~~ +- DCAE and DMaaP pods should be up and running. + +- PM mapper service should be running. + +- Config DB service, CPS and AAI should be running. + +- The environment should have helm and kubernetes installed. + +- Check whether all the charts mentioned in the requirements.yaml file are present in the charts/ folder. If not present, package the respective chart and put it in the charts/ folder. + + For example: + .. code-block:: bash + + helm package <dcaegen2-services-common> + + + +Deployment steps +~~~~~~~~~~~~~~~~ +1. Go to the directory where dcae-slice-analysis-ms chart is present and Execute the below command. + .. code-block:: bash + + helm install <slice_analysis_ms> <dcae-slice-analysis-ms> --namespace onap --set global.masterPassword=guilin2021 + + +2. We can check the logs of the slice-analysis-ms container by using the below command + .. code-block:: bash + + kubectl logs -f -n onap <dev-dcae-slice-analysis-ms-9fd8495f7-zmnlw> -c <dcae-slice-analysis-ms> + + +3. To un-deploy + .. code-block:: bash + + helm uninstall <slice_analysis_ms> + + + +Application configurations +~~~~~~~~~~~~~~~~~~~~~~~~~~ ++-------------------------------+------------------------------------------------+ +|Configuration | Description | ++===============================+================================================+ +|postgres host | Host where the postgres application is running | ++-------------------------------+------------------------------------------------+ +|pollingInterval | Dmaap Polling interval in milliseconds | ++-------------------------------+------------------------------------------------+ +|pollingTimeout | Dmaap Polling timeout in milliseconds | ++-------------------------------+------------------------------------------------+ +|configDb service | Host where the config DB application is running| ++-------------------------------+------------------------------------------------+ +|configDbEnabled | To choose whether to use config DB or CPS & AAI| ++-------------------------------+------------------------------------------------+ +|aai url | Host where the AAI application is running | ++-------------------------------+------------------------------------------------+ +|cps url | Host where cps tbdmt application is running | ++-------------------------------+------------------------------------------------+ +|samples | Minimum number of samples to be present | +| | for analysis | ++-------------------------------+------------------------------------------------+ +|minimumPercentageChange | Minimum percentage of configuration change | +| | above which control loop should be triggered | ++-------------------------------+------------------------------------------------+ +|initialDelaySeconds | Initial delay in milliseconds for the consumer | +| | thread to start after the application startup | ++-------------------------------+------------------------------------------------+ +|cl_topic | Dmaap topic URL to which onset message to | +| | trigger the control loop are posted | ++-------------------------------+------------------------------------------------+ +|performance_management_topic | Dmaap topic URL to which PM data are posted | +| | by network functions | ++-------------------------------+------------------------------------------------+ +|intelligent_slicing_topic | Dmaap topic URL to which ML MS posts the | +| | messages | ++-------------------------------+------------------------------------------------+ +|dcae_cl_response_topic | Dmaap topic URL to which Policy posts the | +| | message after successful control loop trigger | ++-------------------------------+------------------------------------------------+ + |