openstack/charm-ceph-nfs
Code Issues Proposed changes

Add basic info to README

Browse Source
This commit is contained in:
Chris MacNaughton 2022-02-10 09:30:44 +01:00
parent 8d410253d0
commit f345dd3dbf
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -7,16 +7,29 @@ by CephFS. It supports Ceph Pacific and above.
## Usage
TODO: Provide high-level usage, such as required config or relations
CephNFS provides an additional service when deployed with Ceph and CephFS.
It should be related to CephMon:
juju add-relation ceph-nfs:ceph-client ceph-mon:client
Once all relations have settled, it is possible to create a new export:
juju run-action --wait ceph-nfs/0 create-share name=test-share size=10 allowed-ips=10.0.0.0/24
The above command has creates an NFS share that is 10GB in size, and is
accessible from any machine in the 10.0.0.0-10.0.0.255 network space. To
grant access to a new network address, the `grant-access` action should be
used:
juju run-action --wait ceph-nfs/0 grant-access name=test-share allowed-ips=192.168.0.10 mode=r
This command has granted read-only access to the named share to a specific
address: `192.168.0.1`.
## Relations
TODO: Provide any relations which are provided or required by your charm
## OCI Images
TODO: Include a link to the default image your charm uses
## Contributing
Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines