Juju Charm - Cinder Ceph backend
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Billy Olsen fdc7a1da3d Prune gate tests 4 days ago
actions Update tox.ini files from release-tools gold copy 4 years ago
charmhelpers Hotfix charmhelpers sync for local_address() fix 1 month ago
files Sync charm/ceph helpers, tox, and requirements 1 year ago
hooks Fixes for ceph-replication-device relation 1 month ago
lib Update tox.ini files from release-tools gold copy 4 years ago
templates Add marker to avoid empty directory problem for git migration 5 years ago
tests Prune gate tests 4 days ago
unit_tests Fixes for ceph-replication-device relation 1 month ago
.gitignore Add support for Erasure Coded pools 6 months ago
.gitreview OpenDev Migration Patch 1 year ago
.project Initial version of charm 7 years ago
.pydevproject Fix support for cinder ceph rbd on Ocata 4 years ago
.stestr.conf Replace ostestr with stestr in testing framework. 2 years ago
.zuul.yaml Switch to Ussuri jobs 1 year ago
LICENSE Re-license charm as Apache-2.0 4 years ago
Makefile Sync helpers for 20.05 9 months ago
README.md Add blurb about Ceph BlueStore compression 4 months ago
charm-helpers-hooks.yaml Sync charm/ceph helpers, tox, and requirements 1 year ago
config.yaml Add 'rbd-mirroring-mode' to replicated 'create-pool' broker req op 2 months ago
copyright Re-license charm as Apache-2.0 4 years ago
icon.svg Update charm icon 3 years ago
metadata.yaml Remove Disco and Eoan bits 1 month ago
requirements.txt Sync release-tools 2 months ago
revision Fixes from testing 7 years ago
setup.cfg Initial version of charm 7 years ago
test-requirements.txt Updates for testing period for 20.01 release 1 month ago
tox.ini Sync release-tools 2 months ago



Cinder is the OpenStack block storage (volume) service. Ceph is a unified, distributed storage system designed for excellent performance, reliability, and scalability. Ceph-backed Cinder therefore allows for scalability and redundancy for storage volumes. This arrangement is intended for large-scale production deployments.

The cinder-ceph charm provides a Ceph (RBD) storage backend for Cinder and is used in conjunction with the cinder charm and an existing Ceph cluster (via the ceph-mon or the ceph-proxy charms).

Specialised use cases:

  • Through the use of multiple application names (e.g. cinder-ceph-1, cinder-ceph-2), multiple Ceph clusters can be associated with a single Cinder deployment.

  • A variety of storage types can be achieved with a single Ceph cluster by mapping pools with multiple cinder-ceph applications. For instance, different pools could be used for HDD or SSD devices. See option rbd-pool-name below.



This section covers common and/or important configuration options. See file config.yaml for the full list of options, along with their descriptions and default values. See the Juju documentation for details on configuring applications.


The pool-type option dictates the storage pool type. See section 'Ceph pool type' for more information.


The rbd-pool-name option sets an existing rbd pool that Cinder should map to.

Ceph pool type

Ceph storage pools can be configured to ensure data resiliency either through replication or by erasure coding. This charm supports both types via the pool-type configuration option, which can take on the values of 'replicated' and 'erasure-coded'. The default value is 'replicated'.

For this charm, the pool type will be associated with Cinder volumes.

Note: Erasure-coded pools are supported starting with Ceph Luminous.

Replicated pools

Replicated pools use a simple replication strategy in which each written object is copied, in full, to multiple OSDs within the cluster.

The ceph-osd-replication-count option sets the replica count for any object stored within the 'cinder-ceph' rbd pool. Increasing this value increases data resilience at the cost of consuming more real storage in the Ceph cluster. The default value is '3'.

Important: The ceph-osd-replication-count option must be set prior to adding the relation to the ceph-mon (or ceph-proxy) application. Otherwise, the pool's configuration will need to be set by interfacing with the cluster directly.

Erasure coded pools

Erasure coded pools use a technique that allows for the same resiliency as replicated pools, yet reduces the amount of space required. Written data is split into data chunks and error correction chunks, which are both distributed throughout the cluster.

Note: Erasure coded pools require more memory and CPU cycles than replicated pools do.

When using erasure coded pools for Cinder volumes two pools will be created: a replicated pool (for storing RBD metadata) and an erasure coded pool (for storing the data written into the RBD). The ceph-osd-replication-count configuration option only applies to the metadata (replicated) pool.

Erasure coded pools can be configured via options whose names begin with the ec- prefix.

Important: It is strongly recommended to tailor the ec-profile-k and ec-profile-m options to the needs of the given environment. These latter options have default values of '1' and '2' respectively, which result in the same space requirements as those of a replicated pool.

See Ceph Erasure Coding in the OpenStack Charms Deployment Guide for more information.

Ceph BlueStore compression

This charm supports BlueStore inline compression for its associated Ceph storage pool(s). The feature is enabled by assigning a compression mode via the bluestore-compression-mode configuration option. The default behaviour is to disable compression.

The efficiency of compression depends heavily on what type of data is stored in the pool and the charm provides a set of configuration options to fine tune the compression behaviour.

Note: BlueStore compression is supported starting with Ceph Mimic.


These instructions will show how to deploy Cinder and connect it to an existing Juju-managed Ceph cluster.

Let file cinder.yaml contain the following:

  block-device: None

Deploy Cinder and add relations to essential OpenStack components:

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

Now deploy cinder-ceph and add a relation to both the cinder and ceph-mon applications:

juju deploy cinder-ceph

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

Additionally, when both the nova-compute and cinder-ceph applications are deployed a relation is needed between them:

juju add-relation cinder-ceph:ceph-access nova-compute:ceph-access


Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.