Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace MasterURL with AggregatorURL in WorkerConfig #1141

Merged

Conversation

zubron
Copy link
Contributor

@zubron zubron commented Jul 8, 2020

What this PR does / why we need it:
We renamed the master command to aggregator in #847 (released in
v0.15.3). However, we left some of the existing uses in place to prevent
backwards incompatibility. This change renames the MasterURL field in
WorkerConfig to AggregatorURL in keeping with our terminology
elsewhere. Worker containers are configured using environment variables.
This change renames the environment variable but also adds some
compatibility for the original environment variable to still be
processed.

It is possible for different image versions to be used for the
aggregator and the worker (although it would have to be explicitly set
in the generated manifest). This changes allows older versions of
Sonobuoy to be used as the aggregator image but does not allow older
versions to be used as the worker image. Although some compatibility is
broken, this seems acceptable as we don't recommend mixing versions of
images within a single sonobuoy run.

Signed-off-by: Bridget McErlean bmcerlean@vmware.com

Release note:

The `MasterURL` field of `WorkerConfig` has been renamed to `AggregatorURL`. The environment variable for setting that field when starting a worker container has been changed from `MASTER_URL` to `AGGREGATOR_URL`. This will break  compatibility between versions of Sonobuoy, however it will only affect users who manually edit the manifest produced by Sonobuoy to run different image versions for the aggregator and worker. Sonobuoy image version v0.18.3 and earlier can be used as the aggregator with workers that use image versions v0.18.4 and later. Sonobuoy image version v0.18.4 and later *cannot* be used as the aggregator image with workers that use image version v0.18.3 and earlier. We strongly recommend that you use the same version of the image for both the aggregator and the workers. From v0.19.0 onwards, and backwards compatibility between image versions will be dropped and using different image versions for the aggregator and worker will not be supported.

We renamed the `master` command to `aggregator` in vmware-tanzu#847 (released in
v0.15.3). However, we left some of the existing uses in place to prevent
backwards incompatibility. This change renames the `MasterURL` field in
`WorkerConfig` to `AggregatorURL` in keeping with our terminology
elsewhere. Worker containers are configured using environment variables.
This change renames the environment variable but also adds some
compatibility for the original environment variable to still be
processed.

It is possible for different image versions to be used for the
aggregator and the worker (although it would have to be explicitly set
in the generated manifest). This changes allows older versions of
Sonobuoy to be used as the aggregator image but does not allow older
versions to be used as the worker image. Although some compatibility is
broken, this seems acceptable as we don't recommend mixing versions of
images within a single sonobuoy run.

Signed-off-by: Bridget McErlean <bmcerlean@vmware.com>
@zubron zubron force-pushed the rename-master-to-aggregator-worker-config branch from cbab299 to f024f98 Compare July 8, 2020 19:25
@zubron zubron merged commit 392d68e into vmware-tanzu:master Jul 8, 2020
@zubron zubron deleted the rename-master-to-aggregator-worker-config branch July 8, 2020 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant