cinder #35

Supports: trusty
Add to new model


Cinder is the block storage service for the OpenStack.


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

Cinder is made up of 3 separate services: an API service, a scheduler and a
volume service. This charm allows them to be deployed in different
combination, depending on user preference and requirements.

This charm was developed to support deploying Folsom on both
Ubuntu Quantal and Ubuntu Precise. Since Cinder is only available for
Ubuntu 12.04 via the Ubuntu Cloud Archive, deploying this charm to a
Precise machine will by default install Cinder and its dependencies from
the Cloud Archive.


Cinder may be deployed in a number of ways. This charm focuses on 3 main
configurations. All require the existence of the other core OpenStack
services deployed via Juju charms, specifically: mysql, rabbitmq-server,
keystone and nova-cloud-controller. The following assumes these services
have already been deployed.

Basic, all-in-one using local storage and iSCSI

The api server, scheduler and volume service are all deployed into the same
unit. Local storage will be initialized as a LVM phsyical device, and a volume
group initialized. Instance volumes will be created locally as logical volumes
and exported to instances via iSCSI. This is ideal for small-scale deployments
or testing:

cat >cinder.cfg <<END
    block-device: sdc
    overwrite: true
juju deploy --config=cinder.cfg cinder
juju add-relation cinder keystone
juju add-relation cinder mysql
juju add-relation cinder rabbitmq-server
juju add-relation cinder nova-cloud-controller

Separate volume units for scale out, using local storage and iSCSI

Separating the volume service from the API service allows the storage pool
to easily scale without the added complexity that accompanies load-balancing
the API server. When we've exhausted local storage on volume server, we can
simply add-unit to expand our capacity. Future requests to allocate volumes
will be distributed across the pool of volume servers according to the
availability of storage space.

cat >cinder.cfg <<END
    enabled-services: api, scheduler
    enabled-services: volume
    block-device: sdc
    overwrite: true
juju deploy --config=cinder.cfg cinder cinder-api
juju deploy --config=cinder.cfg cinder cinder-volume
juju add-relation cinder-api mysql
juju add-relation cinder-api rabbitmq-server
juju add-relation cinder-api keystone
juju add-relation cinder-api nova-cloud-controller
juju add-relation cinder-volume mysql
juju add-relation cinder-volume rabbitmq-server

# When more storage is needed, simply add more volume servers.
juju add-unit cinder-volume

All-in-one using Ceph-backed RBD volumes

All 3 services can be deployed to the same unit, but instead of relying
on local storage to back volumes an external Ceph cluster is used. This
allows scalability and redundancy needs to be satisified and Cinder's RBD
driver used to create, export and connect volumes to instances. This assumes
a functioning Ceph cluster has already been deployed using the official Ceph
charm and a relation exists between the Ceph service and the nova-compute

cat >cinder.cfg <<END
    block-device: None
juju deploy --config=cinder.cfg cinder
juju add-relation cinder ceph
juju add-relation cinder keystone
juju add-relation cinder mysql
juju add-relation cinder rabbitmq-server
juju add-relation cinder nova-cloud-controller


The default value for most config options should work for most deployments.

Users should be aware of three options, in particular:

openstack-origin: Allows Cinder to be installed from a specific apt repository.
See config.yaml for a list of supported sources.

block-device: When using local storage, a block device should be specified to
back a LVM volume group. It's important this device exists on
all nodes that the service may be deployed to.

overwrite: Whether or not to wipe local storage that of data that may prevent
it from being initialized as a LVM phsyical device. This includes
filesystems and partition tables. CAUTION

enabled-services: Can be used to separate cinder services between service
service units (see previous section)

Deploying from source

The minimum openstack-origin-git config required to deploy from source is:

openstack-origin-git: include-file://cinder-juno.yaml

    - {name: requirements,
       repository: 'git://',
       branch: stable/juno}
    - {name: cinder,
       repository: 'git://',
       branch: stable/juno}

Note that there are only two 'name' values the charm knows about: 'requirements'
and 'cinder'. These repositories must correspond to these 'name' values.
Additionally, the requirements repository must be specified first and the
cinder repository must be specified last. All other repostories are installed
in the order in which they are specified.

The following is a full list of current tip repos (may not be up-to-date):

openstack-origin-git: include-file://cinder-master.yaml

    - {name: requirements,
       repository: 'git://',
       branch: master}
    - {name: oslo-concurrency,
       repository: 'git://',
       branch: master}
    - {name: oslo-config,
       repository: 'git://',
       branch: master}
    - {name: oslo-context,
       repository': 'git://',
       branch: master}
    - {name: oslo-db,
       repository: 'git://',
       branch: master}
    - {name: oslo-i18n,
       repository: 'git://',
       branch: master}
    - {name: oslo-messaging,
       repository: 'git://',
       branch: master}
    - {name: oslo-serialization,
       repository: 'git://',
       branch: master}
    - {name: oslo-utils,
       repository: 'git://',
       branch: master}
    - {name: oslo-rootwrap,
       repository: 'git://',
       branch: master}
    - {name: oslo-vmware,
       repository: 'git://',
       branch: master}
    - {name: osprofiler,
       repository: 'git://',
       branch: master}
    - {name: pbr,
       repository: 'git://',
       branch: master}
    - {name: python-barbicanclient,
       repository: 'git://',
       branch: master}
    - {name: python-glanceclient,
       repository: 'git://',
       branch: master}
    - {name: python-novaclient,
       repository: 'git://',
       branch: master}
    - {name: python-swiftclient:
       repository: 'git://',
       branch: master}
    - {name: sqlalchemy-migrate,
       repository: 'git://',
       branch: master}
    - {name: stevedore,
       repository: 'git://',
       branch: master}
    - {name: taskflow,
       repository: 'git://',
       branch: master}
    - {name: keystonemiddleware,
       repository: 'git://',
       branch: master}
    - {name: cinder,
       repository: 'git://',
       branch: master}


