docs/sections/services/tcagen2-docker/installation.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:
   4
   5
   6 Installation
   7 ============
   8
   9 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.
  10
  11 Deployment Prerequisite/dependencies
  12 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  13
  14     - DCAE and DMaaP pods should be up and running.
  15     - MongoDB should be up and running
  16     - Make sure that cfy is installed and configured to work with the Cloudify deployment.
  17
  18 Deployment steps
  19 ^^^^^^^^^^^^^^^^
  20
  21 Following are steps if manual deployment/undeployment is required.  Steps to deploy are below
  22
  23
  24 Enter the Cloudify Manager kuberenetes pod
  25
  26     .. note::
  27       For doing this, follow the below steps
  28
  29       * First get the bootstrap pod name by running run this: kubectl get pods -n onap | grep bootstrap
  30       * Then login to bootstrap pod by running this: kubectl exec -it <bootstrap pod> bash -n onap
  31
  32     - Tca-gen2 blueprint directory (/blueprints/k8s-tcagen2.yaml). The blueprint is also maintained in gerrit and can be downloaded from https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-tcagen2.yaml
  33
  34     - Create input file required for deployment
  35
  36         Configuration of the service consists of generating an inputs file (YAML) which will be used as part of the
  37         Cloudify install. The tca-gen2 blueprints was designed with known defaults for the majority of the fields.
  38
  39         Below you will find examples of fields which can be configured, and some of the fields
  40         which must be configured.  An input file is loaded into bootstrap container (/inputs/k8s-tcagen2-inputs.yaml).
  41
  42
  43         .. csv-table::
  44             :widths: auto
  45             :delim: ;
  46             :header: Property , Sample Value , Description , Required
  47
  48             tca_handle_in_subscribe_url ; http://message-router:3904/events/unauthenticated.TCAGEN2_OUTPUT/; DMaap topic to publish CL event output ; No
  49             tca_handle_in_subscribe_url ; http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/; DMaap topic to subscribe VES measurement feeds ; No
  50             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
  51
  52         Example inputs.yaml
  53
  54         .. code-block:: yaml
  55
  56                 tag_version: nexus3.onap.org:10001/onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1
  57                 tca_handle_in_subscribe_url: "http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/"
  58                 tca_handle_out_publish_url: "http://message-router:3904/events/unauthenticated.TCAGEN2_OUTPUT/"
  59
  60
  61     - Create deployment
  62
  63         .. code-block:: bash
  64
  65              cfy install --blueprint-id tcagen2 --deployment-id tcagen2 -i /inputs/k8s-tcagen2-inputs.yaml /blueprints/k8s-tcagen2.yaml
  66
  67
  68
  69 To undeploy TCA-gen2, steps are shown below
  70
  71 - Uninstall running TCA-gen2 and delete deployment
  72     .. code-block:: bash
  73
  74         cfy uninstall tcagen2
  75 - Delete blueprint
  76     .. code-block:: bash
  77
  78         cfy blueprints delete tcagen2
  79