update link to upper-constraints.txt
[dcaegen2.git] / docs / sections / services / tcagen2-docker / 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 .. _tcagen2-installation-helm:
4
5
6 Helm Installation
7 =================
8
9 The TCA-gen2 microservice can be deployed using helm charts in the oom repository.
10
11 Deployment Pre-requisites
12 ~~~~~~~~~~~~~~~~~~~~~~~~~
13 - DCAE and DMaaP pods should be up and running.
14 - MongoDB should be up and running.
15
16 Deployment steps
17 ~~~~~~~~~~~~~~~~
18
19 - Default app config values can be updated in oom/kubernetes/dcaegen2-services/components/dcae-tcagen2/values.yaml.
20
21 - Make the chart and deploy using the following command:
22
23   .. code-block:: bash
24
25     cd oom/kubernetes/
26     make dcaegen2-services
27     helm install dev-dcaegen2-services dcaegen2-services --namespace <namespace> --set global.masterPassword=<password>
28
29 - To deploy only tcagen2:
30
31   .. code-block:: bash
32
33     helm install dev-dcae-tcagen2 dcaegen2-services/components/dcae-tcagen2 --namespace <namespace> --set global.masterPassword=<password>
34
35 - To Uninstall
36
37   .. code-block:: bash
38
39     helm uninstall dev-dcae-tcagen2
40
41 Application Configurations
42 --------------------------
43 +-------------------------------+------------------------------------------------+
44 |Configuration                  | Description                                    |
45 +===============================+================================================+
46 |streams_subscribes             | Dmaap topics that the MS will consume messages |
47 +-------------------------------+------------------------------------------------+
48 |streams_publishes              | Dmaap topics that the MS will publish messages |
49 +-------------------------------+------------------------------------------------+
50 |streams_subscribes.            | Max polling Interval for consuming config data |
51 |tca_handle_in.                 | from dmaap                                     |
52 |polling.auto_adjusting.max     |                                                |
53 |                               |                                                |
54 +-------------------------------+------------------------------------------------+
55 |streams_subscribes.            | Min polling Interval for consuming config data |
56 |tca_handle_in.                 | from dmaap                                     |
57 |polling.auto_adjusting.min     |                                                |
58 |                               |                                                |
59 +-------------------------------+------------------------------------------------+
60 |streams_subscribes.            | Step down in polling Interval for consuming    |
61 |tca_handle_in.                 | config data from dmaap                         |
62 |polling.auto_adjusting.        |                                                |
63 |step_down                      |                                                |
64 +-------------------------------+------------------------------------------------+
65 |streams_subscribes.            | Step up polling Interval for consuming config  |
66 |tca_handle_in.                 | data from dmaap                                |
67 |polling.auto_adjusting.step_up |                                                |
68 +-------------------------------+------------------------------------------------+
69 |spring.data.mongodb.uri        | MongoDB URI                                    |
70 +-------------------------------+------------------------------------------------+
71 |tca.aai.generic_vnf_path       | AAI generic VNF path                           |
72 +-------------------------------+------------------------------------------------+
73 |tca.aai.node_query_path        | AAI node query path                            |
74 +-------------------------------+------------------------------------------------+
75 |tca.aai.password               | AAI password                                   |
76 +-------------------------------+------------------------------------------------+
77 |tca.aai.url                    | AAI base URL                                   |
78 +-------------------------------+------------------------------------------------+
79 |tca.aai.username               | AAI username                                   |
80 +-------------------------------+------------------------------------------------+
81 |streams_subscribes.            | DMAAP Consumer group for subscription          |
82 |tca_handle_in.consumer_group   |                                                |
83 +-------------------------------+------------------------------------------------+
84 |streams_subscribes.            | DMAAP Consumer id for subscription             |
85 |tca_handle_in.consumer_ids[0]  |                                                |
86 +-------------------------------+------------------------------------------------+
87 |tca.policy                     | Policy details                                 |
88 +-------------------------------+------------------------------------------------+
89 |tca.processing_batch_size      | Processing batch size                          |
90 +-------------------------------+------------------------------------------------+
91 |tca.enable_abatement           | Enable abatement                               |
92 +-------------------------------+------------------------------------------------+
93 |tca.enable_ecomp_logging       | Enable ecomp logging                           |
94 +-------------------------------+------------------------------------------------+