(boolean) If True enables openstack upgrades for this charm via juju actions. You will still need to set openstack-origin to the new repository but instead of an upgrade running automatically across all units, it will wait for you to execute the openstack-upgrade action for this charm on each unit. If False it will revert to existing behavior of upgrading all units on config change.
(int) OpenStack Volume API listening port.
(string) The block devices on which to create LVM volume group. May be set to None for deployments that will not need local storage (eg, Ceph/RBD-backed volumes). This can also be a space delimited list of block devices to attempt to use in the cinder LVM volume group - each block device detected will be added to the available physical volumes in the volume group. May be set to the path and size of a local file (/path/to/file.img|$sizeG), which will be created and used as a loopback device (for testing only). $sizeG defaults to 5G
(int) This value dictates the number of replicas ceph must make of any object it stores withing the cinder rbd pool. Of course, this only applies if using Ceph as a backend store. Note that once the cinder rbd pool has been created, changing this value will not have any effect (although it can be changed in ceph by manually configuring your ceph cluster).
(string) Comma-separated list of key=value config flags. These values will be placed in the cinder.conf [DEFAULT] section.
(string) Database to request access.
(string) Username to request database access.
(boolean) Enable debug logging.
(string) If splitting cinder services between units, define which services to install and configure.
(string) Cloud instances provide ephermeral storage which is normally mounted on /mnt. . Providing this option will force an unmount of the ephemeral device so that it can be used as a Cinder storage device. This is useful for testing purposes (cloud deployment is not a typical use case).
(int) Newer storage drivers may require the v2 Glance API to perform certain actions e.g. the RBD driver requires requires this to support COW cloning of images. This option will default to v1 for backwards compatibility older glance services.
(string) Default network interface on which HA cluster will bind to communication with the other members of the HA Cluster.
(int) Default multicast port number that will be used to communicate between HA Cluster nodes.
(int) Client timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 30000ms is used.
(int) Connect timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 5000ms is used.
(int) Queue timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 5000ms is used.
(int) Server timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 30000ms is used.
(string) Used by the nrpe-external-master subordinate charm. A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like: juju-myservice-0 If you're running multiple environments with the same services in them this allows you to differentiate between them.
(string) A comma-separated list of nagios servicegroups. If left empty, the nagios_context will be used as the servicegroup
(string) Repository from which to install. May be one of the following: distro (default), ppa:somecustom/ppa, a deb url sources entry, or a supported Cloud Archive release pocket. Supported Cloud Archive sources include: cloud:<series>-<openstack-release> cloud:<series>-<openstack-release>/updates cloud:<series>-<openstack-release>/staging cloud:<series>-<openstack-release>/proposed For series=Precise we support cloud archives for openstack-release: * icehouse For series=Trusty we support cloud archives for openstack-release: * juno * kilo * ... NOTE: updating this setting to a source that is known to provide a later version of OpenStack will trigger a software upgrade. NOTE: when openstack-origin-git is specified, openstack specific packages will be installed from source rather than from the openstack-origin repository.
(string) Specifies a YAML-formatted dictionary listing the git repositories and branches from which to install OpenStack and its dependencies. Note that the installed config files will be determined based on the OpenStack release of the openstack-origin option. For more details see
(string) The IP address and netmask of the OpenStack Admin network (e.g., . This network will be used for admin endpoints.
(string) The IP address and netmask of the OpenStack Internal network (e.g., . This network will be used for internal endpoints.
(string) The hostname or address of the public endpoints created for cinder in the keystone identity provider. This value will be used for public endpoints. For example, an os-public-hostname set to '' with ssl enabled will create two public endpoints for cinder:$(tenant_id)s and$(tenant_id)s
(string) The IP address and netmask of the OpenStack Public network (e.g., . This network will be used for public endpoints.
(string) If true, charm will attempt to overwrite block devices containing previous filesystems or LVM, assuming it is not in use.
(boolean) If True enables IPv6 support. The charm will expect network interfaces to be configured with an IPv6 address. If set to False (default) IPv4 is expected. NOTE: these charms do not currently support IPv6 privacy extension. In order for this charm to function correctly, the privacy extension must be disabled and a non-temporary address must be configured/available on your network interface.
(string) Username to request access on rabbitmq-server.
(string) RabbitMQ virtual host to request access on rabbitmq-server.
(string) OpenStack Region
(boolean) If True, charm will attempt to remove missing physical volumes from volume group, if logical volumes are not allocated on them.
(boolean) If True, charm will attempt to remove missing physical volumes from volume group, even when logical volumes are allocated on them. This option overrides 'remove-missing' when set.
(string) SSL CA to use with the certificate and key provided - this is only required if you are providing a privately signed ssl_cert and ssl_key.
(string) SSL certificate to install and use for API ports. Setting this value and ssl_key will enable reverse proxying, point Cinder's entry in the Keystone catalog to use https, and override any certficiate and key issued by Keystone (if it is configured to do so).
(string) SSL key to use with certificate specified as ssl_cert.
(boolean) Setting this to True will allow supporting services to log to syslog.
(boolean) Enable verbose logging.
(string) Virtual IP(s) to use to front API services in HA configuration. . If multiple networks are being used, a VIP should be provided for each network, separated by spaces.
(int) Default CIDR netmask to use for HA vip when it cannot be automatically determined.
(string) Default network interface to use for HA vip when it cannot be automatically determined.
(string) Name of volume group to create and store Cinder volumes.
(int) The CPU core multiplier to use when configuring worker processes for Cinder. By default, the number of workers for each daemon is set to twice the number of CPU cores a service unit has.