From dc4ca2015e073f09514588120d5165eab7b1020f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=A4=E7=90=86=E8=A1=A1=20=28Li-Heng=20Yu=29?= <007seadog@gmail.com> Date: Wed, 13 Nov 2024 04:42:00 +0800 Subject: [PATCH] doc: fixed broken doc links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The deploy link in the README is broken. Fixed more broken links requested by iPraveenParihar in #4958 Signed-off-by: 尤理衡 (Li-Heng Yu) <007seadog@gmail.com> --- README.md | 6 +++--- charts/ceph-csi-cephfs/README.md | 2 +- charts/ceph-csi-rbd/README.md | 2 +- charts/ceph-csi-rbd/values.yaml | 4 ++-- docs/resource-cleanup.md | 4 ++-- docs/snap-clone.md | 2 +- examples/rbd/storageclass.yaml | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7e216c477..07d5825b3 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,9 @@ attaching them to workloads. Independent CSI plugins are provided to support RBD and CephFS backed volumes, - For details about configuration and deployment of RBD plugin, please refer - [rbd doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-rbd.md) and + [rbd doc](https://github.com/ceph/ceph-csi/blob/devel/docs/rbd/deploy.md) and for CephFS plugin configuration and deployment please - refer [cephFS doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-cephfs.md). + refer [cephFS doc](https://github.com/ceph/ceph-csi/blob/devel/docs/cephfs/deploy.md). - For example usage of the RBD and CephFS CSI plugins, see examples in `examples/`. - Stale resource cleanup, please refer [cleanup doc](docs/resource-cleanup.md). @@ -75,7 +75,7 @@ Ceph CSI version, they will be asked to upgrade when requesting support. ### Ceph-CSI features and available versions -Please refer [rbd nbd mounter](./docs/rbd-nbd.md#support-matrix) +Please refer [rbd nbd mounter](./docs/design/proposals/rbd-nbd.md#support-matrix) for its support details. | Plugin | Features | Feature Status | CSI Driver Version | CSI Spec Version | Ceph Cluster Version | Kubernetes Version | diff --git a/charts/ceph-csi-cephfs/README.md b/charts/ceph-csi-cephfs/README.md index 1fdca5b29..7ed366d71 100644 --- a/charts/ceph-csi-cephfs/README.md +++ b/charts/ceph-csi-cephfs/README.md @@ -174,7 +174,7 @@ charts and their default values. | `provisionerSocketFile` | The filename of the provisioner socket | `csi-provisioner.sock` | | `pluginSocketFile` | The filename of the plugin socket | `csi.sock` | | `readAffinity.enabled` | Enable read affinity for CephFS subvolumes. Recommended to set to true if running kernel 5.8 or newer. | `false` | -| `readAffinity.crushLocationLabels` | Define which node labels to use as CRUSH location. This should correspond to the values set in the CRUSH map. For more information, click [here](https://github.com/ceph/ceph-csi/blob/v3.9.0/docs/deploy-cephfs.md#read-affinity-using-crush-locations-for-cephfs-subvolumes)| `[]` | +| `readAffinity.crushLocationLabels` | Define which node labels to use as CRUSH location. This should correspond to the values set in the CRUSH map. For more information, click [here](https://github.com/ceph/ceph-csi/blob/devel/docs/cephfs/deploy.md#read-affinity-using-crush-locations-for-cephfs-subvolumes)| `[]` | | `kubeletDir` | Kubelet working directory | `/var/lib/kubelet` | | `driverName` | Name of the csi-driver | `cephfs.csi.ceph.com` | | `configMapName` | Name of the configmap which contains cluster configuration | `ceph-csi-config` | diff --git a/charts/ceph-csi-rbd/README.md b/charts/ceph-csi-rbd/README.md index 4bf4694e7..b1156e579 100644 --- a/charts/ceph-csi-rbd/README.md +++ b/charts/ceph-csi-rbd/README.md @@ -187,7 +187,7 @@ charts and their default values. | `topology.enabled` | Specifies whether topology based provisioning support should be exposed by CSI | `false` | | `topology.domainLabels` | DomainLabels define which node labels to use as domains for CSI nodeplugins to advertise their domains | `{}` | | `readAffinity.enabled` | Enable read affinity for RBD volumes. Recommended to set to true if running kernel 5.8 or newer. | `false` | -| `readAffinity.crushLocationLabels` | Define which node labels to use as CRUSH location. This should correspond to the values set in the CRUSH map. For more information, click [here](https://github.com/ceph/ceph-csi/blob/v3.9.0/docs/deploy-rbd.md#read-affinity-using-crush-locations-for-rbd-volumes)| `[]` | +| `readAffinity.crushLocationLabels` | Define which node labels to use as CRUSH location. This should correspond to the values set in the CRUSH map. For more information, click [here](https://github.com/ceph/ceph-csi/blob/devel/docs/rbd/deploy.md#read-affinity-using-crush-locations-for-rbd-volumes)| `[]` | | `provisionerSocketFile` | The filename of the provisioner socket | `csi-provisioner.sock` | | `pluginSocketFile` | The filename of the plugin socket | `csi.sock` | | `kubeletDir` | kubelet working directory | `/var/lib/kubelet` | diff --git a/charts/ceph-csi-rbd/values.yaml b/charts/ceph-csi-rbd/values.yaml index 16142e32d..aa17fed95 100644 --- a/charts/ceph-csi-rbd/values.yaml +++ b/charts/ceph-csi-rbd/values.yaml @@ -46,7 +46,7 @@ csiConfig: [] csiMapping: [] # Configuration for the encryption KMS -# Ref: https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-rbd.md +# Ref: https://github.com/ceph/ceph-csi/blob/devel/docs/rbd/deploy.md # Example: # encryptionKMSConfig: # vault-unique-id-1: @@ -415,7 +415,7 @@ storageClass: # By default host-path /var/log/ceph of node is bind-mounted into # csi-rbdplugin pod at /var/log/ceph mount path. This is to configure # target bindmount path used inside container for ceph clients logging. - # See docs/rbd-nbd.md for available configuration options. + # See docs/design/proposals/rbd-nbd.md for available configuration options. # cephLogDir: /var/log/ceph cephLogDir: "" diff --git a/docs/resource-cleanup.md b/docs/resource-cleanup.md index 69ca86acb..23162afa9 100644 --- a/docs/resource-cleanup.md +++ b/docs/resource-cleanup.md @@ -28,7 +28,7 @@ a. get pv_name ### 2. Get omap key/value a. get omapkey (suffix of csi.volumes.default is value used for the CLI option - [--instanceid](deploy-rbd.md#configuration) in the provisioner deployment.) + [--instanceid](rbd/deploy.md#configuration) in the provisioner deployment.) ``` rados listomapkeys csi.volumes.default -p pool_name | grep pv_name @@ -56,7 +56,7 @@ b. get omapval ### 3. Delete the RBD image or CephFS subvolume -a. remove rbd image(csi-vol-omapval, the prefix csi-vol is value of [volumeNamePrefix](deploy-rbd.md#configuration)) +a. remove rbd image(csi-vol-omapval, the prefix csi-vol is value of [volumeNamePrefix](rbd/deploy.md#configuration)) ``` rbd remove rbd_image_name -p pool_name diff --git a/docs/snap-clone.md b/docs/snap-clone.md index e6c970738..c1106c572 100644 --- a/docs/snap-clone.md +++ b/docs/snap-clone.md @@ -56,7 +56,7 @@ The snapshot is created on/for an existing PVC. You should have a PVC in bound state before creating snapshot from it. It is recommended to create a volume snapshot or a PVC clone only when the PVC is not in use. -Please refer pvc creation [doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-cephfs.md) +Please refer pvc creation [doc](https://github.com/ceph/ceph-csi/blob/devel/docs/cephfs/deploy.md) for more information on how to create a PVC. - Verify if PVC is in Bound state diff --git a/examples/rbd/storageclass.yaml b/examples/rbd/storageclass.yaml index 5d2fc5eba..9d87b03ef 100644 --- a/examples/rbd/storageclass.yaml +++ b/examples/rbd/storageclass.yaml @@ -101,7 +101,7 @@ parameters: # By default host-path /var/log/ceph of node is bind-mounted into # csi-rbdplugin pod at /var/log/ceph mount path. This is to configure # target bindmount path used inside container for ceph clients logging. - # See docs/rbd-nbd.md for available configuration options. + # See docs/design/proposals/rbd-nbd.md for available configuration options. # cephLogDir: /var/log/ceph # (optional) ceph client log strategy