Skip to content

docs(deployments): list the collector-omnibus tag for every channel - #1027

Merged
Starosdev merged 1 commit into
developfrom
docs/channel-tags-collector-omnibus
Oct 21, 2026
Merged

Starosdev merged 1 commit into
developfrom
docs/channel-tags-collector-omnibus

Conversation

@Starosdev

Copy link
Copy Markdown
Owner

Summary

The published channel tag table listed every collector image except collector-omnibus, for all three channels. docker/image-matrix.json carries eight entries including collector-omnibus, and docker-build.yaml emits a <channel>-${{ matrix.image }} tag for each of them, so latest-collector-omnibus, beta-collector-omnibus and develop-collector-omnibus all exist and none were documented.

The omission matters more than the other seven would, because collector-omnibus is the image a hub/spoke deployment runs. A reader picking a tag found latest-collector, latest-collector-zfs and the rest listed, and reasonably concluded the one they wanted was not published.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring (no functional changes)
  • CI/CD or infrastructure 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: adds latest-collector-omnibus, beta-collector-omnibus and develop-collector-omnibus to their channel rows, positioned after <channel>-collector to match the order in docker/image-matrix.json.
  • docs/TROUBLESHOOTING_DOCKER.md: that file names docker-build.yaml as 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

  • I have tested this locally
  • I have added/updated tests that prove my fix/feature works
  • All existing tests pass

Separating what is verified from what is read off the workflow definition:

  • Verified in GHCR: latest-collector-omnibus and develop-collector-omnibus both resolve, and latest-collector-omnibus was confirmed pullable with a manifest listing amd64 and arm64.
  • Read from docker-build.yaml: the docker/metadata-action config emits beta-${{ matrix.image }} when the ref is refs/heads/beta, which is what puts beta-collector-omnibus in 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.
  • The link target DEPLOYMENTS.md#published-channel-tags matches the existing ## Published Channel Tags heading.

No code or workflow changes, so nothing here affects a build.

Checklist

  • My code follows the project's code style
  • I have performed a self-review of my code
  • I have commented my code where necessary (particularly complex areas)
  • I have updated the documentation if needed
  • My changes generate no new warnings
  • No console.log, debug statements, or commented-out code

Additional Notes

Review: not required (documentation only, no runtime or build effect).

Heads-up on CI: Build darwin/amd64, Build darwin/arm64 and Build freebsd/amd64 have 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.

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.
@Starosdev
Starosdev merged commit 53a405d into develop Oct 21, 2026
19 of 20 checks passed
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