Project

General

Profile

Wiki » History » Version 122

okurz, 2021-07-14 09:30
Add backup section, from https://progress.opensuse.org/issues/44078

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 104 okurz
For tickets referencing "auto_review" see
76
https://github.com/os-autoinst/scripts/blob/master/README.md#auto-review---automatically-detect-known-issues-in-openqa-jobs-label-openqa-jobs-with-ticket-references-and-optionally-retrigger
77
for a suggested template snippet.
78
79 72 nicksinger
### Feature requests
80 13 okurz
81
Subject: `<Short description, example: "grub3 btrfs support" (feature)>`
82
83
84
```
85
## User story
86
<As a <role>, I want to <do an action>, to <achieve which goal> >
87
88 72 nicksinger
## Acceptance criteria
89 13 okurz
* <**AC1:** the first acceptance criterion that needs to be fulfilled to do this, example: Clicking "restart button" causes restart of the job>
90
* <**AC2:** also think about the "not-actions", example: other jobs are not affected>
91
92 72 nicksinger
## Tasks
93 13 okurz
* <first task to do as an easy starting point>
94 69 okurz
* <what do do next, all tasks optionally with an effort estimation in hours, e.g. "(0.5-2h)">
95 13 okurz
* <optional: mark "optional" tasks>
96
97 72 nicksinger
## Further details
98 17 okurz
<everything that does not fit into above sections>
99 13 okurz
```
100
101
example ticket: #10212
102
103 62 SLindoMansilla
## Further decision steps working on test issues
104 61 SLindoMansilla
105 62 SLindoMansilla
Test issues could be one of the following sources. Feel free to use the following template in tickets as well
106 1 alarrosa
107 62 SLindoMansilla
```
108
## Problem
109
* **H1** The product has changed
110
 * **H1.1** product changed slightly but in an acceptable way without the need for communication with DEV+RM --> adapt test
111
 * **H1.2** product changed slightly but in an acceptable way found after feedback from RM --> adapt test
112
 * **H1.3** product changed significantly --> after approval by RM adapt test
113 61 SLindoMansilla
114 62 SLindoMansilla
* **H2** Fails because of changes in test setup
115
 * **H2.1** Our test hardware equipment behaves different
116
 * **H2.2** The network behaves different
117
118
* **H3** Fails because of changes in test infrastructure software, e.g. os-autoinst, openQA
119
* **H4** Fails because of changes in test management configuration, e.g. openQA database settings
120
* **H5** Fails because of changes in the test software itself (the test plan in source code as well as needles)
121
* **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
122
```
123 25 okurz
124
## pull request handling on github
125
126
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.
127
128
* **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
129
* **wip**: Marked by the reviewee itself as "[WIP]" or "[DO-NOT-MERGE]" or similar
130
* **question**: Questions to the reviewee, not answered yet
131 54 okurz
132
133
## Where to contribute?
134
135
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:
136
137
* *improve test coverage*:
138
 * *user story*: As openqa backend as well as test developer I want better test coverage of our projects to reduce technical debt
139
 * *acceptance criteria*: test coverage is significantly higher than before
140
 * *suggestions*: check current coverage in each individual project (os-autoinst/openQA/os-autoinst-distri-opensuse) and add tests as necessary
141
142 28 okurz
143 1 alarrosa
# Use cases
144 40 okurz
145 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.
146
147 6 okurz
## Use case 1
148 4 okurz
**User:** QA-Project Managment
149 1 alarrosa
**primary actor:** QA Project Manager, QA Team Leads
150
**stakeholder:** Directors, VP
151 7 okurz
**trigger:** product milestones, providing a daily status
152 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.“
153 28 okurz
	
