History

Corey Bryant b455c46541 Add yoga bundles and release-tool syncs * charm-helpers sync for classic charms * sync from release-tools * switch to release-specific zosci functional tests * run focal-ussuri as smoke tests * remove trusty, xenial, and groovy metadata/tests * drop py35 and add py39 * drop bluestore model alias to simplify osci.yaml Change-Id: I1df6bb74fd96d934aa97cce18307a3227b165882		2021-11-18 16:07:37 -05:00
..
actions	Add .gitreview and clean up repo	2017-01-06 08:29:43 -08:00
files	Sync charm/ceph helpers, tox, and requirements	2019-09-30 22:41:33 -05:00
lib	Remove ntp installation in ceph-fs.	2021-09-13 08:03:56 +00:00
reactive	Add BlueStore Compression support	2020-10-06 16:51:52 +02:00
templates	Fix Ceph upgrade issue by porting charm to common framework	2020-06-12 08:24:57 +02:00
tests	Add yoga bundles and release-tool syncs	2021-11-18 16:07:37 -05:00
README.md	Add blurb about Ceph BlueStore compression	2020-10-20 13:18:39 +02:00
actions.yaml	Add .gitreview and clean up repo	2017-01-06 08:29:43 -08:00
config.yaml	Add BlueStore Compression support	2020-10-06 16:51:52 +02:00
copyright	Add .gitreview and clean up repo	2017-01-06 08:29:43 -08:00
icon.svg	Update charm icon	2017-07-31 13:48:41 -05:00
layer.yaml	Fix Ceph upgrade issue by porting charm to common framework	2020-06-12 08:24:57 +02:00
metadata.yaml	Add yoga bundles and release-tool syncs	2021-11-18 16:07:37 -05:00
test-requirements.txt	Sync release-tools	2021-07-22 14:52:05 +02:00
tox.ini	Add xena bundles	2021-09-21 13:52:56 +01:00
wheelhouse.txt	Updates to flip all libraries back to master	2021-05-03 16:02:38 +01:00

README.md

Overview

Ceph is a unified, distributed storage system designed for excellent performance, reliability, and scalability.

The ceph-fs charm deploys the metadata server daemon (MDS) for the Ceph distributed file system (CephFS). The deployment is done within the context of an existing Ceph cluster.

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. A YAML file (e.g. ceph-osd.yaml) is often used to store configuration options. See the Juju documentation for details on configuring applications.

`pool-type`

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

`source`

The source option states the software sources. A common value is an OpenStack UCA release (e.g. 'cloud:xenial-queens' or 'cloud:bionic-ussuri'). See Ceph and the UCA. The underlying host's existing apt sources will be used if this option is not specified (this behaviour can be explicitly chosen by using the value of 'distro').

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 CephFS 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 'ceph-fs-data' cephfs 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 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 CephFS file systems two pools will be created: a replicated pool (for storing MDS metadata) and an erasure coded pool (for storing the data written into a CephFS volume). 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.

Deployment

To deploy a single MDS node within an existing Ceph cluster:

juju deploy ceph-fs
juju add-relation ceph-fs:ceph-mds ceph-mon:mds

High availability

Highly available CephFS is achieved by deploying multiple MDS servers (i.e. multiple ceph-fs units).

Actions

This section lists Juju actions supported by the charm. Actions allow specific operations to be performed on a per-unit basis. To display action descriptions run juju actions ceph-fs. If the charm is not deployed then see file actions.yaml.

get-quota
remove-quota
set-quota

Bugs

Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.