Project

General

Profile

Wiki » History » Version 100

okurz, 2020-10-12 14:22
fix the position of "Epics and Sagas" on the page as the paragraph about use of categories should still belong t …, well, "ticket categories" :)

1 3 okurz
# Introduction
2 1 alarrosa
3 3 okurz
This is the organisation wiki for the **openQA Project**.
4 49 okurz
The source code is hosted in the [os-autoinst github project](http://github.com/os-autoinst/), especially [openQA itself](http://github.com/os-autoinst/openQA) and the main backend [os-autoinst](http://github.com/os-autoinst/os-autoinst)
5 1 alarrosa
6 48 okurz
If you are interested in the tests for SUSE/openSUSE products take a look into the [openqatests](https://progress.opensuse.org/projects/openqatests) project.
7
8 70 szarate
If you are looking for entry level issues to contribute to the backend, take a look at [this search query](https://progress.opensuse.org/projects/openqav3/search?utf8=%E2%9C%93&issues=1&q=entrance+level+issue)
9
10 14 okurz
{{toc}}
11
12 3 okurz
# Organisational
13 1 alarrosa
14 51 okurz
## ticket workflow
15
16 65 SLindoMansilla
Picture: http://imagebin.suse.de/2127/img
17 64 SLindoMansilla
18 51 okurz
The following ticket statuses are used together and their meaning is explained:
19
20 63 okurz
* *New*: No one has worked on the ticket (e.g. the ticket has not been properly refined) or no one is feeling responsible for the work on this ticket.
21 73 riafarov
* *Workable*: The ticket has been refined and is ready to be picked.
22
* *In Progress*: Assignee is actively working on the ticket.
23 1 alarrosa
* *Resolved*: The complete work on this issue is done and the according issue is supposed to be fixed as observed (Should be updated together with a link to a merged pull request or also a link to an production openQA showing the effect)
24 73 riafarov
* *Feedback*: Further work on the ticket is blocked by open points or is awaiting for the feedback to proceed. Sometimes also used to ask Assignee about progress on inactivity.
25 74 okurz
* *Blocked*: Further work on the ticket is blocked by some external dependency (e.g. bugs, not implemented features). There should be a link to another ticket, bug, trello card, etc. where it can be seen what the ticket is blocked by.
26 51 okurz
* *Rejected*: The issue is considered invalid, should not be done, is considered out of scope.
27
* *Closed*: As this can be set only by administrators it is suggested to not use this status.
28
29
It is good practice to update the status together with a comment about it, e.g. a link to a pull request or a reason for reject.
30
31 80 okurz
## ticket categories
32
33
* *Concrete Bugs*: Regressions, crashes, error messages
34
* *Feature requests*: Ideas or wishes for extension, enhancement, improvement
35
* *Organisational*: Organisational tasks within the project(s), not directly code related
36
* *Support*: Support of users, usage problems, questions
37
38 1 alarrosa
Please avoid the use of other, deprecated categories
39
40
Suggestion by *okurz*: I recommend to avoid the word "bug" in our categories because of the usual "is it a bug or a feature" struggle. Instead I suggest to strictly define "Regressions & Crashes" to clearly separate "it used to work in before" from "this was never part of requirements" for Features. Any ticket of this category also means that our project processes missed something so we have points for improvements, e.g. extend things to look out for in code review.
41 100 okurz
42
## Epics and Sagas
43
44
[epic]s and [saga]s belong to the "coordination" tracker, project contributors are not required to follow this convention but the tracker may be changed automagically in the future: http://mailman.suse.de/mailman/private/qa-sle/2020-October/002722.html 
45 83 okurz
46 13 okurz
## ticket templates
47
You can use these templates to fill in tickets and further improve them with more detail over time. Copy the code block, paste it into a new issue, replace every block marked with "<…>" with your content or delete if not appropriate.
48
49 71 nicksinger
### Defects
50 13 okurz
51
Subject: `<Short description, example: "openQA dies when triggering any Windows ME tests">`
52
53 1 alarrosa
54 13 okurz
```
55 71 nicksinger
## Observation
56 13 okurz
<description of what can be observed and what the symptoms are, provide links to failing test results and/or put short blocks from the log output here to visualize what is happening>
57
58 71 nicksinger
## Steps to reproduce
59 1 alarrosa
* <do this>
60 13 okurz
* <do that>
61 1 alarrosa
* <observe result>
62 13 okurz
63 71 nicksinger
## Problem
64 13 okurz
<problem investigation, can also include different hypotheses, should be labeled as "H1" for first hypothesis, etc.>
65
66 71 nicksinger
## Suggestion
67 13 okurz
<what to do as a first step>
68
69 71 nicksinger
## Workaround
70 13 okurz
<example: retrigger job>
71
```
72
73
example ticket: #10526
74
75 72 nicksinger
### Feature requests
76 13 okurz
77
Subject: `<Short description, example: "grub3 btrfs support" (feature)>`
78
79
80
```
81
## User story
82
<As a <role>, I want to <do an action>, to <achieve which goal> >
83
84 72 nicksinger
## Acceptance criteria
85 13 okurz
* <**AC1:** the first acceptance criterion that needs to be fulfilled to do this, example: Clicking "restart button" causes restart of the job>
86
* <**AC2:** also think about the "not-actions", example: other jobs are not affected>
87
88 72 nicksinger
## Tasks
89 13 okurz
* <first task to do as an easy starting point>
90 69 okurz
* <what do do next, all tasks optionally with an effort estimation in hours, e.g. "(0.5-2h)">
91 13 okurz
* <optional: mark "optional" tasks>
92
93 72 nicksinger
## Further details
94 17 okurz
<everything that does not fit into above sections>
95 13 okurz
```
96
97
example ticket: #10212
98
99 62 SLindoMansilla
## Further decision steps working on test issues
100 61 SLindoMansilla
101 62 SLindoMansilla
Test issues could be one of the following sources. Feel free to use the following template in tickets as well
102 1 alarrosa
103 62 SLindoMansilla
```
104
## Problem
105
* **H1** The product has changed
106
 * **H1.1** product changed slightly but in an acceptable way without the need for communication with DEV+RM --> adapt test
107
 * **H1.2** product changed slightly but in an acceptable way found after feedback from RM --> adapt test
108
 * **H1.3** product changed significantly --> after approval by RM adapt test
109 61 SLindoMansilla
110 62 SLindoMansilla
* **H2** Fails because of changes in test setup
111
 * **H2.1** Our test hardware equipment behaves different
112
 * **H2.2** The network behaves different
113
114
* **H3** Fails because of changes in test infrastructure software, e.g. os-autoinst, openQA
115
* **H4** Fails because of changes in test management configuration, e.g. openQA database settings
116
* **H5** Fails because of changes in the test software itself (the test plan in source code as well as needles)
117
* **H6** Sporadic issue, i.e. the root problem is already hidden in the system for a long time but does not show symptoms every time
118
```
119 25 okurz
120
## pull request handling on github
121
122
As a reviewer of pull requests on github for all related repositories, e.g. https://github.com/os-autoinst/os-autoinst-distri-opensuse/pulls, apply labels in case PRs are open for a longer time and can not be merged so that we keep our backlog clean and know why PRs are blocked.
123
124
* **notready**: Triaged as not ready yet for merging, no (immediate) reaction by the reviewee, e.g. when tests are missing, other scenarios break, only tested for one of SLE/TW
125
* **wip**: Marked by the reviewee itself as "[WIP]" or "[DO-NOT-MERGE]" or similar
126
* **question**: Questions to the reviewee, not answered yet
127 54 okurz
128
129
## Where to contribute?
130
131
If you want to help openQA development you can take a look into the existing [issues](https://progress.opensuse.org/projects/openqav3/issues). There are also some "always valid" tasks to be working on:
132
133
* *improve test coverage*:
134
 * *user story*: As openqa backend as well as test developer I want better test coverage of our projects to reduce technical debt
135
 * *acceptance criteria*: test coverage is significantly higher than before
136
 * *suggestions*: check current coverage in each individual project (os-autoinst/openQA/os-autoinst-distri-opensuse) and add tests as necessary
137
138 28 okurz
139 1 alarrosa
# Use cases
140 40 okurz
141 28 okurz
The following use cases 1-6 have been defined within a SUSE workshop (others have been defined later) to clarify how different actors work with openQA. Some of them are covered already within openQA quite well, some others are stated as motivation for further feature development.
142
143 6 okurz
## Use case 1
144 4 okurz
**User:** QA-Project Managment
145 1 alarrosa
**primary actor:** QA Project Manager, QA Team Leads
146
**stakeholder:** Directors, VP
147 7 okurz
**trigger:** product milestones, providing a daily status
148 1 alarrosa
**user story:** „As a QA project manager I want to check on a daily basis the „openQA Dashboard“ to get a summary/an overall status of the „reviewers results“ in order to take the right actions and prioritize tasks in QA accordingly.“
149 28 okurz
	
150 4 okurz
## Use case 2
151 1 alarrosa
**User:** openQA-Admin
152
**primary actor:** Backend-Team
153 4 okurz
**stakeholder:** Qa-Prjmgr, QA-TL, openQA Tech-Lead
154 7 okurz
**trigger:** Bugs, features, new testcases
155 5 okurz
**user story:** „As an openQA admin I constantly check in the web-UI the system health and I manage its configuration to ensure smooth operation of the tool.“
156 28 okurz
157 1 alarrosa
## Use case 3
158
**User:** QA-Reviewer
159
**primary actor:** QA-Team
160 4 okurz
**stakeholder:** QA-Prjmgr, Release-Mgmt, openQA-Admin
161 7 okurz
**trigger:** every new build
162
**user story:** „As an openQA-Reviewer at any point in time I review on the webpage of openQA the overall status of a build in order to track and find bugs, because I want to find bugs as early as possible and report them.“
163 28 okurz
164 1 alarrosa
## Use case 4
165
**User:** Testcase-Contributor
166 4 okurz
**primary actor:** All development teams, Maintenance QA
167 5 okurz
**stakeholder:** QA-Reviewer, openQA-Admin, openQA Tech-Lead
168 40 okurz
**trigger:** features, new functionality, bugs, new product/package
169 7 okurz
**user story:** „As developer when there are new features, new functionality, bugs, new product/package in git I contribute my testcases because I want to ensure good quality submissions and smooth product integration.“
170 28 okurz
171 4 okurz
## Use case 5
172
**User:** Release-Mgmt
173
**primary actor:** Release Manager
174 1 alarrosa
**stakeholder:** Directors, VP, PM, TAMs, Partners
175 7 okurz
**trigger:** Milestones
176
**user story:** „As a Release-Manager on a daily basis I check on a dashboard for the product health/build status in order to act early in case of failures and have concrete and current reports.“
177 28 okurz
178 4 okurz
## Use case 6
179
**User:** Staging-Admin
180
**primary actor:** Staging-Manager for the products
181 1 alarrosa
**stakeholder:** Release-Mgmt, Build-Team
182
**trigger:** every single submission to projects
183 40 okurz
**user story:** „As a Staging-Manager I review the build status of packages with every staged submission to the „staging projects“ in the „staging dashboard“ and the test-status of the pre-integrated fixes, because I want to identify major breakage before integration to the products and provide fast feedback back to the development.“
184
185
## Use case 7
186
**User:** Bug investigator
187
**primary actor:** Any bug assignee for openQA observed bugs
188
**stakeholder:** Developer
189
**trigger:** bugs
190 8 okurz
**user story:** „As a developer that has been assigned a bug which has been observed in openQA I can review referenced tests, find a newer and the most recent job in the same scenario, understand what changed since the last successful job, what other jobs show same symptoms to investigate the root cause fast and use openQA for verification of a bug fix.“
191 15 okurz
192 8 okurz
# Thoughts about categorizing test results, issues, states within openQA
193
by okurz
194
195
When reviewing test results it is important to distinguish between different causes of "failed tests"
196
197
## Nomenclature
198
199 58 okurz
### Test status categories
200 1 alarrosa
A common definition about the status of a test regarding the product it tests: "false|true positive|negative" as described on https://en.wikipedia.org/wiki/False_positives_and_false_negatives. "positive|negative" describes the outcome of a test ("positive": test signals presence of issue; "negative": no signal) whereas "false|true" describes the conclusion of the test regarding the presence of issues in the SUT or product in our case ("true": correct reporting; "false": incorrect reporting), e.g. "true negative", test successful, no issues detected and there are no issues, product is working as expected by customer. Another example: Think of testing as of a fire alarm. An alarm (event detector) should only go off (be "positive") *if* there is a fire (event to detect) --> "true positive" whereas *if* there is *no* fire there should be *no* alarm --> "true negative".
201 10 okurz
202 1 alarrosa
Another common but potentially ambiguous categorization:
203 10 okurz
204
* *broken*: the test is not behaving as expected (Ambiguity: "as expected" by whom?) --> commonly a "false positive", can also be "false negative" but hard to detect
205
* *failing*: the test is behaving as expected, but the test output is a fail --> "true positive"
206
* *working*: the test is behaving as expected (with no comment regarding the result, though some might ambiguously imply 'result is negative')
207
* *passing*: the test is behaving as expected, but the result is a success --> "true negative"
208 8 okurz
209 9 okurz
If in doubt declare a test as "broken". We should review the test and examine if it is behaving as expected.
210 10 okurz
211 8 okurz
Be careful about "positive/negative" as some might also use "positive" to incorrectly denote a passing test (and "negative" for failing test) as an indicator of "working product" not an indicator about "issue present". If you argue what is "used in common speech" think about how "false positive" is used as in "false alarm" --> "positive" == "alarm raised", also see https://narainko.wordpress.com/2012/08/26/understanding-false-positive-and-false-negative/
212
213 10 okurz
### Priorization of work regarding categories
214 3 okurz
In this sense development+QA want to accomplish a "true negative" state whenever possible (no issues present, therefore none detected). As QA and test developers we want to prevent "false positives" ("false alarms" declaring a product as broken when it is not but the test failed for other reasons), also known as "type I error" and "false negatives" (a product issue is not catched by tests and might "slip through" QA and at worst is only found by an external outside customer) also known as "type II error". Also see https://en.wikipedia.org/wiki/Type_I_and_type_II_errors. In the context of openQA and system testing paired with screen matching a "false positive" is much more likely as the tests are very susceptible to subtle variations and changes even if they should be accepted. So when in doubt, create an issue in progress, look at it again, and find that it was a false alarm, rather than wasting more peoples time with INVALID bug reports by believing the product to be broken when it isn't. To quote Richard Brown: "I […] believe this is the route to ongoing improvement - if we have tests which produce such false alarms, then that is a clear indicator that the test needs to be reworked to be less ambiguous, and that IS our job as openQA developers to deal with".
215 11 okurz
216
## Further categorization of statuses, issues and such in testing, especially automatic tests
217
By okurz
218
219
This categorization scheme is meant to help in communication in either written or spoken discussions being simple, concise, easy to remember while unambiguous in every case.
220
While used for naming it should also be used as a decision tree and can be followed from the top following each branch.
221
222
### Categorization scheme
223
224
To keep it simple I will try to go in steps of deciding if a potential issue is of one of two categories in every step (maybe three) and go further down from there. The degree of further detailing is not limited, i.e. it can be further extended. Naming scheme should follow arabic number (for two levels just 1 and 2) counting schemes added from the right for every additional level of decision step and detail without any separation between the digits, e.g. "1111" for the first type in every level of detail up to level four. Also, I am thinking of giving the fully written form phonetic name to unambiguously identify each on every level as long as not more individual levels are necessary. The alphabet should be reserved for higher levels and higher priority types.
225
Every leaf of the tree must have an action assigned to it.
226 12 okurz
227 11 okurz
1 **failed** (ZULU)
228
11 new (passed->failed) (YANKEE)
229
111 product issue ("true positive") (WHISKEY)
230 44 okurz
1111 unfiled issue (SIERRA)
231 11 okurz
11111 hard issue (openqa *fail*) (KILO)
232
111121 critical / potential ship stopper (INDIA) --> immediately file bug report with "ship_stopper?" flag; opt. inform RM directly
233 44 okurz
111122 non-critical hard issue (HOTEL) --> file bug report
234 11 okurz
11112 soft issue (openqa *softfail* on job level, not on module level) (JULIETT) --> file bug report on failing test module
235
1112 bugzilla bug exists (ROMEO)
236
11121 bug was known to openqa / openqa developer --> cross-reference (bug->test, test->bug) AND raise review process issue, improve openqa process
237
11122 bug was filed by other sources (e.g. beta-tester) --> cross-reference (bug->test, test->bug)
238
112 test issue ("false positive") (VICTOR)
239
1121 progress issue exists (QUEBEC) --> cross-reference (issue->test, test->issue)
240
1122 unfiled test issue (PAPA)
241
11221 easy to do w/o progress issue
242
112211 need needles update --> re-needle if sure, TODO how to notify?
243
112212 pot. flaky, timeout
244
1122121 retrigger yields PASS --> comment in progress about flaky issue fixed
245
1122122 reproducible on retrigger --> file progress issue
246
11222 needs progress issue filed --> file progress issue
247
12 existing / still failing (failed->failed) (XRAY)
248
121 product issue (UNIFORM)
249
1211 unfiled issue (OSCAR) --> file bug report AND raise review process issue (why has it not been found and filed?)
250
1212 bugzilla bug exists (NOVEMBER) --> ensure cross-reference, also see rules for 1112 ROMEO
251
122 test issue (TANGO)
252
1221 progress issue exists (MIKE) --> monitor, if persisting reprioritize test development work
253
1222 needs progress issue filed (LIMA) --> file progress issue AND raise review process issue, see 1211 OSCAR
254
2 **passed** (ALFA)
255
21 stable (passed->passed) (BRAVO)
256
211 existing "true negative" (DELTA) --> monitor, maybe can be made stricter
257
212 existing "false negative" (ECHO) --> needs test improvement
258
22 fixed (failed->passed) (CHARLIE)
259
222 fixed "true negative" (FOXTROTT) --> TODO split monitor, see 211 DELTA
260
2221 was test issue --> close progress issue
261
2222 was product issue
262
22221 no bug report exists --> raise review process issue (why was it not filed?)
263
22222 bug report exists
264
222221 was marked as RESOLVED FIXED
265
221 fixed but "false negative" (GOLF) --> potentially revert test fix, also see 212 ECHO
266 41 okurz
267
268 11 okurz
Priority from high to low: INDIA->OSCAR->HOTEL->JULIETT->…
269 35 okurz
270 82 okurz
# Proposals for uses of labels
271 23 okurz
With [Show bug or label icon on overview if labeled (gh#550)](https://github.com/os-autoinst/openQA/pull/550) it is possible to add custom labels just by writing them. Nevertheless, a convention should be found for a common benefit. <del>Beware that labels are also automatically carried over with (Carry over labels from previous jobs in same scenario if still failing [gh#564])(https://github.com/os-autoinst/openQA/pull/564) which might make consistent test failures less visible when reviewers only look for test results without labels or bugrefs.</del> Labels are not anymore automatically carried over ([gh#1071](https://github.com/os-autoinst/openQA/pull/1071)).
272
273
List of proposed labels with their meaning and where they could be applied.
274
275
* ***`fixed_<build_ref>`***: If a test failure is already fixed in a more recent build and no bug reference is known, use this label together with a reference to a more recent passed test run in the same scenario. Useful for reviewing older builds. Example (https://openqa.suse.de/tests/382518#comments):
276
277
```
278
label:fixed_Build1501
279
280
t#382919
281
```
282 24 okurz
283
* ***`needles_added`***: In case needles were missing for test changes or expected product changes caused needle matching to fail, use this label with a reference to the test PR or a proper reasoning why the needles were missing and how you added them. Example (https://openqa.suse.de/tests/388521#comments):
284
285
```
286
label:needles_added
287
288
needles for https://github.com/os-autoinst/os-autoinst-distri-opensuse/pull/1353 were missing, added by jpupava in the meantime.
289 60 mgriessmeier
```
290
291 67 okurz
# s390x Test Organisation
292 1 alarrosa
293 67 okurz
See the following picture for a graphical overview of the current s390x test infrastructure at SUSE:
294
295
![SUSE s390x test infrastructure](qa_sle_openqa_s390x_test_infrastructure.jpg)
296
297 75 okurz
## Upgrades
298 60 mgriessmeier
299
### on z/VM 
300
#### special Requirements
301
302
Due to the lack of proper use of hdd-images on zVM, we need to workaround this with having a dedicated worker_class aka a dedicated Host where we run two jobs with START_AFTER_TEST,
303
the first one which installs the basesystem we want to have upgraded and a second one which is doing the actually upgrade (e.g migration_offline_sle12sp2_zVM_preparation and migration_offline_sle12sp2_zVM)
304
305
Since we encountered issues with randomly other preparation jobs are started in between there, we need to ensure that we have one complete chain for all migration jobs running on one worker, that means for example:
306
307 75 okurz
1. migration_offline_sle12sp2_zVM_preparation 
308
1. migration_offline_sle12sp2_zVM (START_AFTER_TEST=#1) 
309
1. migration_offline_sle12sp2_allpatterns_zVM_preparation (START_AFTER_TEST=#2) 
310
1. migration_offline_sle12sp2_allpatterns_zVM 
311
1. ...
312 66 okurz
313
This scheme ensures that all actual Upgrade jobs are finding the prepared system and are able to upgrade it
314
315
### on z/KVM
316
317 67 okurz
No special requirements anymore, see details in #18016
318 77 nicksinger
319
## Automated z/VM LPAR installation with openQA using qnipl
320
321 78 nicksinger
There is an ongoing effort to automate the LPAR creation and installation on z/VM. A first idea resulted in the creation of [qnipl](https://github.com/openSUSE/dracut-qnipl). `qnipl` enables one to boot a very slim initramfs from a shared medium (e.g. shared SCSI-disks) and supply it with the needed parameters to chainload a "normal SLES installation" using kexec.
322 77 nicksinger
This method is required for z/VM because snipl (Simple network initial program loader) can only load/boot LPARs from specific disks, not network resources.
323
324
### Setup
325
326
1. Get a shared disk for all your LPARs
327
  * Normally this can easily done by infra/gschlotter
328
  * Disks needs to be connected to all guests which should be able to network-boot
329
1. Boot a fully installed SLES on one of the LPARs to start preparing the shared-disk
330
1. Put a DOS partition table on the disk and create one single, large partition on there
331
1. Put a FS on there. Our first test was on ext2 and it worked flawlessly in our attempts
332
1. Install `zipl` (The s390x bootloader from IBM) on this partition
333
  * A simple and sufficient config can be found in [poo#33682](https://progress.opensuse.org/issues/33682)
334
1. clone [`qnipl`](https://github.com/nicksinger/dracut-qnipl) to your dracut modules (e.g. /usr/lib/dracut/modules.d/95qnipl)
335
1. Include the module named `qnipl` to your dracut modules for initramfs generation
336
  * e.g. in /etc/dracut.conf.d/99-qnipl.conf add: `add_dracutmodules+=qnipl`
337
1. Generate your initramfs (e.g. `dracut -f -a "url-lib qnipl" --no-hostonly-cmdline /tmp/custom_initramfs`)
338
  * Put the initramfs next to your kernel binary on the partition you want to prepare
339
1. From now on you can use `snipl` to boot any LPAR connected with this shared disk from network
340
  * example: `snipl -f ./snipl.conf -s P0069A27-LP3 -A fa00 --wwpn_scsiload 500507630713d3b3 --lun_scsiload 4001401100000000 --ossparms_scsiload "install=http://openqa.suse.de/assets/repo/SLE-15-Installer-DVD-s390x-Build533.2-Media1 hostip=10.161.159.3/20 gateway=10.161.159.254 Nameserver=10.160.0.1 Domain=suse.de ssh=1 regurl=http://all-533.2.proxy.scc.suse.de"`
341
  * `--ossparms_scsiload` is then evaluated and used by `qnipl` to kexec into the installer with the (for the installer) needed parameters
342
343
### Further details
344
345 78 nicksinger
Further details can also be found in the [github repo](https://github.com/openSUSE/dracut-qnipl/blob/master/README.md). Pull requests, questions and ideas always welcome!
346 84 okurz
347 1 alarrosa
# Infrastructure setup for o3 (openqa.opensuse.org)
348 87 okurz
349 88 okurz
o3 consists of a VM running the web UI and physical worker machines. The VM for 3 has netapp backed storage on rotating disk so less performant than SSD but cheaper. So eventually we might have the possibility to use SSD based storage. Currently there are four virtual storage devices provided to o3 totalling to 10 TB.
350
351 87 okurz
## Automatic update of o3
352
353
o3 is automatically deployed on a daily base, that includes both the webUI host as well as the workers.
354 1 alarrosa
355 90 okurz
### Automatic update of o3 webUI host
356 1 alarrosa
357 90 okurz
Done with cron job in `/etc/cron.d/auto-update`
358
359 87 okurz
### Recurring automatic update of openQA workers
360
361 94 okurz
All o3 workers (except power8) apply a daily automatic update and are "Transactional Servers" running openSUSE Leap. power8 is non-transactional with a weekly update every Sunday.
362 87 okurz
363
This was for a number of reasons including:
364
365
* Getting all the machines consistent after a few years of drift
366
* Making it easier to keep them consistent by leveraging a read only root filesystem
367
* Guaranteeing rollbackability by using transactional updates
368
369 1 alarrosa
This was done by rbrown also to fulfill the prerequisite to getting them viable for multi-machine testing
370 87 okurz
371 90 okurz
These systems currently patch themselves and reboot automatically in the default maintenance window of 0330-0500 CET/CEST.
372 87 okurz
373
On problems this could be changed in the following way:
374
375
* Edit the maintenance window in /etc/rebootmgr.conf
376
* Disable the automatic reboot by "systemctl disable rebootmgr.service"
377
* Disable the automatic patching by "systemctl disable transactional-update.timer"
378
379
SUSE employees have access to the bootmenu for the openQA worker machines, e.g. openqaworker1 and openqaworker4 via openqaworker1- ipmi.suse.de and openqaworker4-ipmi.suse.de which are both connected to the r&d network. For imagetester one would need to go through SUSE-IT in an unlikely event of a boot-preventing update. "snapper rollback" can be executed from a booted, functionally operative machine which one can ssh into.
380 84 okurz
381 91 okurz
To execute commands manually on all workers one can do for example the following:
382
383
```
384
for i in aarch64 openqaworker1 openqaworker4 openqaworker7 power8 imagetester rebel; do echo $i && ssh root@$i "(transactional-update -n dup || zypper -n dup) && reboot" ; done
385
```
386
387
mind the correct list of machines.
388
389 92 okurz
For manual investigation https://github.com/kubic-project/microos-toolbox can be helpful
390
391 96 okurz
## Accessing o3 infrastructure
392
393
The o3 webui host as well as the workers within the o3 infrastructure can be accessed over ssh by using `ssh -p 2213 gate.opensuse.org`. Ask one of the existing admins to put your ssh key there to be able to login.
394
395 89 ggardet_arm
## AArch64 specific configurations on o3
396
397
On o3, the aarch64 workers need additional configuration.
398
399
### Setup HugePages
400
401
You need to setup HugePages support to improve performances with qemu VM and to match current aarch64 `MACHINE` configuration.
402
For the D05 machine, the configuration is: `40` pages with a size of `1G`.
403
If there are some permissions issues on `/dev/hugepages/`, check https://progress.opensuse.org/issues/53234
404
405
406 84 okurz
## Moving worker from osd to o3
407
408
* Ensure system management, e.g. over IPMI works. This is untouched by the following steps and can be used during the process for recovery and setup
409
* Ensure network is configured for DHCP
410
* Instruct SUSE-IT to change VLAN for machine from 2 to 662 (example: https://infra.nue.suse.com/SelfService/Display.html?id=16458)
411
* Remove from osd:
412
413
```
414
salt-key -y -d openqaworker7.suse.de
415
```
416
417
* Add entry on o3 to `/etc/dnsmasq.d/openqa.conf` with MAC address, e.g.
418
419
```
420
dhcp-host=54:ab:3a:24:34:b8,openqaworker7
421
```
422
423
* Add entry to `/etc/hosts` which dnsmasq picks up to give out a DHCP lease, e.g.
424
425
```
426
192.168.112.12   openqaworker7.openqanet.opensuse.org openqaworker7
427
```
428
429 85 okurz
* Adapt NFS mount point
430
431
```
432
sed -i '/openqa\.suse\.de/d' /etc/fstab && echo 'openqa1-opensuse:/ /var/lib/openqa/share nfs4 ro,fsc 0 0' >> /etc/fstab
433
```
434
435 84 okurz
* Reload dnsmasq with `systemctl restart dnsmasq`
436
* Restart network on machine (over IMPI) using `systemctl restart network` and monitor in o3:`journalctl -f -u dnsmasq` until address is assigned, e.g.:
437
438
```
439
Feb 29 10:48:30 ariel dnsmasq[28105]: read /etc/hosts - 30 addresses
440
Feb 29 10:48:54 ariel dnsmasq-dhcp[28105]: DHCPREQUEST(eth1) 10.160.1.101 54:ab:3a:24:34:b8
441
Feb 29 10:48:54 ariel dnsmasq-dhcp[28105]: DHCPNAK(eth1) 10.160.1.101 54:ab:3a:24:34:b8 wrong network
442
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPDISCOVER(eth1) 54:ab:3a:24:34:b8
443
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPOFFER(eth1) 192.168.112.12 54:ab:3a:24:34:b8
444
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPREQUEST(eth1) 192.168.112.12 54:ab:3a:24:34:b8
445
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPACK(eth1) 192.168.112.12 54:ab:3a:24:34:b8 openqaworker7
446 85 okurz
```
447
448
* Ensure all mountpoints up
449
450
```
451
mount -a
452 84 okurz
```
453
454
* Change root password to o3 one
455 86 okurz
* Allow ssh password authentication: `sed -i 's/^PasswordAuthentication/#&/' /etc/ssh/sshd_config && systemctl restart sshd`
456 84 okurz
* Add personal ssh key to machine, e.g. openqaworker7:/root/.ssh/authorized_keys
457
* Update /etc/openqa/client.conf with the same key as used on other workers for "openqa1-opensuse"
458
* Update /etc/openqa/workers.ini with similar config as used on other workers, e.g. based on openqaworker4, example:
459
460
```
461
# diff -Naur /etc/openqa/workers.ini{.osd,}
462
--- /etc/openqa/workers.ini.osd 2020-02-29 15:21:47.737998821 +0100
463
+++ /etc/openqa/workers.ini     2020-02-29 15:22:53.334464958 +0100
464
@@ -1,17 +1,10 @@
465
-# This file is generated by salt - don't touch
466
-# Hosted on https://gitlab.suse.de/openqa/salt-pillars-openqa
467
-# numofworkers: 10
468
-
469
 [global]
470
-HOST=openqa.suse.de
471
-CACHEDIRECTORY=/var/lib/openqa/cache
472
-LOG_LEVEL=debug
473
-WORKER_CLASS=qemu_x86_64,qemu_x86_64_staging,tap,openqaworker7
474
-WORKER_HOSTNAME=10.160.1.101
475
-
476
-[1]
477
-WORKER_CLASS=qemu_x86_64,qemu_x86_64_staging,tap,qemu_x86_64_ibft,openqaworker7
478
+HOST=http://openqa1-opensuse
479
+WORKER_HOSTNAME=192.168.112.12
480
+CACHEDIRECTORY = /var/lib/openqa/cache
481
+CACHELIMIT = 50
482
+WORKER_CLASS = openqaworker7,qemu_x86_64
483
484
-[openqa.suse.de]
485
-TESTPOOLSERVER = rsync://openqa.suse.de/tests
486
+[http://openqa1-opensuse]
487
+TESTPOOLSERVER = rsync://openqa1-opensuse/tests
488
```
489
490
* Remove OSD specifics
491
492
```
493
systemctl disable --now auto-update.timer salt-minion telegraf
494
for i in  NPI SUSE_CA telegraf-monitoring; do zypper rr $i; done
495
zypper -n dup --force-resolution --allow-vendor-change
496
```
497
498
* If the machine is not a transactional-server one has the following options: Keep as is and handle like power8 (also not transactional), enable transactional updates w/o root being r/o, change to root being r/o on-the-fly, reinstall as transactional. At least option 2 is suggested, enable transactional updates:
499
500
```
501
zypper -n in transactional-update
502
systemctl enable --now transactional-update.timer rebootmgr
503
```
504
505
* Enable apparmor
506
507
```
508
zypper -n in apparmor-utils
509
systemctl unmask apparmor
510
systemctl enable --now apparmor
511
```
512
513
* Switch firewall from SuSEfirewall2 to firewalld
514
515
```
516
zypper -n in firewalld && zypper -n rm SuSEfirewall2
517
systemctl enable --now firewalld
518
firewall-cmd --zone=trusted --add-interface=br1
519
firewall-cmd --set-default-zone trusted
520
firewall-cmd --zone=trusted --add-masquerade
521
```
522
523
* Copy over special openSUSE UEFI staging images, see #63382
524
* Check operation with a single openQA worker instance:
525
526
```
527
systemctl enable --now openqa-worker.target openqa-worker@1
528
```
529
530
* Test with an openQA job cloned from a production job, e.g. for openqaworker7
531
532
```
533
openqa-clone-job --within-instance https://openqa.opensuse.org/t${id} WORKER_CLASS=openqaworker7
534
```
535
536
* After the latest openQA job could successfully finish enable more worker instances
537
538
```
539
systemctl unmask openqa-worker@{2..14} && systemctl enable --now openqa-worker@{2..14}
540
```
541
542
* Monitor if nightly update works, e.g. look for journal entry:
543
544
```
545
Mar 01 00:08:26 openqaworker7 transactional-update[10933]: Calling zypper up
546
547
Mar 01 00:08:51 openqaworker7 transactional-update[10933]: transactional-update finished - informed rebootmgr
548
Mar 01 00:08:51 openqaworker7 systemd[1]: Started Update the system.
549
550
Mar 01 03:30:00 openqaworker7 rebootmgrd[40760]: rebootmgr: reboot triggered now!
551
552
Mar 01 03:36:32 openqaworker7 systemd[1]: Reached target openQA Worker.
553
```
554 93 okurz
555 95 okurz
## Distribution upgrades
556
557
```
558 98 livdywan
new_version=15.2 # Specify the target release
559
560
# Change the release via the special $releasever
561 95 okurz
. /etc/os-release
562
sed -i -e "s/${VERSION_ID}/\$releasever/g" /etc/zypp/repos.d/*
563
zypper --releasever=$new_version ref
564
test -f /etc/openqa/openqa.ini && sudo -u geekotest /opt/openqa-scripts/dump-psql
565
zypper -n --releasever=$new_version dup --auto-agree-with-licenses --replacefiles --download-in-advance
566 98 livdywan
567
# Check config files for relevant changes
568 97 okurz
rpmconfigcheck
569 95 okurz
for i in $(cat /var/adm/rpmconfigcheck) ; do vimdiff ${i%.rpm*} $i ; done
570
rm $(cat /var/adm/rpmconfigcheck)
571 98 livdywan
572 95 okurz
reboot
573
systemctl --failed
574
```
575
576 93 okurz
# openQA infrastructure needs (o3 + osd)
577
578
TL;DR: SSD storage for o3 would be good, new OSD ARM workers needed, missing redundancy for o3-ppc, rest is fine for the time being
579
580
2020-03: SUSE IT (EngInfra) provided us more space for O3 but we have only slow rotating-disk storage. Performance could be improved by providing SSD storage.
581
582
The most time and effort we currently struggle with storage space for OSD (openqa.suse.de) ~~both OSD (openqa.suse.de) as well as O3 (openqa.opensuse.org) (2020-03: Situation on o3 resolved with more storage provided by SUSE IT)~~. Both instances (OSD + O3) are using precious netapp-storage but there is currently no better approach to use different, external storage. An increase of the available space would be appreciated, ~~o3 being more important right now than osd,~~ see https://progress.opensuse.org/issues/57494 for details. Graphs like 
583
https://stats.openqa-monitor.qa.suse.de/d/nRDab3Jiz/openqa-jobs-test?orgId=1&from=1578343509900&to=1578653794173&fullscreen&panelId=12 show how usual test backlogs are worked on within OSD by architecture. It can be seen that both the ppc64le and aarch64 backlogs are reduced fast so we do not need more ppc64le or aarch64 machines. However, we have a stability problem with all three aarch64 workers. Potentially new machine(s) could help, see https://progress.opensuse.org/issues/41882 for details.