Deprecate use of "master" in resource labels and names #1139
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
zubron
commented
Jul 7, 2020
| @@ -177,15 +178,15 @@ kind: Service | |||
| metadata: | |||
| labels: | |||
| component: sonobuoy | |||
| run: sonobuoy-master | |||
| name: sonobuoy-master | |||
| sonobuoy-component: aggregator | |||
There was a problem hiding this comment.
The aggregator service is not queried within the Sonobuoy codebase so this label could be updated without impact.
We renamed the `master` command to `aggregator` in vmware-tanzu#847 (released in v0.15.3). However, `master` was still being used in some of our Kubernetes resource labels and names. We want to remove uses of insensitive language and as such use different labels for identifying resources. Now, any aggregator resources will have the label `sonobuoy-component: aggregator` and plugin resources will have `sonobuoy-component: plugin`. The existing label is still in place as it was used to identify the aggregator pod (which is required most sonobuoy commands once a run has started). Removing it now would prevent users with older clients from using newer images, or querying the state of runs started by newer clients. Instead, both labels will be applied howeve the `sonobuoy-component: aggregator` label is the preferred label. If the aggregator pod cannot be found using the new label, the client will retry using the now deprecated label. When retrying, the client will display a warning that it is attempting to find the pod using the deprecated label. Newer clients will be able to query the state of runs with old labels applied, and older clients will be able to query the state of runs created by the newer clients. The name of the service created by Sonobuoy has been renamed to `sonobuoy-aggregator`. This has no user facing impact. Signed-off-by: Bridget McErlean <[email protected]>
zubron
force-pushed
the
deprecate-master-label
branch
from
48b00e2 to
d7f1f4f
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.
What this PR does / why we need it:
We renamed the
mastercommand toaggregatorin #847 (released inv0.15.3). However,
masterwas still being used in some of ourKubernetes resource labels and names. We want to remove usage of
insensitive language and as such use different labels for
identifying resources.
Now, any aggregator resources will have the label
sonobuoy-component: aggregatorand plugin resources will havesonobuoy-component: plugin. The existing label is still in place as itwas used to identify the aggregator pod (which is required most sonobuoy
commands once a run has started). Removing it now would prevent users
with older clients from using newer images, or querying the state of
runs started by newer clients. Instead, both labels will be applied
howeve the
sonobuoy-component: aggregatorlabel is the preferredlabel. If the aggregator pod cannot be found using the new label, the
client will retry using the now deprecated label. When retrying, the
client will display a warning that it is attempting to find the pod
using the deprecated label.
Newer clients will be able to query the state of runs with old labels
applied, and older clients will be able to query the state of runs
created by the newer clients.
The name of the service created by Sonobuoy has been renamed to
sonobuoy-aggregator. This has no user facing impact.Signed-off-by: Bridget McErlean [email protected]
Release note: