33.1. Openstack Client¶

Warning

Almost all parts of this Chapter describes the matters and tasks OUTSIDE of Service Provider’s Support, including how to configure the Customer Client settings. Therefore, you are required to fully understand and confirm the details on these tasks explained here in advance before you will execute these tasks. Additionally, the contents on this page is ONLY the things that Service Provider has already confirmed under the specific environments, regarding the softwares as described below. However, this chapter also describes some OpenSource software matters, so you are noted that Service Provider can NOT fully guarantee any motions nor provide any supports, regarding these matters.

33.1.1. Overviews¶

Here, Enterprise Cloud 2.0 Tutorial describes when and how to set up OpenStackClient (hereafter called “OSC”) in Enterprise Cloud 2.0 , a OpenStack compatible API available to API Client.

OpenStackClient [1]

OpenStackClient is is a CUI Client in order for you utilize OpenStack (e.g. multiple services, such as Nova; Cinder; Keystone, etc.). Following shows an exemplary of the way you set up OSC (2.6.0), which enables basic operations via the command line, upon the Ubuntu 14.0.2 .

33.1.2. Use an OpenStack Client (OSC)¶

33.1.2.1. Download and Setup an OSC¶

Install the relevant OSC.

# sudo apt-get update
# sudo apt-get install python-pip gcc python-dev python-pip python-setuptools
# sudo pip install pytz
# sudo pip install python-openstackclient

Note

If you install OSC via pip, please verify the version of Python beforehand. Python 3.x are not supported at OSC 2.6.0.

Note

Normally, any mutual dependency between pip packages could be automatically resolved, if impossible to resolve any dependency issues, operate an adequate resolution reviewing the relevant error log. When there is any failure in the time of installing a [ python-openstackclient ], we recommend that you firstly clean up a current pip environment to resolve any error occurrence in the relevant dependency, and next reinstall the [ python-openstackclient ]. NOTE: The prior [ pytz ] installation has already executed, for any error could incur when any dependency issue is solved.

Create new OSC setting files.

# mkdir -p ~/.config/openstack/
# touch ~/.config/openstack/clouds.yaml

By following the below setting sample as a reference, create your setting files on the yaml format by utilizing . You are highly recommended to utilize any text editor, such as vim, in order that you do NOT input any unrequited space like a half-space and / or a full-space. (NOTE: You need to input your own unique parameters, which are shown as the “$” mark in the below sample file.) You are also required to set up the value of the highlighted lined as below.

clouds:
  ecl2:
    auth:
      auth_url: $AuthURL
      project_name: $TenantName
      username: $Sample-User
      password: $Sample-User-Password
    identity_api_version: 3
    region_name: $Region-Code
    interface: public
    project_domain_name: Default
    user_domain_name: Default

#4th line (auth_url)
- Input the endpoint of Keystone ( e.g. ‘https://keystone-jp1-ecl.api.ntt.com/v3/‘ )
# 5th line (project_name)
- Input the Tenant name, viewing Verifying Tenant ID . ( e.g. ‘tenant-sample01’)
# 6th line (username)
- Input your own API Secret Key (API Secret), following Verifying User Information . (e.g. ‘ DJ0lAxtptGTV9HZbiPPOe1nj9icP0CGV’ )
# 7 line (password)
- Input your unique API Secret key, following Verifying User Information . (e.g. ‘A990fiJklk12H35K’ )
# 8th line (region_name)
- Input the Region name, viewing Verifying Tenant ID . ( e.g. ‘jp1 ‘)

Finally, you will get started with your command, after completing all of these settings.

33.1.2.2. Do Operation Check¶

Here you can obtain the overview of the packets you currently have then check the operations with “list image” ( image list command). First, log in to the OSC shell by utilizing following command.

$ openstack --os-cloud ecl2
(openstack)

Next, show “(openstack) image list” with the image list command. If the list including the Official Images as described below will display, you can success to correctly obtain the list.

(openstack) image list
+--------------------------------------+----------------------------------------------------------------------+--------+
| ID                                   | Name                                                                 | Status |
+--------------------------------------+----------------------------------------------------------------------+--------+
| cae83324-92b3-487f-97e1-1725a30cda57 | CoreOS-835.9.0_64_baremetal-server_01                                | active |
| e212522f-3a0b-4735-a14c-ba600fca057a | WindowsServer-2012R2_Standard_64_include-license_virtual-server_10   | active |
| bf93870e-85cd-401a-aa2c-cef4af63d2e1 | CentOS-7.1-1503_64_virtual-server_00                                 | active |
| c2808326-4711-4054-8251-cc472b8b29e4 | Ubuntu-14.04.1_64_virtual-server_00                                  | active |
| 650b4732-d430-4b00-a7c6-93237ad864df | WindowsServer-2012R2_Standard_64_BYOL_baremetal-server_01            | active |
| 3b943219-4210-4da5-8163-f6256585ab92 | RedHatEnterpriseLinux-7.1_64_BYOL_baremetal-server_01                | active |
| 6ba2ef25-059a-44c9-aadf-912c7ff06cde | ESXi-5.5.u3a_64_BYOL_baremetal-server_01                             | active |
| ad057e07-a9a3-440f-bc84-4658a5ea381d | WindowsServer-2012R2_Datacenter_64_BYOL_baremetal-server_01          | active |
| 60b36f46-9c93-41d6-b7f7-8797da160741 | CentOS-7.1-1503_64_baremetal-server_01                               | active |
| ebefa62e-3075-497d-b00f-48ad305b5591 | WindowsServer-2012R2_Standard_64_include-license_baremetal-server_01 | active |
| e9ae86d5-fc9d-42a6-9018-2b796600b3f4 | Ubuntu-14.04.1_64_baremetal-server_01                                | active |
| 5b9f9ad7-f5b7-4404-a92c-ee98611d6046 | RedHatEnterpriseLinux-7.1_64_include-license_baremetal-server_01     | active |
| d8087804-0a74-4c7b-b0e1-b4094fbc9cf3 | Ubuntu-14.04.1-server-amd64.iso                                      | active |
+--------------------------------------+----------------------------------------------------------------------+--------+

For the further details of the way to utilize OSC, please refer to Official Documents or the “Help” shown with openstack -h .

Warning

Enterprise Cloud 2.0 does NOT enable you to utilize any API, which requires the “_admin_” role in OpenStack. For more information, please refer to respective “API References”.

Footnote

[1]	OpenStack Client is an OSS software, distributed by Apache 2.0 License. You can utilize this only to the API, which is conformed to OpenStack.

33. Use Enterprise Cloud CLI/SDK

33.2. Basic Information on API Call