From be691bb9a927d737a0867914700ad9bee3abf25b Mon Sep 17 00:00:00 2001 From: Peter Matulis Date: Fri, 5 Feb 2021 14:59:19 -0500 Subject: [PATCH] Update README Add a relation to the keystone application Small driveby improvements Add new Documentation section template Change-Id: I19fb3637ef6afe671cbc93d2f8c974e9c0ea1481 --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5b864ae9..d5299108 100644 --- a/README.md +++ b/README.md @@ -96,11 +96,17 @@ the compression behaviour. ## Deployment -To deploy a single RADOS gateway node within an existing Ceph cluster: +Ceph RADOS Gateway is often containerised. Here a single unit is deployed to a +new container on machine '1' within an existing Ceph cluster: - juju deploy ceph-radosgw + juju deploy --to lxd:1 ceph-radosgw juju add-relation ceph-radosgw:mon ceph-mon:radosgw +If the RADOS Gateway is being integrated into OpenStack then a relation to the +keystone application is needed: + + juju add-relation ceph-radosgw:identity-service keystone:identity-service + Expose the service: juju expose ceph-radosgw @@ -109,7 +115,7 @@ Expose the service: traffic by default. In general, MAAS is the only cloud type that does not employ firewalling. -The gateway can be accessed over port 80 (as per `juju status ceph-radosgw` +The Gateway can be accessed over port 80 (as per `juju status ceph-radosgw` output). ## Multi-site replication @@ -210,18 +216,24 @@ display action descriptions run `juju actions ceph-radosgw`. If the charm is not deployed then see file `actions.yaml`. * `pause` -* `resume` * `promote` * `readonly` * `readwrite` +* `resume` * `tidydefaults` +# Documentation + +The OpenStack Charms project maintains two documentation guides: + +* [OpenStack Charm Guide][cg]: for project information, including development + and support notes +* [OpenStack Charms Deployment Guide][cdg]: for charm usage information + # Bugs Please report bugs on [Launchpad][lp-bugs-charm-ceph-radosgw]. -For general charm questions refer to the OpenStack [Charm Guide][cg]. - [juju-docs-actions]: https://jaas.ai/docs/actions