ceph osd #245

Ceph is a distributed storage and network file system designed to provide
excellent performance, reliability, and scalability.
This charm provides the Ceph OSD personality for expanding storage capacity
within a ceph deployment.


Ceph is a distributed storage and network file system designed to provide
excellent performance, reliability, and scalability.

This charm deploys additional Ceph OSD storage service units and should be
used in conjunction with the 'ceph' charm to scale out the amount of storage
available in a Ceph cluster.


The charm also supports specification of the storage devices to use in the ceph

    A list of devices that the charm will attempt to detect, initialise and
    activate as ceph storage.

    This this can be a superset of the actual storage devices presented to
    each service unit and can be changed post ceph-osd deployment using
    `juju set`.

For example::

    osd-devices: /dev/vdb /dev/vdc /dev/vdd /dev/vde

Boot things up by using::

juju deploy -n 3 --config ceph.yaml ceph

You can then deploy this charm by simple doing::

juju deploy -n 10 --config ceph.yaml ceph-osd
juju add-relation ceph-osd ceph

Once the ceph charm has bootstrapped the cluster, it will notify the ceph-osd
charm which will scan for the configured storage devices and add them to the
pool of available storage.

Network Space support

This charm supports the use of Juju Network Spaces, allowing the charm to be bound to network space configurations managed directly by Juju. This is only supported with Juju 2.0 and above.

Network traffic can be bound to specific network spaces using the public (front-side) and cluster (back-side) bindings:

juju deploy ceph-osd --bind "public=data-space cluster=cluster-space"

alternatively these can also be provided as part of a Juju native bundle configuration:

  charm: cs:xenial/ceph-osd
  num_units: 1
    public: data-space
    cluster: cluster-space

Please refer to the Ceph Network Reference for details on how using these options effects network traffic within a Ceph deployment.

NOTE: Spaces must be configured in the underlying provider prior to attempting to use them.

NOTE: Existing deployments using ceph-*-network configuration options will continue to function; these options are preferred over any network space binding provided if set.

Contact Information

Author: James Page james.page@ubuntu.com
Report bugs at: http://bugs.launchpad.net/charms/+source/ceph-osd/+filebug
Location: http://jujucharms.com/charms/ceph-osd


                            Enable apparmor profile. Valid settings: 'complain', 'enforce' or 'disable'.
NOTE: changing the value of this option is disruptive to a running Ceph
cluster as all ceph-osd processes must be restarted as part of changing the
apparmor profile enforcement mode.

                            YAML-formatted associative array of sysctl key/value pairs to be set
persistently. By default we set pid_max, max_map_count and
threads-max to a high value to avoid problems with large numbers (>20)
of OSDs recovering. very large clusters should set those values even
higher (e.g. max for kernel.pid_max is 4194303).

{ kernel.pid_max : 2097152, vm.max_map_count : 524288, kernel.threads-max: 2097152, vm.vfs_cache_pressure: 1, vm.swappiness: 1 }
                            Custom availablility zone to provide to Ceph for the OSD placement

                            Format of filesystem to use for OSD devices; supported formats include:

  xfs (Default >= 0.48.3)
  ext4 (Only option < 0.48.3)
  btrfs (experimental and not recommended)

Only supported with ceph >= 0.48.3.

                            The IP address and netmask of the cluster (back-side) network (e.g.,
If multiple networks are to be used, a space-delimited list of a.b.c.d/x
can be provided.

                            If set to True, supporting services will log to syslog.

                            This parameter will adjust every block device in your server to allow
greater IO operation sizes.  If you have a RAID card with cache on it
consider tuning this much higher than the 1MB default.  1MB is a safe
default for spinning HDDs that don't have much cache.

                            Ceph osd journal size. The journal size should be at least twice the
product of the expected drive speed multiplied by filestore max sync
interval. However, the most common practice is to partition the journal
drive (often an SSD), and mount it such that Ceph uses the entire
partition for the journal.

Only supported with ceph >= 0.48.3.

                            Configure use of direct IO for OSD journals.
                            Optional configuration to support use of additional sources such as:

  - ppa:myteam/ppa
  - cloud:trusty-proposed/kilo
  - http://my.archive.com/ubuntu main

The last option should be used in conjunction with the key configuration

Note that a minimum ceph version of 0.48.2 is required for use with this
charm which is NOT provided by the packages in the main Ubuntu archive
for precise but is provided in the Ubuntu cloud archive.

                            The devices to format and set up as osd volumes.

These devices are the range of devices that will be checked for and
used across all service units, in addition to any volumes attached
via the --storage flag during deployment.

For ceph >= 0.56.6 these can also be directories instead of devices - the
charm assumes anything not starting with /dev is a directory instead.

                            By default, the charm will not encrypt Ceph OSD devices; however, by
setting osd-encrypt to True, Ceph's dmcrypt support will be used to
encrypt OSD devices.

Specifying this option on a running Ceph OSD node will have no effect
until new disks are added, at which point new disks will be encrypted.

                            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.

                            A comma-separated list of nagios servicegroups.
If left empty, the nagios_context will be used as the servicegroup

                            Setting this to true will tell Ceph to replicate across Juju's
Availability Zone instead of specifically by host.

                            The IP address and netmask of the public (front-side) network (e.g.,
If multiple networks are to be used, a space-delimited list of a.b.c.d/x
can be provided.

                            By default, the charm will raise errors if a whitelisted device is found,
but for some reason the charm is unable to initialize the device for use
by Ceph.

Setting this option to 'True' will result in the charm classifying such
problems as warnings only and will not result in a hook error.

                            Key ID to import to the apt keyring to support use with arbitary source
configuration from outside of Launchpad archives or PPA's.

                            User provided Ceph configuration. Supports a string representation of
a python dictionary where each top-level key represents a section in
the ceph.conf template. You may only use sections supported in the
WARNING: this is not the recommended way to configure the underlying
services that this charm installs and is used at the user's own risk.
This option is mainly provided as a stop-gap for users that either
want to test the effect of modifying some config or who have found
a critical bug in the way the charm has configured their services
and need it fixed immediately. We ask that whenever this is used,
that the user consider opening a bug on this charm at
http://bugs.launchpad.net/charms providing an explanation of why the
config was needed so that we may consider it for inclusion as a
natively supported config in the the charm.

                            The device to use as a shared journal drive for all OSD's.  By default
no journal device will be used.

Only supported with ceph >= 0.48.3.

                            OSD debug level. Max is 20.
                            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:
If you're running multiple environments with the same services in them
this allows you to differentiate between them.

                            By default, the charm will not re-format a device that already looks
as if it might be an OSD device.  This is a safeguard to try to
prevent data loss.

Specifying this option (any value) forces a reformat of any OSD devices
found which are not already mounted.

                            Apply system hardening. Supports a space-delimited list of modules
to run. Supported modules currently include os, ssh, apache and mysql.

                            Enabling this option will attempt to tune your network card sysctls and
hard drive settings. This changes hard drive read ahead settings and
max_sectors_kb.  For the network card this will detect the link speed
and make appropriate sysctl changes. Enabling this option should
generally be safe.

                            Cloud instances provide ephermeral storage which is normally mounted
on /mnt.

Setting this option to the path of the ephemeral mountpoint will force
an unmount of the corresponding device so that it can be used as a OSD
storage device.  This is useful for testing purposes (cloud deployment
is not a typical use case).