Repository navigation
Name the split worker services in documented compose commands - #593
Merged
Merged
Conversation
The guides still ran docker-compose commands against the removed `worker` service. Each now names worker-scan, worker-default (or both), or the dev stack's celery-worker, by the queue that runs the task in question. A new unit test checks every service a documented docker-compose command names against the compose file it targets, replacing the private-CA page's check.
Apply .env changes with `docker-compose up -d`, since restart keeps the old environment. Fix the Trivy verify and mirror commands, the cosign key helper hint (it runs on the host), the workspace du glob and the KO runbook anchors. The guard now reads per-subcommand options, --scale services, unknown -f files, .env.example and scripts/, and checks each locale separately.
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.
The EN and KO guides had 106
docker-composecommands (53 per locale) and 20 code-formatted service mentions naming theworkerservice, which the production compose no longer has. Each now names the service that runs the task. Scan diagnostics, workspace and Trivy DB inspection,trivycommands and the stuck-scan restart go toworker-scan. The one-shottrustedoss.trivy_db_refreshcall goes toworker-default. Logs for Trivy DB downloads and backups, which either default-queue consumer can run, name both. The dev getting-started command usescelery-worker, and the architecture table lists both workers and points to the engine profile.Commands on the rewritten lines that would still fail are fixed too. Compose reads
.envonly when it creates a container, so every "edit.env, then restart" instruction now usesdocker-compose up -d <services>. Other fixes: the Trivy verify step (--skip-updatecannot be combined with--download-db-only; it now runstrivy versionin the container),trivy image --download-db-only, theUpdatedAtmetadata field,-A tasks.celery_app, the mirror credential path under/home/trustedoss, a mirror login on each worker,duglobbing inside the container, and the KO runbook anchors. The cosign key helper is documented as a host script, because it is not in the image and/cosignis read-only; its hint inscripts/cosign-keygen.shand.env.examplechanged with it.tests/unit/test_docs_compose_service_names.pyparses everydocker-composecommand in the guides' code, the README,.env.exampleandscripts/. It resolves the compose file from-f, fails on a-ffile that is not in the repository, reads options per subcommand, and requires each named service (positional or in--scale/--exit-code-from) to exist. It replaces the narrower log-command check on the private-CA page. Reintroducing a stale name (KO inline code, an EN code block,--scaleandrun --rmin.env.example) or removing the KO private-CA log command each fails it for that reason, and it asserts command floors per locale.Closes #582