-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for build pruning #4536
Add documentation for build pruning #4536
Conversation
== Build Pruning | ||
|
||
By default, builds that have completed their lifecycle are persisted indefinitely. | ||
You can limit the number of previous builds that are kept around by supplying a positive |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/kept around/retained/
failedBuildsHistoryLimit: 2 <2> | ||
---- | ||
<1> `successfulBuildsHistoryLimit` will prune builds with a status of `completed` | ||
<2> `failedBuildsHistoryLimit` will prune builds with a status of `failed`, `cancelled`, or `error` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"will retain up to 2 builds with a status of completed"
"will retain up to 2 builds with a status of failed, cancelled, or error"
Build pruning is triggered by the following actions: | ||
|
||
- the build configuration is updated | ||
- a build completes it's lifecycle |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/it's/its/
@bparees updated |
successfulBuildsHistoryLimit: 2 <1> | ||
failedBuildsHistoryLimit: 2 <2> | ||
---- | ||
<1> `successfulBuildsHistoryLimit` will retain up to 2 builds with a status of `completed` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
somehow you put an extra space after the "2" :)
@bparees fixed |
please cross-link this new section and the existing build pruning section to each other: people reading about one technique will probably want to be aware of the existence of the other technique. |
@bparees updated |
lgtm. @openshift/team-documentation ptal/merge. |
LGTM |
[rev_history] |
@bmcelvee this doc appears to have found its way into 3.4/3.5: it should not have (the feature is 3.6+) |
@bparees sorry about that. It has now been removed: 3.4: https://docs.openshift.com/container-platform/3.4/dev_guide/builds/advanced_build_operations.html 3.5: https://docs.openshift.com/container-platform/3.5/dev_guide/builds/advanced_build_operations.html |
Provides supporting documentation for openshift/origin#13788 and openshift/origin#14375
@openshift/devex ptal