From f182ec6fad646c0b105c967ff7527eeac48c21ef Mon Sep 17 00:00:00 2001 From: Yifei Zhang Date: Fri, 9 Aug 2024 11:17:02 +1000 Subject: [PATCH] CLIP-1911: Added comment regarding the usage of RWO access mode. --- src/main/charts/bamboo/README.md | 2 +- src/main/charts/bamboo/values.yaml | 3 +++ src/main/charts/confluence/README.md | 2 +- src/main/charts/confluence/values.yaml | 3 +++ src/main/charts/crowd/README.md | 2 +- src/main/charts/crowd/values.yaml | 3 +++ src/main/charts/jira/README.md | 2 +- src/main/charts/jira/values.yaml | 3 +++ 8 files changed, 16 insertions(+), 4 deletions(-) diff --git a/src/main/charts/bamboo/README.md b/src/main/charts/bamboo/README.md index b5872a311..6413455ad 100644 --- a/src/main/charts/bamboo/README.md +++ b/src/main/charts/bamboo/README.md @@ -198,7 +198,7 @@ Kubernetes: `>=1.21.x-0` | volumes.sharedHome.nfsPermissionFixer.imageTag | string | `"latest"` | Image tag for the permission fixer init container. Defaults to latest | | volumes.sharedHome.nfsPermissionFixer.mountPath | string | `"/shared-home"` | The path in the K8s initContainer where the shared-home volume will be mounted | | volumes.sharedHome.nfsPermissionFixer.resources | object | `{}` | Resources requests and limits for nfsPermissionFixer init container See: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -| volumes.sharedHome.persistentVolumeClaim.accessModes | list | `["ReadWriteMany"]` | Specify the access modes that should be used for the 'shared-home' volume claim. | +| volumes.sharedHome.persistentVolumeClaim.accessModes | list | `["ReadWriteMany"]` | Specify the access modes that should be used for the 'shared-home' volume claim. Note: 'ReadWriteOnce' (RWO) is suitable only for single-node installations. Be aware that changing the access mode of an existing PVC might be impossible, as the PVC spec is immutable. https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes | | volumes.sharedHome.persistentVolumeClaim.create | bool | `false` | If 'true', then a 'PersistentVolumeClaim' and 'PersistentVolume' will be dynamically created for shared-home based on the 'StorageClassName' supplied below. | | volumes.sharedHome.persistentVolumeClaim.resources | object | `{"requests":{"storage":"1Gi"}}` | Specifies the standard K8s resource requests and/or limits for the shared-home volume claims. | | volumes.sharedHome.persistentVolumeClaim.storageClassName | string | `nil` | Specify the name of the 'StorageClass' that should be used for the 'shared-home' volume claim. | diff --git a/src/main/charts/bamboo/values.yaml b/src/main/charts/bamboo/values.yaml index bd2f583eb..9c3bd8e91 100644 --- a/src/main/charts/bamboo/values.yaml +++ b/src/main/charts/bamboo/values.yaml @@ -255,6 +255,9 @@ volumes: create: false # -- Specify the access modes that should be used for the 'shared-home' volume claim. + # Note: 'ReadWriteOnce' (RWO) is suitable only for single-node installations. + # Be aware that changing the access mode of an existing PVC might be impossible, as the PVC spec is immutable. + # https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes # accessModes: - ReadWriteMany diff --git a/src/main/charts/confluence/README.md b/src/main/charts/confluence/README.md index 006f6a6c9..e93c8dffb 100644 --- a/src/main/charts/confluence/README.md +++ b/src/main/charts/confluence/README.md @@ -241,7 +241,7 @@ Kubernetes: `>=1.21.x-0` | volumes.sharedHome.nfsPermissionFixer.imageTag | string | `"latest"` | Image tag for the permission fixer init container. Defaults to latest | | volumes.sharedHome.nfsPermissionFixer.mountPath | string | `"/shared-home"` | The path in the K8s initContainer where the shared-home volume will be mounted | | volumes.sharedHome.nfsPermissionFixer.resources | object | `{}` | Resources requests and limits for nfsPermissionFixer init container See: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -| volumes.sharedHome.persistentVolumeClaim.accessModes | list | `["ReadWriteMany"]` | Specify the access modes that should be used for the 'shared-home' volume claim. | +| volumes.sharedHome.persistentVolumeClaim.accessModes | list | `["ReadWriteMany"]` | Specify the access modes that should be used for the 'shared-home' volume claim. Note: 'ReadWriteOnce' (RWO) is suitable only for single-node installations. Be aware that changing the access mode of an existing PVC might be impossible, as the PVC spec is immutable. https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes | | volumes.sharedHome.persistentVolumeClaim.create | bool | `false` | If 'true', then a 'PersistentVolumeClaim' and 'PersistentVolume' will be dynamically created for shared-home based on the 'StorageClassName' supplied below. | | volumes.sharedHome.persistentVolumeClaim.resources | object | `{"requests":{"storage":"1Gi"}}` | Specifies the standard K8s resource requests limits for the shared-home volume claims. | | volumes.sharedHome.persistentVolumeClaim.storageClassName | string | `nil` | Specify the name of the 'StorageClass' that should be used for the 'shared-home' volume claim. | diff --git a/src/main/charts/confluence/values.yaml b/src/main/charts/confluence/values.yaml index 3b2849046..98eb35aa9 100644 --- a/src/main/charts/confluence/values.yaml +++ b/src/main/charts/confluence/values.yaml @@ -298,6 +298,9 @@ volumes: create: false # -- Specify the access modes that should be used for the 'shared-home' volume claim. + # Note: 'ReadWriteOnce' (RWO) is suitable only for single-node installations. + # Be aware that changing the access mode of an existing PVC might be impossible, as the PVC spec is immutable. + # https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes # accessModes: - ReadWriteMany diff --git a/src/main/charts/crowd/README.md b/src/main/charts/crowd/README.md index 6e615be23..4b8a5f9ed 100644 --- a/src/main/charts/crowd/README.md +++ b/src/main/charts/crowd/README.md @@ -185,7 +185,7 @@ Kubernetes: `>=1.21.x-0` | volumes.sharedHome.nfsPermissionFixer.imageTag | string | `"latest"` | Image tag for the permission fixer init container. Defaults to latest | | volumes.sharedHome.nfsPermissionFixer.mountPath | string | `"/shared-home"` | The path in the K8s initContainer where the shared-home volume will be mounted | | volumes.sharedHome.nfsPermissionFixer.resources | object | `{}` | Resources requests and limits for nfsPermissionFixer init container See: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -| volumes.sharedHome.persistentVolumeClaim.accessModes | list | `["ReadWriteMany"]` | Specify the access modes that should be used for the 'shared-home' volume claim. | +| volumes.sharedHome.persistentVolumeClaim.accessModes | list | `["ReadWriteMany"]` | Specify the access modes that should be used for the 'shared-home' volume claim. Note: 'ReadWriteOnce' (RWO) is suitable only for single-node installations. Be aware that changing the access mode of an existing PVC might be impossible, as the PVC spec is immutable. https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes | | volumes.sharedHome.persistentVolumeClaim.create | bool | `false` | If 'true', then a 'PersistentVolumeClaim' and 'PersistentVolume' will be dynamically created for shared-home based on the 'StorageClassName' supplied below. | | volumes.sharedHome.persistentVolumeClaim.resources | object | `{"requests":{"storage":"1Gi"}}` | Specifies the standard K8s resource requests and/or limits for the shared-home volume claims. | | volumes.sharedHome.persistentVolumeClaim.storageClassName | string | `nil` | Specify the name of the 'StorageClass' that should be used for the 'shared-home' volume claim. | diff --git a/src/main/charts/crowd/values.yaml b/src/main/charts/crowd/values.yaml index 16f24f119..59f9e5fa9 100644 --- a/src/main/charts/crowd/values.yaml +++ b/src/main/charts/crowd/values.yaml @@ -737,6 +737,9 @@ volumes: create: false # -- Specify the access modes that should be used for the 'shared-home' volume claim. + # Note: 'ReadWriteOnce' (RWO) is suitable only for single-node installations. + # Be aware that changing the access mode of an existing PVC might be impossible, as the PVC spec is immutable. + # https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes # accessModes: - ReadWriteMany diff --git a/src/main/charts/jira/README.md b/src/main/charts/jira/README.md index c26e5485c..4616c965b 100644 --- a/src/main/charts/jira/README.md +++ b/src/main/charts/jira/README.md @@ -185,7 +185,7 @@ Kubernetes: `>=1.21.x-0` | volumes.sharedHome.nfsPermissionFixer.imageTag | string | `"latest"` | Image tag for the permission fixer init container. Defaults to latest | | volumes.sharedHome.nfsPermissionFixer.mountPath | string | `"/shared-home"` | The path in the K8s initContainer where the shared-home volume will be mounted | | volumes.sharedHome.nfsPermissionFixer.resources | object | `{}` | Resources requests and limits for nfsPermissionFixer init container See: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -| volumes.sharedHome.persistentVolumeClaim.accessModes | list | `["ReadWriteMany"]` | Specify the access modes that should be used for the 'shared-home' volume claim. | +| volumes.sharedHome.persistentVolumeClaim.accessModes | list | `["ReadWriteMany"]` | Specify the access modes that should be used for the 'shared-home' volume claim. Note: 'ReadWriteOnce' (RWO) is suitable only for single-node installations. Be aware that changing the access mode of an existing PVC might be impossible, as the PVC spec is immutable. https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes | | volumes.sharedHome.persistentVolumeClaim.create | bool | `false` | If 'true', then a 'PersistentVolumeClaim' and 'PersistentVolume' will be dynamically created for shared-home based on the 'StorageClassName' supplied below. | | volumes.sharedHome.persistentVolumeClaim.resources | object | `{"requests":{"storage":"1Gi"}}` | Specifies the standard K8s resource requests and/or limits for the shared-home volume claims. | | volumes.sharedHome.persistentVolumeClaim.storageClassName | string | `nil` | Specify the name of the 'StorageClass' that should be used for the 'shared-home' volume claim. | diff --git a/src/main/charts/jira/values.yaml b/src/main/charts/jira/values.yaml index a031c4350..0ac3cb208 100644 --- a/src/main/charts/jira/values.yaml +++ b/src/main/charts/jira/values.yaml @@ -266,6 +266,9 @@ volumes: create: false # -- Specify the access modes that should be used for the 'shared-home' volume claim. + # Note: 'ReadWriteOnce' (RWO) is suitable only for single-node installations. + # Be aware that changing the access mode of an existing PVC might be impossible, as the PVC spec is immutable. + # https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes # accessModes: - ReadWriteMany