charm-ceph-radosgw/README.md
James Page 9c291e3863 Add Juju Network Space support
Juju 2.0 provides support for network spaces, allowing
charm authors to support direct binding of relations and
extra-bindings onto underlying network spaces.

Resync charm-helpers to pickup support in API endpoint
resolution code and add API extra-bindings to the charm
metadata.

Change-Id: Iada9f4d29cca9963900d4ec722c7681fa554b16c
2016-03-31 13:05:19 +01:00

3.4 KiB

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.

Scale-out

Its possible to scale-out the RADOS Gateway itself::

juju add-unit -n 2 ceph-radosgw

and then stick a HA loadbalancer on the front::

juju deploy haproxy juju add-relation haproxy ceph-radosgw

Should give you a bit more bang on the front end if you really need it.

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.