summaryrefslogtreecommitdiffstats
path: root/docs/installation.rst
diff options
context:
space:
mode:
authorOfir Sonsino <os0695@att.com>2017-11-08 16:55:45 +0200
committerOfir Sonsino <os0695@att.com>2017-11-08 16:55:45 +0200
commitb07d7922c9bba8d33918ecdb2fd3d3bc03175b9f (patch)
treec16da6ad68dee60b327bff15a9f612c96aa3014b /docs/installation.rst
parent50552cd71c58a5708679702f7e61e9c63bc93729 (diff)
Update ReadTheDocs docs folder
Change-Id: Ifec6f6fd659b1a6d6a3c23f2c02eb2c1fdc0973e Issue-ID: VID-71 Signed-off-by: Ofir Sonsino <os0695@att.com>
Diffstat (limited to 'docs/installation.rst')
-rw-r--r--docs/installation.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 00000000..a2b93d02
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,31 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation
+============
+
+VID is delivered in a Docker image format.
+
+Installing VID Using a Docker Image
+-----------------------------------
+
+Please follow the instructions given below, for installing VID using a Docker image.
+
+1. Download the vid & mariadb Docker image
+
+.. code-block:: bash
+
+ docker pull mariadb:10
+ docker login -u docker -p docker nexus3.onap.org:10001
+ docker pull nexus3.onap.org:10001/openecomp/vid:v1.1.0
+
+2. Install by running following command (Use the path for the lf_config folder under the VID git repository as CONFIG_PATH)
+
+.. code-block:: bash
+
+ #start Maria-DB
+ docker run --name vid-mariadb -e MYSQL_DATABASE=vid_openecomp_epsdk -e MYSQL_USER=vidadmin -e MYSQL_PASSWORD=YOUR_PASSWORD -e MYSQL_ROOT_PASSWORD=ROOT_PASSWORD -v CONFIG_PATH/vid-my.cnf:/etc/mysql/my.cnf -v CONFIG_PATH/vid-pre-init.sql:/docker-entrypoint-initdb.d/vid-pre-init.sql -v /var/lib/mysql -d mariadb:10
+
+ #start VID server
+ docker run -e VID_MYSQL_DBNAME=vid_openecomp_epsdk -e VID_MYSQL_PASS=YOUR_PASSWORD --name vid-server -p 8080:8080 --link vid-mariadb:vid-mariadb-docker-instance -d nexus3.onap.org:10001/openecomp/vid:v1.1.0
+