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