DevStack plugin to configure Ceph backend.
Go to file
Ghanshyam Mann 6f1a6e2b9b [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html
Story: #2007236
Task: #38554

Change-Id: I1b544695dc5cc1c9f2cdd5fc3f686dae94d52aaa
2020-04-22 14:07:07 +00:00
devstack Enable extend_attached_volume feature 2019-12-06 14:56:37 +00:00
doc [ussuri][goal] Update contributor documentation 2020-04-22 14:07:07 +00:00
manila run IPv6 scenario tests with CephFS/NFS back end 2019-07-24 18:50:35 +00:00
.gitignore Set up the doc infra and add doc job 2020-04-22 00:54:27 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:40:27 +00:00
.zuul.yaml Set up the doc infra and add doc job 2020-04-22 00:54:27 +00:00
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2020-04-22 14:07:07 +00:00
LICENSE Initial commit 2015-11-27 19:43:03 +00:00
README.md Update opendev repository 2019-04-23 17:52:51 +08:00
tempest_blacklist.txt Skip tempest.api.network tests 2019-04-24 10:11:20 -04:00
tox.ini Set up the doc infra and add doc job 2020-04-22 00:54:27 +00:00

README.md

Team and repository tags

Team and repository tags

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
  • 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.

  • 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.

  • Ceph can be enabled as the storage backend for Manila with the following setting in your local.conf:

    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
    

    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
  • 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