Skip to content
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

Merged
merged 1 commit into from
Jun 6, 2017
Merged

Add documentation for build pruning #4536

merged 1 commit into from
Jun 6, 2017

Conversation

coreydaley
Copy link
Member

Provides supporting documentation for openshift/origin#13788 and openshift/origin#14375

@openshift/devex ptal

== 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
Copy link
Contributor

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`
Copy link
Contributor

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
Copy link
Contributor

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 bparees self-assigned this Jun 6, 2017
@coreydaley
Copy link
Member Author

@bparees updated

successfulBuildsHistoryLimit: 2 <1>
failedBuildsHistoryLimit: 2 <2>
----
<1> `successfulBuildsHistoryLimit` will retain up to 2 builds with a status of `completed`
Copy link
Contributor

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" :)

@coreydaley
Copy link
Member Author

@bparees fixed

@bparees
Copy link
Contributor

bparees commented Jun 6, 2017

please cross-link this new section and the existing build pruning section to each other:
https://docs.openshift.org/latest/admin_guide/pruning_resources.html#pruning-builds

people reading about one technique will probably want to be aware of the existence of the other technique.

@coreydaley
Copy link
Member Author

@bparees updated

@bparees
Copy link
Contributor

bparees commented Jun 6, 2017

lgtm. @openshift/team-documentation ptal/merge.

@bmcelvee bmcelvee self-assigned this Jun 6, 2017
@bmcelvee bmcelvee added this to the Next Release milestone Jun 6, 2017
@bmcelvee
Copy link
Contributor

bmcelvee commented Jun 6, 2017

LGTM

@bmcelvee bmcelvee merged commit 18432fb into openshift:master Jun 6, 2017
@bmcelvee
Copy link
Contributor

bmcelvee commented Jun 6, 2017

[rev_history]
|xref:../admin_guide/pruning_resources.adoc#admin-guide-pruning-resources[Pruning Objects]
|Added note to xref:../admin_guide/pruning_resources.adoc#pruning-builds[Pruning Builds] linking to the xref:../dev_guide/builds/advanced_build_operations.adoc#build-pruning[Build Pruning] section.
%
|xref:../dev_guide/builds/advanced_build_operations.adoc#dev-guide-advanced-build-operations[Advanced Build Operations]
|Added the xref:../dev_guide/builds/advanced_build_operations.adoc#build-pruning[Build Pruning] section.
%

@vikram-redhat vikram-redhat modified the milestones: Staging, Future Release, OCP 3.6 GA Aug 9, 2017
@vikram-redhat vikram-redhat modified the milestones: OCP 3.6 GA, Staging, TEMP Sep 7, 2017
@vikram-redhat vikram-redhat modified the milestones: OCP 3.6 GA, Staging, TEMP Sep 24, 2017
@bparees
Copy link
Contributor

bparees commented Nov 7, 2017

@bmcelvee this doc appears to have found its way into 3.4/3.5:
https://docs.openshift.com/container-platform/3.4/dev_guide/builds/advanced_build_operations.html#build-pruning

it should not have (the feature is 3.6+)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants