Skip to content

Commit

Permalink
Merge pull request #458 from wallrj/fix-helm-typos
Browse files Browse the repository at this point in the history 
Fix helm chart typos
  • Loading branch information
@cert-manager-prow
cert-manager-prow[bot] authored Dec 11, 2024
2 parents 6ee95d4 + fd35dd6 commit c724008
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 55 deletions.
33 changes: 14 additions & 19 deletions deploy/charts/istio-csr/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,14 +121,14 @@ Service type to expose metrics.
> false
> ```
Create Prometheus ServiceMonitor resource for approver-policy.
Create a Prometheus ServiceMonitor resource.
#### **app.metrics.service.servicemonitor.prometheusInstance** ~ `string`
> Default value:
> ```yaml
> default
> ```
The value for the "prometheus" label on the ServiceMonitor. This allows for multiple Prometheus instances selecting difference ServiceMonitors using label selectors.
The value for the "prometheus" label on the ServiceMonitor. This allows for multiple Prometheus instances selecting different ServiceMonitors using label selectors.
#### **app.metrics.service.servicemonitor.interval** ~ `string`
> Default value:
> ```yaml
Expand Down Expand Up @@ -156,7 +156,7 @@ Additional labels to give the ServiceMonitor resource.
> false
> ```
Create the runtime-configuration ConfigMap
Create the runtime-configuration ConfigMap.
#### **app.runtimeConfiguration.name** ~ `string`
> Default value:
> ```yaml
Expand Down Expand Up @@ -286,9 +286,7 @@ An optional file location to a PEM encoded root CA that the root CA. ConfigMap i
> 1h
> ```
Requested duration of gRPC serving certificate. Will be automatically renewed.
Based on NIST 800-204A recommendations (SM-DR13).
https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf
Requested duration of gRPC serving certificate. Will be automatically renewed. Based on [NIST 800-204A recommendations (SM-DR13)](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf).
#### **app.tls.istiodCertificateEnable** ~ `boolean,string,null`
> Default value:
> ```yaml
Expand All @@ -303,7 +301,7 @@ If true, create the istiod certificate using a cert-manager certificate as part
> 1h
> ```
Requested duration of istio's Certificate. Will be automatically renewed. Default is based on NIST 800-204A recommendations (SM-DR13). https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf. Warning: cert-manager does not allow a duration on Certificates less than 1 hour.
Requested duration of istio's Certificate. Will be automatically renewed. Default is based on [NIST 800-204A recommendations (SM-DR13)](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf). Warning: cert-manager does not allow a duration on Certificates less than 1 hour.
#### **app.tls.istiodCertificateRenewBefore** ~ `string`
> Default value:
> ```yaml
Expand Down Expand Up @@ -353,9 +351,7 @@ The istio cluster ID to verify incoming CSRs.
> 1h
> ```
Maximum validity duration that can be requested for a certificate. istio-csr will request a duration of the smaller of this value, and that of the incoming gRPC CSR.
Based on NIST 800-204A recommendations (SM-DR13).
https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf
Maximum validity duration that can be requested for a certificate. istio-csr will request a duration of the smaller of this value, and that of the incoming gRPC CSR. Based on [NIST 800-204A recommendations (SM-DR13)](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf).
#### **app.server.serving.address** ~ `string`
> Default value:
> ```yaml
Expand Down Expand Up @@ -390,7 +386,7 @@ The type of private key to generate for the serving certificate. Only RSA (defau
> ""
> ```
A comma-separated list of service accounts that are allowed to use node authentication for CSRs, eg. "istio-system/ztunnel"
A comma-separated list of service accounts that are allowed to use node authentication for CSRs, eg. "istio-system/ztunnel".
#### **app.istio.revisions[0]** ~ `string`
> Default value:
> ```yaml
Expand Down Expand Up @@ -457,7 +453,7 @@ Optional extra annotations for pod.
> []
> ```
Optional extra volumes. Useful for mounting custom root CAs
Optional extra volumes. Useful for mounting custom root CAs.
For example:
Expand All @@ -473,7 +469,7 @@ volumes:
> []
> ```
Optional extra volume mounts. Useful for mounting custom root CAs
Optional extra volume mounts. Useful for mounting custom root CAs.
For example:
Expand All @@ -488,8 +484,7 @@ volumeMounts:
> {}
> ```
Kubernetes pod resources
ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Kubernetes [pod resources](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/).
For example:
Expand Down Expand Up @@ -528,7 +523,7 @@ resources:
> {}
> ```
Expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#affinity-v1-core
Expects input structure as per [specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#affinity-v1-core).
For example:
Expand All @@ -549,7 +544,7 @@ affinity:
> []
> ```
Expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#toleration-v1-core
Expects input structure as per [specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#toleration-v1-core).
For example:
Expand Down Expand Up @@ -593,14 +588,14 @@ Kubernetes node selector: node labels for pod assignment.
> {}
> ```
Labels to apply to all resources
Labels to apply to all resources.
#### **extraObjects** ~ `array`
> Default value:
> ```yaml
> []
> ```
Create resources alongside installing istio-csr, via Helm values. Can accept an array of YAML-formatted resources. Each array entry can include multiple YAML documents, separated by '---'
Create resources alongside installing istio-csr, via Helm values. Can accept an array of YAML-formatted resources. Each array entry can include multiple YAML documents, separated by '---'.
For example:
Expand Down
28 changes: 14 additions & 14 deletions deploy/charts/istio-csr/values.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
},
"helm-values.affinity": {
"default": {},
"description": "Expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#affinity-v1-core\n\nFor example:\naffinity:\n nodeAffinity:\n requiredDuringSchedulingIgnoredDuringExecution:\n nodeSelectorTerms:\n - matchExpressions:\n - key: foo.bar.com/role\n operator: In\n values:\n - master",
"description": "Expects input structure as per [specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#affinity-v1-core).\n\nFor example:\naffinity:\n nodeAffinity:\n requiredDuringSchedulingIgnoredDuringExecution:\n nodeSelectorTerms:\n - matchExpressions:\n - key: foo.bar.com/role\n operator: In\n values:\n - master",
"type": "object"
},
"helm-values.app": {
Expand Down Expand Up @@ -310,7 +310,7 @@
},
"helm-values.app.metrics.service.servicemonitor.enabled": {
"default": false,
"description": "Create Prometheus ServiceMonitor resource for approver-policy.",
"description": "Create a Prometheus ServiceMonitor resource.",
"type": "boolean"
},
"helm-values.app.metrics.service.servicemonitor.interval": {
Expand All @@ -325,7 +325,7 @@
},
"helm-values.app.metrics.service.servicemonitor.prometheusInstance": {
"default": "default",
"description": "The value for the \"prometheus\" label on the ServiceMonitor. This allows for multiple Prometheus instances selecting difference ServiceMonitors using label selectors.",
"description": "The value for the \"prometheus\" label on the ServiceMonitor. This allows for multiple Prometheus instances selecting different ServiceMonitors using label selectors.",
"type": "string"
},
"helm-values.app.metrics.service.servicemonitor.scrapeTimeout": {
Expand Down Expand Up @@ -377,7 +377,7 @@
},
"helm-values.app.runtimeConfiguration.create": {
"default": false,
"description": "Create the runtime-configuration ConfigMap",
"description": "Create the runtime-configuration ConfigMap.",
"type": "boolean"
},
"helm-values.app.runtimeConfiguration.issuer": {
Expand Down Expand Up @@ -457,7 +457,7 @@
},
"helm-values.app.server.caTrustedNodeAccounts": {
"default": "",
"description": "A comma-separated list of service accounts that are allowed to use node authentication for CSRs, eg. \"istio-system/ztunnel\"",
"description": "A comma-separated list of service accounts that are allowed to use node authentication for CSRs, eg. \"istio-system/ztunnel\".",
"type": "string"
},
"helm-values.app.server.clusterID": {
Expand All @@ -467,7 +467,7 @@
},
"helm-values.app.server.maxCertificateDuration": {
"default": "1h",
"description": "Maximum validity duration that can be requested for a certificate. istio-csr will request a duration of the smaller of this value, and that of the incoming gRPC CSR.\nBased on NIST 800-204A recommendations (SM-DR13).\nhttps://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf",
"description": "Maximum validity duration that can be requested for a certificate. istio-csr will request a duration of the smaller of this value, and that of the incoming gRPC CSR. Based on [NIST 800-204A recommendations (SM-DR13)](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf).",
"type": "string"
},
"helm-values.app.server.serving": {
Expand Down Expand Up @@ -556,7 +556,7 @@
},
"helm-values.app.tls.certificateDuration": {
"default": "1h",
"description": "Requested duration of gRPC serving certificate. Will be automatically renewed.\nBased on NIST 800-204A recommendations (SM-DR13).\nhttps://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf",
"description": "Requested duration of gRPC serving certificate. Will be automatically renewed. Based on [NIST 800-204A recommendations (SM-DR13)](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf).",
"type": "string"
},
"helm-values.app.tls.istiodAdditionalDNSNames": {
Expand All @@ -567,7 +567,7 @@
},
"helm-values.app.tls.istiodCertificateDuration": {
"default": "1h",
"description": "Requested duration of istio's Certificate. Will be automatically renewed. Default is based on NIST 800-204A recommendations (SM-DR13). https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf. Warning: cert-manager does not allow a duration on Certificates less than 1 hour.",
"description": "Requested duration of istio's Certificate. Will be automatically renewed. Default is based on [NIST 800-204A recommendations (SM-DR13)](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-204A.pdf). Warning: cert-manager does not allow a duration on Certificates less than 1 hour.",
"type": "string"
},
"helm-values.app.tls.istiodCertificateEnable": {
Expand Down Expand Up @@ -599,7 +599,7 @@
},
"helm-values.commonLabels": {
"default": {},
"description": "Labels to apply to all resources",
"description": "Labels to apply to all resources.",
"type": "object"
},
"helm-values.deploymentAnnotations": {
Expand All @@ -614,7 +614,7 @@
},
"helm-values.extraObjects": {
"default": [],
"description": "Create resources alongside installing istio-csr, via Helm values. Can accept an array of YAML-formatted resources. Each array entry can include multiple YAML documents, separated by '---'\n\nFor example:\nextraObjects:\n - |\n apiVersion: v1\n kind: ConfigMap\n metadata:\n name: '{{ template \"cert-manager-istio-csr.fullname\" . }}-extra-configmap'",
"description": "Create resources alongside installing istio-csr, via Helm values. Can accept an array of YAML-formatted resources. Each array entry can include multiple YAML documents, separated by '---'.\n\nFor example:\nextraObjects:\n - |\n apiVersion: v1\n kind: ConfigMap\n metadata:\n name: '{{ template \"cert-manager-istio-csr.fullname\" . }}-extra-configmap'",
"items": {},
"type": "array"
},
Expand Down Expand Up @@ -698,7 +698,7 @@
},
"helm-values.resources": {
"default": {},
"description": "Kubernetes pod resources\nref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n\nFor example:\nresources:\n limits:\n cpu: 100m\n memory: 128Mi\n requests:\n cpu: 100m\n memory: 128Mi",
"description": "Kubernetes [pod resources](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/).\n\nFor example:\nresources:\n limits:\n cpu: 100m\n memory: 128Mi\n requests:\n cpu: 100m\n memory: 128Mi",
"type": "object"
},
"helm-values.securityContext": {
Expand Down Expand Up @@ -781,7 +781,7 @@
},
"helm-values.tolerations": {
"default": [],
"description": "Expects input structure as per specification https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#toleration-v1-core\n\nFor example:\ntolerations:\n- key: foo.bar.com/role\n operator: Equal\n value: master\n effect: NoSchedule",
"description": "Expects input structure as per [specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#toleration-v1-core).\n\nFor example:\ntolerations:\n- key: foo.bar.com/role\n operator: Equal\n value: master\n effect: NoSchedule",
"items": {},
"type": "array"
},
Expand All @@ -793,13 +793,13 @@
},
"helm-values.volumeMounts": {
"default": [],
"description": "Optional extra volume mounts. Useful for mounting custom root CAs\n\nFor example:\nvolumeMounts:\n- name: root-ca\n mountPath: /etc/tls",
"description": "Optional extra volume mounts. Useful for mounting custom root CAs.\n\nFor example:\nvolumeMounts:\n- name: root-ca\n mountPath: /etc/tls",
"items": {},
"type": "array"
},
"helm-values.volumes": {
"default": [],
"description": "Optional extra volumes. Useful for mounting custom root CAs\n\nFor example:\nvolumes:\n- name: root-ca\n secret:\n secretName: root-cert",
"description": "Optional extra volumes. Useful for mounting custom root CAs.\n\nFor example:\nvolumes:\n- name: root-ca\n secret:\n secretName: root-cert",
"items": {},
"type": "array"
}
Expand Down
Loading

0 comments on commit c724008

Please sign in to comment.