From e67b0317c73e5a94151d89e79fc64dd5682e9e5b Mon Sep 17 00:00:00 2001 From: John Mulligan Date: Wed, 14 Aug 2019 12:49:38 -0400 Subject: [PATCH] doc: document csi naming "prefix" as the rook operator namespace Update the rbd and cephfs docs to include the new prefixed style of name for the rook-managed csi instances. Document that this prefix must match the namespace the rook operator is deployed in. Signed-off-by: John Mulligan --- Documentation/ceph-block.md | 8 +++++++- Documentation/ceph-filesystem.md | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/Documentation/ceph-block.md b/Documentation/ceph-block.md index 302fd7dc8..4d08bad44 100644 --- a/Documentation/ceph-block.md +++ b/Documentation/ceph-block.md @@ -45,7 +45,8 @@ apiVersion: storage.k8s.io/v1 kind: StorageClass metadata: name: rook-ceph-block -provisioner: rbd.csi.ceph.com +# Change "rook-ceph" provisioner prefix to match the operator namespace if needed +provisioner: rook-ceph.rbd.csi.ceph.com parameters: # clusterID is the namespace where the rook cluster is running clusterID: rook-ceph @@ -60,6 +61,11 @@ parameters: reclaimPolicy: Delete ``` +If you've deployed the Rook operator in a namespace other than "rook-ceph" +as is common change the prefix in the provisioner to match the namespace +you used. For example, if the Rook operator is running in "rook-op" the +provisioner value should be "rook-op.rbd.csi.ceph.com". + Create the storage class. ```bash kubectl create -f cluster/examples/kubernetes/ceph/csi/rbd/storageclass.yaml diff --git a/Documentation/ceph-filesystem.md b/Documentation/ceph-filesystem.md index e500504fa..a9ce8e14c 100644 --- a/Documentation/ceph-filesystem.md +++ b/Documentation/ceph-filesystem.md @@ -86,7 +86,8 @@ apiVersion: storage.k8s.io/v1 kind: StorageClass metadata: name: rook-cephfs -provisioner: cephfs.csi.ceph.com +# Change "rook-ceph" provisioner prefix to match the operator namespace if needed +provisioner: rook-ceph.cephfs.csi.ceph.com parameters: # clusterID is the namespace where operator is deployed. clusterID: rook-ceph @@ -112,6 +113,11 @@ parameters: reclaimPolicy: Delete ``` +If you've deployed the Rook operator in a namespace other than "rook-ceph" +as is common change the prefix in the provisioner to match the namespace +you used. For example, if the Rook operator is running in "rook-op" the +provisioner value should be "rook-op.rbd.csi.ceph.com". + Create the storage class. ```bash kubectl create -f cluster/examples/kubernetes/ceph/csi/cephfs/storageclass.yaml