docs/MultiCloud-Administrator-Guide.rst

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