diff options
| author |   Ofir Sonsino <os0695@att.com> | 2017-11-08 12:17:53 +0200 |
|---|---|---|
| committer | Ofir Sonsino <os0695@att.com> | 2017-11-08 12:17:53 +0200 |
| commit | 50552cd71c58a5708679702f7e61e9c63bc93729 (patch) | |
| tree | 314109841da09dce87ec486235c6173b3c77c29e /docs | |
| parent | 4dade77663ca66b4ffa093d4b64a3505254a29fd (diff) | |
Update ReadTheDocs docs folder
Change-Id: Ie87e9f78e00a66ca53796363fb1c92be378f7e73
Issue-ID: VID-71
Signed-off-by: Ofir Sonsino <os0695@att.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs-delivery.rst | 23 | ||||
| -rw-r--r-- | docs/docs-installation.rst | 4 | ||||
| -rw-r--r-- | docs/docs-logging.rst | 2 |
3 files changed, 13 insertions, 16 deletions
diff --git a/docs/docs-delivery.rst b/docs/docs-delivery.rst index ee0333439..13a9aa389 100644 --- a/docs/docs-delivery.rst +++ b/docs/docs-delivery.rst @@ -4,15 +4,12 @@ Delivery ======== -VID is delivered as a Docker image, and uses MariaDb which is also delivered as a Docker image. The two images are linked. - - -- MariaDB Image - Create a container using the Docker MariaDB image. +- | **MariaDB Image** + | Create a container using the Docker MariaDB image. -- VID Image - Create a Docker image which extends the Tomcat Docker image, and linked to the MariaDB container created earlier. - Configuration of the Docker container will be customized by providing environment variables to the "docker run" command. +- | **VID Image** + | Create a Docker image which extends the Tomcat Docker image, and linked to the MariaDB container created earlier. + | Configuration of the Docker container will be customized by providing environment variables to the "docker run" command. .. blockdiag:: @@ -32,9 +29,9 @@ VID is delivered as a Docker image, and uses MariaDb which is also delivered as Recommended Rackspace VM Flavor -------------------------------- -+------------+------------------------+--------+------+-----------+-------+-------------+--+--+--+ -| ID | Flavor name | Memory | Disk | Ephemeral | VCPUs | RTTX factor | | | | -+------------+------------------------+--------+------+-----------+-------+-------------+--+--+--+ -| general1-2 | 2GB General Purpose v1 | 2048 | 40 | 0 | 2 | 400.0 | | | | -+------------+------------------------+--------+------+-----------+-------+-------------+--+--+--+ ++------------+------------------------+--------+------+-----------+-------+-------------+ +| ID | Flavor name | Memory | Disk | Ephemeral | VCPUs | RTTX factor | ++============+========================+========+======+===========+=======+=============+ +| general1-2 | 2GB General Purpose v1 | 2048 | 40 | 0 | 2 | 400.0 | ++------------+------------------------+--------+------+-----------+-------+-------------+ diff --git a/docs/docs-installation.rst b/docs/docs-installation.rst index 151f486fd..a2b93d021 100644 --- a/docs/docs-installation.rst +++ b/docs/docs-installation.rst @@ -17,7 +17,7 @@ Please follow the instructions given below, for installing VID using a Docker im 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 + 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) @@ -27,5 +27,5 @@ Please follow the instructions given below, for installing VID using a Docker im 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 + 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 diff --git a/docs/docs-logging.rst b/docs/docs-logging.rst index e9a424b11..52d18e85f 100644 --- a/docs/docs-logging.rst +++ b/docs/docs-logging.rst @@ -9,7 +9,7 @@ Where to Access Log Information +------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Location | Type | Description | -+------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++================================================+=====================+===========================================================================================================================================================================================+ | /usr/local/tomcat/logs/catalina.YYYY-MM-DD.log | Jetty server log | Tomcat server information | +------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | /opt/app/vid/logs/vid/audit.log | Application audit | An audit record is created in response to code transactions/operations taking place in VID. For instance "start logging". | |