Improve README
This improvement is part of a wave of polish in preparation for the launch of the Ceph product. Add Configuration, Actions, and Bugs sections. In config.yaml, modernise example values for 'source' and use consistent words with the ceph-osd, ceph-mon, and ceph-fs charms. Change-Id: Iaf45df89db4b471c6379e09881758dae4b723783
This commit is contained in:
Peter Matulis
parent
4c02fa9c42
commit
29ea9f428b
|
|
@ -1,35 +1,69 @@
|
|||
# CephFS Charm
|
||||
|
||||
This charm exists to provide integration of CephFS.
|
||||
|
||||
# Overview
|
||||
|
||||
Ceph is a distributed storage and network file system designed to provide
|
||||
[Ceph][ceph-upstream] is a unified, distributed storage system designed for
|
||||
excellent performance, reliability, and scalability.
|
||||
|
||||
This charm deploys a Ceph MDS cluster.
|
||||
The ceph-fs charm deploys the metadata server daemon (MDS) for the Ceph
|
||||
distributed file system (CephFS). It is used in conjunction with the
|
||||
[ceph-mon][ceph-mon-charm] and the [ceph-osd][ceph-osd-charm] charms.
|
||||
|
||||
Usage
|
||||
=====
|
||||
Highly available CephFS is achieved by deploying multiple MDS servers (i.e.
|
||||
multiple ceph-fs units).
|
||||
|
||||
Boot things up by using:
|
||||
# Usage
|
||||
|
||||
juju deploy -n 3 ceph-mon
|
||||
juju deploy -n 3 ceph-osd
|
||||
## Configuration
|
||||
|
||||
You can then deploy this charm by simply doing:
|
||||
This section covers common and/or important configuration options. See file
|
||||
`config.yaml` for the full list of options, along with their descriptions and
|
||||
default values. A YAML file (e.g. `ceph-osd.yaml`) is often used to store
|
||||
configuration options. See the [Juju documentation][juju-docs-config-apps] for
|
||||
details on configuring applications.
|
||||
|
||||
#### `source`
|
||||
|
||||
The `source` option states the software sources. A common value is an OpenStack
|
||||
UCA release (e.g. 'cloud:xenial-queens' or 'cloud:bionic-ussuri'). See [Ceph
|
||||
and the UCA][cloud-archive-ceph]. The underlying host's existing apt sources
|
||||
will be used if this option is not specified (this behaviour can be explicitly
|
||||
chosen by using the value of 'distro').
|
||||
|
||||
## Deployment
|
||||
|
||||
We are assuming a pre-existing Ceph cluster.
|
||||
|
||||
To deploy a single MDS node:
|
||||
|
||||
juju deploy ceph-fs
|
||||
juju add-relation ceph-fs ceph-mon
|
||||
|
||||
Once the ceph-mon and osd charms have bootstrapped the cluster, the ceph-mon
|
||||
charm will notify the ceph-fs charm.
|
||||
Then add a relation to the ceph-mon application:
|
||||
|
||||
Contact Information
|
||||
===================
|
||||
juju add-relation ceph-fs:ceph-mds ceph-mon:mds
|
||||
|
||||
## Ceph
|
||||
## Actions
|
||||
|
||||
- [Ceph website](http://ceph.com)
|
||||
- [Ceph mailing lists](http://ceph.com/resources/mailing-list-irc/)
|
||||
- [Ceph bug tracker](http://tracker.ceph.com/projects/ceph)
|
||||
This section lists Juju [actions][juju-docs-actions] supported by the charm.
|
||||
Actions allow specific operations to be performed on a per-unit basis. To
|
||||
display action descriptions run `juju actions ceph-fs`. If the charm is not
|
||||
deployed then see file `actions.yaml`.
|
||||
|
||||
* `get-quota`
|
||||
* `remove-quota`
|
||||
* `set-quota`
|
||||
|
||||
# Bugs
|
||||
|
||||
Please report bugs on [Launchpad][lp-bugs-charm-ceph-fs].
|
||||
|
||||
For general charm questions refer to the OpenStack [Charm Guide][cg].
|
||||
|
||||
<!-- LINKS -->
|
||||
|
||||
[cg]: https://docs.openstack.org/charm-guide
|
||||
[ceph-upstream]: https://ceph.io
|
||||
[ceph-mon-charm]: https://jaas.ai/ceph-mon
|
||||
[ceph-osd-charm]: https://jaas.ai/ceph-osd
|
||||
[juju-docs-actions]: https://jaas.ai/docs/actions
|
||||
[juju-docs-config-apps]: https://juju.is/docs/configuring-applications
|
||||
[lp-bugs-charm-ceph-fs]: https://bugs.launchpad.net/charm-ceph-fs/+filebug
|
||||
[cloud-archive-ceph]: https://wiki.ubuntu.com/OpenStack/CloudArchive#Ceph_and_the_UCA
|
||||
|
|
|
|||
|
|
@ -8,14 +8,14 @@ options:
|
|||
default: distro
|
||||
description: |
|
||||
Optional configuration to support use of additional sources such as:
|
||||
.
|
||||
- ppa:myteam/ppa
|
||||
- cloud:trusty-proposed/kilo
|
||||
- cloud:bionic-ussuri
|
||||
- cloud:xenial-proposed/queens
|
||||
- http://my.archive.com/ubuntu main
|
||||
.
|
||||
The last option should be used in conjunction with the key configuration
|
||||
option.
|
||||
Note that a minimum ceph version of 0.48.2 is required for use with this
|
||||
charm which is NOT provided by the packages in the main Ubuntu archive
|
||||
for precise but is provided in the Ubuntu cloud archive.
|
||||
key:
|
||||
type: string
|
||||
default:
|
||||
|
|
|
|||
Loading…
Reference in New Issue