Repository navigation
docs(deployments): list the collector-omnibus tag for every channel - #1027
Merged
Merged
Conversation
The published channel tag table omitted `latest-collector-omnibus`,
`beta-collector-omnibus` and `develop-collector-omnibus`, although
`docker/image-matrix.json` carries `collector-omnibus` and docker-build.yaml
emits a `<channel>-${{ matrix.image }}` tag for each of its eight entries. The
omission matters because collector-omnibus is the image a hub/spoke deployment
runs, so a reader checking which tag to pull found every sibling collector
listed and not that one.
TROUBLESHOOTING_DOCKER.md named docker-build.yaml as the build orchestrator and
then listed only the two all-in-one tags per channel, which reads as the
complete set. It now points at the table rather than restating a partial list,
so the two files cannot drift apart again.
This file contains hidden or 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
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.
Summary
The published channel tag table listed every collector image except
collector-omnibus, for all three channels.docker/image-matrix.jsoncarries eight entries includingcollector-omnibus, anddocker-build.yamlemits a<channel>-${{ matrix.image }}tag for each of them, solatest-collector-omnibus,beta-collector-omnibusanddevelop-collector-omnibusall exist and none were documented.The omission matters more than the other seven would, because
collector-omnibusis the image a hub/spoke deployment runs. A reader picking a tag foundlatest-collector,latest-collector-zfsand the rest listed, and reasonably concluded the one they wanted was not published.Type of Change
Related Issues
Found while working on #1016, which was reverted by #1017. That revert restored this table to its prior content, and this is the correction the table actually needed.
Changes Made
docs/DEPLOYMENTS.md: addslatest-collector-omnibus,beta-collector-omnibusanddevelop-collector-omnibusto their channel rows, positioned after<channel>-collectorto match the order indocker/image-matrix.json.docs/TROUBLESHOOTING_DOCKER.md: that file namesdocker-build.yamlas the build orchestrator and then lists only the two all-in-one tags per channel, which reads as the complete set. It now links to the table instead of restating a partial list, so the two files cannot drift apart again.Testing
Separating what is verified from what is read off the workflow definition:
latest-collector-omnibusanddevelop-collector-omnibusboth resolve, andlatest-collector-omnibuswas confirmed pullable with a manifest listing amd64 and arm64.docker-build.yaml: thedocker/metadata-actionconfig emitsbeta-${{ matrix.image }}when the ref isrefs/heads/beta, which is what putsbeta-collector-omnibusin the beta row. I did not confirm that tag against the registry, because paging the package versions API did not reach the beta entries. The row describes what the workflow publishes for that channel, which is the same basis as every other entry in it.DEPLOYMENTS.md#published-channel-tagsmatches the existing## Published Channel Tagsheading.No code or workflow changes, so nothing here affects a build.
Checklist
Additional Notes
Review: not required (documentation only, no runtime or build effect).
Heads-up on CI:
Build darwin/amd64,Build darwin/arm64andBuild freebsd/amd64have been timing out in the queue without being assigned a runner, five times across yesterday's pull requests. They report as failures while recording zero steps. If they do it here, it is unrelated to a documentation change.