action #157147
closedcoordination #103944: [saga][epic] Scale up: More robust handling of diverse infrastructure with varying performance
coordination #157144: [epic] Groups of worker classes: Regions, locations, etc.
Documentation for OSD worker region, location, datacenter keys in https://gitlab.suse.de/openqa/salt-pillars-openqa/-/blob/master/openqa/workerconf.sls size:S
0%
Description
Motivation¶
Based on request by fniederwanger in Slack.
With https://gitlab.suse.de/openqa/salt-pillars-openqa/-/merge_requests/705 we have introduced region+location+datacenter keys in the worker class settings. That is generally documented as example in http://open.qa/docs/#_assigning_jobs_to_workers but not directly describes the relevant settings for OSD users. We should ensure that this concept is described with users of the OSD infrastructure in mind, e.g. in https://wiki.suse.net/index.php/OpenQA and/or https://gitlab.suse.de/openqa/salt-states-openqa/-/blob/master/README.md and/or https://gitlab.suse.de/openqa/salt-pillars-openqa/-/blob/master/README.md?ref_type=heads
Acceptance criteria¶
- AC1: http://open.qa/docs/#_assigning_jobs_to_workers suggests the specific concept of "region-…,datacenter-…,location-…"
- AC2: A SUSE specific documentation explains the meaning of "region, datacenter, location" used within https://gitlab.suse.de/openqa/salt-pillars-openqa/-/blob/master/openqa/workerconf.sls
Suggestions¶
Incorporate ideas from #157144-2
- Simply change the lower text in http://open.qa/docs/#_assigning_jobs_to_workers with the specific concept of "region-…,datacenter-…,location-…"
- Add a SUSE specific documentation for the meaning of "region, datacenter, location" used within https://gitlab.suse.de/openqa/salt-pillars-openqa/-/blob/master/openqa/workerconf.sls, possibly in https://gitlab.suse.de/openqa/salt-pillars-openqa/-/blob/master/README.md itself, maybe referencing that repo in detail on https://wiki.suse.net/index.php/OpenQA and/or https://gitlab.suse.de/openqa/salt-states-openqa/-/blob/master/README.md