feat!: Add config to disable proxy /shutdown admin endpoint #12705
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Alex Leong <[email protected]>
olix0r
changed the title
olix0r
requested changes
Jun 14, 2024
charts/linkerd2-cni/README.md
Outdated
| @@ -25,7 +25,7 @@ Kubernetes: `>=1.22.0-0` | |||
| | commonLabels | object | `{}` | Labels to apply to all resources | | |||
| | destCNIBinDir | string | `"/opt/cni/bin"` | Directory on the host where the CNI configuration will be placed | | |||
| | destCNINetDir | string | `"/etc/cni/net.d"` | Directory on the host where the CNI plugin binaries reside | | |||
| | disableIPv6 | bool | `false` | Disables adding IPv6 rules on top of IPv4 rules | | |||
There was a problem hiding this comment.
intentional? looks like you need a rebase
olix0r
reviewed
Jun 14, 2024
pkg/k8s/labels.go
Outdated
| @@ -209,6 +209,10 @@ const ( | |||
| // ProxyGIDAnnotation can be used to override the GID config. | |||
| ProxyGIDAnnotation = ProxyConfigAnnotationsPrefix + "/proxy-gid" | |||
|
|
|||
| // ProxyEnableShutdownEndpointAnnotation can be used to override the | |||
| // LINKERD2_PROXY_SHUTDOWN_ENDPOINT_ENABLED config. | |||
| ProxyEnableShutdownEndpointAnnotation = ProxyConfigAnnotationsPrefix + "/enable-shutdown-endpoint" | |||
There was a problem hiding this comment.
As discussed, I think we probably ought to use something like
Suggested change
| ProxyEnableShutdownEndpointAnnotation = ProxyConfigAnnotationsPrefix + "/enable-shutdown-endpoint" | |
| ProxyEnableShutdownEndpointAnnotation = ProxyConfigAnnotationsPrefix + "/proxy-admin-shutdown" |
with a value of 'enabled'.
truecauses YAML weirdness, since the value must be explicitly quoted to avoid type errors in annotations.enabledis properly handled a string value without quotes.- Consistent proxy- prefixes sort together and help express scoping/grouping.
Signed-off-by: Alex Leong <[email protected]>
olix0r
approved these changes
Jun 14, 2024
|
Why isn't this documented as a breaking change in the release notes, since we've changed a default value here? |
|
@KenVanGrinsven Ouch, thanks for pointing that out! I've edited the release notes to cover that, and will be updating the docs shortly. Sorry for the misstep, and thanks for pointing it out! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We add a
proxy.enableShutdownEndpointHelm value and correspondingconfig.linkerd.io/enableShutdownEndpointworkload annotation for configuring the proxy's/shutdownadmin endpoint. These configs work by setting theLINKERD2_PROXY_SHUTDOWN_ENDPOINT_ENABLEDenv var on the proxy.Depends on linkerd/linkerd2-proxy#3014