~james-page/charms/raring/ceph-radosgw/trunk

« back to all changes in this revision

Viewing changes to README

  • Committer: James Page
  • Date: 2012-10-08 15:58:16 UTC
  • Revision ID: james.page@canonical.com-20121008155816-3fbaiab1hcgmjrrg
Minor tweak to copyright

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Overview
 
2
========
 
3
 
 
4
Ceph is a distributed storage and network file system designed to provide
 
5
excellent performance, reliability, and scalability.
 
6
 
 
7
This charm deploys the RADOS Gateway, a S3 and Swift compatible HTTP gateway
 
8
for online object storage on-top of a ceph cluster.
 
9
 
 
10
This charm only supports the S3 gateway at this point in time.
 
11
 
 
12
Usage
 
13
=====
 
14
 
 
15
In order to use this charm, it assumed that you have already deployed a ceph
 
16
storage cluster using the 'ceph' charm with something like this::
 
17
 
 
18
   juju deploy -n 3 --config ceph.yaml ceph
 
19
 
 
20
To deploy the RADOS gateway simple do::
 
21
 
 
22
   juju deploy ceph-radosgw
 
23
   juju add-relation ceph-radosgw ceph
 
24
 
 
25
You can then directly access the RADOS gateway by exposing the service::
 
26
 
 
27
   juju expose ceph-radosgw
 
28
 
 
29
The gateway can be accessed over port 80 (as show in juju status exposed
 
30
ports).
 
31
 
 
32
Note that you will need to login to one of the service units supporting the
 
33
ceph-radosgw charm to generate some access credentials::
 
34
 
 
35
   radosgw-admin user create --uid="ubuntu" --display-name="Ubuntu Ceph"
 
36
 
 
37
Scale-out
 
38
=========
 
39
 
 
40
Its possible to scale-out the RADOS Gateway itself::
 
41
 
 
42
   juju add-unit -n 2 ceph-radosgw
 
43
 
 
44
and then stick a HA loadbalancer on the front::
 
45
 
 
46
   juju deploy haproxy
 
47
   juju add-relation haproxy ceph-radosgw
 
48
 
 
49
Should give you a bit more bang on the front end if you really need it.
 
50
 
 
51
Bootnotes
 
52
=========
 
53
 
 
54
The Ceph RADOS Gateway makes use of a multiverse package,
 
55
libapache2-mod-fastcgi.   As such it will try to automatically enable the
 
56
multiverse pocket in /etc/apt/sources.list.  Note that there is noting
 
57
'wrong' with multiverse components - they typically have less liberal
 
58
licensing policies or suchlike.