Skip to content

Commit 6ab0fdd

Browse files
authored
docs: 📚 fix comment grammar in values
1 parent 3093fc0 commit 6ab0fdd

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

‎traefik/VALUES.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Kubernetes: `>=1.22.0-0`
3737
| autoscaling.maxReplicas | string | `nil` | maxReplicas is the upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. |
3838
| autoscaling.metrics | list | `[]` | metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). |
3939
| autoscaling.minReplicas | string | `nil` | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. |
40-
| autoscaling.scaleTargetRef | object | `{"apiVersion":"apps/v1","kind":"Deployment","name":"{{ template \"traefik.fullname\" . }}"}` | scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. |
40+
| autoscaling.scaleTargetRef | object | `{"apiVersion":"apps/v1","kind":"Deployment","name":"{{ template \"traefik.fullname\" . }}"}` | scaleTargetRef points to the target resource to scale, and is used for the pods for which metrics should be collected, as well as to actually change the replica count. |
4141
| certificatesResolvers | object | `{}` | Certificates resolvers configuration. Ref: https://doc.traefik.io/traefik/https/acme/#certificate-resolvers See EXAMPLES.md for more details. |
4242
| commonLabels | object | `{}` | Add additional label to all resources |
4343
| core.defaultRuleSyntax | string | `""` | Can be used to use globally v2 router syntax. Deprecated since v3.4 /!\. See https://doc.traefik.io/traefik/v3.0/migration/v2-to-v3/#new-v3-syntax-notable-changes |
@@ -130,7 +130,7 @@ Kubernetes: `>=1.22.0-0`
130130
| hub.providers.consulCatalogEnterprise.namespaces | string | `""` | Sets the namespaces used to discover services (Consul Enterprise only). |
131131
| hub.providers.consulCatalogEnterprise.partition | string | `""` | Sets the partition used to discover services (Consul Enterprise only). |
132132
| hub.providers.consulCatalogEnterprise.prefix | string | `"traefik"` | Prefix for consul service tags. |
133-
| hub.providers.consulCatalogEnterprise.refreshInterval | int | `15` | Interval for check Consul API. |
133+
| hub.providers.consulCatalogEnterprise.refreshInterval | int | `15` | Interval for checking Consul API. |
134134
| hub.providers.consulCatalogEnterprise.requireConsistent | bool | `false` | Forces the read to be fully consistent. |
135135
| hub.providers.consulCatalogEnterprise.serviceName | string | `"traefik"` | Name of the Traefik service in Consul Catalog (needs to be registered via the |
136136
| hub.providers.consulCatalogEnterprise.stale | bool | `false` | Use stale consistency for catalog reads. |
@@ -190,7 +190,7 @@ Kubernetes: `>=1.22.0-0`
190190
| ingressRoute.healthcheck.middlewares | list | `[]` | Additional ingressRoute middlewares (e.g. for authentication) |
191191
| ingressRoute.healthcheck.services | list | `[{"kind":"TraefikService","name":"ping@internal"}]` | The internal service used for the healthcheck ingressRoute |
192192
| ingressRoute.healthcheck.tls | object | `{}` | TLS options (e.g. secret containing certificate) |
193-
| instanceLabelOverride | string | `""` | This field override the default app.kubernetes.io/instance label for all Objects. |
193+
| instanceLabelOverride | string | `""` | This field overrides the default app.kubernetes.io/instance label for all Objects. |
194194
| livenessProbe.failureThreshold | int | `3` | The number of consecutive failures allowed before considering the probe as failed. |
195195
| livenessProbe.initialDelaySeconds | int | `2` | The number of seconds to wait before starting the first probe. |
196196
| livenessProbe.periodSeconds | int | `10` | The number of seconds to wait between consecutive probes. |
@@ -299,7 +299,7 @@ Kubernetes: `>=1.22.0-0`
299299
| metrics.prometheus.serviceMonitor.namespaceSelector | object | `{}` | |
300300
| metrics.prometheus.serviceMonitor.relabelings | list | `[]` | |
301301
| metrics.prometheus.serviceMonitor.scrapeTimeout | string | `""` | |
302-
| namespaceOverride | string | `""` | This field override the default Release Namespace for Helm. It will not affect optional CRDs such as `ServiceMonitor` and `PrometheusRules` |
302+
| namespaceOverride | string | `""` | This field overrides the default Release Namespace for Helm. It will not affect optional CRDs such as `ServiceMonitor` and `PrometheusRules` |
303303
| nodeSelector | object | `{}` | nodeSelector is the simplest recommended form of node selection constraint. |
304304
| oci_meta | object | `{"enabled":false,"images":{"hub":{"image":"traefik-hub","tag":"latest"},"proxy":{"image":"traefik","tag":"latest"}},"repo":"traefik"}` | Required for OCI Marketplace integration. See https://docs.public.content.oci.oraclecloud.com/en-us/iaas/Content/Marketplace/understanding-helm-charts.htm |
305305
| oci_meta.enabled | bool | `false` | Enable specific values for Oracle Cloud Infrastructure |
@@ -381,7 +381,7 @@ Kubernetes: `>=1.22.0-0`
381381
| providers.file.enabled | bool | `false` | Create a file provider |
382382
| providers.file.watch | bool | `true` | Allows Traefik to automatically watch for file changes |
383383
| providers.kubernetesCRD.allowCrossNamespace | bool | `false` | Allows IngressRoute to reference resources in namespace other than theirs |
384-
| providers.kubernetesCRD.allowEmptyServices | bool | `true` | Allows to return 503 when there is no endpoints available |
384+
| providers.kubernetesCRD.allowEmptyServices | bool | `true` | Allows to return 503 when there are no endpoints available |
385385
| providers.kubernetesCRD.allowExternalNameServices | bool | `false` | Allows to reference ExternalName services in IngressRoute |
386386
| providers.kubernetesCRD.enabled | bool | `true` | Load Kubernetes IngressRoute provider |
387387
| providers.kubernetesCRD.ingressClass | string | `""` | When the parameter is set, only resources containing an annotation with the same value are processed. Otherwise, resources missing the annotation, having an empty value, or the value traefik are processed. It will also set required annotation on Dashboard and Healthcheck IngressRoute when enabled. |
@@ -395,7 +395,7 @@ Kubernetes: `>=1.22.0-0`
395395
| providers.kubernetesGateway.statusAddress.hostname | string | `""` | This Hostname will get copied to the Gateway status.addresses. |
396396
| providers.kubernetesGateway.statusAddress.ip | string | `""` | This IP will get copied to the Gateway status.addresses, and currently only supports one IP value (IPv4 or IPv6). |
397397
| providers.kubernetesGateway.statusAddress.service | object | `{"enabled":true,"name":"","namespace":""}` | The Kubernetes service to copy status addresses from. When using third parties tools like External-DNS, this option can be used to copy the service loadbalancer.status (containing the service's endpoints IPs) to the gateways. Default to Service of this Chart. |
398-
| providers.kubernetesIngress.allowEmptyServices | bool | `true` | Allows to return 503 when there is no endpoints available |
398+
| providers.kubernetesIngress.allowEmptyServices | bool | `true` | Allows to return 503 when there are no endpoints available |
399399
| providers.kubernetesIngress.allowExternalNameServices | bool | `false` | Allows to reference ExternalName services in Ingress |
400400
| providers.kubernetesIngress.enabled | bool | `true` | Load Kubernetes Ingress provider |
401401
| providers.kubernetesIngress.ingressClass | string | `nil` | When ingressClass is set, only Ingresses containing an annotation with the same value are processed. Otherwise, Ingresses missing the annotation, having an empty value, or the value traefik are processed. |
@@ -456,7 +456,7 @@ Kubernetes: `>=1.22.0-0`
456456
| updateStrategy.rollingUpdate.maxSurge | int | `1` | |
457457
| updateStrategy.rollingUpdate.maxUnavailable | int | `0` | |
458458
| updateStrategy.type | string | `"RollingUpdate"` | Customize updateStrategy of Deployment or DaemonSet |
459-
| versionOverride | string | `""` | This field override the default version extracted from image.tag |
459+
| versionOverride | string | `""` | This field overrides the default version extracted from image.tag |
460460
| volumes | list | `[]` | Add volumes to the traefik pod. The volume name will be passed to tpl. This can be used to mount a cert pair or a configmap that holds a config.toml file. After the volume has been mounted, add the configs into traefik by using the `additionalArguments` list below, eg: `additionalArguments: - "--providers.file.filename=/config/dynamic.toml" - "--ping" - "--ping.entrypoint=web"` |
461461

462462
----------------------------------------------

‎traefik/values.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ providers: # @schema additionalProperties: false
281281
allowCrossNamespace: false
282282
# -- Allows to reference ExternalName services in IngressRoute
283283
allowExternalNameServices: false
284-
# -- Allows to return 503 when there is no endpoints available
284+
# -- Allows to return 503 when there are no endpoints available
285285
allowEmptyServices: true
286286
# -- When the parameter is set, only resources containing an annotation with the same value are processed. Otherwise, resources missing the annotation, having an empty value, or the value traefik are processed. It will also set required annotation on Dashboard and Healthcheck IngressRoute when enabled.
287287
ingressClass: ""
@@ -296,7 +296,7 @@ providers: # @schema additionalProperties: false
296296
enabled: true
297297
# -- Allows to reference ExternalName services in Ingress
298298
allowExternalNameServices: false
299-
# -- Allows to return 503 when there is no endpoints available
299+
# -- Allows to return 503 when there are no endpoints available
300300
allowEmptyServices: true
301301
# -- When ingressClass is set, only Ingresses containing an annotation with the same value are processed. Otherwise, Ingresses missing the annotation, having an empty value, or the value traefik are processed.
302302
ingressClass: # @schema type:[string, null]
@@ -982,7 +982,7 @@ autoscaling: # @schema additionalProperties: false
982982
metrics: []
983983
# -- behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).
984984
behavior: {}
985-
# -- scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
985+
# -- scaleTargetRef points to the target resource to scale, and is used for the pods for which metrics should be collected, as well as to actually change the replica count.
986986
scaleTargetRef:
987987
apiVersion: apps/v1
988988
kind: Deployment
@@ -1100,14 +1100,14 @@ podSecurityContext:
11001100
# See #595 for more details and traefik/tests/values/extra.yaml for example.
11011101
extraObjects: []
11021102

1103-
# -- This field override the default Release Namespace for Helm.
1103+
# -- This field overrides the default Release Namespace for Helm.
11041104
# It will not affect optional CRDs such as `ServiceMonitor` and `PrometheusRules`
11051105
namespaceOverride: ""
11061106

1107-
# -- This field override the default app.kubernetes.io/instance label for all Objects.
1107+
# -- This field overrides the default app.kubernetes.io/instance label for all Objects.
11081108
instanceLabelOverride: ""
11091109

1110-
# -- This field override the default version extracted from image.tag
1110+
# -- This field overrides the default version extracted from image.tag
11111111
versionOverride: ""
11121112

11131113
# Traefik Hub configuration. See https://doc.traefik.io/traefik-hub/
@@ -1197,7 +1197,7 @@ hub:
11971197
partition: ""
11981198
# -- Prefix for consul service tags.
11991199
prefix: "traefik"
1200-
# -- Interval for check Consul API.
1200+
# -- Interval for checking Consul API.
12011201
refreshInterval: 15
12021202
# -- Forces the read to be fully consistent.
12031203
requireConsistent: false
@@ -1265,7 +1265,7 @@ hub:
12651265
key: ""
12661266
# -- When insecureSkipVerify is set to true, the TLS connection accepts any certificate presented by the server. Default: false.
12671267
insecureSkipVerify: false
1268-
# Enable export of errors logs to the platform. Default: true.
1268+
# Enable export of error logs to the platform. Default: true.
12691269
sendlogs: # @schema type:[boolean, null]
12701270

12711271
tracing:

0 commit comments

Comments
 (0)