]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: document that the kcephfs mount helper will search keyring files for secrets
authorJeff Layton <jlayton@redhat.com>
Mon, 19 Aug 2019 11:10:30 +0000 (07:10 -0400)
committerNathan Cutler <ncutler@suse.com>
Thu, 14 Nov 2019 16:25:02 +0000 (17:25 +0100)
Signed-off-by: Jeff Layton <jlayton@redhat.com>
(cherry picked from commit 551b271af47debe4e4cce81149bd4a59fb928937)

Conflicts:
doc/cephfs/kernel.rst
- refrain from backporting bad newline insertion (bad because in the middle of
  a paragraph) to Nautilus

doc/cephfs/fstab.rst
doc/cephfs/kernel.rst

index 785208d7f2f8210b07606182a04fe87a20652b8b..344c80d9e41bcaab7cdd2d600f76c078a00ae82a 100644 (file)
@@ -15,10 +15,11 @@ following to ``/etc/fstab``::
 
 For example:: 
 
-       10.10.10.10:6789:/     /mnt/ceph    ceph    name=admin,secretfile=/etc/ceph/secret.key,noatime,_netdev    0       2
+       10.10.10.10:6789:/     /mnt/ceph    ceph    name=admin,noatime,_netdev    0       2
        
-.. important:: The ``name`` and ``secret`` or ``secretfile`` options are 
-   mandatory when you have Ceph authentication running. 
+The default for the ``name=`` parameter is ``guest``. If the ``secret`` or
+``secretfile`` options are not specified then the mount helper will attempt to
+find a secret for the given ``name`` in one of the configured keyrings.
  
 See `User Management`_ for details.
    
index 3b5a75086a54cb3ee5a07dea1dac4dbc9457ccd5..89f481f9f644f8c7c08b07895a0a94e747009947 100644 (file)
@@ -9,8 +9,12 @@ monitor host name(s) into IP address(es) for you. For example::
        sudo mkdir /mnt/mycephfs
        sudo mount -t ceph 192.168.0.1:6789:/ /mnt/mycephfs
 
-To mount the Ceph file system with ``cephx`` authentication enabled, you must
-specify a user name and a secret. ::
+To mount the Ceph file system with ``cephx`` authentication enabled, the kernel
+must authenticate with the cluster. The default ``name=`` option is ``guest``.
+The mount.ceph helper will automatically attempt to find a secret key in the
+keyring.
+
+The secret can also be specified manually with the ``secret=`` option. ::
 
        sudo mount -t ceph 192.168.0.1:6789:/ /mnt/mycephfs -o name=admin,secret=AQATSKdNGBnwLhAAnNDKnH65FmVKpXZJVasUeQ==
 
@@ -18,11 +22,11 @@ The foregoing usage leaves the secret in the Bash history. A more secure
 approach reads the secret from a file. For example::
 
        sudo mount -t ceph 192.168.0.1:6789:/ /mnt/mycephfs -o name=admin,secretfile=/etc/ceph/admin.secret
+
+See `User Management`_ for details on cephx.
        
-If you have more than one filesystem, specify which one to mount using
+If you have more than one file system, specify which one to mount using
 the ``mds_namespace`` option, e.g. ``-o mds_namespace=myfs``.
-    
-See `User Management`_ for details on cephx.
 
 To unmount the Ceph file system, you may use the ``umount`` command. For example::