clean up some sphinx warnings
[dcaegen2.git] / docs / sections / services / slice-analysis-ms / installation-helm.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. _sliceanalysis-installation-helm:
4
5
6 Helm Installation
7 =================
8
9 Slice Analysis MS can be deployed using helm charts as kubernetes applications.
10
11 Deployment Pre-requisites
12 ~~~~~~~~~~~~~~~~~~~~~~~~~
13 - DCAE and DMaaP pods should be up and running.
14
15 - PM mapper service should be running.
16
17 - Config DB service, CPS and AAI should be running.
18
19 - The environment should have helm and kubernetes installed.
20
21 - 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.
22
23   For example:
24       .. code-block:: bash
25
26           helm package <dcaegen2-services-common>
27
28
29
30 Deployment steps
31 ~~~~~~~~~~~~~~~~
32 1. Go to the directory where dcae-slice-analysis-ms chart is present and Execute the below command.
33     .. code-block:: bash
34
35         helm install <slice_analysis_ms> <dcae-slice-analysis-ms> --namespace onap --set global.masterPassword=guilin2021
36
37
38 2. We can check the logs of the slice-analysis-ms container by using the below command
39     .. code-block:: bash
40
41         kubectl logs -f -n onap <dev-dcae-slice-analysis-ms-9fd8495f7-zmnlw> -c <dcae-slice-analysis-ms>
42
43
44 3. To un-deploy
45
46 .. code-block:: bash
47
48         helm uninstall <slice_analysis_ms>
49
50
51
52 Application configurations
53 ~~~~~~~~~~~~~~~~~~~~~~~~~~
54 +-------------------------------+------------------------------------------------+
55 |Configuration                  | Description                                    |
56 +===============================+================================================+
57 |postgres host                  | Host where the postgres application is running |
58 +-------------------------------+------------------------------------------------+
59 |pollingInterval                | Dmaap Polling interval in milliseconds         |
60 +-------------------------------+------------------------------------------------+
61 |pollingTimeout                 | Dmaap Polling timeout in milliseconds          |
62 +-------------------------------+------------------------------------------------+
63 |configDb service               | Host where the config DB application is running|
64 +-------------------------------+------------------------------------------------+
65 |configDbEnabled                | To choose whether to use config DB or CPS & AAI|
66 +-------------------------------+------------------------------------------------+
67 |aai url                        | Host where the AAI application is running      |
68 +-------------------------------+------------------------------------------------+
69 |cps url                        | Host where cps tbdmt application is running    |
70 +-------------------------------+------------------------------------------------+
71 |samples                        | Minimum number of samples to be present        |
72 |                               | for analysis                                   |
73 +-------------------------------+------------------------------------------------+
74 |minimumPercentageChange        | Minimum percentage of configuration change     |
75 |                               | above which control loop should be triggered   |
76 +-------------------------------+------------------------------------------------+
77 |initialDelaySeconds            | Initial delay in milliseconds for the consumer |
78 |                               | thread to start after the application startup  |
79 +-------------------------------+------------------------------------------------+
80 |cl_topic                       | Dmaap topic URL to which onset message to      |
81 |                               | trigger  the control loop are posted           |
82 +-------------------------------+------------------------------------------------+
83 |performance_management_topic   | Dmaap topic URL to which PM data are posted    |
84 |                               | by network functions                           |
85 +-------------------------------+------------------------------------------------+
86 |intelligent_slicing_topic      | Dmaap topic URL to which ML MS posts the       |
87 |                               | messages                                       |
88 +-------------------------------+------------------------------------------------+
89 |dcae_cl_response_topic         | Dmaap topic URL to which Policy posts the      |
90 |                               | message after successful control loop trigger  |
91 +-------------------------------+------------------------------------------------+