totp: fix copy/paste mistake

[pve-docs.git] / pve-storage-cephfs.adoc

diff --git a/pve-storage-cephfs.adoc b/pve-storage-cephfs.adoc
index 4035617698d8d5679a4bf2fc5c0f3be26f1769d2..8d36246e7ea94ef78af9826214251aa2417bc123 100644 (file)
--- a/pve-storage-cephfs.adoc
+++ b/pve-storage-cephfs.adoc
@@ -34,6 +34,10 @@ Configuration
 This backend supports the common storage properties `nodes`,
 `disable`, `content`, as well as the following `cephfs` specific properties:
 
+fs-name::
+
+Name of the Ceph FS.
+
 monhost::
 
 List of monitor daemon addresses. Optional, only needed if Ceph is not running
@@ -64,6 +68,7 @@ cephfs: cephfs-external
         path /mnt/pve/cephfs-external
         content backup
         username admin
+        fs-name cephfs
 ----
 NOTE: Don't forget to set up the client's secret key file, if cephx was not
 disabled.
@@ -71,32 +76,49 @@ disabled.
 Authentication
 ~~~~~~~~~~~~~~
 
-If you use `cephx` authentication, which is enabled by default, you need to copy
-the secret from your external Ceph cluster to a Proxmox VE host.
+NOTE: If Ceph is installed locally on the {pve} cluster, the following is done
+automatically when adding the storage.
+
+If you use `cephx` authentication, which is enabled by default, you need to
+provide the secret from the external Ceph cluster.
+
+To configure the storage via the CLI, you first need to make the file
+containing the secret available. One way is to copy the file from the external
+Ceph cluster directly to one of the {pve} nodes. The following example will
+copy it to the `/root` directory of the node on which we run it:
 
-Create the directory `/etc/pve/priv/ceph` with
+----
+# scp <external cephserver>:/etc/ceph/cephfs.secret /root/cephfs.secret
+----
 
- mkdir /etc/pve/priv/ceph
+Then use the `pvesm` CLI tool to configure the external RBD storage, use the
+`--keyring` parameter, which needs to be a path to the secret file that you
+copied.  For example:
 
-Then copy the secret
+----
+# pvesm add cephfs <name> --monhost "10.1.1.20 10.1.1.21 10.1.1.22" --content backup --keyring /root/cephfs.secret
+----
 
- scp cephfs.secret <proxmox>:/etc/pve/priv/ceph/<STORAGE_ID>.secret
+When configuring an external RBD storage via the GUI, you can copy and paste
+the secret into the appropriate field.
 
-The secret must be renamed to match your `<STORAGE_ID>`. Copying the
-secret generally requires root privileges. The file must only contain the
-secret key itself, as opposed to the `rbd` backend which also contains a
-`[client.userid]` section.
+The secret is only the key itself, as opposed to the `rbd` backend which also
+contains a `[client.userid]` section.
+
+The secret will be stored at
+
+----
+# /etc/pve/priv/ceph/<STORAGE_ID>.secret
+----
 
 A secret can be received from the Ceph cluster (as Ceph admin) by issuing the
 command below, where `userid` is the client ID that has been configured to
 access the cluster. For further information on Ceph user management, see the
-Ceph docs footnote:[Ceph user management
-{cephdocs-url}/rados/operations/user-management/].
+Ceph docs.footnoteref:[cephusermgmt]
 
- ceph auth get-key client.userid > cephfs.secret
-
-If Ceph is installed locally on the PVE cluster, that is, it was set up using
-`pveceph`, this is done automatically.
+----
+# ceph auth get-key client.userid > cephfs.secret
+----
 
 Storage Features
 ~~~~~~~~~~~~~~~~