Adding docs for CADI
[dmaap/datarouter.git] / docs / 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
4 Installation
5 =============
6
7 **Standalone**
8 Pre-requisites:
9
10 * docker 18.09.3 or higher.
11 * docker-compose 1.17.1 or higher.
12 * Ensure port 8080 is not already in use.
13
14 1. Clone the DMaaP Data Router project from ONAP gerrit:
15
16 .. code-block:: bash
17
18     git clone https://gerrit.onap.org/r/dmaap/datarouter
19
20 2. Move/cd to the docker-compose directory and execute the following:
21
22 .. code-block:: bash
23
24     cd datarouter/datarouter-docker-compose/src/main/resources/
25
26     docker-compose up -d
27
28
29 The following docker containers should be deployed successfully:
30
31 .. code-block:: bash
32
33     docker ps --format '{{.Image}}'
34
35     nexus3.onap.org:10001/onap/dmaap/datarouter-node
36     nexus3.onap.org:10001/onap/dmaap/datarouter-prov
37     nexus3.onap.org:10001/onap/dmaap/datarouter-subscriber
38     mariadb:10.2.14
39
40
41 To verify that the provisioning API is active, get the IP of the datarouter-prov container:
42
43 .. code-block:: bash
44
45     docker inspect --format '{{ .NetworkSettings.Networks.resources_testing_net.IPAddress }}' datarouter-prov
46
47 and execute the following CURL command:
48
49 .. code-block:: bash
50
51     curl -k https://{DR_PROV_CONTAINER_IP}:8443/internal/prov