From 60ceaa46786a736e215388c6cf354f53d0930f77 Mon Sep 17 00:00:00 2001 From: Ofir Sonsino Date: Sun, 29 Oct 2017 17:11:07 +0200 Subject: Update ReadTheDocs docs folder Change-Id: Ia8f1a44ae5cfa488af76e3fcf3560e9efd707f8e Issue-ID: VID-71 Signed-off-by: Ofir Sonsino --- docs/docs-installation.rst | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) (limited to 'docs/docs-installation.rst') diff --git a/docs/docs-installation.rst b/docs/docs-installation.rst index be64a63bb..9d15efbf7 100644 --- a/docs/docs-installation.rst +++ b/docs/docs-installation.rst @@ -4,17 +4,28 @@ Installation ============ -.. note:: - * This section is used to describe how a software component is acquired and installed. - - * This section is typically: provided for a platform-component and application; and - referenced in user guides. +VID is delivered in a Docker image format. + +Using docker image +------------------ + +Please follow the instructions given below, for installing VID using docker image. + +1. Download the vid & mariadb docker image - * This note must be removed after content has been added. +.. code-block:: bash -Environment ------------ + docker pull mariadb:10 + docker login -u docker -p docker nexus3.onap.org:10001 + docker pull nexus3.onap.org:10001/openecomp/vid:1.1-STAGING-latest +2. Install by running following command (Use the path for lf_config folder under 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:1.1-STAGING-latest -Steps ------ -- cgit 1.2.3-korg