Juju Charm - Cinder LVM backend

Go to file

Alex Kavanagh 7ac83dcfac Updates for caracal testing support These updates, on the master branch, are to support testing the caracal packages and support of the charms for caracal. They do NOT lock the charms down, and don't change the testing branches to stable branches. Change-Id: I2f53746a8ef01285ac5e7cb301186796825a58fd		2024-02-24 19:53:22 +00:00
src	Updates for caracal testing support	2024-02-24 19:53:22 +00:00
unit_tests	Fix target_helper config for >= Wallaby	2023-10-17 15:58:57 -03:00
.gitignore	Add *.charm to gitignore	2022-04-18 21:06:15 +01:00
.gitreview	Curate the cinder-lvm charm	2021-09-30 17:43:33 -03:00
.stestr.conf	Initial Cookiecutter Commit.	2020-08-03 17:13:40 -03:00
.zuul.yaml	Add Antelope support	2023-03-09 20:57:25 +00:00
README.md	Curate the cinder-lvm charm	2021-09-30 17:43:33 -03:00
bindep.txt	Add Kinetic and Zed support	2022-08-31 19:52:22 +01:00
charmcraft.yaml	Updates for caracal testing support	2024-02-24 19:53:22 +00:00
copyright	Curate the cinder-lvm charm	2021-09-30 17:43:33 -03:00
metadata.yaml	Curate the cinder-lvm charm	2021-09-30 17:43:33 -03:00
osci.yaml	Updates for caracal testing support	2024-02-24 19:53:22 +00:00
rename.sh	Update to build using charmcraft	2022-02-01 19:47:58 +00:00
requirements.txt	Add Kinetic and Zed support	2022-08-31 19:52:22 +01:00
test-requirements.txt	Add Kinetic and Zed support	2022-08-31 19:52:22 +01:00
tox.ini	Updates for caracal testing support	2024-02-24 19:53:22 +00:00

README.md

Overview

The cinder-lvm charm provides an LVM backend for Cinder, the core OpenStack block storage (volume) service. It is a subordinate charm that is used in conjunction with the cinder charm.

Note: The cinder-lvm charm is supported starting with OpenStack Queens.

Usage

Configuration

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.

`allocation-type`

Refers to volume provisioning type. Values can be 'thin', 'thick', 'auto' (resolves to 'thin' if supported) , and 'default' (resolves to 'thick'). The default value is 'default'.

`block-device`

Specifies a space-separated list of devices to use for LVM physical volumes. This is a mandatory option. Value types include:

block devices (e.g. 'sdb' or '/dev/sdb')
a path to a local file with the size appended after a pipe (e.g. '/path/to/file|10G'). The file will be created if necessary and be mapped to a loopback device. This is intended for development and testing purposes. The default size is 5G.

To prevent potential data loss an already formatted device (or one containing LVM metadata) cannot be used unless the overwrite configuration option is set to 'true'.

`config-flags`

Comma-separated list of key=value configuration flags. These will be added to Cinder's cinder.conf file and will only affect the LVM backend.

`overwrite`

Permits (with a value of 'true') the charm to attempt to overwrite storage devices (specified by the block-devices option) if they contain pre-existing filesystems or LVM metadata. The default is 'false'. A device in use on the host will never be overwritten.

Deployment

Specify a block device (here we choose /dev/sdb) and then add a relation to the cinder charm:

juju deploy --config block-device=sdb cinder-lvm
juju add-relation cinder-lvm:storage-backend cinder:storage-backend

Documentation

The OpenStack Charms project maintains two documentation guides:

OpenStack Charm Guide: for project information, including development and support notes
OpenStack Charms Deployment Guide: for charm usage information

Bugs

Please report bugs on Launchpad.