diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 22 | ||||
| -rw-r--r-- | docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst (renamed from docs/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/APIs/NSLCM_API/index.rst (renamed from docs/APIs/NSLCM_API/index.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst (renamed from docs/APIs/VNFLCM_API/VNFLCM_API.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/APIs/VNFLCM_API/VNFM_API.png (renamed from docs/APIs/VNFLCM_API/VNFM_API.png) | bin | 53033 -> 53033 bytes | |||
| -rw-r--r-- | docs/platform/APIs/VNFLCM_API/index.rst (renamed from docs/APIs/VNFLCM_API/index.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst (renamed from docs/APIs/VNFMDriver_API/VNFM_Driver_API.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/APIs/VNFMDriver_API/index.rst (renamed from docs/APIs/VNFMDriver_API/index.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/APIs/index.rst (renamed from docs/APIs/index.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/architecture.rst (renamed from docs/architecture.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/components.png (renamed from docs/components.png) | bin | 6381 -> 6381 bytes | |||
| -rw-r--r-- | docs/platform/delivery.rst (renamed from docs/delivery.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/index.rst | 24 | ||||
| -rw-r--r-- | docs/platform/installation.rst (renamed from docs/installation.rst) | 26 | ||||
| -rw-r--r-- | docs/platform/logging.rst (renamed from docs/logging.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/offeredapis.rst (renamed from docs/offeredapis.rst) | 0 | ||||
| -rw-r--r-- | docs/platform/vfc-arc.png (renamed from docs/vfc-arc.png) | bin | 71929 -> 71929 bytes | |||
| -rw-r--r-- | docs/release-notes.rst | 54 |
18 files changed, 92 insertions, 34 deletions
diff --git a/docs/index.rst b/docs/index.rst index 8311287b..5538de9d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,24 +1,16 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. _vfc_index: +VF-C(Virtual Function Controller) +--------------------------------- -ONAP VF-C -========= +As part of the integration between OpenECOMP and OPEN-O, this proposed project VF-C leverages ETSI NFV MANO architecture and information model as a reference, and implements full life cycle management and FCAPS of VNF and NS. -As part of the integration between OpenECOMP and OPEN-O, VF-C leverages ETSI NFV MANO architecture and information model as a reference, and implements life cycle management and FCAPS of VNF and NS. - -* support NS and VNF lifecycle management based on the ONAP tosca and yang data model and workflow -* support integration with multi VNFMs via drivers, which include vendors VNFM and generic VNFM -* support integration with multi VNFs via generic VNFM, which does not provide VNFM function -* support integration with multi VIMS via Multi-VIM, which include the opensource and commercial VIMs -* support microservice architecture and model driven resource orchestration and management +This document is aimed to give the users some brief introductions on VF-C from different aspects. The users could find useful information, e.g. the architecuture, the APIs and the installation steps, etc. as well as the release notes of VF-C in this document. .. toctree:: :maxdepth: 1 + + platform/index.rst + release-notes.rst - architecture.rst - delivery.rst - APIs/index - installation.rst diff --git a/docs/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst b/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst index bada11e7..bada11e7 100644 --- a/docs/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst +++ b/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst diff --git a/docs/APIs/NSLCM_API/index.rst b/docs/platform/APIs/NSLCM_API/index.rst index ffbf0756..ffbf0756 100644 --- a/docs/APIs/NSLCM_API/index.rst +++ b/docs/platform/APIs/NSLCM_API/index.rst diff --git a/docs/APIs/VNFLCM_API/VNFLCM_API.rst b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst index c6db4326..c6db4326 100644 --- a/docs/APIs/VNFLCM_API/VNFLCM_API.rst +++ b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst diff --git a/docs/APIs/VNFLCM_API/VNFM_API.png b/docs/platform/APIs/VNFLCM_API/VNFM_API.png Binary files differindex b267abc2..b267abc2 100644 --- a/docs/APIs/VNFLCM_API/VNFM_API.png +++ b/docs/platform/APIs/VNFLCM_API/VNFM_API.png diff --git a/docs/APIs/VNFLCM_API/index.rst b/docs/platform/APIs/VNFLCM_API/index.rst index 1e679b15..1e679b15 100644 --- a/docs/APIs/VNFLCM_API/index.rst +++ b/docs/platform/APIs/VNFLCM_API/index.rst diff --git a/docs/APIs/VNFMDriver_API/VNFM_Driver_API.rst b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst index f7a9c67e..f7a9c67e 100644 --- a/docs/APIs/VNFMDriver_API/VNFM_Driver_API.rst +++ b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst diff --git a/docs/APIs/VNFMDriver_API/index.rst b/docs/platform/APIs/VNFMDriver_API/index.rst index cf017587..cf017587 100644 --- a/docs/APIs/VNFMDriver_API/index.rst +++ b/docs/platform/APIs/VNFMDriver_API/index.rst diff --git a/docs/APIs/index.rst b/docs/platform/APIs/index.rst index b05bede2..b05bede2 100644 --- a/docs/APIs/index.rst +++ b/docs/platform/APIs/index.rst diff --git a/docs/architecture.rst b/docs/platform/architecture.rst index dc7ef09b..dc7ef09b 100644 --- a/docs/architecture.rst +++ b/docs/platform/architecture.rst diff --git a/docs/components.png b/docs/platform/components.png Binary files differindex 253e63bf..253e63bf 100644 --- a/docs/components.png +++ b/docs/platform/components.png diff --git a/docs/delivery.rst b/docs/platform/delivery.rst index 1a6ab3b4..1a6ab3b4 100644 --- a/docs/delivery.rst +++ b/docs/platform/delivery.rst diff --git a/docs/platform/index.rst b/docs/platform/index.rst new file mode 100644 index 00000000..8311287b --- /dev/null +++ b/docs/platform/index.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. _vfc_index: + +ONAP VF-C +========= + +As part of the integration between OpenECOMP and OPEN-O, VF-C leverages ETSI NFV MANO architecture and information model as a reference, and implements life cycle management and FCAPS of VNF and NS. + +* support NS and VNF lifecycle management based on the ONAP tosca and yang data model and workflow +* support integration with multi VNFMs via drivers, which include vendors VNFM and generic VNFM +* support integration with multi VNFs via generic VNFM, which does not provide VNFM function +* support integration with multi VIMS via Multi-VIM, which include the opensource and commercial VIMs +* support microservice architecture and model driven resource orchestration and management + + +.. toctree:: + :maxdepth: 1 + + architecture.rst + delivery.rst + APIs/index + installation.rst diff --git a/docs/installation.rst b/docs/platform/installation.rst index 0d361716..486ce151 100644 --- a/docs/installation.rst +++ b/docs/platform/installation.rst @@ -84,19 +84,7 @@ For testing, we can use curl command to access the swagger api. :: - docker run -d --name vfc-resmanagement -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/resmanagement - -For testing, we can use curl command to access the swagger api. - -:: - - curl http://${MSB_IP}:80/api/resmgr/v1/swagger.json - -- Install vfc-nfvo-resmanagement component. - -:: - - docker run -d --name vfc-resmanagement -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/resmanagement + docker run -d --name vfc-resmanagement -p 8480:8480 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/resmanagement For testing, we can use curl command to access the swagger api. @@ -120,7 +108,7 @@ For testing, we can use curl command to access the swagger api. :: - docker run -d --name vfc-emsdriver -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/emsdriver + docker run -d --name vfc-emsdriver -p 8206:8206 -e MSB_ADDR=${MSB_IP}:80 -e VES_ADDR=${VES_COLLECTOR_IP}:8080 -e VES_AUTHINFO="":"" nexus3.onap.org:10001/onap/vfc/emsdriver For testing, we can use curl command to access the swagger api. @@ -149,27 +137,27 @@ For testing, we can use curl command to access the swagger api. :: docker run -d --name vfc-gvnfmdriver -p 8484:8484 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/gvnfmdriver - docker run -d --name vfc-jujudriver -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/jujudriver + docker run -d --name vfc-jujudriver -p 8483:8483 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/jujudriver For testing, we can use curl command to access the swagger api. :: curl http://${MSB_IP}:80/api/gvnfmdriver/v1/swagger.json - curl http://${MSB_IP}:80/openoapi/jujuvnfm/v1/swagger.json + curl http://${MSB_IP}:80/api/jujuvnfmdriver/v1/swagger.json - Install vfc-svnfmdriver components. :: docker run -d --name vfc-ztevmanagerdriver -p 8410:8410 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/ztevmanagerdriver - docker run -d --name vfc-svnfm-huawei -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nfvo/svnfm/huawei - docker run -d --name vfc-svnfm-nokia -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nfvo/svnfm/nokia + docker run -d --name vfc-svnfm-huawei -p 8482:8482 -p 8443:8443 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nfvo/svnfm/huawei + docker run -d --name vfc-svnfm-nokia -p 8486:8486 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nfvo/svnfm/nokia For testing, we can use curl command to access the swagger api. :: curl http://${MSB_IP}:80/api/ztevmanagerdriver/v1/swagger.json - curl http://${MSB_IP}:80/api/hwvnfm/v1/swagger.json + curl http://${MSB_IP}:80/api/huaweivnfmdriver/v1/swagger.json curl http://${MSB_IP}:80/api/nokiavnfmdriver/v1/swagger.json diff --git a/docs/logging.rst b/docs/platform/logging.rst index 8d480e28..8d480e28 100644 --- a/docs/logging.rst +++ b/docs/platform/logging.rst diff --git a/docs/offeredapis.rst b/docs/platform/offeredapis.rst index 79af6645..79af6645 100644 --- a/docs/offeredapis.rst +++ b/docs/platform/offeredapis.rst diff --git a/docs/vfc-arc.png b/docs/platform/vfc-arc.png Binary files differindex 561488b2..561488b2 100644 --- a/docs/vfc-arc.png +++ b/docs/platform/vfc-arc.png diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 00000000..f06fbc90 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,54 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +VF-C 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. + +VF-C includes two main component:NFV-O and GVNFM, can implement life cycle management and FCAPS of VNF and NS. VF-C takes part in end2end service orchestration and close loop automatiion by working with SO,DCAE and Policy. +VF-C also provides standard south bound interface to VNFMs and can integration with multi vendor VNFMs via drivers. + + + +Version: x.y.z +-------------- + + +:Release Date: yyyy-mm-dd + + + +**New Features** + + - + - NS lifecycle management, including NS instance creation,termination and healing + - VNF lifecycle management, including VNF nstance creation,termination and healing + - VNF FCAPS, collecting FCAPS data from vendor EMS + - VNFM Integration, Integration with specific VNFMs of vendors to deploy commercial VNFs + - VNF Integration, Integration with VNF via GVNFM + + +**Bug Fixes** + + +**Known Issues** + +**Security Issues** + + +**Upgrade Notes** + +**Deprecation Notes** + +**Other** + +=========== + +End of Release Notes |
