docs/multicloud-plugin-windriver/UserGuide-MultiCloud-WindRiver-TitaniumCloud.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0\r
   2 .. International License.  http://creativecommons.org/licenses/by/4.0\r
   3 .. Copyright (c) 2017-2018 Wind River Systems, Inc.\r
   4 \r
   5 ===============================================\r
   6 MultiCloud Plugin for Wind River Titanium Cloud\r
   7 ===============================================\r
   8 \r
   9 The following guides are provided to describe tasks that a user of\r
  10 ONAP may need to perform when operating ONAP to orchestrate VNF onto\r
  11 an instance of Wind River Titanium Cloud\r
  12 \r
  13 \r
  14 Supported Features\r
  15 ``````````````````\r
  16 \r
  17 **Proxy endpoints for OpenStack services**\r
  18 \r
  19     MultiCloud plugin for Wind River Titanium Cloud supports the proxy of OpenStack services\r
  20     The catalog of proxied services is exactly the catalog of OpenStack services\r
  21 \r
  22 **VFC specific Northbound API**\r
  23 \r
  24     MultiCloud plugin for Wind River Titanium Cloud supports VFC with the legacy APIs\r
  25     which was inherited from OPEN-O MultiVIM project.\r
  26 \r
  27 **Support enhanced SO/OOF workflow**\r
  28 \r
  29     MultiCloud plugin for Wind River Titanium Cloud supports infra_workload APIs from Casablanca Release.\r
  30 \r
  31     These APIs enhances the workflow of Heat based VNF orchestration by:\r
  32         offloading Heat template/parameter updating from SO to MultiCloud plugins\r
  33 \r
  34         Enabling the "Centralized Representation of Cloud Regions"\r
  35 \r
  36         Automate the heatbridge action by updating the AAI with deployed Heat stack resources\r
  37 \r
  38 **Support OOF**\r
  39 \r
  40     MultiCloud plugin for Wind River Titanium Cloud supports capacity check from Beijing Release.\r
  41 \r
  42 **Conform to Consistent ID of a Cloud Region**\r
  43 \r
  44     Northbound API v1 supports the composite keys {cloud-owner}/{cloud-region-id} as\r
  45     the ID of a cloud region\r
  46 \r
  47 **Decoupling between cloud-region-id and OpenStack Region ID**\r
  48 \r
  49     {cloud-region-id} should be populated by users while on-boarding a cloud region,\r
  50     With ONAP A and B release, it must be the same as the "OpenStack Region ID" of the\r
  51     represented OpenStack instance. From ONAP C release, this restriction has been removed.\r
  52 \r
  53     The backward compatibility is maintained so that user can still populate the {cloud-reigon-id} by\r
  54     "OpenStack Region ID".\r
  55 \r
  56     Users could also specify the "OpenStack Region ID" while onboarding a cloud region\r
  57     out of multi-region instances.\r
  58 \r
  59     Note: There are still restrictions to populate {cloud-owner} and {cloud-region-id}, please\r
  60     refer to section "On-board a Cloud Region"\r
  61 \r
  62 **Support on-boarding of Multi-Region instances**\r
  63 \r
  64     Multiple OpenStack instances federated with the "multi-region" feature\r
  65     can be on-boarded into ONAP with a single click. ONAP user needs to\r
  66     register only the primary region into ONAP, and the multicloud plugin for Wind River\r
  67 \r
  68     Titanium Cloud will discover and on-board all other secondary regions automatically.\r
  69 \r
  70     This feature supports Titanium Cloud feature "Distributed Cloud" to on-board all subclouds with a single click.\r
  71 \r
  72     This feature can be controlled by user with configuration options while on-boarding a cloud region\r
  73 \r
  74 **HPA discovery**\r
  75 \r
  76     MultiCloud plugin for Wind River Titanium Cloud supports discover and\r
  77     registration into AAI with regarding to following HPA capability:\r
  78     CPU Pinning, HugePage, ...\r
  79 \r
  80 **Cloud Region decommission**\r
  81 \r
  82     MultiCloud plugin for Wind River Titanium Cloud support the decommission of a cloud region with a single API requests.\r
  83     This API is not yet integrated with ESR GUI portal.\r
  84 \r
  85 **VESagent**\r
  86 \r
  87     MultiCloud plugin for Wind River Titanium Cloud supports VESagent\r
  88     which can be configured to monitor the VM status and assert or abate\r
  89     fault event to VES collector for close loop control over\r
  90     infrastructure resources.\r
  91 \r
  92 **LOGGING**\r
  93     MultiCloud plugin for Wind River Titanium Cloud supports centralized logging with OOM deployed ONAP\r
  94 \r
  95 \r
  96 Supported Use Cases\r
  97 ```````````````````\r
  98 \r
  99 **vFW/vDNS**\r
 100 \r
 101    The vFW/vDNS are the VNFs modeled with HEAT templates\r
 102    MultiCloud plugin for Wind River Titanium Cloud has been tested with vFW/vDNS use cases from Amsterdam Release.\r
 103 \r
 104 **vCPE**\r
 105 \r
 106    **vCPE without HPA orchestration**\r
 107       vCPE is the VNF modeled with HEAT templates, basic Use case from Amsterdam Release\r
 108       does not include any HPA orchestration.\r
 109 \r
 110    **vCPE with HPA orchestration**\r
 111       From Beijing Release,a variation of vCPE use case include HPA orchestration\r
 112 \r
 113    MultiCloud plugin for Wind River Titanium Cloud has been tested with both cases.\r
 114 \r
 115 **vVoLTE**\r
 116 \r
 117    MultiCloud plugin for Wind River Titanium Cloud has been tested with vVoLTE use case.\r
 118 \r
 119 \r
 120 Known Issues:\r
 121 ``````````````````\r
 122 \r
 123 1, MULTICLOUD-359 : The image uploading API from VFC specific NBI does not work with large image file.\r
 124 \r
 125 \r
 126 \r
 127 .. include:: Tutorial-Onboard-WindRiver-TitaniumCloud.rst\r
 128 \r
 129 \r
 130 Tutorial: Cloud Region Decommission:\r
 131 ````````````````````````````````````\r
 132 \r
 133 ESR GUI Portal cannot decommission a cloud region which has been updated by\r
 134 MultiCloud Plugin for Wind River Titanium Cloud, and it does not request MultiCloud\r
 135 to help on that yet. So it is required to issue a rest API request to MultiCloud with\r
 136 a single curl commands:\r
 137 \r
 138 \r
 139 .. code-block:: console\r
 140 \r
 141     curl -X DELETE \\r
 142     'http://$ONAP_MSB_IP:$ONAP_MSB_PORT/api/multicloud-titaniumcloud/v0/CloudOwner_RegionOne' \\r
 143     -H 'Accept: application/json' \\r
 144     -H 'Cache-Control: no-cache' \\r
 145     -H 'Content-Type: application/json' \\r
 146     -H 'Postman-Token: 8577e1cc-1038-471d-8b3b-d36fe44ae023'\r
 147 \r
 148 \r
 149 .. include:: Tutorial-HPA-Provision-Discovery-WindRiver-TitaniumCloud.rst\r
 150 \r
 151 \r
 152 .. include:: Tutorial-VESagent-MultiCloud-WindRiver-TitaniumCloud.rst\r