docs/MultiCloud-Administrator-Guide.rst

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