From f345dd3dbf1f5047cd7f73d03ab01e0df9f38e17 Mon Sep 17 00:00:00 2001 From: Chris MacNaughton Date: Thu, 10 Feb 2022 09:30:44 +0100 Subject: [PATCH] Add basic info to README --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9f5a908..23e8008 100644 --- a/README.md +++ b/README.md @@ -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