diff options
| author | John Mulligan <jmulligan@redhat.com> | 2023-02-15 16:04:07 -0500 |
|---|---|---|
| committer | Anoop C S <anoopcs@samba.org> | 2023-02-24 04:43:32 +0000 |
| commit | 5e49d4b4311e9a7059bffd52152a6464d7da49e4 (patch) | |
| tree | 4dca7dbcebe37404cf65af1ac9fa310675d40f05 /docs-xml | |
| parent | 98388e2bf0d35405c974fa7d9671a36e055ed9a6 (diff) | |
| download | samba-5e49d4b4311e9a7059bffd52152a6464d7da49e4.tar.gz | |
doc/vfs_ceph: update confusing default hint for ceph:user_id param
Previously, the manpage hinted that the `ceph:user_id` parameter derived
a default value from the process id. This implies that it referring
to the PID but this is not what libcephfs actually does. Rather, this
param is used to derive the `client.<id>` authorization name ceph uses.
This mistake probably originates in a comment in the libcephfs header.
When I first started using the vfs_ceph module this confused me as I
didn't know what to use to get access to my cluster. Eventually, after
reading both docs and code I found that it does not use the pid but
defaults to a value in the ceph client library (typically "admin").
Therefore, if you are using commands like `ceph fs authorize x
client.foo` or `ceph auth get client.bar` to authorize a client you
would supply smb.conf with `ceph:user_id = foo` or `ceph:user_id = bar`
respectively. These entries then need corresponding entries in your
ceph keyring file.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
Reviewed-by: Guenther Deschner <gd@samba.org>
Reviewed-by: Anoop C S <anoopcs@samba.org>
Diffstat (limited to 'docs-xml')
| -rw-r--r-- | docs-xml/manpages/vfs_ceph.8.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs-xml/manpages/vfs_ceph.8.xml b/docs-xml/manpages/vfs_ceph.8.xml index 5b32122113a..73726ca1062 100644 --- a/docs-xml/manpages/vfs_ceph.8.xml +++ b/docs-xml/manpages/vfs_ceph.8.xml @@ -118,8 +118,8 @@ <listitem> <para> Allows one to explicitly set the client ID used for the - CephFS mount handle. Empty by default (CephFS uses the - process id). + CephFS mount handle. Empty by default (use the libcephfs + client default). </para> <para> Example: ceph:user_id = samba |