Skip to content

Commit

Permalink
found a couple of small docs updates we could make (#1919)
Browse files Browse the repository at this point in the history
Signed-off-by: Joe Fuller <[email protected]>
  • Loading branch information
joedrf authored Feb 3, 2025
1 parent 42ff474 commit 437bdd3
Show file tree
Hide file tree
Showing 18 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion linkerd.io/content/2-edge/reference/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ instead of their original destination. This will inform Linkerd to override the
endpoint selection of the ingress container and to perform its own endpoint
selection, enabling features such as per-route metrics and traffic splitting.

The proxy can be made to run in `ingress` mode by using the `linkerd.io/inject:
The proxy can be configured to run in `ingress` mode by using the `linkerd.io/inject:
ingress` annotation rather than the default `linkerd.io/inject: enabled`
annotation. This can also be done with the `--ingress` flag in the `inject` CLI
command:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.10/reference/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ instead of their original destination. This will inform Linkerd to override the
endpoint selection of the ingress container and to perform its own endpoint
selection, enabling features such as per-route metrics and traffic splitting.

The proxy can be made to run in `ingress` mode by used the `linkerd.io/inject:
The proxy can be configured to run in `ingress` mode by used the `linkerd.io/inject:
ingress` annotation rather than the default `linkerd.io/inject: enabled`
annotation. This can also be done with the `--ingress` flag in the `inject` CLI
command:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.11/reference/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ instead of their original destination. This will inform Linkerd to override the
endpoint selection of the ingress container and to perform its own endpoint
selection, enabling features such as per-route metrics and traffic splitting.

The proxy can be made to run in `ingress` mode by used the `linkerd.io/inject:
The proxy can be configured to run in `ingress` mode by used the `linkerd.io/inject:
ingress` annotation rather than the default `linkerd.io/inject: enabled`
annotation. This can also be done with the `--ingress` flag in the `inject` CLI
command:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.12/reference/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ instead of their original destination. This will inform Linkerd to override the
endpoint selection of the ingress container and to perform its own endpoint
selection, enabling features such as per-route metrics and traffic splitting.

The proxy can be made to run in `ingress` mode by using the `linkerd.io/inject:
The proxy can be configured to run in `ingress` mode by using the `linkerd.io/inject:
ingress` annotation rather than the default `linkerd.io/inject: enabled`
annotation. This can also be done with the `--ingress` flag in the `inject` CLI
command:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.13/reference/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ instead of their original destination. This will inform Linkerd to override the
endpoint selection of the ingress container and to perform its own endpoint
selection, enabling features such as per-route metrics and traffic splitting.

The proxy can be made to run in `ingress` mode by using the `linkerd.io/inject:
The proxy can be configured to run in `ingress` mode by using the `linkerd.io/inject:
ingress` annotation rather than the default `linkerd.io/inject: enabled`
annotation. This can also be done with the `--ingress` flag in the `inject` CLI
command:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.14/reference/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ instead of their original destination. This will inform Linkerd to override the
endpoint selection of the ingress container and to perform its own endpoint
selection, enabling features such as per-route metrics and traffic splitting.

The proxy can be made to run in `ingress` mode by using the `linkerd.io/inject:
The proxy can be configured to run in `ingress` mode by using the `linkerd.io/inject:
ingress` annotation rather than the default `linkerd.io/inject: enabled`
annotation. This can also be done with the `--ingress` flag in the `inject` CLI
command:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.15/reference/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ instead of their original destination. This will inform Linkerd to override the
endpoint selection of the ingress container and to perform its own endpoint
selection, enabling features such as per-route metrics and traffic splitting.

The proxy can be made to run in `ingress` mode by using the `linkerd.io/inject:
The proxy can be configured to run in `ingress` mode by using the `linkerd.io/inject:
ingress` annotation rather than the default `linkerd.io/inject: enabled`
annotation. This can also be done with the `--ingress` flag in the `inject` CLI
command:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.16/reference/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ instead of their original destination. This will inform Linkerd to override the
endpoint selection of the ingress container and to perform its own endpoint
selection, enabling features such as per-route metrics and traffic splitting.

The proxy can be made to run in `ingress` mode by using the `linkerd.io/inject:
The proxy can be configured to run in `ingress` mode by using the `linkerd.io/inject:
ingress` annotation rather than the default `linkerd.io/inject: enabled`
annotation. This can also be done with the `--ingress` flag in the `inject` CLI
command:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.17/reference/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ instead of their original destination. This will inform Linkerd to override the
endpoint selection of the ingress container and to perform its own endpoint
selection, enabling features such as per-route metrics and traffic splitting.

The proxy can be made to run in `ingress` mode by using the `linkerd.io/inject:
The proxy can be configured to run in `ingress` mode by using the `linkerd.io/inject:
ingress` annotation rather than the default `linkerd.io/inject: enabled`
annotation. This can also be done with the `--ingress` flag in the `inject` CLI
command:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/data/cli/2-10.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ AnnotationsReference:
- Description: Used to configure the outbound TCP connection timeout in the proxy
Name: config.linkerd.io/proxy-outbound-connect-timeout
- Description: The proxy sidecar will stay alive for at least the given period before
receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`.
receiving SIGTERM signal from Kubernetes but no longer than the pod's `terminationGracePeriodSeconds`.
If not provided, it will be defaulted to `0`
Name: config.alpha.linkerd.io/proxy-wait-before-exit-seconds
CLIReference:
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/data/cli/2-11.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ AnnotationsReference:
- Description: Used to configure the outbound TCP connection timeout in the proxy
Name: config.linkerd.io/proxy-outbound-connect-timeout
- Description: The proxy sidecar will stay alive for at least the given period before
receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`.
receiving SIGTERM signal from Kubernetes but no longer than the pod's `terminationGracePeriodSeconds`.
If not provided, it will be defaulted to `0`
Name: config.alpha.linkerd.io/proxy-wait-before-exit-seconds
- Description: The application container will not start until the proxy is ready;
Expand Down
4 changes: 2 additions & 2 deletions linkerd.io/data/cli/2-12.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ AnnotationsReference:
- Description: Log format (plain or json) for the proxy
Name: config.linkerd.io/proxy-log-format
- Description: Enables HTTP access logging in the proxy. Accepted values are `apache`,
to output the access log in the Appache Common Log Format, and `json`, to output
to output the access log in the Apache Common Log Format, and `json`, to output
the access log in JSON.
Name: config.linkerd.io/access-log
- Description: Enable service profiles for non-Kubernetes services
Expand All @@ -76,7 +76,7 @@ AnnotationsReference:
- Description: Inbound TCP connection timeout in the proxy
Name: config.linkerd.io/proxy-inbound-connect-timeout
- Description: The proxy sidecar will stay alive for at least the given period after
receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`.
receiving SIGTERM signal from Kubernetes but no longer than the pod's `terminationGracePeriodSeconds`.
Defaults to `0`
Name: config.alpha.linkerd.io/proxy-wait-before-exit-seconds
- Description: The application container will not start until the proxy is ready;
Expand Down
4 changes: 2 additions & 2 deletions linkerd.io/data/cli/2-13.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ AnnotationsReference:
- Description: Log format (plain or json) for the proxy
Name: config.linkerd.io/proxy-log-format
- Description: Enables HTTP access logging in the proxy. Accepted values are `apache`,
to output the access log in the Appache Common Log Format, and `json`, to output
to output the access log in the Apache Common Log Format, and `json`, to output
the access log in JSON.
Name: config.linkerd.io/access-log
- Description: Enable service profiles for non-Kubernetes services
Expand All @@ -82,7 +82,7 @@ AnnotationsReference:
from the cache. Defaults to `90s`
Name: config.linkerd.io/proxy-inbound-discovery-cache-unused-timeout
- Description: The proxy sidecar will stay alive for at least the given period after
receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`.
receiving SIGTERM signal from Kubernetes but no longer than the pod's `terminationGracePeriodSeconds`.
Defaults to `0`
Name: config.alpha.linkerd.io/proxy-wait-before-exit-seconds
- Description: The application container will not start until the proxy is ready;
Expand Down
4 changes: 2 additions & 2 deletions linkerd.io/data/cli/2-14.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ AnnotationsReference:
- Description: Log format (plain or json) for the proxy
Name: config.linkerd.io/proxy-log-format
- Description: Enables HTTP access logging in the proxy. Accepted values are `apache`,
to output the access log in the Appache Common Log Format, and `json`, to output
to output the access log in the Apache Common Log Format, and `json`, to output
the access log in JSON.
Name: config.linkerd.io/access-log
- Description: Enable service profiles for non-Kubernetes services
Expand Down Expand Up @@ -88,7 +88,7 @@ AnnotationsReference:
side of the proxy by setting it to a very high value
Name: config.linkerd.io/proxy-disable-inbound-protocol-detect-timeout
- Description: The proxy sidecar will stay alive for at least the given period after
receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`.
receiving SIGTERM signal from Kubernetes but no longer than the pod's `terminationGracePeriodSeconds`.
Defaults to `0`
Name: config.alpha.linkerd.io/proxy-wait-before-exit-seconds
- Description: The application container will not start until the proxy is ready;
Expand Down
4 changes: 2 additions & 2 deletions linkerd.io/data/cli/2-15.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ AnnotationsReference:
- Description: Log format (plain or json) for the proxy
Name: config.linkerd.io/proxy-log-format
- Description: Enables HTTP access logging in the proxy. Accepted values are `apache`,
to output the access log in the Appache Common Log Format, and `json`, to output
to output the access log in the Apache Common Log Format, and `json`, to output
the access log in JSON.
Name: config.linkerd.io/access-log
- Description: Enable service profiles for non-Kubernetes services
Expand Down Expand Up @@ -88,7 +88,7 @@ AnnotationsReference:
side of the proxy by setting it to a very high value
Name: config.linkerd.io/proxy-disable-inbound-protocol-detect-timeout
- Description: The proxy sidecar will stay alive for at least the given period after
receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`.
receiving SIGTERM signal from Kubernetes but no longer than the pod's `terminationGracePeriodSeconds`.
Defaults to `0`
Name: config.alpha.linkerd.io/proxy-wait-before-exit-seconds
- Description: The application container will not start until the proxy is ready;
Expand Down
4 changes: 2 additions & 2 deletions linkerd.io/data/cli/2-16.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ AnnotationsReference:
- Description: Log format (plain or json) for the proxy
Name: config.linkerd.io/proxy-log-format
- Description: Enables HTTP access logging in the proxy. Accepted values are `apache`,
to output the access log in the Appache Common Log Format, and `json`, to output
to output the access log in the Apache Common Log Format, and `json`, to output
the access log in JSON.
Name: config.linkerd.io/access-log
- Description: Enable service profiles for non-Kubernetes services
Expand Down Expand Up @@ -91,7 +91,7 @@ AnnotationsReference:
side of the proxy by setting it to a very high value
Name: config.linkerd.io/proxy-disable-inbound-protocol-detect-timeout
- Description: The proxy sidecar will stay alive for at least the given period after
receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`.
receiving SIGTERM signal from Kubernetes but no longer than the pod's `terminationGracePeriodSeconds`.
Defaults to `0`
Name: config.alpha.linkerd.io/proxy-wait-before-exit-seconds
- Description: The application container will not start until the proxy is ready;
Expand Down
4 changes: 2 additions & 2 deletions linkerd.io/data/cli/2-17.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ AnnotationsReference:
- Description: Log format (plain or json) for the proxy
Name: config.linkerd.io/proxy-log-format
- Description: Enables HTTP access logging in the proxy. Accepted values are `apache`,
to output the access log in the Appache Common Log Format, and `json`, to output
to output the access log in the Apache Common Log Format, and `json`, to output
the access log in JSON.
Name: config.linkerd.io/access-log
- Description: Enable service profiles for non-Kubernetes services
Expand Down Expand Up @@ -91,7 +91,7 @@ AnnotationsReference:
side of the proxy by setting it to a very high value
Name: config.linkerd.io/proxy-disable-inbound-protocol-detect-timeout
- Description: The proxy sidecar will stay alive for at least the given period after
receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`.
receiving SIGTERM signal from Kubernetes but no longer than the pod's `terminationGracePeriodSeconds`.
Defaults to `0`
Name: config.alpha.linkerd.io/proxy-wait-before-exit-seconds
- Description: The application container will not start until the proxy is ready;
Expand Down
4 changes: 2 additions & 2 deletions linkerd.io/data/cli/2-edge.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ AnnotationsReference:
- Description: Log format (plain or json) for the proxy
Name: config.linkerd.io/proxy-log-format
- Description: Enables HTTP access logging in the proxy. Accepted values are `apache`,
to output the access log in the Appache Common Log Format, and `json`, to output
to output the access log in the Apache Common Log Format, and `json`, to output
the access log in JSON.
Name: config.linkerd.io/access-log
- Description: Enable service profiles for non-Kubernetes services
Expand Down Expand Up @@ -88,7 +88,7 @@ AnnotationsReference:
side of the proxy by setting it to a very high value
Name: config.linkerd.io/proxy-disable-inbound-protocol-detect-timeout
- Description: The proxy sidecar will stay alive for at least the given period after
receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`.
receiving SIGTERM signal from Kubernetes but no longer than the pod's `terminationGracePeriodSeconds`.
Defaults to `0`
Name: config.alpha.linkerd.io/proxy-wait-before-exit-seconds
- Description: The application container will not start until the proxy is ready;
Expand Down

0 comments on commit 437bdd3

Please sign in to comment.