summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/tcagen2-docker
diff options
context:
space:
mode:
authorNiranjana <niranjana.y60@wipro.com>2021-10-08 14:12:10 +0000
committerNiranjana Y <niranjana.y60@wipro.com>2021-10-08 15:06:22 +0000
commit939c4866b01b6cceae6e4c7dd61a95d79f07c7ef (patch)
tree7d414a5fb00121d70474302fcdaff9826421cbdc /docs/sections/services/tcagen2-docker
parenta2040ba29cbb7a7d7ba51e95e333696d4b9ea427 (diff)
Add Helm installation guide TCA-GEN2
Issue-ID: DCAEGEN2-2630 Signed-off-by: Niranjana <niranjana.y60@wipro.com> Change-Id: I4d004ff51d6f47ec8c0df88daa1217c8b88cfe39
Diffstat (limited to 'docs/sections/services/tcagen2-docker')
-rw-r--r--docs/sections/services/tcagen2-docker/index.rst1
-rw-r--r--docs/sections/services/tcagen2-docker/installation-helm.rst95
2 files changed, 96 insertions, 0 deletions
diff --git a/docs/sections/services/tcagen2-docker/index.rst b/docs/sections/services/tcagen2-docker/index.rst
index 21da243e..c5fc85da 100644
--- a/docs/sections/services/tcagen2-docker/index.rst
+++ b/docs/sections/services/tcagen2-docker/index.rst
@@ -16,6 +16,7 @@ The TCA-gen2 is docker based mS intended to replace TCA/cdap version, which was
:maxdepth: 1
./installation
+ ./installation-helm.rst
./configuration
./functionality
./delivery \ No newline at end of file
diff --git a/docs/sections/services/tcagen2-docker/installation-helm.rst b/docs/sections/services/tcagen2-docker/installation-helm.rst
new file mode 100644
index 00000000..e4a25d9b
--- /dev/null
+++ b/docs/sections/services/tcagen2-docker/installation-helm.rst
@@ -0,0 +1,95 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. _tcagen2-installation-helm:
+
+
+Helm Installation
+=================
+
+The TCA-gen2 microservice can be deployed using helm charts in the oom repository.
+
+Deployment Pre-requisites
+~~~~~~~~~~~~~~~~~~~~~~~~~
+- DCAE and DMaaP pods should be up and running.
+- MongoDB should be up and running.
+
+Deployment steps
+~~~~~~~~~~~~~~~~
+
+- Default app config values can be updated in oom/kubernetes/dcaegen2-services/components/dcae-tcagen2/values.yaml.
+
+- Make the chart and deploy using the following command:
+
+ .. code-block:: bash
+
+ cd oom/kubernetes/
+ make dcaegen2-services
+ helm install dev-dcaegen2-services dcaegen2-services --namespace <namespace> --set global.masterPassword=<password>
+
+- To deploy only tcagen2:
+
+ .. code-block:: bash
+
+ helm install dev-dcae-tcagen2 dcaegen2-services/components/dcae-tcagen2 --namespace <namespace> --set global.masterPassword=<password>
+
+- To Uninstall
+
+ .. code-block:: bash
+
+ helm uninstall dev-dcae-tcagen2
+
+Application Configurations
+--------------------------
++-------------------------------+------------------------------------------------+
+|Configuration | Description |
++===============================+================================================+
+|streams_subscribes | Dmaap topics that the MS will consume messages |
++-------------------------------+------------------------------------------------+
+|streams_publishes | Dmaap topics that the MS will publish messages |
++-------------------------------+------------------------------------------------+
+|streams_subscribes. | Max polling Interval for consuming config data |
+|tca_handle_in. | from dmaap |
+|polling.auto_adjusting.max | |
+| | |
++-------------------------------+------------------------------------------------+
+|streams_subscribes. | Min polling Interval for consuming config data |
+|tca_handle_in. | from dmaap |
+|polling.auto_adjusting.min | |
+| | |
++-------------------------------+------------------------------------------------+
+|streams_subscribes. | Step down in polling Interval for consuming |
+|tca_handle_in. | config data from dmaap |
+|polling.auto_adjusting. | |
+|step_down | |
++-------------------------------+------------------------------------------------+
+|streams_subscribes. | Step up polling Interval for consuming config |
+|tca_handle_in. | data from dmaap |
+|polling.auto_adjusting.step_up | |
++-------------------------------+------------------------------------------------+
+|spring.data.mongodb.uri | MongoDB URI |
++-------------------------------+------------------------------------------------+
+|tca.aai.generic_vnf_path | AAI generic VNF path |
++-------------------------------+------------------------------------------------+
+|tca.aai.node_query_path | AAI node query path |
++-------------------------------+------------------------------------------------+
+|tca.aai.password | AAI password |
++-------------------------------+------------------------------------------------+
+|tca.aai.url | AAI base URL |
++-------------------------------+------------------------------------------------+
+|tca.aai.username | AAI username |
++-------------------------------+------------------------------------------------+
+|streams_subscribes. | DMAAP Consumer group for subscription |
+|tca_handle_in.consumer_group | |
++-------------------------------+------------------------------------------------+
+|streams_subscribes. | DMAAP Consumer id for subscription |
+|tca_handle_in.consumer_ids[0] | |
++-------------------------------+------------------------------------------------+
+|tca.policy | Policy details |
++-------------------------------+------------------------------------------------+
+|tca.processing_batch_size | Processing batch size |
++-------------------------------+------------------------------------------------+
+|tca.enable_abatement | Enable abatement |
++-------------------------------+------------------------------------------------+
+|tca.enable_ecomp_logging | Enable ecomp logging |
++-------------------------------+------------------------------------------------+
+