Skip to content

Commit

Permalink
update comments based on feedback
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Ramlot <[email protected]>
  • Loading branch information
inteon committed Jan 26, 2024
1 parent ba92d61 commit 40fc59e
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 15 deletions.
31 changes: 24 additions & 7 deletions deploy/charts/istio-csr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,8 @@ ClusterIP
<td>app.metrics.service.servicemonitor.enabled</td>
<td>

Create Prometheus ServiceMonitor resource for approver-policy.

</td>
<td>bool</td>
<td>
Expand All @@ -272,6 +274,8 @@ false
<td>app.metrics.service.servicemonitor.prometheusInstance</td>
<td>

The value for the "prometheus" label on the ServiceMonitor. This allows for multiple Prometheus instances selecting difference ServiceMonitors using label selectors.

</td>
<td>string</td>
<td>
Expand All @@ -287,6 +291,8 @@ default
<td>app.metrics.service.servicemonitor.interval</td>
<td>

The interval that the Prometheus will scrape for metrics.

</td>
<td>string</td>
<td>
Expand All @@ -302,6 +308,8 @@ default
<td>app.metrics.service.servicemonitor.scrapeTimeout</td>
<td>

The timeout on each metric probe request.

</td>
<td>string</td>
<td>
Expand All @@ -317,6 +325,8 @@ default
<td>app.metrics.service.servicemonitor.labels</td>
<td>

Additional labels to give the ServiceMonitor resource.

</td>
<td>object</td>
<td>
Expand Down Expand Up @@ -401,11 +411,12 @@ false
<td>

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
```
</td>
Expand Down Expand Up @@ -761,10 +772,12 @@ istio-system
<td>app.controller.configmapNamespaceSelector</td>
<td>

(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


</td>
<td>unknown</td>
<td>string</td>
<td>

```yaml
Expand Down Expand Up @@ -859,7 +872,9 @@ resources:
<td>affinity</td>
<td>

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:
Expand Down Expand Up @@ -888,7 +903,9 @@ affinity:
<td>tolerations</td>
<td>

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:
Expand Down
28 changes: 20 additions & 8 deletions deploy/charts/istio-csr/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand Down

0 comments on commit 40fc59e

Please sign in to comment.