--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0\r
+.. International License. http://creativecommons.org/licenses/by/4.0\r
+.. Copyright (c) 2017-2018 Wind River Systems, Inc.\r
+\r
+===============================================\r
+MultiCloud Plugin for Wind River Titanium Cloud\r
+===============================================\r
+\r
+The following guides are provided to describe tasks that a user of\r
+ONAP may need to perform when operating ONAP to orchestrate VNF onto\r
+an instance of Wind River Titanium Cloud\r
+\r
+\r
+Supported Features\r
+``````````````````\r
+\r
+**Proxy endpoints for OpenStack services**\r
+\r
+ MultiCloud plugin for Wind River Titanium Cloud supports the proxy of OpenStack services\r
+ The catalog of proxied services is exactly the catalog of OpenStack services\r
+\r
+**VFC specific Northbound API**\r
+\r
+ MultiCloud plugin for Wind River Titanium Cloud supports VFC with the legacy APIs\r
+ which was inherited from OPEN-O MultiVIM project.\r
+\r
+**Support enhanced SO/OOF workflow**\r
+\r
+ MultiCloud plugin for Wind River Titanium Cloud supports infra_workload APIs from Casablanca Release.\r
+\r
+ These APIs enhances the workflow of Heat based VNF orchestration by:\r
+ offloading Heat template/parameter updating from SO to MultiCloud plugins\r
+\r
+ Enabling the "Centralized Representation of Cloud Regions"\r
+\r
+ Automate the heatbridge action by updating the AAI with deployed Heat stack resources\r
+\r
+**Support OOF**\r
+\r
+ MultiCloud plugin for Wind River Titanium Cloud supports capacity check from Beijing Release.\r
+\r
+**Conform to Consistent ID of a Cloud Region**\r
+\r
+ Northbound API v1 supports the composite keys {cloud-owner}/{cloud-region-id} as\r
+ the ID of a cloud region\r
+\r
+**Decoupling between cloud-region-id and OpenStack Region ID**\r
+\r
+ {cloud-region-id} should be populated by users while on-boarding a cloud region,\r
+ With ONAP A and B release, it must be the same as the "OpenStack Region ID" of the\r
+ represented OpenStack instance. From ONAP C release, this restriction has been removed.\r
+\r
+ The backward compatibility is maintained so that user can still populate the {cloud-reigon-id} by\r
+ "OpenStack Region ID".\r
+\r
+ Users could also specify the "OpenStack Region ID" while onboarding a cloud region\r
+ out of multi-region instances.\r
+\r
+ Note: There are still restrictions to populate {cloud-owner} and {cloud-region-id}, please\r
+ refer to section "On-board a Cloud Region"\r
+\r
+**Support on-boarding of Multi-Region instances**\r
+\r
+ Multiple OpenStack instances federated with the "multi-region" feature\r
+ can be on-boarded into ONAP with a single click. ONAP user needs to\r
+ register only the primary region into ONAP, and the multicloud plugin for Wind River\r
+\r
+ Titanium Cloud will discover and on-board all other secondary regions automatically.\r
+\r
+ This feature supports Titanium Cloud feature "Distributed Cloud" to on-board all subclouds with a single click.\r
+\r
+ This feature can be controlled by user with configuration options while on-boarding a cloud region\r
+\r
+**HPA discovery**\r
+\r
+ MultiCloud plugin for Wind River Titanium Cloud supports discover and\r
+ registration into AAI with regarding to following HPA capability:\r
+ CPU Pinning, HugePage, ...\r
+\r
+**Cloud Region decommission**\r
+\r
+ MultiCloud plugin for Wind River Titanium Cloud support the decommission of a cloud region with a single API requests.\r
+ This API is not yet integrated with ESR GUI portal.\r
+\r
+**VESagent**\r
+\r
+ MultiCloud plugin for Wind River Titanium Cloud supports VESagent\r
+ which can be configured to monitor the VM status and assert or abate\r
+ fault event to VES collector for close loop control over\r
+ infrastructure resources.\r
+\r
+**LOGGING**\r
+ MultiCloud plugin for Wind River Titanium Cloud supports centralized logging with OOM deployed ONAP\r
+\r
+\r
+Supported Use Cases\r
+```````````````````\r
+\r
+**vFW/vDNS**\r
+\r
+ The vFW/vDNS are the VNFs modeled with HEAT templates\r
+ MultiCloud plugin for Wind River Titanium Cloud has been tested with vFW/vDNS use cases from Amsterdam Release.\r
+\r
+**vCPE**\r
+\r
+ **vCPE without HPA orchestration**\r
+ vCPE is the VNF modeled with HEAT templates, basic Use case from Amsterdam Release\r
+ does not include any HPA orchestration.\r
+\r
+ **vCPE with HPA orchestration**\r
+ From Beijing Release,a variation of vCPE use case include HPA orchestration\r
+\r
+ MultiCloud plugin for Wind River Titanium Cloud has been tested with both cases.\r
+\r
+**vVoLTE**\r
+\r
+ MultiCloud plugin for Wind River Titanium Cloud has been tested with vVoLTE use case.\r
+\r
+\r
+Known Issues:\r
+``````````````````\r
+\r
+1, MULTICLOUD-359 : The image uploading API from VFC specific NBI does not work with large image file.\r
+\r
+\r
+\r
+.. include:: Tutorial-Onboard-WindRiver-TitaniumCloud.rst\r
+\r
+\r
+Tutorial: Cloud Region Decommission:\r
+````````````````````````````````````\r
+\r
+ESR GUI Portal cannot decommission a cloud region which has been updated by\r
+MultiCloud Plugin for Wind River Titanium Cloud, and it does not request MultiCloud\r
+to help on that yet. So it is required to issue a rest API request to MultiCloud with\r
+a single curl commands:\r
+\r
+\r
+.. code-block:: console\r
+\r
+ curl -X DELETE \\r
+ 'http://$ONAP_MSB_IP:$ONAP_MSB_PORT/api/multicloud-titaniumcloud/v0/CloudOwner_RegionOne' \\r
+ -H 'Accept: application/json' \\r
+ -H 'Cache-Control: no-cache' \\r
+ -H 'Content-Type: application/json' \\r
+ -H 'Postman-Token: 8577e1cc-1038-471d-8b3b-d36fe44ae023'\r
+\r
+\r
+.. include:: Tutorial-HPA-Provision-Discovery-WindRiver-TitaniumCloud.rst\r
+\r
+\r
+.. include:: Tutorial-VESagent-MultiCloud-WindRiver-TitaniumCloud.rst\r
Code Review / multicloud / framework.git / blobdiff