From 40fc59edf8f6d8ba4c0ab00dbe02f365922693ce Mon Sep 17 00:00:00 2001
From: Tim Ramlot <42113979+inteon@users.noreply.github.com>
Date: Fri, 26 Jan 2024 14:03:22 +0100
Subject: [PATCH] update comments based on feedback
Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com>
---
deploy/charts/istio-csr/README.md | 31 ++++++++++++++++++++++-------
deploy/charts/istio-csr/values.yaml | 28 ++++++++++++++++++--------
2 files changed, 44 insertions(+), 15 deletions(-)
diff --git a/deploy/charts/istio-csr/README.md b/deploy/charts/istio-csr/README.md
index 7353b1a1..ad7d6c6c 100644
--- a/deploy/charts/istio-csr/README.md
+++ b/deploy/charts/istio-csr/README.md
@@ -257,6 +257,8 @@ ClusterIP
| app.metrics.service.servicemonitor.enabled |
+Create Prometheus ServiceMonitor resource for approver-policy.
+
|
bool |
@@ -272,6 +274,8 @@ false
| app.metrics.service.servicemonitor.prometheusInstance |
+The value for the "prometheus" label on the ServiceMonitor. This allows for multiple Prometheus instances selecting difference ServiceMonitors using label selectors.
+
|
string |
@@ -287,6 +291,8 @@ default
| app.metrics.service.servicemonitor.interval |
+The interval that the Prometheus will scrape for metrics.
+
|
string |
@@ -302,6 +308,8 @@ default
| app.metrics.service.servicemonitor.scrapeTimeout |
+The timeout on each metric probe request.
+
|
string |
@@ -317,6 +325,8 @@ default
| app.metrics.service.servicemonitor.labels |
+Additional labels to give the ServiceMonitor resource.
+
|
object |
@@ -401,11 +411,12 @@ false
|
Additional annotations to include on certificate requests.
-Takes key/value pairs in the format:
- - name: custom.cert-manager.io/policy-name
+Takes key/value pairs in the format:
```yaml
-value: istio-csr
+additionalAnnotations:
+ - name: custom.cert-manager.io/policy-name
+ value: istio-csr
```
|
@@ -761,10 +772,12 @@ istio-system
app.controller.configmapNamespaceSelector |
-(string) If set, limit where istio-csr creates configmaps with root ca certificates. If unset, configmap created in ALL namespaces. Example: maistra.io/member-of=istio-system
+If set, limit where istio-csr creates configmaps with root ca certificates. If unset, configmap created in ALL namespaces.
+Example: maistra.io/member-of=istio-system
+
|
-unknown |
+string |
```yaml
@@ -859,7 +872,9 @@ resources:
| affinity |
-expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#affinity-v1-core for example:
+Expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#affinity-v1-core
+
+For example:
```yaml
affinity:
@@ -888,7 +903,9 @@ affinity:
| tolerations |
-expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#toleration-v1-core for example:
+Expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#toleration-v1-core
+
+For example:
```yaml
tolerations:
diff --git a/deploy/charts/istio-csr/values.yaml b/deploy/charts/istio-csr/values.yaml
index af6d8088..c57a621a 100644
--- a/deploy/charts/istio-csr/values.yaml
+++ b/deploy/charts/istio-csr/values.yaml
@@ -40,12 +40,19 @@ app:
enabled: true
# Service type to expose metrics.
type: ClusterIP
- # ServiceMonitor resource for this Service.
+ # The ServiceMonitor resource for this Service.
servicemonitor:
+ # Create Prometheus ServiceMonitor resource for approver-policy.
enabled: false
+ # The value for the "prometheus" label on the ServiceMonitor. This allows
+ # for multiple Prometheus instances selecting difference ServiceMonitors
+ # using label selectors.
prometheusInstance: default
+ # The interval that the Prometheus will scrape for metrics.
interval: 10s
+ # The timeout on each metric probe request.
scrapeTimeout: 5s
+ # Additional labels to give the ServiceMonitor resource.
labels: {}
readinessProbe:
@@ -67,8 +74,9 @@ app:
preserveCertificateRequests: false
# Additional annotations to include on certificate requests.
# Takes key/value pairs in the format:
- # - name: custom.cert-manager.io/policy-name
- # value: istio-csr
+ # additionalAnnotations:
+ # - name: custom.cert-manager.io/policy-name
+ # value: istio-csr
additionalAnnotations: []
issuer:
# Issuer name set on created CertificateRequests for both istio-csr's
@@ -146,7 +154,9 @@ app:
controller:
leaderElectionNamespace: istio-system
- # (string) If set, limit where istio-csr creates configmaps with root ca certificates. If unset, configmap created in ALL namespaces. Example: maistra.io/member-of=istio-system
+ # If set, limit where istio-csr creates configmaps with root ca certificates. If unset, configmap created in ALL namespaces.
+ # Example: maistra.io/member-of=istio-system
+ # +docs:type=string
configmapNamespaceSelector:
# Optional extra volumes. Useful for mounting custom root CAs
@@ -179,8 +189,9 @@ volumeMounts: []
# memory: 128Mi
resources: {}
-# expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#affinity-v1-core
-# for example:
+# Expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#affinity-v1-core
+#
+# For example:
# affinity:
# nodeAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
@@ -192,8 +203,9 @@ resources: {}
# - master
affinity: {}
-# expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#toleration-v1-core
-# for example:
+# Expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#toleration-v1-core
+#
+# For example:
# tolerations:
# - key: foo.bar.com/role
# operator: Equal
|