| VENKATESH KUMAR | e64d2d6 | 2020-04-06 18:55:10 -0400 | [diff] [blame] | 1 | Installation |
| 2 | ============ |
| 3 | |
| 4 | TCA-gen2 is a microservice that will be configured and instantiated through Cloudify Manager.TCA-gen2 will be deployed by DCAE deployment among the bootstrapped services. This is more to facilitate automated deployment of ONAP regression test cases required services. During instantiation, the TCA-gen2 will fetch its configuration through the Config Binding Service. Steps to deploy using the CLI tool are shown below. |
| 5 | |
| 6 | Deployment Prerequisite/dependencies |
| 7 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 8 | |
| 9 | - DCAE and DMaaP pods should be up and running. |
| 10 | - MongoDB should be up and running |
| 11 | - Make sure that cfy is installed and configured to work with the Cloudify deployment. |
| 12 | |
| 13 | Deployment steps |
| 14 | ^^^^^^^^^^^^^^^^ |
| 15 | |
| 16 | Following are steps if manual deployment/undeployment is required. Steps to deploy are below |
| 17 | |
| 18 | |
| 19 | Enter the Cloudify Manager kuberenetes pod |
| 20 | |
| 21 | - Tca-gen2 blueprint directory (/blueprints/k8s-tcagen2.yaml). The blueprint is also maintained in gerrit and can be downloaded from |
| 22 | https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-tcagen2.yaml |
| 23 | |
| 24 | - Create input file required for deployment |
| 25 | |
| 26 | Configuration of the service consists of generating an inputs file (YAML) which will be used as part of the |
| 27 | Cloudify install. The tca-gen2 blueprints was designed with known defaults for the majority of the fields. |
| 28 | |
| 29 | Below you will find examples of fields which can be configured, and some of the fields |
| 30 | which must be configured. The full list of configurable parameters can be seen within the bootstrap container under |
| 31 | /inputs/k8s-tcagen2-inputs.yaml |
| 32 | |
| 33 | |
| 34 | .. csv-table:: |
| 35 | :widths: auto |
| 36 | :delim: ; |
| 37 | :header: Property , Sample Value , Description , Required |
| 38 | tca_handle_in_subscribe_url ; http://message-router:3904/events/unauthenticated.TCAGEN2_OUTPUT/; DMaap topic to publish CL event output ; No |
| 39 | tca_handle_in_subscribe_url ; http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/; DMaap topic to subscribe VES measurement feeds ; No |
| 40 | tag_version ; nexus3.onap.org:10001/onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1 ; The tag of the Docker image will be used when deploying the tca-gen2. ; No |
| 41 | |
| 42 | Example inputs.yaml |
| 43 | |
| 44 | .. code-block:: yaml |
| 45 | |
| 46 | tag_version: nexus3.onap.org:10001/onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1 |
| 47 | tca_handle_in_subscribe_url: "http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/" |
| 48 | tca_handle_out_publish_url: "http://message-router:3904/events/unauthenticated.TCAGEN2_OUTPUT/" |
| 49 | |
| 50 | |
| 51 | - Create deployment |
| 52 | |
| 53 | .. code-block:: bash |
| 54 | |
| 55 | cfy install --blueprint-id tca-gen2 --deployment-id tca-gen2 -i k8s-tcagen2-inputs.yaml /blueprints/k8s-tcagen2.yaml |
| 56 | |
| 57 | |
| 58 | |
| 59 | To undeploy TCA-gen2, steps are shown below |
| 60 | |
| 61 | - Uninstall running TCA-gen2 and delete deployment |
| 62 | .. code-block:: bash |
| 63 | |
| 64 | cfy uninstall tca-gen2 |
| 65 | - Delete blueprint |
| 66 | .. code-block:: bash |
| 67 | |
| 68 | cfy blueprints delete tca-gen2 |
| 69 | |