docs/MultiCloud-Administrator-Guide.rst

   1 ..
   2  This work is licensed under a Creative Commons Attribution 4.0
   3  International License.
   4 .. _MultiCloud-Administrator-Guide:
   5
   6 ===================================
   7 ONAP MultiCloud Administrator Guide
   8 ===================================
   9
  10 The guide for MultiCloud Administrator.
  11
  12
  13 Configuration
  14 =============
  15
  16 Multicloud doesn’t have any configuration file for now.
  17
  18 Administration
  19 ==============
  20
  21 From MSB
  22 --------
  23
  24 After Multicloud is up and running, administrator can check Multicloud
  25 services from MSB. Go to MSB UI page, administrator should see several icons
  26 with name that starts with multicloud.
  27
  28 .. image:: ./images/msb-icons.png
  29     :alt: Multicloud icons in MSB
  30     :width: 975
  31     :height: 293
  32     :align: center
  33
  34 The icon named Multicloud is the main framework of Multicloud services. And
  35 other icons are the plugin for corresponding backend cloud. For example,
  36 multilcloud-vio is the plugin for VMware Integrated OpenStack.
  37
  38 Administrator can manage Multicloud from MSB UI page. By clicking the icon
  39 named multicloud, there will be available api URL in the bottom of MSB UI
  40 page. After filling required fields, and clicking `Try it out!`, administrator
  41 can perform GET/POST/PUT/DELETE over Multicloud.
  42
  43 From CLI
  44 --------
  45
  46 Besides the MSB UI page, Administrator could manage Multicloud from command
  47 line interface(CLI). Multicloud’s CLI is the same as OpenStack’s CLI, and
  48 therefore, administrator can use OpenStack Client to manage Multicloud.
  49 To make OpenStack Client work with Multicloud, administrator needs to set the
  50 environment variables of operation system. An example of environment variables
  51 is list as below:
  52
  53 ::
  54
  55     OS_AUTH_URL=http://<msb-ip>:80/api/multicloud/v0/<vim_info>/identity/v3
  56     OS_PROJECT_ID=<project id in backend OpenStack>
  57     OS_PROJECT_NAME=<project name in backend OpenStack>
  58     OS_USER_DOMAIN_NAME=<domain name in backend OpenStack>
  59     OS_USERNAME=<administrator username in backend OpenStack>
  60     OS_PASSWORD=<password of administrator in backend OpenStack>
  61     OS_REGION_NAME=<region name in backend OpenStack>
  62     OS_INTERFACE=internal
  63     OS_IDENTITY_API_VERSION=3
  64
  65 <msb-ip> in OS_AUTH_URL is the IP address of MSB. <vim-info> is composed of
  66 cloud_type and cloud_region_id. These two attributes are information of cloud
  67 from A&AI. Other environment variables listed above are some information from
  68 Multicloud’s backend OpenStack.
  69 After exporting above variables into operation system, administrator can use
  70 OpenStack Client to manage Multicloud. For example:
  71
  72 ::
  73
  74     nova list
  75
  76 will list the virtual machine in Multicloud’s backend OpenStack.
  77
  78
  79 Logging And Diagnostics
  80 =======================
  81
  82
  83 Logging file
  84 ------------
  85
  86 The logging file named "runtime_multivimbroker.log" located at /opt/multivimbroker/logs/ directory
  87 would record  INFO, WARN, ERROR and DEBUG level of information.
  88 The format string of logging is "%(asctime)s-%(funcName)s-%(filename)s-%(lineno)d-%(levelno)s-%(content string)s".
  89 If there are any issues happened in framework service, you are able to check ERROR level logging to
  90 diagnose the problem.
  91 The content of this file list as below:
  92
  93 ::
  94
  95     2017-11-03 07:03:31,646:[multivimbroker.pub.utils.restcall]:[restcall.py]-[63][DEBUG]:request=http://192.168.10.45:80/api/multicloud/v0/vmware_vio/identity/v2.0)
  96     2017-11-03 07:08:38,020:[multivimbroker.pub.utils.restcall]:[restcall.py]-[63][DEBUG]:request=https://192.168.10.26:8443/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/vmware/vio)
  97     2017-11-03 07:08:38,103:[multivimbroker.pub.utils.restcall]:[restcall.py]-[63][DEBUG]:request=http://192.168.10.45:80/api/multicloud/v0/vmware_vio/identity/v2.0)
  98
  99
 100 The stdout of framework service named "nohup.out" located at /opt/multivimbroker/ record each http request.
 101 The content of this file looks like as below:
 102
 103 ::
 104
 105     [25/Oct/2017 00:09:27] "POST /api/multicloud/v0/vmware_vio/identity/v2.0/tokens HTTP/1.0" 500 273
 106     [25/Oct/2017 14:17:27] "POST /api/multicloud/v0/vmware_fake/identity/v2.0/tokens HTTP/1.0" 200 5389
 107     [26/Oct/2017 23:44:13] "POST /api/multicloud/v0/vmware_vio/identity/v3/auth/tokens HTTP/1.0" 200 6213
 108
 109
 110 Each line compose with http method, url and response code, so you are able to check the response status of
 111 every http request.