This charm provides the Cinder volume service for OpenStack. It is intended to be used alongside the other OpenStack components.

Two deployment configurations will be shown. Both assume the existence of core OpenStack services: mysql, rabbitmq-server, keystone, and nova-cloud-controller.

With this configuration, a block device (local to the cinder unit) is used as an LVM physical volume. A logical volume is created (openstack volume create) and exported to a cloud instance via iSCSI (openstack server add volume).

Note: It is not recommended to use the LVM storage method for anything other than testing or for small non-production deployments.

A sample cinder.yaml file's contents:

    cinder:
        block-device: sdc

Important: Make sure the designated block device exists and is not currently in use.

Deploy and add relations in this way:

juju deploy --config cinder.yaml cinder

juju add-relation cinder:cinder-volume-service nova-cloud-controller:cinder-volume-service
juju add-relation cinder:shared-db mysql:shared-db
juju add-relation cinder:identity-service keystone:identity-service
juju add-relation cinder:amqp rabbitmq-server:amqp

Note: It has been reported that the LVM storage method may not properly initialise the physical volume and volume group. See bug LP #1862392.

Here, storage volumes are backed by Ceph to allow for scalability and redundancy. This is intended for large-scale production deployments. These instructions assume a functioning Ceph cluster has been deployed to the cloud.

Note: The Ceph storage method is the recommended method for production deployments.

File cinder.yaml contains the following:

    cinder:
        block-device: None

Deploy and add relations as in the standard configuration (using the altered YAML file). However, to use Ceph as the backend the intermediary cinder-ceph charm is required:

juju deploy cinder-ceph

Then add a relation from this charm to both Cinder and Ceph:

juju add-relation cinder-ceph:storage-backend cinder:storage-backend
juju add-relation cinder-ceph:ceph ceph-mon:client

This charm supports high availability. There are two mutually exclusive HA/clustering strategies:

• virtual IP(s)
• DNS

In both cases, the hacluster subordinate charm is required. It provides the corosync backend HA functionality.

To use virtual IP(s) the clustered nodes and the VIP must be on the same subnet. That is, the VIP must be a valid IP on the subnet for one of the node's interfaces and each node has an interface in said subnet. The VIP becomes a highly-available API endpoint.

At a minimum, the configuration option vip must be defined. The value can take on space-separated values if multiple networks are in use. Optionally, options vip_iface or vip_cidr may be specified.

DNS high availability does not require the clustered nodes to be on the same subnet.

It does require:

• an environment with MAAS 2.0 and Juju 2.0 (as minimum versions)
• clustered nodes with static or "reserved" IP addresses registered in MAAS
• DNS hostnames that are pre-registered in MAAS

At a minimum, the configuration option dns-ha must be set to 'true' and at least one of os-admin-hostname, os-internal-hostname, or os-public-hostname must be set.

The charm will throw an exception in the following circumstances:

• if neither vip nor dns-ha is set and the charm has a relation added to hacluster
• if both vip and dns-ha are set
• if dns-ha is set and none of os-admin-hostname, os-internal-hostname, or os-public-hostname are set

This charm supports the use of Juju network spaces (Juju v.2.0). This feature optionally allows specific types of the application's network traffic to be bound to subnets that the underlying hardware is connected to.

Note: Spaces must be configured in the backing cloud prior to deployment.

API endpoints can be bound to distinct network spaces supporting the network separation of public, internal, and admin endpoints.

Access to the underlying MySQL instance can also be bound to a specific space using the shared-db relation.

For example, providing that spaces 'public-space', 'internal-space', and 'admin-space' exist, the deploy command above could look like this:

juju deploy --config cinder.yaml cinder \
   --bind "public=public-space internal=internal-space admin=admin-space shared-db=internal-space"

Alternatively, configuration can be provided as part of a bundle:

    cinder:
      charm: cs:cinder
      num_units: 1
      bindings:
        public: public-space
        internal: internal-space
        admin: admin-space
        shared-db: internal-space

Note: Existing cinder units configured with the os-admin-network, os-internal-network, or os-public-network options will continue to honour them. Furthermore, these options override any space bindings, if set.

This section covers Juju actions supported by the charm. Actions allow specific operations to be performed on a per-unit basis.

Perform the OpenStack service upgrade. Configuration option action-managed-upgrade must be set to 'True'.

Pause the cinder unit. This action will stop the Cinder service.

Remove unused services entities from the database after enabling HA with a stateless backend such as the cinder-ceph application.

Update the host attribute of volumes from currenthost to newhost.

Resume the cinder unit. This action will start the Cinder service if paused.

Validate the running configuration against the OpenStack security guides checklist.

Update the 'os-vol-host-attr:host' volume attribute. Used for migrating volumes to another backend.

Policy overrides is an advanced feature that allows an operator to override the default policy of an OpenStack service. The policies that the service supports, the defaults it implements in its code, and the defaults that a charm may include should all be clearly understood before proceeding.

Caution: It is possible to break the system (for tenants and other services) if policies are incorrectly applied to the service.

Policy statements are placed in a YAML file. This file (or files) is then (ZIP) compressed into a single file and used as an application resource. The override is then enabled via a Boolean charm option.

Here are the essential commands (filenames are arbitrary):

zip overrides.zip override-file.yaml
juju attach-resource cinder policyd-override=overrides.zip
juju config cinder use-policyd-override=true

See appendix Policy Overrides in the OpenStack Charms Deployment Guide for a thorough treatment of this feature.

Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.