Skip to content

Commit fa323f8

Browse files
committed
docs: improve the comments readability in configs
Signed-off-by: jzywieck <jzywiecki@splunk.com>
1 parent 11c1b89 commit fa323f8

File tree

6 files changed

+18
-12
lines changed

6 files changed

+18
-12
lines changed

config/default-with-webhook/kustomization-cluster.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Adds namespace to all resources.
2-
# Cluster-scoped deployment WITH webhook enabled (opt-in)
3-
# Requires cert-manager to be installed in the cluster
2+
# Cluster-scoped deployment with enterprise validation webhooks enabled (opt-in).
3+
# The standalone App webhook is enabled by default via config/default.
4+
# Requires cert-manager to be installed in the cluster.
45
namespace: splunk-operator
56

67
# Value of this field is prepended to the
@@ -20,7 +21,7 @@ bases:
2021
- ../persistent-volume
2122
- ../service
2223
- ../manager
23-
# [WEBHOOK] Enabled for opt-in webhook deployment
24+
# [WEBHOOK] Enabled for enterprise validation webhooks
2425
- ../webhook
2526
# [CERTMANAGER] Required for webhook TLS
2627
- ../certmanager
@@ -34,7 +35,7 @@ patchesStrategicMerge:
3435
# through a ComponentConfig type
3536
#- manager_config_patch.yaml
3637

37-
# [WEBHOOK] Enabled for webhook deployment
38+
# [WEBHOOK] Enabled for enterprise validation webhooks
3839
- manager_webhook_patch.yaml
3940

4041
# [CERTMANAGER] Enabled for CA injection in the admission webhooks

config/default-with-webhook/kustomization-namespace.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Adds namespace to all resources.
2-
# Namespace-scoped deployment WITH webhook enabled (opt-in)
3-
# Requires cert-manager to be installed in the cluster
2+
# Namespace-scoped deployment with enterprise validation webhooks enabled (opt-in).
3+
# The standalone App webhook is enabled by default via config/default.
4+
# Requires cert-manager to be installed in the cluster.
45
namespace: splunk-operator
56

67
# Value of this field is prepended to the
@@ -20,7 +21,7 @@ bases:
2021
- ../persistent-volume
2122
- ../service
2223
- ../manager
23-
# [WEBHOOK] Enabled for opt-in webhook deployment
24+
# [WEBHOOK] Enabled for enterprise validation webhooks
2425
- ../webhook
2526
# [CERTMANAGER] Required for webhook TLS
2627
- ../certmanager
@@ -34,7 +35,7 @@ patchesStrategicMerge:
3435
# through a ComponentConfig type
3536
#- manager_config_patch.yaml
3637

37-
# [WEBHOOK] Enabled for webhook deployment
38+
# [WEBHOOK] Enabled for enterprise validation webhooks
3839
- manager_webhook_patch.yaml
3940

4041
# [CERTMANAGER] Enabled for CA injection in the admission webhooks

config/default-with-webhook/kustomization.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Adds namespace to all resources.
2-
# Cluster-scoped deployment WITH webhook enabled (opt-in)
3-
# Requires cert-manager to be installed in the cluster
2+
# Cluster-scoped deployment with enterprise validation webhooks enabled (opt-in).
3+
# The standalone App webhook is enabled by default via config/default.
4+
# Requires cert-manager to be installed in the cluster.
45
namespace: splunk-operator
56

67
# Value of this field is prepended to the
@@ -20,7 +21,7 @@ bases:
2021
- ../persistent-volume
2122
- ../service
2223
- ../manager
23-
# [WEBHOOK] Enabled for opt-in webhook deployment
24+
# [WEBHOOK] Enabled for enterprise validation webhooks
2425
- ../webhook
2526
# [CERTMANAGER] Required for webhook TLS
2627
- ../certmanager
@@ -34,7 +35,7 @@ patchesStrategicMerge:
3435
# through a ComponentConfig type
3536
#- manager_config_patch.yaml
3637

37-
# [WEBHOOK] Enabled for webhook deployment
38+
# [WEBHOOK] Enabled for enterprise validation webhooks
3839
- manager_webhook_patch.yaml
3940

4041
# [CERTMANAGER] Enabled for CA injection in the admission webhooks

config/default/kustomization-cluster.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ bases:
2020
- ../manager
2121
# [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
2222
# crd/kustomization.yaml
23+
# - ../webhook
2324
- ../app-webhook
2425
# [CERTMANAGER] Required for apps webhook
2526
- ../certmanager

config/default/kustomization-namespace.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ bases:
2020
- ../manager
2121
# [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
2222
# crd/kustomization.yaml
23+
# - ../webhook
2324
- ../app-webhook
2425
# [CERTMANAGER] Required for apps webhook
2526
- ../certmanager

config/default/kustomization.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ bases:
2020
- ../manager
2121
# [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
2222
# crd/kustomization.yaml
23+
# - ../webhook
2324
- ../app-webhook
2425
# [CERTMANAGER] Required for apps webhook
2526
- ../certmanager

0 commit comments

Comments
 (0)