Bug 980566

Summary:	Update documentation for role names to reflect possibility of using custom values.
Product:	[Retired] Beaker	Reporter:	Luigi Toscano <ltoscano>
Component:	Doc	Assignee:	Carol Bouchard <cbouchar>
Status:	CLOSED NEXTRELEASE	QA Contact:	tools-bugs <tools-bugs>
Severity:	unspecified	Docs Contact:
Priority:	low
Version:	0.13	CC:	jingwang, mastyk, qwan, tklohna, tools-bugs
Target Milestone:	27.0	Keywords:	Documentation, EasyFix, Patch, Triaged
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Enhancement
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2019-12-11 07:45:03 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 Luigi Toscano 2013-07-02 18:05:49 UTC

Description of problem:
The description of roles in the "Multihost tasks" section[1] could give the impression that CLIENTS, SERVERS and DRIVERS are the only possible choice as role, but any valid bash variable name can be used as role.
The description of role names could be more generic.

See https://lists.fedorahosted.org/pipermail/beaker-devel/2013-July/000612.html

[1] http://beaker-project.org/docs/user-guide/multihost.html

Version-Release number of selected component (if applicable):
0.13

Comment 2 Raymond Mancy 2013-07-02 23:00:53 UTC

SERVERS, CLIENTS and DRIVERS are actually hardcoded into certain helper functions of the rhts test env (actually, report_finish() is the only one I can see).

If your test does not rely on this (which it may not) then yes, any other value for ROLE will be fine. However, the integration of those role values should either be documented, or removed from rhts.

Comment 3 Nick Coghlan 2013-07-03 00:57:02 UTC

Any documentation updates should mention cases where the name *does* matter with respect to any helper functions, but the current docs certainly give the wrong impression.