Bug 1475371 - [DOCS] Measurement units for the keep younger than variable for prune
Summary: [DOCS] Measurement units for the keep younger than variable for prune
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.4.0
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: ---
Assignee: Ashley Hardin
QA Contact: DeShuai Ma
Vikram Goyal
URL:
Whiteboard: 3.7-release-plan
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-07-26 14:02 UTC by Eric Jones
Modified: 2023-09-14 04:01 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-09-11 14:23:14 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Eric Jones 2017-07-26 14:02:20 UTC
Document URL: 
https://docs.openshift.com/container-platform/3.4/admin_guide/pruning_resources.html

Section Number and Name: 
Cluster Administration
Pruning Objects

Describe the issue: 
All three of the objects that we describe the ability to prune for include the variable --keep-younger-than but none of them mention the valid settings, only stating that the default is 60m

Suggestions for improvement: 
Include the valid units of measurement for this variable

I would like to get total confirmation from someone in engineering on this but based on the fact that the code [0][1][2] appears to use the time package [3] which only accepts Nanoseconds (ns), Microseconds (us), Milliseconds (ms), Seconds (s), Minutes (m), and Hours (h), it would appear very likely that those are the valid units of measurement for this variable.

[0] https://github.com/openshift/origin/blob/a5f7000a7f3ce3f0832d9dcf8eb58073d6eb84c7/pkg/cmd/admin/prune/images.go
[1] https://github.com/openshift/origin/blob/a5f7000a7f3ce3f0832d9dcf8eb58073d6eb84c7/pkg/cmd/admin/prune/deployments.go
[2] https://github.com/openshift/origin/blob/a5f7000a7f3ce3f0832d9dcf8eb58073d6eb84c7/pkg/cmd/admin/prune/builds.go
[3] https://golang.org/pkg/time/#Duration

Comment 2 Ashley Hardin 2017-08-17 20:56:38 UTC
Work in progress: https://github.com/openshift/openshift-docs/pull/5041

Comment 3 DeShuai Ma 2017-08-23 08:58:04 UTC
verified the change!

Comment 4 openshift-github-bot 2017-08-23 12:55:26 UTC
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/df177f919d2e770f7ccb404eaab0c85c76784f84
Merge pull request #5041 from ahardin-rh/keep-younger-than

Bug 1475371, Added valid units of measurement for --keep-younger-than

Comment 6 Red Hat Bugzilla 2023-09-14 04:01:39 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 1000 days


Note You need to log in before you can comment on or make changes to this bug.