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

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