From b6d85e3975381ea00c40db0c078ba88e4056eac0 Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Thu, 4 Nov 2021 10:41:44 -0400 Subject: [PATCH] doc/mgr/nfs: document rgw user and bucket exports Signed-off-by: Sage Weil --- doc/mgr/nfs.rst | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/doc/mgr/nfs.rst b/doc/mgr/nfs.rst index 548f7b62da780..79e6c29be9f99 100644 --- a/doc/mgr/nfs.rst +++ b/doc/mgr/nfs.rst @@ -271,11 +271,21 @@ permissible values. Create RGW Export ----------------- -To export a bucket +There are two kinds of RGW exports: + +- a *user* export will export all buckets owned by an + RGW user, where the top-level directory of the export is a list of buckets. +- a *bucket* export will export a single bucket, where the top-level directory contains + the objects in the bucket. + +RGW bucket export +^^^^^^^^^^^^^^^^^ + +To export a *bucket*: .. code:: - $ ceph nfs export create rgw --cluster-id --pseudo-path --bucket [--readonly] [--client_addr ...] [--squash ] + $ ceph nfs export create rgw --cluster-id --pseudo-path --bucket [--user-id ] [--readonly] [--client_addr ...] [--squash ] For example, to export *mybucket* via NFS cluster *mynfs* at the pseudo-path */bucketdata* to any host in the ``192.168.10.0/24`` network @@ -291,6 +301,10 @@ For example, to export *mybucket* via NFS cluster *mynfs* at the pseudo-path */b ```` is the name of the bucket that will be exported. +```` is optional, and specifies which RGW user will be used for read and write +operations to the bucket. If it is not specified, the user who owns the bucket will be +used. + .. note:: Currently, if multi-site RGW is enabled, Ceph can only export RGW buckets in the default realm. ```` is the list of client address for which these export @@ -302,6 +316,22 @@ for permissible values. value is `no_root_squash`. See the `NFS-Ganesha Export Sample`_ for permissible values. +RGW user export +^^^^^^^^^^^^^^^ + +To export an RGW *user*: + +.. code:: + + $ ceph nfs export create rgw --cluster-id --pseudo-path --user-id [--readonly] [--client_addr ...] [--squash ] + +For example, to export *myuser* via NFS cluster *mynfs* at the pseudo-path */myuser* to any host in the ``192.168.10.0/24`` network + +.. code:: + + $ ceph nfs export create rgw --cluster-id mynfs --pseudo-path /bucketdata --user-id myuser --client_addr 192.168.10.0/24 + + Delete Export ------------- -- 2.39.5