docs/MultiCloud-Administrator-Guide.rst

   1 ===================================
   2 ONAP MultiCloud Administrator Guide
   3 ===================================
   4
   5 The guide for MultiCloud Administrator.
   6
   7
   8 Configuration
   9 =============
  10
  11 Multicloud doesn’t have any configuration file for now.
  12
  13 Administration
  14 ==============
  15
  16 From MSB
  17 --------
  18
  19 After Multicloud is up and running, administrator can check Multicloud
  20 services from MSB. Go to MSB UI page, administrator should see several icons
  21 with name that starts with multicloud.
  22
  23 .. image:: ./images/msb-icons.png
  24     :alt: Multicloud icons in MSB
  25     :width: 975
  26     :height: 293
  27     :align: center
  28
  29 The icon named Multicloud is the main framework of Multicloud services. And
  30 other icons are the plugin for corresponding backend cloud. For example,
  31 multilcloud-vio is the plugin for VMware Integrated OpenStack.
  32
  33 Administrator can manage Multicloud from MSB UI page. By clicking the icon
  34 named multicloud, there will be available api URL in the bottom of MSB UI
  35 page. After filling required fields, and clicking `Try it out!`, administrator
  36 can perform GET/POST/PUT/DELETE over Multicloud.
  37
  38 From CLI
  39 --------
  40
  41 Besides the MSB UI page, Administrator could manage Multicloud from command
  42 line interface(CLI). Multicloud’s CLI is the same as OpenStack’s CLI, and
  43 therefore, administrator can use OpenStack Client to manage Multicloud.
  44 To make OpenStack Client work with Multicloud, administrator needs to set the
  45 environment variables of operation system. An example of environment variables
  46 is list as below:
  47
  48 ::
  49
  50     OS_AUTH_URL=http://<msb-ip>:80/api/multicloud/v0/<vim_info>/identity/v3
  51     OS_PROJECT_ID=<project id in backend OpenStack>
  52     OS_PROJECT_NAME=<project name in backend OpenStack>
  53     OS_USER_DOMAIN_NAME=<domain name in backend OpenStack>
  54     OS_USERNAME=<administrator username in backend OpenStack>
  55     OS_PASSWORD=<password of administrator in backend OpenStack>
  56     OS_REGION_NAME=<region name in backend OpenStack>
  57     OS_INTERFACE=internal
  58     OS_IDENTITY_API_VERSION=3
  59
  60 <msb-ip> in OS_AUTH_URL is the IP address of MSB. <vim-info> is composed of
  61 cloud_type and cloud_region_id. These two attributes are information of cloud
  62 from A&AI. Other environment variables listed above are some information from
  63 Multicloud’s backend OpenStack.
  64 After exporting above variables into operation system, administrator can use
  65 OpenStack Client to mange Multicloud. For example:
  66
  67 ::
  68
  69     nova list
  70
  71 will list the virtual machine in Multicloud’s backend OpenStack.
  72