154 4 okurz
## Use case 2
155 1 alarrosa
**User:** openQA-Admin
156
**primary actor:** Backend-Team
157 4 okurz
**stakeholder:** Qa-Prjmgr, QA-TL, openQA Tech-Lead
158 7 okurz
**trigger:** Bugs, features, new testcases
159 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.“
160 28 okurz
161 1 alarrosa
## Use case 3
162
**User:** QA-Reviewer
163
**primary actor:** QA-Team
164 4 okurz
**stakeholder:** QA-Prjmgr, Release-Mgmt, openQA-Admin
165 7 okurz
**trigger:** every new build
166
**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.“
167 28 okurz
168 1 alarrosa
## Use case 4
169
**User:** Testcase-Contributor
170 4 okurz
**primary actor:** All development teams, Maintenance QA
171 5 okurz
**stakeholder:** QA-Reviewer, openQA-Admin, openQA Tech-Lead
172 40 okurz
**trigger:** features, new functionality, bugs, new product/package
173 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.“
174 28 okurz
175 4 okurz
## Use case 5
176
**User:** Release-Mgmt
177
**primary actor:** Release Manager
178 1 alarrosa
**stakeholder:** Directors, VP, PM, TAMs, Partners
179 7 okurz
**trigger:** Milestones
180
**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.“
181 28 okurz
182 4 okurz
## Use case 6
183
**User:** Staging-Admin
184
**primary actor:** Staging-Manager for the products
185 1 alarrosa
**stakeholder:** Release-Mgmt, Build-Team
186
**trigger:** every single submission to projects
187 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.“
188
189
## Use case 7
190
**User:** Bug investigator
191
**primary actor:** Any bug assignee for openQA observed bugs
192
**stakeholder:** Developer
193
**trigger:** bugs
194 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.“
195 15 okurz
196 8 okurz
# Thoughts about categorizing test results, issues, states within openQA
197
by okurz
198
199
When reviewing test results it is important to distinguish between different causes of "failed tests"
200
201
## Nomenclature
202
203 58 okurz
### Test status categories
204 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".
205 10 okurz
206 1 alarrosa
Another common but potentially ambiguous categorization:
207 10 okurz
208
* *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
209
* *failing*: the test is behaving as expected, but the test output is a fail --> "true positive"
210
* *working*: the test is behaving as expected (with no comment regarding the result, though some might ambiguously imply 'result is negative')
211
* *passing*: the test is behaving as expected, but the result is a success --> "true negative"
212 8 okurz
213 9 okurz
If in doubt declare a test as "broken". We should review the test and examine if it is behaving as expected.
214 10 okurz
215 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/
216
217 10 okurz
### Priorization of work regarding categories
218 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".
219 11 okurz
220
## Further categorization of statuses, issues and such in testing, especially automatic tests
221
By okurz
222
223
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.
224
While used for naming it should also be used as a decision tree and can be followed from the top following each branch.
225
226
### Categorization scheme
227
228
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.
229
Every leaf of the tree must have an action assigned to it.
230 12 okurz
231 11 okurz
1 **failed** (ZULU)
232
11 new (passed->failed) (YANKEE)
233
111 product issue ("true positive") (WHISKEY)
234 44 okurz
1111 unfiled issue (SIERRA)
235 11 okurz
11111 hard issue (openqa *fail*) (KILO)
236
111121 critical / potential ship stopper (INDIA) --> immediately file bug report with "ship_stopper?" flag; opt. inform RM directly
237 44 okurz
111122 non-critical hard issue (HOTEL) --> file bug report
238 11 okurz
11112 soft issue (openqa *softfail* on job level, not on module level) (JULIETT) --> file bug report on failing test module
239
1112 bugzilla bug exists (ROMEO)
240
11121 bug was known to openqa / openqa developer --> cross-reference (bug->test, test->bug) AND raise review process issue, improve openqa process
241
11122 bug was filed by other sources (e.g. beta-tester) --> cross-reference (bug->test, test->bug)
242
112 test issue ("false positive") (VICTOR)
243
1121 progress issue exists (QUEBEC) --> cross-reference (issue->test, test->issue)
244
1122 unfiled test issue (PAPA)
245
11221 easy to do w/o progress issue
246
112211 need needles update --> re-needle if sure, TODO how to notify?
247
112212 pot. flaky, timeout
248
1122121 retrigger yields PASS --> comment in progress about flaky issue fixed
249
1122122 reproducible on retrigger --> file progress issue
250
11222 needs progress issue filed --> file progress issue
251
12 existing / still failing (failed->failed) (XRAY)
252
121 product issue (UNIFORM)
253
1211 unfiled issue (OSCAR) --> file bug report AND raise review process issue (why has it not been found and filed?)
254
1212 bugzilla bug exists (NOVEMBER) --> ensure cross-reference, also see rules for 1112 ROMEO
255
122 test issue (TANGO)
256
1221 progress issue exists (MIKE) --> monitor, if persisting reprioritize test development work
257
1222 needs progress issue filed (LIMA) --> file progress issue AND raise review process issue, see 1211 OSCAR
258
2 **passed** (ALFA)
259
21 stable (passed->passed) (BRAVO)
260
211 existing "true negative" (DELTA) --> monitor, maybe can be made stricter
261
212 existing "false negative" (ECHO) --> needs test improvement
262
22 fixed (failed->passed) (CHARLIE)
263
222 fixed "true negative" (FOXTROTT) --> TODO split monitor, see 211 DELTA
264
2221 was test issue --> close progress issue
265
2222 was product issue
266
22221 no bug report exists --> raise review process issue (why was it not filed?)
267
22222 bug report exists
268
222221 was marked as RESOLVED FIXED
269
221 fixed but "false negative" (GOLF) --> potentially revert test fix, also see 212 ECHO
270 41 okurz
271
272 11 okurz
Priority from high to low: INDIA->OSCAR->HOTEL->JULIETT->…
273 35 okurz
274 82 okurz
# Proposals for uses of labels
275 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)).
276
277
List of proposed labels with their meaning and where they could be applied.
278
279
* ***`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):
280
281
```
282
label:fixed_Build1501
283
284
t#382919
285
```
286 24 okurz
287
* ***`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):
288
289
```
290
label:needles_added
291
292
needles for https://github.com/os-autoinst/os-autoinst-distri-opensuse/pull/1353 were missing, added by jpupava in the meantime.
293 60 mgriessmeier
```
294
295 67 okurz
# s390x Test Organisation
296 1 alarrosa
297 67 okurz
See the following picture for a graphical overview of the current s390x test infrastructure at SUSE:
298
299
![SUSE s390x test infrastructure](qa_sle_openqa_s390x_test_infrastructure.jpg)
300
301 75 okurz
## Upgrades
302 60 mgriessmeier
303
### on z/VM 
304
#### special Requirements
305
306
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,
307
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)
308
309
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:
310
311 75 okurz
1. migration_offline_sle12sp2_zVM_preparation 
312
1. migration_offline_sle12sp2_zVM (START_AFTER_TEST=#1) 
313
1. migration_offline_sle12sp2_allpatterns_zVM_preparation (START_AFTER_TEST=#2) 
314
1. migration_offline_sle12sp2_allpatterns_zVM 
315
1. ...
316 66 okurz
317
This scheme ensures that all actual Upgrade jobs are finding the prepared system and are able to upgrade it
318
319
### on z/KVM
320
321 67 okurz
No special requirements anymore, see details in #18016
322 77 nicksinger
323
## Automated z/VM LPAR installation with openQA using qnipl
324
325 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.
326 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.
327
328
### Setup
329
330
1. Get a shared disk for all your LPARs
331
  * Normally this can easily done by infra/gschlotter
332
  * Disks needs to be connected to all guests which should be able to network-boot
333
1. Boot a fully installed SLES on one of the LPARs to start preparing the shared-disk
334
1. Put a DOS partition table on the disk and create one single, large partition on there
335
1. Put a FS on there. Our first test was on ext2 and it worked flawlessly in our attempts
336
1. Install `zipl` (The s390x bootloader from IBM) on this partition
337
  * A simple and sufficient config can be found in [poo#33682](https://progress.opensuse.org/issues/33682)
338
1. clone [`qnipl`](https://github.com/nicksinger/dracut-qnipl) to your dracut modules (e.g. /usr/lib/dracut/modules.d/95qnipl)
339
1. Include the module named `qnipl` to your dracut modules for initramfs generation
340
  * e.g. in /etc/dracut.conf.d/99-qnipl.conf add: `add_dracutmodules+=qnipl`
341
1. Generate your initramfs (e.g. `dracut -f -a "url-lib qnipl" --no-hostonly-cmdline /tmp/custom_initramfs`)
342
  * Put the initramfs next to your kernel binary on the partition you want to prepare
343
1. From now on you can use `snipl` to boot any LPAR connected with this shared disk from network
344
  * 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"`
345
  * `--ossparms_scsiload` is then evaluated and used by `qnipl` to kexec into the installer with the (for the installer) needed parameters
346
347
### Further details
348
349 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!
350 84 okurz
351 109 okurz
# Infrastructure setup for o3 (openqa.opensuse.org) and osd (openqa.suse.de)
352 1 alarrosa
353 109 okurz
## o3 (openqa.opensuse.org)
354
355 113 okurz
o3 consists of a VM running the web UI and physical worker machines. The VM for o3 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.
356 88 okurz
357 109 okurz
### Automatic update of o3
358 1 alarrosa
359 87 okurz
o3 is automatically deployed on a daily base, that includes both the webUI host as well as the workers.
360 90 okurz
361 109 okurz
#### Automatic update of o3 webUI host
362 1 alarrosa
363 90 okurz
Done with cron job in `/etc/cron.d/auto-update`
364
365 109 okurz
#### Recurring automatic update of openQA workers
366 87 okurz
367 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.
368 87 okurz
369
This was for a number of reasons including:
370
371
* Getting all the machines consistent after a few years of drift
372
* Making it easier to keep them consistent by leveraging a read only root filesystem
373
* Guaranteeing rollbackability by using transactional updates
374
375 1 alarrosa
This was done by rbrown also to fulfill the prerequisite to getting them viable for multi-machine testing
376 87 okurz
377 90 okurz
These systems currently patch themselves and reboot automatically in the default maintenance window of 0330-0500 CET/CEST.
378 87 okurz
379
On problems this could be changed in the following way:
380
381
* Edit the maintenance window in /etc/rebootmgr.conf
382
* Disable the automatic reboot by "systemctl disable rebootmgr.service"
383
* Disable the automatic patching by "systemctl disable transactional-update.timer"
384
385
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.
386 84 okurz
387 91 okurz
To execute commands manually on all workers one can do for example the following:
388
389
```
390
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
391
```
392 1 alarrosa
393 91 okurz
mind the correct list of machines.
394
395 92 okurz
For manual investigation https://github.com/kubic-project/microos-toolbox can be helpful
396
397 111 okurz
#### Rollback of updates
398
399
Updates on workers can be rolled back using `transactional-update` affecting the transactional workers (others are likely not updated that often):
400
401
```
402
for i in aarch64 openqaworker1 openqaworker4 openqaworker7 power8 imagetester rebel; do echo $i && ssh root@$i "transactional-update rollback last && reboot"; done
403
```
404
405
Updates on the central webUI host openqa.opensuse.org can be rolled back by using either older variants of packages that receive maintenance updates or using the locally cached packages in e.g. /var/cache/zypp/packages/devel_openQA/noarch using `zypper in --oldpackage`, similar to https://github.com/os-autoinst/openQA/blob/master/script/openqa-rollback#L39
406
407 109 okurz
### Accessing o3 infrastructure
408 96 okurz
409
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.
410
411 102 okurz
To give access for a new user an existing admin can do the following:
412 1 alarrosa
413 102 okurz
```
414
sudo useradd -G users,trusted --create-home $user
415 112 okurz
echo "$ssh_key_from_user" | sudo tee -a /home/$user/.ssh/authorized_keys
416 102 okurz
```
417
418 109 okurz
#### SSH configuration
419 105 nicksinger
420
To easily access all hosts behind the jump host you can use the following config for your ssh client (`~.ssh/config`):
421
422
```
423
Host ariel
424
  HostName gate.opensuse.org
425
  Port 2213
426
427
Host *.opensuse.org
428
  ProxyCommand ssh -q -A -x ariel -W %h:%p
429
```
430
431
**A word of warning**: be aware that this enables agent-forwarding to at least the jumphost. Please read up for yourself if and how bad you consider the security implications of doing so.
432
433 108 SLindoMansilla
434
#### Debugging qemu SUTs in openqa.opensuse.org
435
436
SUT: System Under Test
437
438
os-autoinst starts qemu with network type that doesn't allow access from the outside, so ssh is not possible. But, qemu is started with a VNC channel available from the host (the openQA-worker).
439
Running vncviewer inside a headless server is useless, but it is possible to use gate.opensuse.org as a jump host and SSH port forwarding to start vncviewer client from your desktop environment and connect to the VNC channel of the qemu SUT.
440
441
```
442
ssh -p 2213 -L LOCAL_PORT:WORKER_HOSTNAME:QEMU_VNC_PORT USERNAME@gate.opensuse.org
443
```
444
445
For example, if user **bernhard**, wants to connect to openqaworker7:11, and wants to use local port **43043**
446
Being the IP of openqaworker7 **192.168.112.12**
447
And the VNC channel port of openqa-worker@11 **6001** (5990 + 11)
448
449
##### 1. Create SSH tunnel with port forwarding
450
* on laptop shell 1: ssh -p 2213 -L 43043:192.168.112.12:6001 bernhard@gate.opensuse.org
451 1 alarrosa
* Keep shell open to keep the tunnel open and the port forwarding
452 108 SLindoMansilla
453 1 alarrosa
##### 2. Open vncviewer
454
* on laptop shell 2: vncviewer -Shared localhost:43043
455
* `-shared` is needed to not kick the VNC connection of os-autoinst. If it is kicked, the job will terminate and the qemu process will be killed.
456
457 109 okurz
### AArch64 specific configurations on o3
458 1 alarrosa
459 109 okurz
On o3, the aarch64 workers need additional configuration.
460
461
#### Setup HugePages
462
463
You need to setup HugePages support to improve performances with qemu VM and to match current aarch64 `MACHINE` configuration.
464
For the D05 machine, the configuration is: `40` pages with a size of `1G`.
465
If there are some permissions issues on `/dev/hugepages/`, check https://progress.opensuse.org/issues/53234
466
467 121 okurz
### Monitoring
468
469
There is an internal munin instance on o3. Anyone wanting to look at the HTML pages, do this:
470
```
471
rsync -a o3:/srv/www/htdocs/munin ~/o3-munin/ 
472
```
473
(where "o3" is configured in your ssh config of course)
474
475 89 ggardet_arm
## Mitigation of boot failure or disk issues
476
477
### Worker stuck in recovery
478
479
Check disk health and consider manual fixup of mount points, e.g.:
480
481
```
482
test -e /dev/md/openqa || lsblk -n | grep -v nvme | grep "/$" && mdadm --create /dev/md/openqa --level=0 --force --raid-devices=$(ls /dev/nvme?n1 | wc -l) --run /dev/nvme?n1 || mdadm --create /dev/md/openqa --level=0 --force --raid-devices=1 --run /dev/nvme0n1p3
483
```
484
485 106 okurz
## PPC specific configurations
486
487
In one case it was necessary to disable snapshots for petitboot with `nvram -p default --update-config "petitboot,snapshots?=false"` to prevent a race condition between dm_raid and btrfs trying to discover bootable devices (https://progress.opensuse.org/issues/68053#note-25). In another case https://bugzilla.opensuse.org/show_bug.cgi?id=1174166 caused the boot entries to be not properly discovered and it was necessary to prevent grub from trying to update the according sections (https://progress.opensuse.org/issues/68053#note-31).
488 89 ggardet_arm
489 84 okurz
## Moving worker from osd to o3
490
491
* 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
492
* Ensure network is configured for DHCP
493
* Instruct SUSE-IT to change VLAN for machine from 2 to 662 (example: https://infra.nue.suse.com/SelfService/Display.html?id=16458)
494
* Remove from osd:
495
496
```
497
salt-key -y -d openqaworker7.suse.de
498
```
499
500
* Add entry on o3 to `/etc/dnsmasq.d/openqa.conf` with MAC address, e.g.
501
502
```
503
dhcp-host=54:ab:3a:24:34:b8,openqaworker7
504
```
505
506
* Add entry to `/etc/hosts` which dnsmasq picks up to give out a DHCP lease, e.g.
507
508
```
509
192.168.112.12   openqaworker7.openqanet.opensuse.org openqaworker7
510
```
511
512 85 okurz
* Adapt NFS mount point
513
514
```
515
sed -i '/openqa\.suse\.de/d' /etc/fstab && echo 'openqa1-opensuse:/ /var/lib/openqa/share nfs4 ro,fsc 0 0' >> /etc/fstab
516
```
517
518 84 okurz
* Reload dnsmasq with `systemctl restart dnsmasq`
519
* Restart network on machine (over IMPI) using `systemctl restart network` and monitor in o3:`journalctl -f -u dnsmasq` until address is assigned, e.g.:
520
521
```
522
Feb 29 10:48:30 ariel dnsmasq[28105]: read /etc/hosts - 30 addresses
523
Feb 29 10:48:54 ariel dnsmasq-dhcp[28105]: DHCPREQUEST(eth1) 10.160.1.101 54:ab:3a:24:34:b8
524
Feb 29 10:48:54 ariel dnsmasq-dhcp[28105]: DHCPNAK(eth1) 10.160.1.101 54:ab:3a:24:34:b8 wrong network
525
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPDISCOVER(eth1) 54:ab:3a:24:34:b8
526
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPOFFER(eth1) 192.168.112.12 54:ab:3a:24:34:b8
527
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPREQUEST(eth1) 192.168.112.12 54:ab:3a:24:34:b8
528
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPACK(eth1) 192.168.112.12 54:ab:3a:24:34:b8 openqaworker7
529 85 okurz
```
530
531
* Ensure all mountpoints up
532
533
```
534
mount -a
535 84 okurz
```
536
537
* Change root password to o3 one
538 86 okurz
* Allow ssh password authentication: `sed -i 's/^PasswordAuthentication/#&/' /etc/ssh/sshd_config && systemctl restart sshd`
539 84 okurz
* Add personal ssh key to machine, e.g. openqaworker7:/root/.ssh/authorized_keys
540
* Update /etc/openqa/client.conf with the same key as used on other workers for "openqa1-opensuse"
541
* Update /etc/openqa/workers.ini with similar config as used on other workers, e.g. based on openqaworker4, example:
542
543
```
544
# diff -Naur /etc/openqa/workers.ini{.osd,}
545
--- /etc/openqa/workers.ini.osd 2020-02-29 15:21:47.737998821 +0100
546
+++ /etc/openqa/workers.ini     2020-02-29 15:22:53.334464958 +0100
547
@@ -1,17 +1,10 @@
548
-# This file is generated by salt - don't touch
549
-# Hosted on https://gitlab.suse.de/openqa/salt-pillars-openqa
550
-# numofworkers: 10
551
-
552
 [global]
553
-HOST=openqa.suse.de
554
-CACHEDIRECTORY=/var/lib/openqa/cache
555
-LOG_LEVEL=debug
556
-WORKER_CLASS=qemu_x86_64,qemu_x86_64_staging,tap,openqaworker7
557
-WORKER_HOSTNAME=10.160.1.101
558
-
559
-[1]
560
-WORKER_CLASS=qemu_x86_64,qemu_x86_64_staging,tap,qemu_x86_64_ibft,openqaworker7
561
+HOST=http://openqa1-opensuse
562
+WORKER_HOSTNAME=192.168.112.12
563
+CACHEDIRECTORY = /var/lib/openqa/cache
564
+CACHELIMIT = 50
565
+WORKER_CLASS = openqaworker7,qemu_x86_64
566
567
-[openqa.suse.de]
568
-TESTPOOLSERVER = rsync://openqa.suse.de/tests
569
+[http://openqa1-opensuse]
570
+TESTPOOLSERVER = rsync://openqa1-opensuse/tests
571
```
572
573
* Remove OSD specifics
574
575
```
576
systemctl disable --now auto-update.timer salt-minion telegraf
577
for i in  NPI SUSE_CA telegraf-monitoring; do zypper rr $i; done
578
zypper -n dup --force-resolution --allow-vendor-change
579
```
580
581
* 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:
582
583
```
584
zypper -n in transactional-update
585
systemctl enable --now transactional-update.timer rebootmgr
586
```
587
588
* Enable apparmor
589
590
```
591
zypper -n in apparmor-utils
592
systemctl unmask apparmor
593
systemctl enable --now apparmor
594
```
595
596
* Switch firewall from SuSEfirewall2 to firewalld
597
598
```
599
zypper -n in firewalld && zypper -n rm SuSEfirewall2
600
systemctl enable --now firewalld
601
firewall-cmd --zone=trusted --add-interface=br1
602
firewall-cmd --set-default-zone trusted
603
firewall-cmd --zone=trusted --add-masquerade
604
```
605
606
* Copy over special openSUSE UEFI staging images, see #63382
607
* Check operation with a single openQA worker instance:
608
609
```
610
systemctl enable --now openqa-worker.target openqa-worker@1
611
```
612
613
* Test with an openQA job cloned from a production job, e.g. for openqaworker7
614
615
```
616
openqa-clone-job --within-instance https://openqa.opensuse.org/t${id} WORKER_CLASS=openqaworker7
617
```
618
619
* After the latest openQA job could successfully finish enable more worker instances
620
621
```
622
systemctl unmask openqa-worker@{2..14} && systemctl enable --now openqa-worker@{2..14}
623
```
624
625
* Monitor if nightly update works, e.g. look for journal entry:
626
627
```
628
Mar 01 00:08:26 openqaworker7 transactional-update[10933]: Calling zypper up
629
630
Mar 01 00:08:51 openqaworker7 transactional-update[10933]: transactional-update finished - informed rebootmgr
631
Mar 01 00:08:51 openqaworker7 systemd[1]: Started Update the system.
632
633
Mar 01 03:30:00 openqaworker7 rebootmgrd[40760]: rebootmgr: reboot triggered now!
634
635
Mar 01 03:36:32 openqaworker7 systemd[1]: Reached target openQA Worker.
636
```
637 93 okurz
638 95 okurz
## Distribution upgrades
639
640 101 okurz
Consider using https://github.com/okurz/auto-upgrade/blob/master/auto-upgrade or manual:
641
642 95 okurz
```
643 98 livdywan
new_version=15.2 # Specify the target release
644 1 alarrosa
645 98 livdywan
# Change the release via the special $releasever
646 1 alarrosa
. /etc/os-release
647
sed -i -e "s/${VERSION_ID}/\$releasever/g" /etc/zypp/repos.d/*
648
zypper --releasever=$new_version ref
649
test -f /etc/openqa/openqa.ini && sudo -u geekotest /opt/openqa-scripts/dump-psql
650
zypper -n --releasever=$new_version dup --auto-agree-with-licenses --replacefiles --download-in-advance
651
652
# Check config files for relevant changes
653 95 okurz
rpmconfigcheck
654
for i in $(cat /var/adm/rpmconfigcheck) ; do vimdiff ${i%.rpm*} $i ; done
655
rm $(cat /var/adm/rpmconfigcheck)
656
657 98 livdywan
reboot
658
systemctl --failed
659 1 alarrosa
```
660 97 okurz
661 109 okurz
## Remote management with IPMI
662 95 okurz
663 119 livdywan
o3 and osd worker machines are controllable over IPMI from within the SUSE network, see [openqa/workerconf.sls](https://gitlab.suse.de/openqa/salt-pillars-openqa/-/blob/master/openqa/workerconf.sls) for the commands.
664
It is recommended to use [shell aliases](https://gitlab.suse.de/openqa/salt-pillars-openqa#get-ipmi-definition-aliases) for convenience.
665 109 okurz
666
`ipmitool` can sometimes behave unreliably. It seems (to okurz) as if ipmitool version ipmitool-1.8.18+git20200916.1245aaa387dc from openSUSE Tumbleweed or Factory or the "systemsmanagement" OBS repo is more reliable than the version supplied with openSUSE Leap 15.2 (See #80544#note-14) and given a stable internet connection it is certainly possible to have a consistent serial console experience.
667
668 110 okurz
To ensure that remotely controlled machines power on automatically after a power loss ensure to set the power restory policy to "previous", especially for new machines. Using https://gitlab.suse.de/openqa/salt-pillars-openqa/#get-ipmi-definition-aliases :
669
670
```
671
IFS=$'\n'; for i in $(sed 's/^alias .*="\(.*\)"/\1/' ~/.openqa_ipmi_aliases); do eval "$i" chassis policy previous; done
672
```
673
674 109 okurz
## openQA infrastructure needs (o3 + osd)
675
676 115 okurz
TL;DR: new OSD ARM workers needed, missing redundancy for o3-ppc, rest is needing replacement as nearly all current hardware is out of vendor provided maintenance (as of 2021-05), SSD storage for o3 would be good
677 93 okurz
678
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.
679
680
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 
681
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.
682 107 okurz
683 117 okurz
## Setup guide for new machines
684
685
* Make sure to set /etc/salt/minion_id to the FQDN (see #90875#note-2 for reference)
686
* Add to salt using https://gitlab.suse.de/openqa/salt-states-openqa
687
688 120 okurz
## Take machines out of salt-controlled production
689
690
E.g. for investigation or development or manual maintenance work
691 118 okurz
692
```
693
ssh osd "sudo salt-key -y -d $hostname"
694
ssh $hostname "sudo systemctl disable --now telegraf openqa-worker-auto-restart@\*"
695
```
696
697
## Bring back machines into production
698
699
```
700
ssh osd "sudo salt-key -a -d $hostname && sudo salt --state-output=changes $hostname state.apply"
701
```
702
703
Depending on your actions further manual cleanup might be necessary, e.g. `ssh $hostname "sudo systemctl unmask telegraf salt-minion"`
704 117 okurz
705 122 okurz
## Backup
706
707
Automatic backup for the o3 webui host introduced with https://gitlab.suse.de/okurz/backup-server-salt/tree/master/rsnapshot covering so far /etc and the SQL database dumps.
708
709 109 okurz
## Best practices for infrastructure work
710 107 okurz
711
* Same as in OSD deployment we should look for failed grafana alerts if users report something suspicious
712
* Collect all the information between "last good" and "first bad" and then also find the git diff in openqa/salt-states-openqa
713
* Apply proper "scientific method" with written down hypotheses, experiments and conclusions in tickets, follow https://progress.opensuse.org/projects/openqav3/wiki#Further-decision-steps-working-on-test-issues
714
* Keep salt states to describe what should *not* be there
715
* Try out older btrfs snapshots in systems for crosschecking and boot with disabled salt. In the kernel cmdline append `systemd.mask=salt-minion.service`
716
* Team should conduct a work backlog check on a daily base, e.g. look for urgent tickets related to infrastructure problems
717 116 okurz
* Test reboot stability of machines with commands like in https://progress.opensuse.org/issues/78010#note-31 e.g.
718
719
```
720
for run in {01..30}; do for host in $host; do echo -n "run: $run, $host: ping .. " && timeout -k 5 600 sh -c "until ping -c30 $host >/dev/null; do :; done" && echo -n "ok, ssh .. " && timeout -k 5 600 sh -c "until nc -z -w 1 $host 22; do :; done" && echo -n "ok, uptime/reboot: " && ssh $host "uptime && sudo reboot" && sleep 120 || break; done || break; done
721
```