docs: name the host-scan variable requirement, including for down - #53
Merged
Merged
Conversation
`docker-compose.host-scan.yml` declares `BUMBLEBEE_HOST_DIR` as required, so any command that names that file aborts without it, `down` included. A reader who starts the stack with the documented snippet and then tries to stop it gets a Compose interpolation error with no obvious cause. Verified against a fresh clone: with the variable unset, `docker compose -f docker-compose.yml -f docker-compose.host-scan.yml down` fails with "required variable BUMBLEBEE_HOST_DIR is missing a value", while `docker compose up -d` and `docker compose exec backend ls /host` run without it because they name only the base file.
![codescene-access[bot]](https://avatars.githubusercontent.com/in/3755875?s=60&v=4){kind=small}
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
1 participant
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 host-scan override declares BUMBLEBEE_HOST_DIR as required, so every command that names that file aborts without it,
downincluded. A reader who starts the stack with the documented snippet and then tries to stop it gets a Compose interpolation error with no obvious cause.This adds three lines: the requirement, the exact stop command, and the note that commands naming only the base file are unaffected.
Verified against a fresh clone. With the variable unset,
docker compose -f docker-compose.yml -f docker-compose.host-scan.yml downfails with "required variable BUMBLEBEE_HOST_DIR is missing a value", whiledocker compose up -danddocker compose exec backend ls /hostrun without it because they name only the base file.