Adds documentation about the CephFS LWRP

diff --git a/README.md b/README.md
index 60ed16f1a0eb0aa1d488c673bdba0c0be080688f..892708c55f04d3dd3f839eeff1371e51aa588552 100644 (file)
--- a/README.md
+++ b/README.md
@@ -82,6 +82,44 @@ Includes:
 
 Ceph Rados Gateway nodes should use the ceph-radosgw role
 
+## Resources/Providers
+
+### ceph\_client
+
+The ceph\_client LWRP provides an easy way to construct a Ceph client key. These keys are needed by anything that needs to talk to the Ceph cluster, including RadosGW, CephFS, and RBD access.
+
+#### Actions
+
+- :add - creates a client key with the given parameters
+
+#### Parameters
+
+- :name - name attribute. The name of the client key to create. This is used to provide a default for the other parameters
+- :caps - A hash of capabilities that should be granted to the client key. Defaults to `{ 'mon' => 'allow r', 'osd' => 'allow r' }`
+- :as\_keyring - Whether the key should be saved in a keyring format or a simple secret key. Defaults to true, meaning it is saved as a keyring
+- :keyname - The key name to register in Ceph. Defaults to `client.#{name}.#{hostname}`
+- :filename - Where to save the key. Defaults to `/etc/ceph/ceph.client.#{name}.#{hostname}.keyring` if `as_keyring` and `/etc/ceph/ceph.client.#{name}.#{hostname}.secret` if not `as_keyring`
+- :owner - Which owner should own the saved key file. Defaults to root
+- :group - Which group should own the saved key file. Defaults to root
+- :mode - What file mode should be applied. Defaults to '00640'
+
+### ceph\_cephfs
+
+The ceph\_cephfs LWRP provides an easy way to mount CephFS. It will automatically create a Ceph client key for the machine and mount CephFS to the specified location. If the kernel client is used, instead of the fuse client, a pre-existing subdirectory of CephFS can be mounted instead of the root.
+
+#### Actions
+
+- :mount - mounts CephFS
+- :umount - unmounts CephFS
+- :remount - remounts CephFS
+- :enable - adds an fstab entry to mount CephFS
+- :disable - removes an fstab entry to mount CephFS
+
+#### Parameters
+
+- :directory - name attribute. Where to mount CephFS in the local filesystem
+- :use\_fuse - whether to use ceph-fuse or the kernel client to mount the filesystem. ceph-fuse is updated more often, but the kernel client allows for subdirectory mounting. Defaults to true
+- :cephfs\_subdir - which CephFS subdirectory to mount. Defaults to '/'. An exception will be thrown if this option is set to anything other than '/' if use\_fuse is also true
 
 ## LICENSE AND AUTHORS