Only write service-defaults if protocol set #169
Merged
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
lkysow
commented
Nov 30, 2019
| // the protocol was empty. This is the same as setting it to tcp. This | ||
| // would then override any global proxy-defaults config. Now, we only | ||
| // write the config if a protocol is explicitly set. | ||
| writeServiceDefaults := h.WriteServiceDefaults && protocol != "" |
There was a problem hiding this comment.
Here's the only real change. Previously this was just the value of h.WriteServiceDefaults
lkysow
commented
Nov 30, 2019
| // Default protocol is specified by a flag if not explicitly annotated | ||
| if _, ok := pod.ObjectMeta.Annotations[annotationProtocol]; !ok { | ||
| if _, ok := pod.ObjectMeta.Annotations[annotationProtocol]; !ok && h.DefaultProtocol != "" { |
There was a problem hiding this comment.
Previously we would write an annotation even if the protocol was empty (i.e. we'd set it to the empty string).
adilyse
approved these changes
Dec 4, 2019
connect-inject/container_init.go
Outdated
| {{- if .CentralConfig }} | ||
| # Create the central config's service registration | ||
| {{- if .WriteServiceDefaults }} | ||
| # Create the service-defaults config for the service | ||
| cat <<EOF >/consul/connect-inject/central-config.hcl |
There was a problem hiding this comment.
Since everything is being renamed to "service-defaults", does it make sense to rename the file be written as well? (This would need to be changed several places, as well as in the tests.)
Suggested change
| cat <<EOF >/consul/connect-inject/central-config.hcl | |
| cat <<EOF >/consul/connect-inject/service-defaults.hcl |
Previously, we would write a service-defaults config regardless of the value of the -default-protocol flag or the Pod's protocol annotation. If neither of these were set, we would write a config with protocol set to the empty string. This is the same as setting it to tcp. So for every service, we were by default setting its protocol to tcp. If a user explicitly created a global proxy-defaults config and set the protocol to, say, http. Then our service-defaults config would override that protocol. This behaviour was unexpected because users had never explicitly told us to write a service-defaults config and it wasn't helping them. This change will cause us to only write a service-defaults config if the protocol is explicitly set–either via the -default-protocol flag or via the Pod annotation. I've also renamed the CentralConfig field to WriteServiceDefaults because there are many types of central config now so it's best to be explicit. Fixes #168
lkysow
force-pushed
the
protocol-write
branch
2 times, most recently
from
9f22760 to
afb5808
Compare
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.
Previously, we would write a service-defaults config regardless of the
value of the -default-protocol flag or the Pod's protocol annotation. If
neither of these were set, we would write a config with protocol set to
the empty string. This is the same as setting it to tcp. So for every
service, we were by default setting its protocol to tcp.
If a user explicitly created a global proxy-defaults config and set the
protocol to, say, http. Then our service-defaults config would override
that protocol. This behaviour was unexpected because users had never
explicitly told us to write a service-defaults config and it wasn't
helping them.
This change will cause us to only write a service-defaults config if the
protocol is explicitly set–either via the -default-protocol flag or via
the Pod annotation.
I've also renamed the CentralConfig field to WriteServiceDefaults
because there are many types of central config now so it's best to be
explicit.
Fixes #168