Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1146147

Summary:	Watchman throttler plugin use and configuration is not documented in depth
Product:	OpenShift Container Platform	Reporter:	Timothy Williams <tiwillia>
Component:	Documentation	Assignee:	brice <bfallonf>
Status:	CLOSED NEXTRELEASE	QA Contact:	Bilhar <baulakh>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	2.1.0	CC:	bfallonf, jokerman, libra-onpremise-devel, mmccomas, randall_theobald, tiwillia
Target Milestone:	---
Target Release:	---
Hardware:	All
OS:	Linux
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2014-12-04 23:55:38 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 Timothy Williams 2014-09-24 14:54:56 UTC

Description of problem:
The watchman throttler plugin is not documented in detail in the Administration guide. Currently, there is a small mention of what it does, but nothing further. There is no information on configuring it, using it, or how it works.

  https://access.redhat.com/documentation/en-US/OpenShift_Enterprise/2/html-single/Administration_Guide/index.html#sect-The_Watchman_Tool

The below kb solution contains the missing content:

  https://access.redhat.com/solutions/1202813

Comment 2 Randall Theobald 2014-09-24 19:10:05 UTC

For OpenShift Enterprise installers, this information should be front and center. Five out of five contacts I know that installed separate OSE installations hit this and had no idea what was going on. I'd bet the majority of OSE installers will want to just turn throttling off, so the documentation should clearly state how to do this. It should also say how the existing defaults are VERY aggressive (if a gear uses over 30% of its allocation for 2 min, it will be throttled). Many OSE installers will be using it for production deployments, not just dev environments.

Comment 3 brice 2014-10-01 06:39:48 UTC

Hey, Tim.

I've rearranged the Watchman sections of the Admin Guide for the purposes of this BZ; specifically 8.5.5.2 Supported Watchman Plug-ins. I've added the paragraph above the table on how to enable/disable any plugin, as it applies to not just the throttler plug-in, but all, then added a formalpara on Configuring the Throttler Plug-in where we talk about the configuration parameters and what they do. 

Please let me know if there's anything you think I've missed, or if you have any different sugegstions.

Thanks!

Comment 6 brice 2014-10-02 00:25:01 UTC

Cool, thanks, Tim. I'll put this onto QA.

QA:
- Made "Enabling Watchman" a standlone topic
- Added para on enabling and disabling plug-ins in "Supported Watchman Plug-ins" and added the actualy plug-in files (*.rb files) to the table
- Added formalpara on Configuring the Throttler Plug-in

Comment 8 Randall Theobald 2014-12-03 18:42:27 UTC

I am not seeing this info available publicly yet in the Admin Guide. Is it just not live yet, or did something go wrong with making the change live? Trying to get a public link on the throttler config to forward to my team.