Bug 1286893

Summary:	[DOCS] [openshift-doc] Need documentation of container log rotation with json-file options
Product:	OpenShift Container Platform	Reporter:	Kenjiro Nakayama <knakayam>
Component:	Documentation	Assignee:	Ashley Hardin <ahardin>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Vikram Goyal <vigoyal>
Severity:	medium	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	medium
Version:	3.1.0	CC:	aos-bugs, jokerman, knakayam, mmccomas
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-02-15 16:35:30 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 Kenjiro Nakayama 2015-12-01 03:18:19 UTC

Description of problem:
- Docker 1.8.2 has the function to manage json-file logs. http://docs.docker.com/engine/reference/logging/overview/#the-json-file-options
- It should included in OSEv3 docs as well.


Document URL: 
- https://docs.openshift.com/enterprise/3.1/install_config/index.html


Section Number and Name: 
- The section of container log rotation should be inserted before/after 
Aggregating Container Logs section.


Suggestions for improvement: 
(Ref)  http://docs.docker.com/engine/reference/logging/overview/#the-json-file-options
(Ref) https://access.redhat.com/solutions/2064433


Additional information: 
- This ticket has been forked from https://bugzilla.redhat.com/show_bug.cgi?id=1252648#c19

Comment 1 Kenjiro Nakayama 2016-01-19 05:57:43 UTC

There are two sections to update. 

1. As I mentioned above, it should be added in the log section.(insert before/after Aggregating Container Logs section.)

2. Update advance installation section (https://docs.openshift.com/enterprise/3.1/install_config/install/advanced_install.html), since ansible installer can set the log option.

As for #2, I filed to github openshift-docs as well. - ref. https://github.com/openshift/openshift-docs/issues/1447

Comment 3 Ashley Hardin 2016-01-28 21:10:00 UTC

PR created (WIP): https://github.com/openshift/openshift-docs/pull/1495

Please take a look and offer suggestions. Thanks!

Comment 4 Kenjiro Nakayama 2016-02-02 04:08:16 UTC

I will re-review after you update from current review. (I am dropping need-info now.)

Comment 5 openshift-github-bot 2016-02-11 22:06:11 UTC

Commits pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/37817d38437ac2377c47eaecde2ad2ba2ea602b0
Bug 1286893, added info on container log rotation with json-file options

https://github.com/openshift/openshift-docs/commit/e81abaac30ce4279594c0e66c8b0a60e2b11f18b
Merge pull request #1495 from ahardin-rh/docker-log

Bug 1286893, added info on container log rotation with json-file options

Comment 6 Ashley Hardin 2016-02-11 22:25:43 UTC

Several rounds of edits are complete. Please reopen if further changes are needed.

Comment 7 Ashley Hardin 2016-02-15 16:35:30 UTC

Content is published:

https://docs.openshift.com/enterprise/3.1/install_config/install/prerequisites.html#managing-docker-container-logs

https://access.redhat.com/documentation/en/openshift-enterprise/version-3.1/installation-and-configuration/#managing-docker-container-logs

https://access.redhat.com/documentation/en/openshift-enterprise/version-3.1/installation-and-configuration/#configuring-host-variables

https://docs.openshift.com/enterprise/3.1/install_config/install/advanced_install.html#configuring-host-variables