Bug 1693685

Summary:	Document Default Build History Limits
Product:	OpenShift Container Platform	Reporter:	Adam Kaplan <adam.kaplan>
Component:	Documentation	Assignee:	Latha S <lmurthy>
Status:	CLOSED WONTFIX	QA Contact:	Xiaoli Tian <xtian>
Severity:	medium	Docs Contact:	Latha S <lmurthy>
Priority:	unspecified
Version:	3.11.0	CC:	mmccomas
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2022-07-14 07:56:58 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Adam Kaplan 2019-03-28 13:30:28 UTC

Document URL: https://docs.openshift.com/container-platform/3.11/dev_guide/builds/advanced_build_operations.html#build-pruning

Section Number and Name: Builds/Advanced Build Operations/Build Pruning

Describe the issue: doc incorrectly states that completed builds are persisted indefinitely. In 3.11 and above only the 5 most recent builds for Completed and Failed are retained by default.

Suggestions for improvement: Update the 3.11 as follows -
"By default, the five most recent Completed builds and the five most recent Failed builds are retained."

The doc should also note that removing `successfulBuildsHistoryLimit` and/or `failedBuildsHistoryLimit` field in the BuildConfig spec will cause builds of the respective category to be retained indefinitely.

Additional information: DevEx will also need to update their API doc note in https://github.com/openshift/api/blob/release-3.11/build/v1/types.go#L904

Comment 1 Adam Kaplan 2019-03-29 13:49:23 UTC

OpenShift API PR: https://github.com/openshift/api/pull/271

Comment 2 Adam Kaplan 2019-05-08 21:48:39 UTC

@Vikram - please let me know if you want the API doc PR backported to 3.11.z