diff options
| -rw-r--r-- | docs/docs-delivery.rst | 31 | ||||
| -rw-r--r-- | docs/docs-installation.rst | 31 | ||||
| -rw-r--r-- | docs/docs-logging.rst | 29 | ||||
| -rw-r--r-- | docs/docs-release-notes.rst | 36 |
4 files changed, 48 insertions, 79 deletions
diff --git a/docs/docs-delivery.rst b/docs/docs-delivery.rst index f3f083a73..a66497049 100644 --- a/docs/docs-delivery.rst +++ b/docs/docs-delivery.rst @@ -4,41 +4,20 @@ Delivery ======== -.. note:: - * This section is used to describe a software component packaging. - For a run-time component this might be executable images, containers, etc. - For an SDK this might be libraries. - - * This section is typically provided for a platform-component and sdk; - and referenced in developer and user guides - - * This note must be removed after content has been added. - -Example use of a block diagram. +VID is delivered as a docker image, and uses MariaDb which also delivered as a docker image. The two images are linked. .. blockdiag:: blockdiag layers { orientation = portrait - a -> m; - b -> n; - c -> x; - m -> y; - m -> z; + VID -> MariaDb; + MariaDb -> VID; group l1 { color = blue; - x; y; z; - } - group l2 { - color = yellow; - m; n; + VID; MariaDb; } - group l3 { - color = orange; - a; b; c; - } - } + 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 ------ diff --git a/docs/docs-logging.rst b/docs/docs-logging.rst index 374837695..ee1cc7392 100644 --- a/docs/docs-logging.rst +++ b/docs/docs-logging.rst @@ -7,20 +7,17 @@ Logging Where to Access Information --------------------------- -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| Location | Type | Description | Rolling | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| /opt/app/vid/logs/vid/application.log | Jetty server log | This log describes inner flows inside VID | the log rolls daily | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| /opt/app/vid/logs/vid/audit.log | application audit | An audit record is created for some of the operations in VID | rolls at 20 mb | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| /opt/app/vid/logs/vid/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 mb | -| | | The file is located under: WEB-INF/classes/logback.xml. | | -| | | This log holds the debug and trace level output of the application. | | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| /opt/app/vid/logs/vid/error.log | application logging | This log holds the info and error level output of the application. | rolls at 20 mb | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Location | Type | Description | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/application.log | Jetty server log | This log describes inner flows inside VID | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/audit.log | application audit | An audit record is created for some of the operations in VID | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | +| | | The file is located under: WEB-INF/classes/logback.xml. | +| | | This log holds the debug and trace level output of the application. | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/error.log | application logging | This log holds the info and error level output of the application. | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Error / Warning Messages ------------------------- diff --git a/docs/docs-release-notes.rst b/docs/docs-release-notes.rst index b568bee82..665a0bcec 100644 --- a/docs/docs-release-notes.rst +++ b/docs/docs-release-notes.rst @@ -3,45 +3,27 @@ Release Notes ============= -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - -Version: x.y.z +Version: 1.1.0 -------------- -:Release Date: yyyy-mm-dd +:Release Date: 2017-11-16 **New Features** -One or two sentences explaining the purpose of this Release. - -**Bug Fixes** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. -**Known Issues** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. - - And an optional sentence providing a workaround. +1. Improved TOSCA parser. +2. Change Management - Provides the Operators one tool to install as well as maintain the services as a self service activity. Ability to schedule and execute change management Workflows(Maintenance activities )for already installed vNFs. +3. PNF - PNFs are already installed on the edges of the cloud. In order to configure the PNF its required to connect the service to the PNF. -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_ +**Known Issues** + - `VID-78 <https://jira.onap.org/browse/VID-78>`_ + VID shows HTML code output whenever customer list is empty (Cosmetic) **Upgrade Notes** - -**Deprecation Notes** - -**Other** +A scheduler is needed for the change management feature to work (not included in Amsterdam release). =========== |