From 0e1e6a925e99446cdd653b606b04c2fc43fb28c0 Mon Sep 17 00:00:00 2001 From: Ofir Sonsino Date: Wed, 8 Nov 2017 11:31:34 +0200 Subject: Update ReadTheDocs docs folder Change-Id: Ia95169494404548706371f608b4e53ac8ffa6ad2 Issue-ID: VID-71 Signed-off-by: Ofir Sonsino --- docs/docs-administration.rst | 19 +++------------- docs/docs-architecture.rst | 20 ++++++++-------- docs/docs-configuration.rst | 53 +++++++++++++++++++++++++++++-------------- docs/docs-consumedapis.rst | 20 ++++++++-------- docs/docs-delivery.rst | 35 ++++++++++++++++++++-------- docs/docs-humaninterfaces.rst | 8 +++++-- docs/docs-installation.rst | 10 ++++---- docs/docs-logging.rst | 34 +++++++++++++++------------ docs/docs-offeredapis.rst | 20 ++++++++-------- docs/docs-release-notes.rst | 11 +++++---- docs/index.rst | 1 + 11 files changed, 133 insertions(+), 98 deletions(-) (limited to 'docs') diff --git a/docs/docs-administration.rst b/docs/docs-administration.rst index 94a740718..33595fdb8 100644 --- a/docs/docs-administration.rst +++ b/docs/docs-administration.rst @@ -4,21 +4,8 @@ Administration ============== - -.. note:: - * This section is used to describe a software component from the perspective of on-going - operation including regular processes and actions that are taken to configure and manage - the component. - - * This section is typically: provided for platform-component or applications; and - referenced in user guides - - * This note must be removed after content has been added. - - -Processes ---------- - - Actions ------- + +- | **Set the list of services to be instantiated by MACRO** + | To set a certain service for the MACRO style instantiation instead of A La Carte, update MACRO_SERVICES in vidConfiguration.js file, with the service model invariant UUID (More info under the Configurations section). \ No newline at end of file diff --git a/docs/docs-architecture.rst b/docs/docs-architecture.rst index 2710cb9a2..40e337fef 100644 --- a/docs/docs-architecture.rst +++ b/docs/docs-architecture.rst @@ -22,18 +22,18 @@ Scope - Macro orchestration. - A la carte orchestration. - - Choose target instantiation environment (e.g. multi-clouds, + - Choose the target instantiation environment (e.g. multi-clouds, testing environment, etc.). - - Check availability of already-created and reserved cloud + - Check the availability of already-created and reserved cloud resources. - Invoke the creations of cloud resources. - - Customize Service and VNF/VF to fit a current instantiation. + - Customize Services and VNF/VF to fit a current instantiation. - Based on SDC Design specific assignments. - - Feedback on instantiation process according to the instantiation + - Feedback on the instantiation process according to the instantiation workflow. - Ability to invoke maintenance operations on an unsuccessful @@ -41,30 +41,30 @@ Scope - Change-management - - Integration with inventory (A&AI) to retrieve current deployed + - Integration with inventory (A&AI) to retrieve currently deployed Services. - Agnostic and specific change-management workflows derived from SDC Service and VNF/VF models. - - Invoke a CM for a given Service and VNF/VF. - - invoke a CM for monitoring-templates (MTs: control-loops). - - invoke a CM for policy changes + - Invoke a CM for monitoring-templates (MTs: control-loops). + - Invoke a CM for policy changes - Invoke a CM for license changes - etc.. - - Ability to operate on a workflow (e.g. actions as stop, start, + - Ability to perform operations on a workflow (e.g. actions as stop, start, restart, resume). - Ability to schedule a workflow - notify - automatic instantiation upon reaching the scheduled time. -- Invoke Security, Load and performance test on a given Service and +- Invoke security, load and performance tests on a given Service and VNF/VF. - Collaboration - - Project/Admin dashboard (include user management, VNF/VF and + - Project/Admin dashboard (includes user management, VNF/VF and Services relevant to the project). - Interfaces: diff --git a/docs/docs-configuration.rst b/docs/docs-configuration.rst index 9142c4c61..6357d5aac 100644 --- a/docs/docs-configuration.rst +++ b/docs/docs-configuration.rst @@ -4,57 +4,76 @@ Configuration ============= -Configurations files are located under ``WEB-INF/conf/`` +Configurations .properties files are located under ``WEB-INF/conf/``, while .js files are under ``scripts/constants/`` system.properties file ---------------------- ``db.connectionURL`` - The connection URL for VID database + The connection URL for the VID database ``db.userName`` - The username for VID database + The username for the VID database ``db.password`` - The password for VID database + The password for the VID database ``aai.server.url.base`` - Base URL for A&AI server + Base URL for the A&AI server ``aai.server.url`` - URL for A&AI server including its version (default: v11) + URL for the A&AI server including its version (default: v11) ``aai.vid.username``, ``aai.vid.pass`` - Credentials for accessing A&AI + Credentials for accessing A&AI server offered APIs ``mso.server.url`` - Base URL for SO server + Base URL for the SO server ``mso.polling.interval.msecs`` - Interval in milliseconds for polling SO for instantiation status + Interval in milliseconds for polling the SO for the instantiation status ``mso.max.polls`` - Max polling tryings fo SO instantiation status + Max attempts for polling the SO instantiation status ``mso.user.name``, ``mso.password.x`` - Credentials for accessing SO + Credentials for accessing the SO server ``scheduler.server.url`` - Base URL for Scheduler + Base URL for the Scheduler ``scheduler.create.new.vnf.change.instance``, ``scheduler.get.time.slots``, ``scheduler.submit.new.vnf.change``, ``scheduler.get.schedules`` Scheduler endpoints asdc.properties file ----------------------------- +---------------------- ``asdc.client.rest.protocol`` - States the protocol for accessing SDC: http or https + States the protocol used for accessing SDC: http or https ``asdc.client.rest.host`` - States the hostname of SDC instance + States the hostname of the SDC instance ``asdc.client.rest.port`` - States the port of SDC instance + States the port of the SDC instance ``asdc.client.rest.auth`` - Basic authorization string to access SDC \ No newline at end of file + Basic authorization string for accessing SDC + +vidConfiguration.js file +------------------------ +``MSO_MAX_POLLS`` + Max attempts for polling the SO instantiation status + +``MSO_POLLING_INTERVAL_MSECS`` + Interval in milliseconds for polling the SO for the instantiation status + +``SCHEDULER_POLLING_INTERVAL_MSECS`` + Interval in milliseconds for polling the Scheduler + +``SCHEDULER_MAX_POLLS`` + Max attempts for polling the Scheduler + +``MACRO_SERVICES`` + | List of all service model invariant UUIDs that need macro instantiation. + | Example: ["3cf30cbb-5fe7-4fb3-b049-559a4997b221", "b135a703-bab5-4295-a37f-580a4f2d0961"] + \ No newline at end of file diff --git a/docs/docs-consumedapis.rst b/docs/docs-consumedapis.rst index 189b80a13..4326aeec6 100644 --- a/docs/docs-consumedapis.rst +++ b/docs/docs-consumedapis.rst @@ -9,9 +9,9 @@ SDC ---- +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| /sdc/v1/catalog/services/meta | Get services general. | +| /sdc/v1/catalog/services/meta | Get available services | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| /sdc/v1/catalog/services/toscaModel | Download csar by UUID | +| /sdc/v1/catalog/services/toscaModel | Download CSAR by UUID | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ SO @@ -38,7 +38,7 @@ SO | POST | Create Volume group | | /serviceInstances/v5//vnfs//volumeGroups | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| DELETE | Delete Volume Group | +| DELETE | Delete Volume group | | /serviceInstances/v5//vnfs//volumeGroups | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ | POST | Create configuration | @@ -55,7 +55,7 @@ SO +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ | GET /orchestrationRequests/v5 | Get orchestration status | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET /tasks/v1 | Get available Manual tasks by request id | +| GET /tasks/v1 | Get available manual tasks by request id | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ @@ -66,13 +66,13 @@ A&AI | GET | Get all subscribers | | aai/v11/business/customers?subscriber-type=INFRA&depth=2 | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET aai/v11/ | Get data for specific subscriber including its available services | +| GET aai/v11/ | Get data for a specific subscriber including its available services | | business/customers/customer/ | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ | GET | Get all service types | | aai/v11/service-design-and-creation/services | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET | Get services by owning entity id | +| GET | Get services by owner entity id | | aai/v11/business/owning-entities? | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ | GET | Get services by project name | @@ -80,17 +80,17 @@ A&AI +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ | GET aai/v11/network/zones | Get all AIC zones | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| POST search/named-query | Get the data regarding instance and it’s related nodes | +| POST search/named-query | Get data regarding an instance and the instance's related nodes | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET aai/v11/ | Get AIC zones for specific service instance | +| GET aai/v11/ | Get AIC zones for a specific service instance | | business/customers/customer// | | | /service-subscriptions/service-subscription//service-instances/service-instance/ | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| PUT Aai/v11/query?format=simple(types: | This is custom query and has multiple types (declared in the url line) | +| PUT Aai/v11/query?format=simple(types: | This is a custom query and has multiple types(declared in the url line)| | “query/vnfFromModelbyRegion?cloudRegionId”,” | | | vnf-topology-fromServiceInstance”) | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| Aai/v11/ | Get human readable version by version id | +| Aai/v11/ | Get the human readable version by version id | | service-design-and-creation/models?depth=2 | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ | business/customers/customer//service-subscriptions/service-subscription/?depth=0 | Get all service subscriptions | diff --git a/docs/docs-delivery.rst b/docs/docs-delivery.rst index a66497049..ee0333439 100644 --- a/docs/docs-delivery.rst +++ b/docs/docs-delivery.rst @@ -4,20 +4,37 @@ Delivery ======== -VID is delivered as a docker image, and uses MariaDb which also delivered as a docker image. The two images are linked. +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. + +- 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:: - blockdiag layers { - orientation = portrait - VID -> MariaDb; - MariaDb -> VID; - group l1 { - color = blue; - VID; MariaDb; - } + node_width = 200; + default_fontsize = 24; + node_height = 100; + orientation = portrait + VID -> MariaDb [dir = both]; + + group l1 { + VID; MariaDb [shape = flowchart.database]; + } } +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 | | | | ++------------+------------------------+--------+------+-----------+-------+-------------+--+--+--+ diff --git a/docs/docs-humaninterfaces.rst b/docs/docs-humaninterfaces.rst index 31843b426..25c7b5d7e 100644 --- a/docs/docs-humaninterfaces.rst +++ b/docs/docs-humaninterfaces.rst @@ -4,8 +4,12 @@ Human Interfaces ================ -The following VID user guides are available in ONAP Wiki: +User Guides +------------ + + +The following VID user guides are available on the ONAP Wiki: -- `VID Application overview `_ +- `VID Application Overview `_ - `Gather and validate data for an infrastructure service/network `_ - `Instantiate an infrastructure service `_ diff --git a/docs/docs-installation.rst b/docs/docs-installation.rst index 9d15efbf7..151f486fd 100644 --- a/docs/docs-installation.rst +++ b/docs/docs-installation.rst @@ -6,12 +6,12 @@ Installation VID is delivered in a Docker image format. -Using docker image ------------------- +Installing VID Using a Docker Image +----------------------------------- -Please follow the instructions given below, for installing VID using docker image. +Please follow the instructions given below, for installing VID using a Docker image. -1. Download the vid & mariadb docker image +1. Download the vid & mariadb Docker image .. code-block:: bash @@ -19,7 +19,7 @@ Please follow the instructions given below, for installing VID using docker imag 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) +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 diff --git a/docs/docs-logging.rst b/docs/docs-logging.rst index ee1cc7392..e9a424b11 100644 --- a/docs/docs-logging.rst +++ b/docs/docs-logging.rst @@ -4,20 +4,24 @@ Logging ======= -Where to Access Information ---------------------------- +Where to Access Log Information +-------------------------------- -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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. | -+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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". | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/application.log | Application logging | This log describes internal flows within VID. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/debug.log | Application logging | Higher level logging can be enabled 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 application's debug and trace level output. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/error.log | Application logging | This log holds the application's exceptions info and error level output. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/metrics.log | Application logging | This log holds the metrics info on application's transactions. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/docs-offeredapis.rst b/docs/docs-offeredapis.rst index 9181b1951..4408bf6f0 100644 --- a/docs/docs-offeredapis.rst +++ b/docs/docs-offeredapis.rst @@ -1,13 +1,13 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -VID API +Offered APIs ================= +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Entity | Method | Path Info | Description | +=====================+==========+=======================================================+===========================================================================================================================================================================================+ -| Health Check | GET | /healthCheck | The Health Status of application check the DB connection | +| Health Check | GET | /healthCheck | The Health Status of the application checks the DB connection. | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | Used by IDNS for redundancy | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -17,7 +17,7 @@ VID API +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | - statusCode Either 200 or 500 | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | - message Additional detail in case of error, empty in case of success. | +| | | | - The message contains additional detail in the case of an error, and is empty in the case of success. | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -39,7 +39,7 @@ VID API +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of application check the DB connection | +| Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of the application checks the DB connection | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,9 +47,9 @@ VID API +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | - statusCode Either 200 or 500 | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | - message Additional detail in case of error, empty in case of success. | +| | | | - message contains additional detail in the case of an error, and is empty in the case of success. | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | - date string of current date & time | +| | | | - date string indicating the current date & time | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,7 +69,7 @@ VID API +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Change management | GET | change-management/workflow {vnfStringsList} | Get Workflows details For VNFs list | +| Change management | GET | change-management/workflow {vnfStringsList} | Get Workflow details for the VNFs list | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,7 +77,7 @@ VID API +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Change management | GET | change-management/mso | Get MSO Change Managements | +| Change management | GET | change-management/mso | Get MSO Change Management details | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -127,7 +127,7 @@ VID API +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Change management | GET | change-management/scheduler | Get Scheduler Change Managements | +| Change management | GET | change-management/scheduler | Get Scheduler Change Management Details | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -135,7 +135,7 @@ VID API +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | HTTP Code 200 | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | response: scheduler details in json | +| | | | response: Scheduler details in json | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | | +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/docs-release-notes.rst b/docs/docs-release-notes.rst index 665a0bcec..7c054a651 100644 --- a/docs/docs-release-notes.rst +++ b/docs/docs-release-notes.rst @@ -14,16 +14,19 @@ Version: 1.1.0 **New Features** 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. +2. Change Management - Provides the Operators a single tool for installing and maintaining the services as a self service activity. Provides the ability to schedule and execute change management workflows, Maintenance activities for vNFs that are already installed . +3. PNF - PNFs are already installed on the edges of the cloud. In order to configure the PNF, the service needs to be connected to the PNF. **Known Issues** - `VID-78 `_ - VID shows HTML code output whenever customer list is empty (Cosmetic) + VID shows the HTML code output whenever the customer list is empty (Cosmetic) **Upgrade Notes** -A scheduler is needed for the change management feature to work (not included in Amsterdam release). +A scheduler is needed for the change management feature to work (not included in the Amsterdam release). + +**Other** +In order to work properly, VID needs a working instance of SDC, A&AI and SO. =========== diff --git a/docs/index.rst b/docs/index.rst index 752fb42d4..4f5b8db4c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,5 +14,6 @@ VID Documentation docs-logging.rst docs-installation.rst docs-configuration.rst + docs-administration.rst docs-humaninterfaces.rst docs-release-notes.rst -- cgit 1.2.3-korg