aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAdrianSlavkovsky <adrian.slavkovsky@orange.com>2017-11-21 18:01:24 +0100
committerAdrianSlavkovsky <adrian.slavkovsky@orange.com>2017-11-21 18:01:24 +0100
commita64188dccf54a603f1d170c1216394ffe5fd3d49 (patch)
treec2405917a19f0319c407ad0662cd7bbd744073aa /docs
parent722f59e75b5e8d6b2f7ade57c00db8c4b9e75078 (diff)
Improving documentation for AAI single VM setup
Prerequisites chapter added. Formatting improved. Change-Id: Ia43d71522bcdc71779c071957e09204c71fec3e3 Issue-ID: AAI-487 Signed-off-by: AdrianSlavkovsky <adrian.slavkovsky@orange.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst71
1 files changed, 43 insertions, 28 deletions
diff --git a/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst b/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst
index 7776ebdb..d869c9ac 100644
--- a/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst
+++ b/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst
@@ -1,56 +1,71 @@
+
.. contents::
:depth: 3
-..
+.. _dev-setup:
How to Docker setup on Single VM
================================
+Prerequisites
+-------------
+1. Linux distribution Ubuntu is assumed (version 16.04 preferred)
+
+2. Make sure that git, docker and docker-compose are installed
+
Step-by-step guide
------------------
-1. You would need to have root access to the vm
+1. You would need to have a root access to the vm
+ .. code-block:: bash
+
+ sudo su - root
+
+2. Navigate to /opt directory
+ .. code-block:: bash
-2. sudo su - root
+ cd /opt
-3. cd /opt
+3. Clone the test-config git project
+ .. code-block:: bash
-4. git clone http://gerrit.onap.org/r/aai/test-config
+ git clone http://gerrit.onap.org/r/aai/test-config
-5. cd test-config
+4. Navigate to /opt/test-config directory
+ .. code-block:: bash
-6. In deploy\_vm1.sh comment out the lines 89-94 which should be an if
- statement checking for the /opt/message-router folder
+ cd test-config
-7. Create a directory called /opt/config
+5. Create a directory called /opt/config
+ .. code-block:: bash
- 1. mkdir /opt/config/
+ mkdir /opt/config/
-8. Create a file called /opt/config/nexus\_username.txt containing the
- text: docker
+6. Create a file called /opt/config/nexus\_username.txt containing the text: docker
+ .. code-block:: bash
- 1. echo "docker" > /opt/config/nexus\_username.txt
+ echo "docker" > /opt/config/nexus_username.txt
-9. Create a file called /opt/config/nexus\_password.txt containing the
- text: docker
+7. Create a file called /opt/config/nexus\_password.txt containing the text: docker
+ .. code-block:: bash
- 1. echo "docker" > /opt/config/nexus\_password.txt
+ echo "docker" > /opt/config/nexus_password.txt
-10. Create a file called /opt/config/dmaap\_topic.txt containing the
- text: AAI-EVENT
+8. Create a file called /opt/config/dmaap\_topic.txt containing the text: AAI-EVENT
+ .. code-block:: bash
- 1. echo " AAI-EVENT" > /opt/config/dmaap\_topic.txt
+ echo "AAI-EVENT" > /opt/config/dmaap_topic.txt
-11. Create a file called /opt/config/nexus\_docker\_repo.txt containing
- text: nexus3.onap.org:10001
+9. Create a file called /opt/config/nexus\_docker\_repo.txt containing text: nexus3.onap.org:10001
+ .. code-block:: bash
- echo "nexus3.onap.org:10001" > /opt/config/nexus\_docker\_repo.txt
+ echo "nexus3.onap.org:10001" > /opt/config/nexus_docker_repo.txt
-1. Create a file called /opt/config/docker\_version.txt containing text:
- 1.1-STAGING-latest
+10. Create a file called /opt/config/docker\_version.txt containing text: 1.1-STAGING-latest
+ .. code-block:: bash
- echo "1.1-STAGING-latest" > /opt/config/docker\_version.txt
+ echo "1.1-STAGING-latest" > /opt/config/docker_version.txt
-1. Please note that in the previous step, docker version is currently
- 1.1-STAGING-latest and this will be changed later
+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
+ .. code-block:: bash
- ./deploy\_vm2.sh && ./deploy\_vm1.sh
+ ./deploy_vm2.sh && ./deploy_vm1.sh