OpenStack¶

Builder type: openstack-qcow2, openstack-vmdk, openstack-vhd or openstack-vdi

Require Cloud Account: Yes www.openstack.org

The OpenStack builder provides information for building and publishing the machine image to the OpenStack cloud platform. This builder supports KVM (openstack-qcow2), VMware (openstack-vmdk), Microsoft (openstack-vhd) or VirtualBox (openstack-vdi) based images for Openstack.

The OpenStack builder requires cloud account information to upload and register the machine image to the OpenStack platform.

The OpenStack builder section has the following definition:

{
  "builders": [
    {
      "type": "openstack-qcow2",
      ...the rest of the definition goes here.
    }
  ]
}

Building a Machine Image¶

For building an image, the valid keys are:

installation (optional): an object providing low-level installation or first boot options. These override any installation options in the Stack section. The following valid keys for installation are:
- diskSize (mandatory): an integer providing the disk size of the machine image to create. Note, this overrides any disk size information in the stack. This cannot be used if an advanced partitioning table is defined in the stack.
type (mandatory): a string providing the machine image type to build. For OpenStack: openstack-qcow2, openstack-vmdk, openstack-vdi or openstack-vhd

Publishing a Machine Image¶

To publish an image, the valid keys are:

account (mandatory): an object providing the OpenStack cloud account information required to publish the built machine image.
description (optional): an object providing the description of the machine image.
imageName (mandatory): a string providing the name of the image that will be displayed.
paraVirtMode (optional) a boolean to determine if the machine should be provisioned in para-virtualised mode. By default, machine images are provisioned in full-virtualised mode
publicImage (optional): a boolean to determine if the machine image is public (for other users to use for provisioning).
tenant (mandatory): a string providing the name of the tenant to register the machine image to.
type (mandatory): a string providing the machine image type to build. For OpenStack: openstack-qcow2, openstack-vmdk, openstack-vdi or openstack-vhd

OpenStack Cloud Account¶

Key: account

Used to authenticate the OpenStack platform.

The OpenStack cloud account has the following valid keys:

file (optional): a string providing the location of the account information. This can be a pathname (relative or absolute) or an URL.
endpoint (mandatory): a string providing the API URL endpoint of the OpenStack glance service. For example: http://www.example.com:9292
keystoneEndpoint (mandatory): a string providing the URL endpoint for the OpenStack keystone service to authenticate with. For example: http://www.example.com:5000
name (mandatory): a string providing the name of the cloud account. This name can be used in a builder section to reference the rest of the cloud account information.
password (mandatory): a string providing the password for authenticating to keystone for publishing images
type (mandatory): a string providing the cloud account type: openstack.
username (mandatory): a string providing the user for authenticating to keystone for publishing images

Note

In the case where name or file is used to reference a cloud account, all the other keys are no longer required in the account definition for the builder.

Example¶

The following example shows an OpenStack builder with all the information to build and publish a machine image to OpenStack.

{
  "builders": [
    {
      "type": "openstack-qcow2",
      "account": {
        "type": "openstack",
        "name": "My OpenStack Account",
        "endpoint": "http://ow2-04.xsalto.net:9292/v1",
        "keystoneEndpoint": "http://ow2-04.xsalto.net:5000/v2.0",
        "username": "test",
        "password": "password"
      },
      "tenant": "opencloudware",
      "imageName": "joris-test",
      "description": "CentOS Core template."
    }
  ]
}

Referencing the Cloud Account¶

To help with security, the cloud account information can be referenced by the builder section. This example is the same as the previous example but with the account information in another file. Create a json file openstack-account.json.

{
  "accounts": [
    {
        "type": "openstack",
        "name": "My OpenStack Account",
        "endpoint": "http://ow2-04.xsalto.net:9292/v1",
        "keystoneEndpoint": "http://ow2-04.xsalto.net:5000/v2.0",
        "username": "test",
        "password": "password"
    }
  ]
}

The builder section can either reference by using file or name.

Reference by file:

{
  "builders": [
    {
      "type": "openstack-qcow2",
      "account": {
        "file": "/home/joris/accounts/openstack-account.json"
      },
      "tenant": "opencloudware",
      "imageName": "joris-test",
      "description": "CentOS Core template."
    }
  ]
}

Reference by name, note the cloud account must already be created by using account create.

{
  "builders": [
    {
      "type": "openstack-qcow2",
      "account": {
        "name": "My OpenStack Account"
      },
      "tenant": "opencloudware",
      "imageName": "joris-test",
      "description": "CentOS Core template."
    }
  ]
}