IBM z/VM Cloud Connector


IBM z/VM Cloud Connector for z/VM 6.4

IBM z/VM Cloud Connector is a development toolkit for managing z/VM host and virtual machines. It provides a set of RESTful APIs to operate z/VM resources including guest, image, network, volume etc. Upper layer cloud management solutions can consume these RESTful APIs directly to manage z/VM.

Service information

The table below lists all IBM z/VM Cloud Connector releases chronologically, from newest to oldest.

Date Version levels Doc links Remarks
Apr 09 2018 1.0.1 IBM z/VM Cloud Connector 1.0.1 Document Must install APAR VM66120
Mar 08 2018 1.0.0 IBM z/VM Cloud Connector 1.0.0 Document Must upgrade to 1.0.1 before Applying APAR VM66120

Installation and Configuration

  • Download from FixCentral
  • The IBM z/VM Cloud Connector tool consists of two packages: python-zvm-sdk and zthin. Both packages are shipped from IBM FixCentral. You can download the appropriate packages according to the version and distribution that you intend to install IBM z/VM Cloud Connector.

    Reference link: FixCentral URL

  • Installation
  • IBM z/VM Cloud Connector must be installed inside a Linux running on z/VM. Currently supported distributions are:

    • SUSE Linux Enterprise Server SLES12sp3 or higher
    • Red Hat Enterprise Linux 7.2 or higher
    • Ubuntu 16.04 LTS

    Please refer to prerequirements of using IBM z/VM Cloud Connector to setup the server on which you will install the IBM z/VM Cloud Connector. Complete those pre-requirements before starting the following steps.

    • Package dependencies
    • The IBM z/VM Cloud Connector requires the following packages. You must prepare the packages before starting the installation.
      • Red Hat Enterprise Linux:
        • python >= 2.7
        • python-netaddr >= 0.7.5
        • python-jwt >= 1.0.1
        • python-requests >= 2.6.0
        • python-routes >= 2.2
        • python-webob >= 1.2.3
        • python-jsonschema >= 2.3.0
        • python-six >= 1.9.0
        • zthin >= 3.1.0

      • SUSE Linux Enterprise Server:
        • python >= 2.7
        • python-netaddr >= 0.7.5
        • python-PyJWT >= 1.0.1
        • python-requests >= 2.6.0
        • python-Routes >= 2.2
        • python-WebOb >= 1.2.3
        • python-jsonschema >= 2.3.0
        • python-six >= 1.9.0
        • zthin >= 3.1.0

      • Ubuntu Enterprise Server:
        • python >= 2.7
        • python-netaddr >= 0.7.5
        • python-jwt >= 1.0.1
        • python-requests >= 2.6.0
        • python-routes >= 2.2
        • python-webob >=1.2.3
        • python-jsonschema >= 2.3.0
        • python-six >= 1.9.0
        • zthin >= 3.1.0

    • Install packages
    • Install the IBM z/VM Cloud Connector either by setting up a package repository containing zthin, python-zvm-sdk and all the required packages, or by installing all the packages directly with the package management tool on your target platform.
  • Configure IBM z/VM Cloud Connector Daemon
  • After the python-zvm-sdk package is installed, there's a zvmsdk.conf.sample file in /etc/zvmsdk which contains all the supported configuration options for IBM z/VM Cloud Connector. In the same folder create your own configuration file based on zvmsdk.conf.sample and name it zvmsdk.conf .

    A Configuration sample file is provided in open source documentation.

  • Start IBM z/VM Cloud Connector Daemon
  • The IBM z/VM Cloud Connector daemon server can be started with the following command:

    • # systemctl start sdkserver

    Make sure the server is started normally by checking service status and refer to the verification of server functions for further information.

  • Deploying IBM z/VM Cloud Connector RESTful-APIs into Web Server
  • The recommended deployment for IBM z/VM Cloud Connector is to have a real web server such as Apache HTTPD or nginx handle the HTTP connections and proxy requests to the independent z/VM SDK server running under a wsgi container such as uwsgi.

    A sample uwsgi configuration file named uwsgi-zvmsdk.conf is provided in /etc/zvmsdk/ after the python-zvm-sdk package is installed. You can customize the settings to best fit your environment.

    Please refer to Setup httpd server for how setting up a web server to run IBM z/VM Cloud Connector REST-APIs.

How to consume IBM z/VM Cloud Connector

The target consumers of IBM z/VM Cloud Connector are cloud solutions. The consumer should develop a z/VM specific driver/plugin which implements features by calling the IBM z/VM Cloud Connector REST API.

One good example is OpenStack integration. Nova zvm virt dirver, neutron zvm agent and ceilometer zvm inspector have been implemented to enable OpenStack perform management tasks on a z/VM system. For more details, refer to Integration Samples

Useful links

Demo videos

Maintainer information

This document is maintained by:

Ji Chen
z/VM Cloud Development
jichenjc@cn.ibm.com
Huang Rui
z/VM Cloud Development
bjhuangr@cn.ibm.com