docs: add buildkitd.toml docs new gc options #5453
Merged
Conversation
This file contains 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
tonistiigi
reviewed
Oct 25, 2024
dvdksn
reviewed
Oct 28, 2024
There was a problem hiding this comment.
I think you could remove gckeepstorage and keepBytes. Users of an older version of BuildKit can refer to an earlier revision of the document in version control, e.g. https://github.com/moby/buildkit/blob/v0.16/docs/buildkitd.toml.md
docs/buildkitd.toml.md
Outdated
Comment on lines
15
to
20
| This config file has been updated, some options may not be available on older | ||
| buildkit versions: | ||
| - In v0.17.0, `reservedSpace`/`maxUsedSpace`/`minFreeSpace` properties were | ||
| added on `worker.oci` and `worker.containerd` as well as to their respective | ||
| `gcpolicy` properties. `gckeepbytes`/`keepBytes` have been deprecated as a | ||
| result. |
There was a problem hiding this comment.
If you want to keep this info here, I suggest adding a ## Changelog section or similar.
There was a problem hiding this comment.
Yah, removed the gckeepstorage and keepBytes docs - happy to point to older versions of the doc 🎉
jedevc
force-pushed
the
config-docs-for-new-gc-opts
branch
from
ffd2516
to
7e384ed
Compare
Signed-off-by: Justin Chadwell <[email protected]>
jedevc
force-pushed
the
config-docs-for-new-gc-opts
branch
from
7e384ed
to
055eabe
Compare
dvdksn
approved these changes
Oct 28, 2024
tonistiigi
approved these changes
Oct 28, 2024
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.
No description provided.