From 9e102f0d449dc8c46e28fb786e6a0bedfeb1bd70 Mon Sep 17 00:00:00 2001 From: yangyan Date: Fri, 10 Nov 2017 11:33:38 +0800 Subject: Add doc missing part Issue-ID: VFC-591 Change-Id: I8c7c520b1935311e8dd0924abb7d4d74f22add02 Signed-off-by: yangyan --- docs/platform/administration.rst | 20 ++++++++++++++++++++ docs/platform/consumedapis.rst | 16 ++++++++++++++++ docs/platform/delivery.rst | 20 ++++++++++++++++++++ docs/platform/index.rst | 5 ++++- docs/platform/logging.rst | 12 ++++++++---- 5 files changed, 68 insertions(+), 5 deletions(-) create mode 100644 docs/platform/administration.rst create mode 100644 docs/platform/consumedapis.rst (limited to 'docs/platform') diff --git a/docs/platform/administration.rst b/docs/platform/administration.rst new file mode 100644 index 00000000..5d0ab06a --- /dev/null +++ b/docs/platform/administration.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Administration +-------------- +VF-C components have been dockerized, can use docker command to manage VF-C. + + +Processes ++++++++++ +* Process 1 +* Process 2 + +Actions ++++++++ +All actions performed on the VF-C components are docker-based. +* Action X +* Action Y + diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst new file mode 100644 index 00000000..cd39a5ec --- /dev/null +++ b/docs/platform/consumedapis.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Consumed APIs +============= +References to APIs offered by other components + +A&AI: Use A&AI API to operate the instance data stored in A&AI, this opration includes CURL +SDC: Use Catalog external API to query csar package +DCAE: Use DCAE Ves collector API to report FCAPS data to DCAE +MSB: Use MSB to register and find microservice +Modeling: Use nfvparser API to parse tosca template + + + + diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst index 1a6ab3b4..9622789d 100644 --- a/docs/platform/delivery.rst +++ b/docs/platform/delivery.rst @@ -25,3 +25,23 @@ VF-C provides vnfm driver northbound api,then Vendor can implement this APIs to For the EMS driver,it can collect VNF lay’s Fcaps data from Vendor EMS, and then translate and put these data to DCAE Vescollector +For the Amsterdan release, VF-C includes the following components: + +NFVO + - vfc-nfvo-lcm + - vfc-nfvo-catalog + - vfc-nfvo-resmgr + - vfc-nfvo-driver-emsdriver + - vfc-nfvo-driver-gvnfm-gvnfmadapter + - vfc-nfvo-driver-gvnfm-jujudriver + - vfc-nfvo-driver-svnfm-ztedriver + - vfc-nfvo-driver-svnfm-huaweidriver + - vfc-nfvo-driver-svnfm-nokiadriver + - vfc-nfvo-driver-sfc-ztesfcdriver +GVNFM + - vfc-gvnfm-vnflcm + - vfc-gvnfm-vnfmgr + - vfc-gvnfm-vnfres +Workflow + - workflow-engine-mgr-service + - activiti-extension \ No newline at end of file diff --git a/docs/platform/index.rst b/docs/platform/index.rst index 8311287b..12fa0be0 100644 --- a/docs/platform/index.rst +++ b/docs/platform/index.rst @@ -19,6 +19,9 @@ As part of the integration between OpenECOMP and OPEN-O, VF-C leverages ETSI NFV :maxdepth: 1 architecture.rst - delivery.rst APIs/index + consumedapis.rst + delivery.rst + logging.rst installation.rst + administration.rst diff --git a/docs/platform/logging.rst b/docs/platform/logging.rst index 8d480e28..df74134a 100644 --- a/docs/platform/logging.rst +++ b/docs/platform/logging.rst @@ -3,12 +3,16 @@ Logging & Diagnostic Information -------------------------------- -Description of how to interact with and diagnose problems with the components -as delivered. + +In Amsterdam release, VF-Clogs are kept inside the docker containers. +You can get the log when the dockers start. Where to Access Information +++++++++++++++++++++++++++ +Use docker logs command to get the log. + +:: + docker logs &{docker-name} + -Error / Warning Messages -++++++++++++++++++++++++ -- cgit 1.2.3-korg