Juju Charm - Ceph RADOS Gateway
Go to file
Doug Hellmann 00ce913cac import zuul job settings from project-config
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.

Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.

Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I855fc3fba891988b687c48f32e5e3badbaac59de
Story: #2002586
Task: #24317
2018-09-11 13:07:44 -04:00
actions Re-license charm as Apache-2.0 2016-06-28 12:06:58 +01:00
files/www [hopem,r=] 2015-11-25 11:09:14 +00:00
hooks Update functional test definitions 2018-08-28 14:45:30 -07:00
lib Update tox.ini files from release-tools gold copy 2016-09-09 19:21:59 +00:00
templates Allow the simple Swift auth to work 2017-06-01 11:28:08 +02:00
tests Update functional test definitions 2018-08-28 14:45:30 -07:00
unit_tests Enable Bionic as a gate test 2018-05-17 11:12:01 -07:00
.coveragerc Finsh unit tests and fix lint 2015-02-10 10:30:13 +00:00
.gitignore Enable Bionic as a gate test 2018-05-17 11:12:01 -07:00
.gitreview Add gitreview prior to migration to openstack 2016-02-24 21:53:29 +00:00
.project Add pydev stuff 2014-01-24 17:20:33 +00:00
.pydevproject Add pydev stuff 2014-01-24 17:20:33 +00:00
.stestr.conf Switch to using stestr 2018-05-22 05:26:59 +00:00
.zuul.yaml import zuul job settings from project-config 2018-09-11 13:07:44 -04:00
actions.yaml Add pause/resume actions and sync charm-helpers 2016-03-29 10:31:28 +00:00
charm-helpers-hooks.yaml Update repo to do ch-sync from Git 2017-09-26 09:00:53 +02:00
charm-helpers-tests.yaml Update repo to do ch-sync from Git 2017-09-26 09:00:53 +02:00
config.yaml Drop duplicate config keys (yaml syntax error) 2018-02-08 17:05:07 +01:00
copyright Re-license charm as Apache-2.0 2016-06-28 12:06:58 +01:00
hardening.yaml Add hardening support 2016-03-24 11:37:10 +00:00
icon.svg Update charm icon 2017-07-31 14:19:44 -05:00
LICENSE Re-license charm as Apache-2.0 2016-06-28 12:06:58 +01:00
Makefile Update repo to do ch-sync from Git 2017-09-26 09:00:53 +02:00
metadata.yaml Update series metadata 2018-07-11 14:03:44 -05:00
README.md Update code block indentation in readme 2016-12-10 07:56:13 +01:00
requirements.txt Fix pbr requirement 2016-04-13 10:25:36 +00:00
revision [hopem] Added use-syslog cfg option to allow logging to syslog 2014-03-25 18:44:22 +00:00
test-requirements.txt Switch to using stestr 2018-05-22 05:26:59 +00:00
TODO Added cephx support 2012-10-09 13:35:06 +01:00
tox.ini Merge "Switch to using stestr" 2018-07-25 16:12:51 +00:00

Overview

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

This charm deploys the RADOS Gateway, a S3 and Swift compatible HTTP gateway for online object storage on-top of a ceph cluster.

Usage

In order to use this charm, it is assumed that you have already deployed a ceph storage cluster using the 'ceph' charm with something like this::

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

To deploy the RADOS gateway simple do::

juju deploy ceph-radosgw
juju add-relation ceph-radosgw ceph

You can then directly access the RADOS gateway by exposing the service::

juju expose ceph-radosgw

The gateway can be accessed over port 80 (as show in juju status exposed ports).

Access

Note that you will need to login to one of the service units supporting the ceph charm to generate some access credentials::

juju ssh ceph/0 \
  'sudo radosgw-admin user create --uid="ubuntu" --display-name="Ubuntu Ceph"'

For security reasons the ceph-radosgw charm is not set up with appropriate permissions to administer the ceph cluster.

Keystone Integration

Ceph >= 0.55 integrates with Openstack Keystone for authentication of Swift requests.

This is enabled by relating the ceph-radosgw service with keystone::

juju deploy keystone
juju add-relation keystone ceph-radosgw

If you try to relate the radosgw to keystone with an earlier version of ceph the hook will error out to let you know.

HA/Clustering

There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases, a relationship to hacluster is required which provides the corosync back end HA functionality.

To use virtual IP(s) the clustered nodes must be on the same subnet such that the VIP is a valid IP on the subnet for one of the node's interfaces and each node has an interface in said subnet. The VIP becomes a highly-available API endpoint.

At a minimum, the config option 'vip' must be set in order to use virtual IP HA. If multiple networks are being used, a VIP should be provided for each network, separated by spaces. Optionally, vip_iface or vip_cidr may be specified.

To use DNS high availability there are several prerequisites. However, DNS HA does not require the clustered nodes to be on the same subnet. Currently the DNS HA feature is only available for MAAS 2.0 or greater environments. MAAS 2.0 requires Juju 2.0 or greater. The clustered nodes must have static or "reserved" IP addresses registered in MAAS. The DNS hostname(s) must be pre-registered in MAAS before use with DNS HA.

At a minimum, the config option 'dns-ha' must be set to true and at least one of 'os-public-hostname', 'os-internal-hostname' or 'os-internal-hostname' must be set in order to use DNS HA. One or more of the above hostnames may be set.

The charm will throw an exception in the following circumstances: If neither 'vip' nor 'dns-ha' is set and the charm is related to hacluster If both 'vip' and 'dns-ha' are set as they are mutually exclusive If 'dns-ha' is set and none of the os-{admin,internal,public}-hostname(s) are set

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.

API endpoints can be bound to distinct network spaces supporting the network separation of public, internal and admin endpoints.

To use this feature, use the --bind option when deploying the charm:

juju deploy ceph-radosgw --bind "public=public-space internal=internal-space admin=admin-space"

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

ceph-radosgw:
  charm: cs:xenial/ceph-radosgw
  num_units: 1
  bindings:
    public: public-space
    admin: admin-space
    internal: internal-space

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

NOTE: Existing deployments using os-*-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-radosgw/+filebug Location: http://jujucharms.com/charms/ceph-radosgw

Bootnotes

The Ceph RADOS Gateway makes use of a multiverse package libapache2-mod-fastcgi. As such it will try to automatically enable the multiverse pocket in /etc/apt/sources.list. Note that there is noting 'wrong' with multiverse components - they typically have less liberal licensing policies or suchlike.