Files
71317476aaadc5d668914fb0cb26c6b49e31ca06
devstack-plugin-ceph /README.md

87 lines
2.9 KiB
Markdown
Raw Normal View History

Team and repository tags
========================
[![Team and repository tags](https://governance.openstack.org/tc/badges/devstack-plugin-ceph.svg)](https://governance.openstack.org/tc/reference/tags/index.html)
Devstack Ceph Plugin
====================
# Overview
Devstack plugin to configure Ceph as the storage backend for openstack services
As part of ```stack.sh```:
* Installs Ceph (client and server) packages
* Creates a Ceph cluster for use with openstack services
Add Manila support for Ubuntu Let the plugin setup and configure CephFS as the storage backend for Manila. This is not done by default. Refer the README to do so. Add 'pre_test_hook' and 'post_test_hook' scripts that would be needed to configure Manila-Ceph CI jobs. The following changes are also made: * Install a development version of Ceph that is compatible with Manila's CephFSNative driver. * The development version is a version greater than Infernalis. And from Infernalis onwards, the ceph daemons are run as user "ceph". So allow the daemons to run as user "ceph" for such versions. * Enhance get_ceph_version to check Ceph version even when the ceph mon daemon is not up, by checking the CLI version. Co-Authored-By: John Spray <john.spray@redhat.com> Change-Id: I74314bfcc6b52d524bb84f2232a988f275b9afbf
2015年12月16日 21:40:38 +05:30
* Configures Ceph as the storage backend for Cinder, Cinder Backup, Nova,
Manila (not by default), and Glance services
* (Optionally) Sets up & configures Rados gateway (aka rgw or radosgw) as a Swift endpoint with Keystone integration
* Set ```ENABLE_CEPH_RGW=True``` in your ```localrc```
* Supports Ceph cluster running local or remote to openstack services
As part of ```unstack.sh``` | ```clean.sh```:
* Tears down the Ceph cluster and its related services
This plugin also gets used to configure Ceph as the storage backend for the upstream Ceph CI job named ```gate-tempest-dsvm-full-devstack-plugin-ceph```
# Usage
* To get started quickly, just enable the plugin in your ```local.conf```:
```enable_plugin devstack-plugin-ceph https://opendev.org/openstack/devstack-plugin-ceph```
Run ```stack.sh``` in your devstack tree and boom! You're good to go.
Add Manila support for Ubuntu Let the plugin setup and configure CephFS as the storage backend for Manila. This is not done by default. Refer the README to do so. Add 'pre_test_hook' and 'post_test_hook' scripts that would be needed to configure Manila-Ceph CI jobs. The following changes are also made: * Install a development version of Ceph that is compatible with Manila's CephFSNative driver. * The development version is a version greater than Infernalis. And from Infernalis onwards, the ceph daemons are run as user "ceph". So allow the daemons to run as user "ceph" for such versions. * Enhance get_ceph_version to check Ceph version even when the ceph mon daemon is not up, by checking the CLI version. Co-Authored-By: John Spray <john.spray@redhat.com> Change-Id: I74314bfcc6b52d524bb84f2232a988f275b9afbf
2015年12月16日 21:40:38 +05:30
* Ceph is setup as the default storage backend for Cinder, Cinder Backup,
Glance and Nova services. You have the ability to control each of the
enabled services with the following configuration in your ```local.conf```:
```
ENABLE_CEPH_CINDER=True # ceph backend for cinder
ENABLE_CEPH_GLANCE=True # store images in ceph
ENABLE_CEPH_C_BAK=True # backup volumes to ceph
ENABLE_CEPH_NOVA=True # allow nova to use ceph resources
```
Change any of the above lines to ```False``` to disable that feature
specifically.
Add Manila support for Ubuntu Let the plugin setup and configure CephFS as the storage backend for Manila. This is not done by default. Refer the README to do so. Add 'pre_test_hook' and 'post_test_hook' scripts that would be needed to configure Manila-Ceph CI jobs. The following changes are also made: * Install a development version of Ceph that is compatible with Manila's CephFSNative driver. * The development version is a version greater than Infernalis. And from Infernalis onwards, the ceph daemons are run as user "ceph". So allow the daemons to run as user "ceph" for such versions. * Enhance get_ceph_version to check Ceph version even when the ceph mon daemon is not up, by checking the CLI version. Co-Authored-By: John Spray <john.spray@redhat.com> Change-Id: I74314bfcc6b52d524bb84f2232a988f275b9afbf
2015年12月16日 21:40:38 +05:30
* Ceph can be enabled as the storage backend for Manila with the following
setting in your ```local.conf```:
Add Manila support for Ubuntu Let the plugin setup and configure CephFS as the storage backend for Manila. This is not done by default. Refer the README to do so. Add 'pre_test_hook' and 'post_test_hook' scripts that would be needed to configure Manila-Ceph CI jobs. The following changes are also made: * Install a development version of Ceph that is compatible with Manila's CephFSNative driver. * The development version is a version greater than Infernalis. And from Infernalis onwards, the ceph daemons are run as user "ceph". So allow the daemons to run as user "ceph" for such versions. * Enhance get_ceph_version to check Ceph version even when the ceph mon daemon is not up, by checking the CLI version. Co-Authored-By: John Spray <john.spray@redhat.com> Change-Id: I74314bfcc6b52d524bb84f2232a988f275b9afbf
2015年12月16日 21:40:38 +05:30
```
ENABLE_CEPH_MANILA=True
```
CephFS Native driver that supports native Ceph protocol is used by default.
To use CephFS NFS-Ganesha driver that supports NFS protocol add the setting:
```
MANILA_CEPH_DRIVER=cephfsnfs
```
Add Manila support for Ubuntu Let the plugin setup and configure CephFS as the storage backend for Manila. This is not done by default. Refer the README to do so. Add 'pre_test_hook' and 'post_test_hook' scripts that would be needed to configure Manila-Ceph CI jobs. The following changes are also made: * Install a development version of Ceph that is compatible with Manila's CephFSNative driver. * The development version is a version greater than Infernalis. And from Infernalis onwards, the ceph daemons are run as user "ceph". So allow the daemons to run as user "ceph" for such versions. * Enhance get_ceph_version to check Ceph version even when the ceph mon daemon is not up, by checking the CLI version. Co-Authored-By: John Spray <john.spray@redhat.com> Change-Id: I74314bfcc6b52d524bb84f2232a988f275b9afbf
2015年12月16日 21:40:38 +05:30
Make sure that the manila plugin is enabled before devstack-plugin-ceph in
the ```local.conf``` file.
* Then run ```stack.sh``` and wait for the _magic_ to happen :)
# Known Issues / Limitations
* Rados Gateway with Keystone for Swift - works on Ubuntu only
* Tempest test failures when using RGW as swift endpoint
* Tempest fails due to verify-tempest-config erroring out, when using RGW as swift endpoint
* Patch sent @ https://review.openstack.org/#/c/264179/
* Manila with CephFS - for Ubuntu, support only for Trusty Tahr (14.04 LTS) and beyond
# TODOs
* Fix Rados Gateway with Keystone for Swift on Fedora
# Bugs
* https://bugs.launchpad.net/devstack-plugin-ceph