Merge "[SLICEMS] Docs for SliceMS Kohn"
[dcaegen2.git] / docs / sections / services / slice-analysis-ms / installation.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
2 .. http://creativecommons.org/licenses/by/4.0\r
3 .. _sliceanalysis-installation:\r
4 \r
5 \r
6 Installation\r
7 ============\r
8 \r
9 Slice Analysis MS can be deployed by OOM. Make sure to enable "dcae-slice-analysis-ms" in oom/kubernetes/dcaegen2-services/values.yaml first.\r
10 \r
11 Deployment Pre-requisites\r
12 ~~~~~~~~~~~~~~~~~~~~~~~~~\r
13 - DCAE and DMaaP pods should be up and running. \r
14 \r
15 - DMaaP Bus Controller PostInstalls job should have completed successfully (executed as part of an OOM install).\r
16 \r
17 - PM mapper service should be running.\r
18 \r
19 - Config DB service should be running.\r
20 \r
21 - Make sure that cfy is installed and configured to work with the Cloudify deployment.\r
22 \r
23 \r
24 Deployment steps\r
25 ~~~~~~~~~~~~~~~~\r
26 1. Execute bash on the bootstrap Kubernetes pod. \r
27    \r
28    kubectl -n onap exec -it <dcaegen2-dcae-bootstrap> bash\r
29 \r
30 2. Go to the /blueprints directory.\r
31 \r
32   Check that the tag_version in the slice-analysis-ms blueprint is correct for the release\r
33   of ONAP that it is being installed on see Nexus link below for slice-analysis-ms for tag_versions.\r
34   Nexus link: https://nexus3.onap.org/#browse/browse:docker.public:v2%2Fonap%2Forg.onap.dcaegen2.services.components.slice-analysis-ms%2Ftags\r
35 \r
36 3. Create an input file.\r
37 \r
38 4. Run the Cloudify install command to install the slice-analysis-ms with the blueprint and the newly    created input file k8s-slice-input.yaml.\r
39 \r
40    $ cfy install k8s-slice-analysis-ms.yaml -i  k8s-slice-input.yaml --blueprint-id sliceanalysisms\r
41 \r
42    Details of the sample output are available at:\r
43    https://wiki.onap.org/pages/viewpage.action?pageId=92998809.\r
44 \r
45 5. To un-deploy\r
46 \r
47   $ cfy uninstall sliceanalysisms\r
48 \r
49 \r
50 Application configurations\r
51 ~~~~~~~~~~~~~~~~~~~~~~~~~~\r
52 +-------------------------------+------------------------------------------------+\r
53 |Configuration                  | Description                                    |\r
54 +===============================+================================================+\r
55 |samples                        | Minimum number of samples to be present        |\r
56 |                               | for analysis                                   |\r
57 +-------------------------------+------------------------------------------------+\r
58 |minimumPercentageChange        | Minimum percentage of configuration change     |\r
59 |                               | above which control loop should be triggered   |\r
60 +-------------------------------+------------------------------------------------+\r
61 |initialDelaySeconds            | Initial delay in milliseconds for the consumer |\r
62 |                               | thread to start after the application startup  |\r
63 +-------------------------------+------------------------------------------------+\r
64 |config_db                      | Host where the config DB application is running|\r
65 +-------------------------------+------------------------------------------------+\r
66 |performance_management_topicurl| Dmaap Topic URL to which PM data are posted    |\r
67 |                               | by network functions                           |\r
68 +-------------------------------+------------------------------------------------+\r
69 |dcae_cl_topic_url              | Dmaap topic to which onset message to trigger  |\r
70 |                               | the control loop are posted                    |\r
71 +-------------------------------+------------------------------------------------+\r
72 |dcae_cl_response_topic_url     | Dmaap topic URL to which Policy posts the      |\r
73 |                               | message after successful control loop trigger  |\r
74 +-------------------------------+------------------------------------------------+\r
75 |intelligent_slicing_topic_url  | Dmaap topic URL to which ML MS posts the       |\r
76 |                               | messages                                       |\r
77 +-------------------------------+------------------------------------------------+\r
78 |dmaap_polling_interval         | Dmaap Polling interval in milliseconds         |\r
79 +-------------------------------+------------------------------------------------+\r
80 \r