Improving documentation for AAI single VM setup
[aai/aai-common.git] / docs / platform / Getting Started / How_to_Docker_setup_on_Single_VM.rst
1
2 .. contents::
3    :depth: 3
4 .. _dev-setup:
5
6 How to Docker setup on Single VM
7 ================================
8
9 Prerequisites
10 -------------
11 1.  Linux distribution Ubuntu is assumed (version 16.04 preferred)
12
13 2.  Make sure that git, docker and docker-compose are installed
14
15 Step-by-step guide
16 ------------------
17
18 1.  You would need to have a root access to the vm
19   .. code-block:: bash
20
21    sudo su - root
22
23 2.  Navigate to /opt directory
24   .. code-block:: bash
25
26    cd /opt
27
28 3.  Clone the test-config git project
29   .. code-block:: bash
30
31    git clone http://gerrit.onap.org/r/aai/test-config
32
33 4.  Navigate to /opt/test-config directory
34   .. code-block:: bash
35
36    cd test-config
37
38 5.  Create a directory called /opt/config
39   .. code-block:: bash
40
41    mkdir /opt/config/
42
43 6.  Create a file called /opt/config/nexus\_username.txt containing the text: docker
44   .. code-block:: bash
45
46     echo "docker" > /opt/config/nexus_username.txt
47
48 7.  Create a file called /opt/config/nexus\_password.txt containing the text: docker
49   .. code-block:: bash
50
51     echo "docker" > /opt/config/nexus_password.txt
52
53 8. Create a file called /opt/config/dmaap\_topic.txt containing the text: AAI-EVENT
54   .. code-block:: bash
55
56     echo "AAI-EVENT" > /opt/config/dmaap_topic.txt
57
58 9. Create a file called /opt/config/nexus\_docker\_repo.txt containing text: nexus3.onap.org:10001
59   .. code-block:: bash
60
61     echo "nexus3.onap.org:10001" > /opt/config/nexus_docker_repo.txt
62
63 10. Create a file called /opt/config/docker\_version.txt containing text: 1.1-STAGING-latest
64   .. code-block:: bash
65
66     echo "1.1-STAGING-latest" > /opt/config/docker_version.txt
67
68 11. Please note that in the previous step, docker version is currently 1.1-STAGING-latest and this will be changed later. Finally, run the installation scripts
69   .. code-block:: bash
70
71     ./deploy_vm2.sh && ./deploy_vm1.sh