[VES-OPENAPI] Update docs with kafka
[dcaegen2.git] / docs / sections / services / restconf / 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 .. _restconf-installation:
4
5
6 Installation
7 ============
8
9 Standalone  docker run command 
10    .. code-block:: bash
11
12             docker run onap/org.onap.dcaegen2.collectors.restconfcollector
13
14 For the current release, RESTConf collector will be a DCAE component that can dynamically be deployed via Cloudify blueprint installation.
15
16
17 Steps to deploy are shown below
18
19 - Enter the Bootstrap POD using kubectl
20
21      .. note::
22        For doing this, follow the below steps
23
24        * First get the bootstrap pod name by running run this: kubectl get pods -n onap | grep bootstrap
25        * Then login to bootstrap pod by running this: kubectl exec -it <bootstrap pod> bash -n onap
26
27 - Validate blueprint
28     .. note::
29       Verify that the version of the plugin used should match with "cfy plugins list" and use an explicit URL to the plugin YAML file if needed in the blueprint.
30
31     .. code-block:: bash
32         
33         cfy blueprints validate /blueprints/k8s-restconf.yaml
34 - Upload validated blueprint
35     .. code-block:: bash
36         
37
38         cfy blueprints upload -b restconfcollector /blueprints/k8s-restconf.yaml
39 - Create deployment
40     .. code-block:: bash
41         
42
43         cfy deployments create -b restconfcollector restconfcollector
44 - Deploy blueprint
45     .. code-block:: bash
46         
47
48         cfy executions start -d restconfcollector install
49
50 To undeploy restconfcollector, steps are shown below
51
52 - Uninstall running restconfcollector and delete deployment
53     .. code-block:: bash
54         
55
56         cfy uninstall restconfcollector
57 - Delete blueprint
58     .. code-block:: bash
59         
60
61         cfy blueprints delete restconfcollector