docs: enhance documentation for objectSelector settings

- Update warning messages in README.md to emphasize caution with modifying objectSelector settings. - Adjust documentation in values.yaml to improve clarity regarding the impact of changing objectSelector. Signed-off-by: dsv <[email protected]>
Nordix · Sep 6, 2024 · 2d0c4ce · 2d0c4ce
1 parent 6a3ca8d
commit 2d0c4ce
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/charts/topolvm/README.md b/charts/topolvm/README.md
@@ -157,9 +157,9 @@ See [Getting Started](https://github.com/topolvm/topolvm/blob/topolvm-chart-v15.
 | webhook.caBundle | string | `nil` | Specify the certificate to be used for AdmissionWebhook. |
 | webhook.existingCertManagerIssuer | object | `{}` | Specify the cert-manager issuer to be used for AdmissionWebhook. |
 | webhook.podMutatingWebhook.enabled | bool | `false` | Enable Pod MutatingWebhook. |
-| webhook.podMutatingWebhook.objectSelector | object | `{}` | Labels required on Pods for webhook action. **Warning**: Modifying this can affect TopoLVM Pod scheduling. Do at your own risk. # ref: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#matching-requests-objectselector |
+| webhook.podMutatingWebhook.objectSelector | object | `{}` | Labels required on Pods for webhook action. **WARNING**: Modifying objectSelector can affect TopoLVM Pod scheduling. Proceed with caution. # ref: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#matching-requests-objectselector |
 | webhook.pvcMutatingWebhook.enabled | bool | `true` | Enable PVC MutatingWebhook. |
-| webhook.pvcMutatingWebhook.objectSelector | object | `{}` | Labels required on PVCs for webhook action. **Warning**: Modifying this can affect TopoLVM PVC management. Do at your own risk. # ref: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#matching-requests-objectselector |
+| webhook.pvcMutatingWebhook.objectSelector | object | `{}` | Labels required on PVCs for webhook action. **WARNING**: Modifying objectSelector can affect TopoLVM PVC management. Proceed with caution. # ref: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#matching-requests-objectselector |
 
 ## Generate Manifests
 

diff --git a/charts/topolvm/values.yaml b/charts/topolvm/values.yaml
@@ -698,14 +698,16 @@ webhook:
     # webhook.podMutatingWebhook.enabled -- Enable Pod MutatingWebhook.
     enabled: false
     # webhook.podMutatingWebhook.objectSelector -- Labels required on Pods for webhook action.
-    # WARNING: Modifying objectSelector can affect TopoLVM Pod scheduling. Proceed with caution.
+    # **WARNING**: Modifying objectSelector can affect TopoLVM Pod scheduling. Proceed with caution.
+    ## ref: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#matching-requests-objectselector
     objectSelector: {}
       # webhook: topolvm
   pvcMutatingWebhook:
     # webhook.pvcMutatingWebhook.enabled -- Enable PVC MutatingWebhook.
     enabled: true
     # webhook.pvcMutatingWebhook.objectSelector -- Labels required on PVCs for webhook action.
-    # WARNING: Modifying objectSelector can affect TopoLVM PVC management. Proceed with caution.
+    # **WARNING**: Modifying objectSelector can affect TopoLVM PVC management. Proceed with caution.
+    ## ref: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#matching-requests-objectselector
     objectSelector: {}
       # webhook: topolvm