Project

General

Profile

Wiki » History » Version 169

osukup, 2022-03-22 18:05

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 165 okurz
If you are looking for entry level issues to contribute to please look into the section [[Wiki#Where-to-contribute|Where to contribute]]
9 70 szarate
10 14 okurz
{{toc}}
11
12 3 okurz
# Organisational
13 1 alarrosa
14 51 okurz
## ticket workflow
15
16
The following ticket statuses are used together and their meaning is explained:
17
18 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.
19 73 riafarov
* *Workable*: The ticket has been refined and is ready to be picked.
20
* *In Progress*: Assignee is actively working on the ticket.
21 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)
22 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.
23 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.
24 51 okurz
* *Rejected*: The issue is considered invalid, should not be done, is considered out of scope.
25
* *Closed*: As this can be set only by administrators it is suggested to not use this status.
26
27
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.
28
29 80 okurz
## ticket categories
30
31
* *Concrete Bugs*: Regressions, crashes, error messages
32
* *Feature requests*: Ideas or wishes for extension, enhancement, improvement
33
* *Organisational*: Organisational tasks within the project(s), not directly code related
34
* *Support*: Support of users, usage problems, questions
35
36 1 alarrosa
Please avoid the use of other, deprecated categories
37
38
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.
39 100 okurz
40
## Epics and Sagas
41
42
[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 
43 83 okurz
44 13 okurz
## ticket templates
45
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.
46
47 71 nicksinger
### Defects
48 13 okurz
49
Subject: `<Short description, example: "openQA dies when triggering any Windows ME tests">`
50
51 1 alarrosa
52 13 okurz
```
53 71 nicksinger
## Observation
54 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>
55
56 71 nicksinger
## Steps to reproduce
57 1 alarrosa
* <do this>
58 13 okurz
* <do that>
59 1 alarrosa
* <observe result>
60 13 okurz
61 71 nicksinger
## Problem
62 13 okurz
<problem investigation, can also include different hypotheses, should be labeled as "H1" for first hypothesis, etc.>
63
64 71 nicksinger
## Suggestion
65 123 okurz
* <what to do as a first step>
66
* <Fix the actual problem>
67
* <Consider fixing the design>
68
* <Consider fixing the team's process>
69
* <Consider to explore further>
70 13 okurz
71 71 nicksinger
## Workaround
72 13 okurz
<example: retrigger job>
73
```
74
75
example ticket: #10526
76
77 104 okurz
For tickets referencing "auto_review" see
78
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
79
for a suggested template snippet.
80
81 72 nicksinger
### Feature requests
82 13 okurz
83
Subject: `<Short description, example: "grub3 btrfs support" (feature)>`
84
85
86
```
87
## User story
88
<As a <role>, I want to <do an action>, to <achieve which goal> >
89
90 72 nicksinger
## Acceptance criteria
91 13 okurz
* <**AC1:** the first acceptance criterion that needs to be fulfilled to do this, example: Clicking "restart button" causes restart of the job>
92
* <**AC2:** also think about the "not-actions", example: other jobs are not affected>
93
94 72 nicksinger
## Tasks
95 13 okurz
* <first task to do as an easy starting point>
96 69 okurz
* <what do do next, all tasks optionally with an effort estimation in hours, e.g. "(0.5-2h)">
97 13 okurz
* <optional: mark "optional" tasks>
98
99 72 nicksinger
## Further details
100 17 okurz
<everything that does not fit into above sections>
101 13 okurz
```
102
103
example ticket: #10212
104
105 62 SLindoMansilla
## Further decision steps working on test issues
106 61 SLindoMansilla
107 62 SLindoMansilla
Test issues could be one of the following sources. Feel free to use the following template in tickets as well
108 1 alarrosa
109 62 SLindoMansilla
```
110
## Problem
111
* **H1** The product has changed
112
 * **H1.1** product changed slightly but in an acceptable way without the need for communication with DEV+RM --> adapt test
113
 * **H1.2** product changed slightly but in an acceptable way found after feedback from RM --> adapt test
114
 * **H1.3** product changed significantly --> after approval by RM adapt test
115 61 SLindoMansilla
116 62 SLindoMansilla
* **H2** Fails because of changes in test setup
117
 * **H2.1** Our test hardware equipment behaves different
118
 * **H2.2** The network behaves different
119
120
* **H3** Fails because of changes in test infrastructure software, e.g. os-autoinst, openQA
121
* **H4** Fails because of changes in test management configuration, e.g. openQA database settings
122
* **H5** Fails because of changes in the test software itself (the test plan in source code as well as needles)
123
* **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
124
```
125 25 okurz
126
## pull request handling on github
127
128
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.
129
130
* **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
131
* **wip**: Marked by the reviewee itself as "[WIP]" or "[DO-NOT-MERGE]" or similar
132
* **question**: Questions to the reviewee, not answered yet
133 54 okurz
134
## Where to contribute?
135 1 alarrosa
136
If you want to help openQA development you can take a look into the existing [issues](https://progress.opensuse.org/projects/openqav3/issues).
137 167 okurz
You can start with
138 168 okurz
* [entrance level issues](https://progress.opensuse.org/projects/openqav3/search?q=entrance+level+issue&open_issues=1)
139 167 okurz
* issues tagged as [easy](https://progress.opensuse.org/projects/openqav3/issues?utf8=%E2%9C%93&set_filter=1&sort=id%3Adesc&f%5B%5D=status_id&op%5Bstatus_id%5D=o&f%5B%5D=issue_tags&op%5Bissue_tags%5D=%3D&v%5Bissue_tags%5D%5B%5D=easy&f%5B%5D=&c%5B%5D=subject&c%5B%5D=project&c%5B%5D=status&c%5B%5D=assigned_to&c%5B%5D=fixed_version&c%5B%5D=is_private&c%5B%5D=due_date&c%5B%5D=relations&group_by=&t%5B%5D=)
140
* issues tagged as [beginner](https://progress.opensuse.org/projects/openqav3/issues?utf8=%E2%9C%93&set_filter=1&sort=id%3Adesc&f%5B%5D=status_id&op%5Bstatus_id%5D=o&f%5B%5D=issue_tags&op%5Bissue_tags%5D=%3D&v%5Bissue_tags%5D%5B%5D=beginner&f%5B%5D=&c%5B%5D=subject&c%5B%5D=project&c%5B%5D=status&c%5B%5D=assigned_to&c%5B%5D=fixed_version&c%5B%5D=is_private&c%5B%5D=due_date&c%5B%5D=relations&group_by=&t%5B%5D=)
141 168 okurz
* ideas from #65271
142 165 okurz
143
There are also some "always valid" tasks to be working on:
144 54 okurz
145
* *improve test coverage*:
146
 * *user story*: As openqa backend as well as test developer I want better test coverage of our projects to reduce technical debt
147
 * *acceptance criteria*: test coverage is significantly higher than before
148
 * *suggestions*: check current coverage in each individual project (os-autoinst/openQA/os-autoinst-distri-opensuse) and add tests as necessary
149 28 okurz
150 1 alarrosa
# Use cases
151 40 okurz
152 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.
153
154 6 okurz
## Use case 1
155 4 okurz
**User:** QA-Project Managment
156 1 alarrosa
**primary actor:** QA Project Manager, QA Team Leads
157
**stakeholder:** Directors, VP
158 7 okurz
**trigger:** product milestones, providing a daily status
159 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.“
160 28 okurz
	
161 4 okurz
## Use case 2
162 1 alarrosa
**User:** openQA-Admin
163
**primary actor:** Backend-Team
164 4 okurz
**stakeholder:** Qa-Prjmgr, QA-TL, openQA Tech-Lead
165 7 okurz
**trigger:** Bugs, features, new testcases
166 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.“
167 28 okurz
168 1 alarrosa
## Use case 3
169
**User:** QA-Reviewer
170
**primary actor:** QA-Team
171 4 okurz
**stakeholder:** QA-Prjmgr, Release-Mgmt, openQA-Admin
172 7 okurz
**trigger:** every new build
173
**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.“
174 28 okurz
175 1 alarrosa
## Use case 4
176
**User:** Testcase-Contributor
177 4 okurz
**primary actor:** All development teams, Maintenance QA
178 5 okurz
**stakeholder:** QA-Reviewer, openQA-Admin, openQA Tech-Lead
179 40 okurz
**trigger:** features, new functionality, bugs, new product/package
180 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.“
181 28 okurz
182 4 okurz
## Use case 5
183
**User:** Release-Mgmt
184
**primary actor:** Release Manager
185 1 alarrosa
**stakeholder:** Directors, VP, PM, TAMs, Partners
186 7 okurz
**trigger:** Milestones
187
**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.“
188 28 okurz
189 4 okurz
## Use case 6
190
**User:** Staging-Admin
191
**primary actor:** Staging-Manager for the products
192 1 alarrosa
**stakeholder:** Release-Mgmt, Build-Team
193
**trigger:** every single submission to projects
194 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.“
195
196
## Use case 7
197
**User:** Bug investigator
198
**primary actor:** Any bug assignee for openQA observed bugs
199
**stakeholder:** Developer
200
**trigger:** bugs
201 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.“
202 15 okurz
203 8 okurz
# Thoughts about categorizing test results, issues, states within openQA
204
by okurz
205
206
When reviewing test results it is important to distinguish between different causes of "failed tests"
207
208
## Nomenclature
209
210 58 okurz
### Test status categories
211 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".
212 10 okurz
213 1 alarrosa
Another common but potentially ambiguous categorization:
214 10 okurz
215
* *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
216
* *failing*: the test is behaving as expected, but the test output is a fail --> "true positive"
217
* *working*: the test is behaving as expected (with no comment regarding the result, though some might ambiguously imply 'result is negative')
218
* *passing*: the test is behaving as expected, but the result is a success --> "true negative"
219 8 okurz
220 9 okurz
If in doubt declare a test as "broken". We should review the test and examine if it is behaving as expected.
221 10 okurz
222 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/
223
224 10 okurz
### Priorization of work regarding categories
225 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".
226 11 okurz
227
## Further categorization of statuses, issues and such in testing, especially automatic tests
228
By okurz
229
230
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.
231
While used for naming it should also be used as a decision tree and can be followed from the top following each branch.
232
233
### Categorization scheme
234
235
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.
236
Every leaf of the tree must have an action assigned to it.
237 12 okurz
238 11 okurz
1 **failed** (ZULU)
239
11 new (passed->failed) (YANKEE)
240
111 product issue ("true positive") (WHISKEY)
241 44 okurz
1111 unfiled issue (SIERRA)
242 11 okurz
11111 hard issue (openqa *fail*) (KILO)
243
111121 critical / potential ship stopper (INDIA) --> immediately file bug report with "ship_stopper?" flag; opt. inform RM directly
244 44 okurz
111122 non-critical hard issue (HOTEL) --> file bug report
245 11 okurz
11112 soft issue (openqa *softfail* on job level, not on module level) (JULIETT) --> file bug report on failing test module
246
1112 bugzilla bug exists (ROMEO)
247
11121 bug was known to openqa / openqa developer --> cross-reference (bug->test, test->bug) AND raise review process issue, improve openqa process
248
11122 bug was filed by other sources (e.g. beta-tester) --> cross-reference (bug->test, test->bug)
249
112 test issue ("false positive") (VICTOR)
250
1121 progress issue exists (QUEBEC) --> cross-reference (issue->test, test->issue)
251
1122 unfiled test issue (PAPA)
252
11221 easy to do w/o progress issue
253
112211 need needles update --> re-needle if sure, TODO how to notify?
254
112212 pot. flaky, timeout
255
1122121 retrigger yields PASS --> comment in progress about flaky issue fixed
256
1122122 reproducible on retrigger --> file progress issue
257
11222 needs progress issue filed --> file progress issue
258
12 existing / still failing (failed->failed) (XRAY)
259
121 product issue (UNIFORM)
260
1211 unfiled issue (OSCAR) --> file bug report AND raise review process issue (why has it not been found and filed?)
261
1212 bugzilla bug exists (NOVEMBER) --> ensure cross-reference, also see rules for 1112 ROMEO
262
122 test issue (TANGO)
263
1221 progress issue exists (MIKE) --> monitor, if persisting reprioritize test development work
264
1222 needs progress issue filed (LIMA) --> file progress issue AND raise review process issue, see 1211 OSCAR
265
2 **passed** (ALFA)
266
21 stable (passed->passed) (BRAVO)
267
211 existing "true negative" (DELTA) --> monitor, maybe can be made stricter
268
212 existing "false negative" (ECHO) --> needs test improvement
269
22 fixed (failed->passed) (CHARLIE)
270
222 fixed "true negative" (FOXTROTT) --> TODO split monitor, see 211 DELTA
271
2221 was test issue --> close progress issue
272
2222 was product issue
273
22221 no bug report exists --> raise review process issue (why was it not filed?)
274
22222 bug report exists
275
222221 was marked as RESOLVED FIXED
276
221 fixed but "false negative" (GOLF) --> potentially revert test fix, also see 212 ECHO
277 41 okurz
278
279 11 okurz
Priority from high to low: INDIA->OSCAR->HOTEL->JULIETT->…
280 35 okurz
281 142 okurz
# Important ticket queries
282
283
* All auto-review tickets: https://progress.opensuse.org/projects/openqav3/issues?query_id=697 , see 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 for further information regarding auto-review
284
* All auto-review+force-result tickets: https://progress.opensuse.org/projects/openqav3/issues?query_id=700
285
286 82 okurz
# Proposals for uses of labels
287 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)).
288
289
List of proposed labels with their meaning and where they could be applied.
290
291
* ***`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):
292
293
```
294
label:fixed_Build1501
295
296
t#382919
297
```
298 24 okurz
299
* ***`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):
300
301
```
302
label:needles_added
303
304
needles for https://github.com/os-autoinst/os-autoinst-distri-opensuse/pull/1353 were missing, added by jpupava in the meantime.
305 60 mgriessmeier
```
306
307 67 okurz
# s390x Test Organisation
308 1 alarrosa
309 67 okurz
See the following picture for a graphical overview of the current s390x test infrastructure at SUSE:
310
311
![SUSE s390x test infrastructure](qa_sle_openqa_s390x_test_infrastructure.jpg)
312
313 75 okurz
## Upgrades
314 60 mgriessmeier
315
### on z/VM 
316
#### special Requirements
317
318
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,
319
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)
320
321
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:
322
323 75 okurz
1. migration_offline_sle12sp2_zVM_preparation 
324
1. migration_offline_sle12sp2_zVM (START_AFTER_TEST=#1) 
325
1. migration_offline_sle12sp2_allpatterns_zVM_preparation (START_AFTER_TEST=#2) 
326
1. migration_offline_sle12sp2_allpatterns_zVM 
327
1. ...
328 66 okurz
329
This scheme ensures that all actual Upgrade jobs are finding the prepared system and are able to upgrade it
330
331
### on z/KVM
332
333 67 okurz
No special requirements anymore, see details in #18016
334 77 nicksinger
335
## Automated z/VM LPAR installation with openQA using qnipl
336
337 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.
338 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.
339
340
### Setup
341
342
1. Get a shared disk for all your LPARs
343
  * Normally this can easily done by infra/gschlotter
344
  * Disks needs to be connected to all guests which should be able to network-boot
345
1. Boot a fully installed SLES on one of the LPARs to start preparing the shared-disk
346
1. Put a DOS partition table on the disk and create one single, large partition on there
347
1. Put a FS on there. Our first test was on ext2 and it worked flawlessly in our attempts
348
1. Install `zipl` (The s390x bootloader from IBM) on this partition
349
  * A simple and sufficient config can be found in [poo#33682](https://progress.opensuse.org/issues/33682)
350
1. clone [`qnipl`](https://github.com/nicksinger/dracut-qnipl) to your dracut modules (e.g. /usr/lib/dracut/modules.d/95qnipl)
351
1. Include the module named `qnipl` to your dracut modules for initramfs generation
352
  * e.g. in /etc/dracut.conf.d/99-qnipl.conf add: `add_dracutmodules+=qnipl`
353
1. Generate your initramfs (e.g. `dracut -f -a "url-lib qnipl" --no-hostonly-cmdline /tmp/custom_initramfs`)
354
  * Put the initramfs next to your kernel binary on the partition you want to prepare
355
1. From now on you can use `snipl` to boot any LPAR connected with this shared disk from network
356
  * 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"`
357
  * `--ossparms_scsiload` is then evaluated and used by `qnipl` to kexec into the installer with the (for the installer) needed parameters
358
359
### Further details
360
361 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!
362 84 okurz
363 109 okurz
# Infrastructure setup for o3 (openqa.opensuse.org) and osd (openqa.suse.de)
364 1 alarrosa
365 109 okurz
## o3 (openqa.opensuse.org)
366
367 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.
368 88 okurz
369 141 okurz
### Accessing the o3 infrastructure
370
371
The o3 webui host as well 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 on the o3 webui host to be able to login.
372
373
To give access for a new user an existing admin can do the following:
374
375
```
376
sudo useradd -G users,trusted --create-home $user
377
echo "$ssh_key_from_user" | sudo tee -a /home/$user/.ssh/authorized_keys
378
```
379
380
#### SSH configuration
381
382
To easily access all hosts behind the jump host you can use the following config for your ssh client (`~.ssh/config`):
383
384
```
385
Host ariel
386
  HostName gate.opensuse.org
387
  Port 2213
388
389
# Note that %h as understood by -W needs the real host, aliases won't work:
390
# kex_exchange_identification: Connection closed by remote host
391
# Connection closed by UNKNOWN port 65535`
392
Host *.opensuse.org
393
  ProxyCommand ssh -q -A -x ariel -W %h:%p
394
```
395
396
**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.
397
398
The workers can only be accessed from "ariel", not directly. One can use password authentication on the workers using the root account. Ask existing admins for the root password. It is suggested that you use key-based authentication. For this put your ssh keys on all the workers, e.g. using the above configuration and `ssh-copy-id`.
399
400
**Notice:** Some machines are connected to the o3 openQA host from other networks and might need different ways of access, at time of writing:
401
402
* Remote (owner: @ggardet_arm):
403
 * ip-10-0-0-58
404
 * oss-cobbler-03
405
 * siodtw01 (for tests on Raspberry Pi 2,3,4)
406
407
### Manual command execution on o3 workers
408
409
To execute commands manually on all workers within the o3 infrastructure one can do for example the following:
410
411
```
412
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
413
```
414
415
mind the correct list of machines.
416
417 91 okurz
### Automatic update of o3
418 92 okurz
419
o3 is automatically deployed on a daily base, that includes both the webUI host as well as the workers.
420 111 okurz
421
#### Automatic update of o3 webUI host
422
423
Done with cron job in `/etc/cron.d/auto-update`
424
425
#### Recurring automatic update of openQA workers
426
427
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.
428
429
This was for a number of reasons including:
430 109 okurz
431 96 okurz
* Getting all the machines consistent after a few years of drift
432
* Making it easier to keep them consistent by leveraging a read only root filesystem
433
* Guaranteeing rollbackability by using transactional updates
434 102 okurz
435 1 alarrosa
This was done by rbrown also to fulfill the prerequisite to getting them viable for multi-machine testing
436 102 okurz
437
These systems currently patch themselves and reboot automatically in the default maintenance window of 0330-0500 CET/CEST.
438 112 okurz
439 102 okurz
On problems this could be changed in the following way:
440
441 109 okurz
* Edit the maintenance window in /etc/rebootmgr.conf
442 105 nicksinger
* Disable the automatic reboot by "systemctl disable rebootmgr.service"
443
* Disable the automatic patching by "systemctl disable transactional-update.timer"
444
445
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.
446
447
For manual investigation https://github.com/kubic-project/microos-toolbox can be helpful
448
449
#### Rollback of updates
450 140 livdywan
451
Updates on workers can be rolled back using `transactional-update` affecting the transactional workers (others are likely not updated that often):
452
453 105 nicksinger
```
454
for i in aarch64 openqaworker1 openqaworker4 openqaworker7 power8 imagetester rebel; do echo $i && ssh root@$i "transactional-update rollback last && reboot"; done
455
```
456
457
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
458 108 SLindoMansilla
459
#### Debugging qemu SUTs in openqa.opensuse.org
460
461
SUT: System Under Test
462
463
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).
464
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.
465
466
```
467
ssh -p 2213 -L LOCAL_PORT:WORKER_HOSTNAME:QEMU_VNC_PORT USERNAME@gate.opensuse.org
468
```
469
470
For example, if user **bernhard**, wants to connect to openqaworker7:11, and wants to use local port **43043**
471
Being the IP of openqaworker7 **192.168.112.12**
472
And the VNC channel port of openqa-worker@11 **6001** (5990 + 11)
473
474
##### 1. Create SSH tunnel with port forwarding
475
* on laptop shell 1: ssh -p 2213 -L 43043:192.168.112.12:6001 bernhard@gate.opensuse.org
476 1 alarrosa
* Keep shell open to keep the tunnel open and the port forwarding
477 108 SLindoMansilla
478 1 alarrosa
##### 2. Open vncviewer
479
* on laptop shell 2: vncviewer -Shared localhost:43043
480
* `-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.
481
482 109 okurz
### AArch64 specific configurations on o3
483 1 alarrosa
484 109 okurz
On o3, the aarch64 workers need additional configuration.
485
486 127 dheidler
#### Setup HugePages
487
488
You need to setup HugePages support to improve performances with qemu VM and to match current aarch64 `MACHINE` configuration.
489
For the D05 machine, the configuration is: `40` pages with a size of `1G`.
490
If there are some permissions issues on `/dev/hugepages/`, check https://progress.opensuse.org/issues/53234
491
492 126 dheidler
### o3 s390 workers
493
494
The s390 workers for openQA are running within podman containers on openqaworker1.
495
The containers are started using systemd but the unit files are specific to the containers and will end up in a restart-loop if this fact is ignored. Whenever the containers are recreated, the systemd files have to be recreated.
496
497
The containers are started like this (for i=101…104):
498
499
```
500
i=101
501 109 okurz
podman run -d -h openqaworker1_container --name openqaworker1_container_$i -p $(python3 -c"p=${i}*10+20003;print(f'{p}:{p}')") -e OPENQA_WORKER_INSTANCE=$i -v /opt/s390x_rebel_replacement:/etc/openqa -v /var/lib/openqa/share:/var/lib/openqa/share registry.opensuse.org/devel/openqa/containers15.2/openqa_worker:latest
502
(cd /etc/systemd/system/; podman generate systemd -f -n openqaworker1_container_$i --restart-policy always)
503
systemctl daemon-reload
504
systemctl enable container-openqaworker1_container_$i
505
```
506
507 133 okurz
As alternative s390x workers can run on the host "rebel" as well. Be aware that openQA workers accessing the same s390x instances must not run in parallel so only enable one worker instance per s390x instance at a time (See https://progress.opensuse.org/issues/97658 for details).
508
509 121 okurz
### Monitoring
510
511
There is an internal munin instance on o3. Anyone wanting to look at the HTML pages, do this:
512
```
513
rsync -a o3:/srv/www/htdocs/munin ~/o3-munin/ 
514
```
515
(where "o3" is configured in your ssh config of course)
516
517 89 ggardet_arm
## Mitigation of boot failure or disk issues
518
519
### Worker stuck in recovery
520
521
Check disk health and consider manual fixup of mount points, e.g.:
522
523
```
524
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
525
```
526
527 106 okurz
## PPC specific configurations
528
529
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).
530 89 ggardet_arm
531 84 okurz
## Moving worker from osd to o3
532
533
* 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
534
* Ensure network is configured for DHCP
535
* Instruct SUSE-IT to change VLAN for machine from 2 to 662 (example: https://infra.nue.suse.com/SelfService/Display.html?id=16458)
536
* Remove from osd:
537
538
```
539
salt-key -y -d openqaworker7.suse.de
540
```
541
542
* Add entry on o3 to `/etc/dnsmasq.d/openqa.conf` with MAC address, e.g.
543
544
```
545
dhcp-host=54:ab:3a:24:34:b8,openqaworker7
546
```
547
548
* Add entry to `/etc/hosts` which dnsmasq picks up to give out a DHCP lease, e.g.
549
550
```
551
192.168.112.12   openqaworker7.openqanet.opensuse.org openqaworker7
552
```
553
554 85 okurz
* Adapt NFS mount point
555
556
```
557
sed -i '/openqa\.suse\.de/d' /etc/fstab && echo 'openqa1-opensuse:/ /var/lib/openqa/share nfs4 ro,fsc 0 0' >> /etc/fstab
558
```
559
560 84 okurz
* Reload dnsmasq with `systemctl restart dnsmasq`
561
* Restart network on machine (over IMPI) using `systemctl restart network` and monitor in o3:`journalctl -f -u dnsmasq` until address is assigned, e.g.:
562
563
```
564
Feb 29 10:48:30 ariel dnsmasq[28105]: read /etc/hosts - 30 addresses
565
Feb 29 10:48:54 ariel dnsmasq-dhcp[28105]: DHCPREQUEST(eth1) 10.160.1.101 54:ab:3a:24:34:b8
566
Feb 29 10:48:54 ariel dnsmasq-dhcp[28105]: DHCPNAK(eth1) 10.160.1.101 54:ab:3a:24:34:b8 wrong network
567
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPDISCOVER(eth1) 54:ab:3a:24:34:b8
568
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPOFFER(eth1) 192.168.112.12 54:ab:3a:24:34:b8
569
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPREQUEST(eth1) 192.168.112.12 54:ab:3a:24:34:b8
570
Feb 29 10:49:10 ariel dnsmasq-dhcp[28105]: DHCPACK(eth1) 192.168.112.12 54:ab:3a:24:34:b8 openqaworker7
571 85 okurz
```
572
573
* Ensure all mountpoints up
574
575
```
576
mount -a
577 84 okurz
```
578
579
* Change root password to o3 one
580 86 okurz
* Allow ssh password authentication: `sed -i 's/^PasswordAuthentication/#&/' /etc/ssh/sshd_config && systemctl restart sshd`
581 84 okurz
* Add personal ssh key to machine, e.g. openqaworker7:/root/.ssh/authorized_keys
582
* Update /etc/openqa/client.conf with the same key as used on other workers for "openqa1-opensuse"
583
* Update /etc/openqa/workers.ini with similar config as used on other workers, e.g. based on openqaworker4, example:
584
585
```
586
# diff -Naur /etc/openqa/workers.ini{.osd,}
587
--- /etc/openqa/workers.ini.osd 2020-02-29 15:21:47.737998821 +0100
588
+++ /etc/openqa/workers.ini     2020-02-29 15:22:53.334464958 +0100
589
@@ -1,17 +1,10 @@
590
-# This file is generated by salt - don't touch
591
-# Hosted on https://gitlab.suse.de/openqa/salt-pillars-openqa
592
-# numofworkers: 10
593
-
594
 [global]
595
-HOST=openqa.suse.de
596
-CACHEDIRECTORY=/var/lib/openqa/cache
597
-LOG_LEVEL=debug
598
-WORKER_CLASS=qemu_x86_64,qemu_x86_64_staging,tap,openqaworker7
599
-WORKER_HOSTNAME=10.160.1.101
600
-
601
-[1]
602
-WORKER_CLASS=qemu_x86_64,qemu_x86_64_staging,tap,qemu_x86_64_ibft,openqaworker7
603
+HOST=http://openqa1-opensuse
604
+WORKER_HOSTNAME=192.168.112.12
605
+CACHEDIRECTORY = /var/lib/openqa/cache
606
+CACHELIMIT = 50
607
+WORKER_CLASS = openqaworker7,qemu_x86_64
608
609
-[openqa.suse.de]
610
-TESTPOOLSERVER = rsync://openqa.suse.de/tests
611
+[http://openqa1-opensuse]
612
+TESTPOOLSERVER = rsync://openqa1-opensuse/tests
613
```
614
615
* Remove OSD specifics
616
617
```
618
systemctl disable --now auto-update.timer salt-minion telegraf
619
for i in  NPI SUSE_CA telegraf-monitoring; do zypper rr $i; done
620
zypper -n dup --force-resolution --allow-vendor-change
621
```
622
623
* 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:
624
625
```
626
zypper -n in transactional-update
627
systemctl enable --now transactional-update.timer rebootmgr
628
```
629
630
* Enable apparmor
631
632
```
633
zypper -n in apparmor-utils
634
systemctl unmask apparmor
635
systemctl enable --now apparmor
636
```
637
638
* Switch firewall from SuSEfirewall2 to firewalld
639
640
```
641
zypper -n in firewalld && zypper -n rm SuSEfirewall2
642
systemctl enable --now firewalld
643
firewall-cmd --zone=trusted --add-interface=br1
644
firewall-cmd --set-default-zone trusted
645
firewall-cmd --zone=trusted --add-masquerade
646
```
647
648
* Copy over special openSUSE UEFI staging images, see #63382
649
* Check operation with a single openQA worker instance:
650
651
```
652
systemctl enable --now openqa-worker.target openqa-worker@1
653
```
654
655
* Test with an openQA job cloned from a production job, e.g. for openqaworker7
656
657
```
658
openqa-clone-job --within-instance https://openqa.opensuse.org/t${id} WORKER_CLASS=openqaworker7
659
```
660
661
* After the latest openQA job could successfully finish enable more worker instances
662
663
```
664
systemctl unmask openqa-worker@{2..14} && systemctl enable --now openqa-worker@{2..14}
665
```
666
667
* Monitor if nightly update works, e.g. look for journal entry:
668
669
```
670
Mar 01 00:08:26 openqaworker7 transactional-update[10933]: Calling zypper up
671
672
Mar 01 00:08:51 openqaworker7 transactional-update[10933]: transactional-update finished - informed rebootmgr
673
Mar 01 00:08:51 openqaworker7 systemd[1]: Started Update the system.
674
675
Mar 01 03:30:00 openqaworker7 rebootmgrd[40760]: rebootmgr: reboot triggered now!
676
677
Mar 01 03:36:32 openqaworker7 systemd[1]: Reached target openQA Worker.
678
```
679 93 okurz
680 95 okurz
## Distribution upgrades
681
682 131 livdywan
**Note:** Performing the upgrade differs slightly depending on the host setup:
683 138 okurz
* On hosts with a writeable `/` you need to enter a root shell i.e. `sudo bash`
684
* Transactional hosts require that you use `transactional-update shell` thereby creating a snapshot which is applied after a reboot, optionally using `--continue` if you want to make further changes to an existing snapshot
685
* Depending on available space it might be necessary to cleanup space before conducting the upgrade, e.g. use `snapper rm <N..M>` to delete older root btrfs snapshots, cleanup unneeded packages, e.g. with https://github.com/okurz/scripts/blob/master/zypper-rm-orphaned and https://github.com/okurz/scripts/blob/master/zypper-rm-unneeded
686
* Consider using https://github.com/okurz/auto-upgrade/blob/master/auto-upgrade or manual (*Tip**: Run this in `screen -d -r || screen` and use e.g. `sudo bash`):
687 101 okurz
688 95 okurz
```
689 137 okurz
new_version=15.3 # Specify the target release
690 1 alarrosa
691 98 livdywan
# Change the release via the special $releasever
692 1 alarrosa
. /etc/os-release
693
sed -i -e "s/${VERSION_ID}/\$releasever/g" /etc/zypp/repos.d/*
694
zypper --releasever=$new_version ref
695
test -f /etc/openqa/openqa.ini && sudo -u geekotest /opt/openqa-scripts/dump-psql
696
zypper -n --releasever=$new_version dup --auto-agree-with-licenses --replacefiles --download-in-advance
697
698
# Check config files for relevant changes
699 95 okurz
rpmconfigcheck
700
for i in $(cat /var/adm/rpmconfigcheck) ; do vimdiff ${i%.rpm*} $i ; done
701
rm $(cat /var/adm/rpmconfigcheck)
702
703 1 alarrosa
reboot
704
systemctl --failed
705 98 livdywan
```
706
707 138 okurz
* Ensure that the upgrade was really successful, e.g. /etc/os-release should show the new version, the above `zypper dup` command should show no more pending actions
708
* Crosscheck for any obvious alerts, pipelines failing, user reports, etc.
709
* Monitor for successful openQA jobs on the host
710 132 livdywan
711 109 okurz
## Remote management with IPMI
712 95 okurz
713 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.
714
It is recommended to use [shell aliases](https://gitlab.suse.de/openqa/salt-pillars-openqa#get-ipmi-definition-aliases) for convenience.
715 109 okurz
716
`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.
717
718 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 :
719
720
```
721
IFS=$'\n'; for i in $(sed 's/^alias .*="\(.*\)"/\1/' ~/.openqa_ipmi_aliases); do eval "$i" chassis policy previous; done
722
```
723
724 130 nicksinger
### Accessing imagetester
725 163 mkittler
Imagetester can't output anything over SOL. Therefore it is necessary to access it over the integrated iKVM console. Unfortunately java-webstart is somewhat broken and requires some extra steps to work:
726 129 nicksinger
727 163 mkittler
1. Access the web interface of the BMC at http://imagetester-ipmi.suse.de and login via the IPMI credentials mentioned in the salt pillars repository.
728
2. Click on the preview image of the "Remote Console Preview" and download the according "launch.jnlp" webstart script.
729 129 nicksinger
3. Grab the required dependencies with curl and place them in a local directory:
730
731
```
732
mkdir /tmp/ikvm
733 163 mkittler
curl -k https://imagetester-ipmi.suse.de:443/liblinux_x86_64__V1.0.3.jar.pack.gz > /tmp/ikvm/liblinux_x86_64__V1.0.3.jar.pack.gz
734
curl -k https://imagetester-ipmi.suse.de:443/iKVM__V1.69.13.0x0.jar.pack.gz > /tmp/ikvm/iKVM__V1.69.13.0x0.jar.pack.gz
735 129 nicksinger
```
736
737 163 mkittler
4. Open the previous downloaded "launch.jnlp" and replace the IP in the first line from e.g. `<jnlp spec="1.0+" codebase="https://10.160.65.195:443/">` to `<jnlp spec="1.0+" codebase="http://127.0.0.1:8080/">`
738
5. Launch some kind of web server which can serve the previously downloaded dependencies for javaws (from /tmp/ikvm). In this example we use python: `python3 -m http.server 8080`
739 129 nicksinger
6. Now you can finally launch the webstart application from your modifies "launch.jnlp" file in a second console: `javaws -nosecurity -jnlp ~/Downloads/launch.jnlp`
740
  * It will ask you how to run the application. You can run it in a sandbox and everything still works
741
7. You should see the monitor output of imagetester now. "Virtual Storage" is also working which allows you to mount an ISO over this remote connection. 
742
743
*Also check https://progress.opensuse.org/issues/96719#note-27 where this was discovered. If you have questions or remarks you can ping @nicksinger*
744 128 okurz
745 109 okurz
## openQA infrastructure needs (o3 + osd)
746
747 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
748 93 okurz
749
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.
750
751
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 
752
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.
753 107 okurz
754 125 okurz
With number of workers and parallel processed tests as well as with the increased number of products tested on OSD and users using the system the workload on OSD constantly increases. CPU load alerts had been seen recently in #96713 and the higher load is visible in https://monitor.qa.suse.de/d/WebuiDb/webui-summary?viewPanel=25 . From time to time should increase the number of CPU cores on the OSD VM due to the higher usage.
755
756 117 okurz
## Setup guide for new machines
757
758
* Make sure to set /etc/salt/minion_id to the FQDN (see #90875#note-2 for reference)
759 135 okurz
* Change IPMI/BMC passwords to use our common passwords instead of default IPMI
760 117 okurz
* Add to salt using https://gitlab.suse.de/openqa/salt-states-openqa
761
762 120 okurz
## Take machines out of salt-controlled production
763
764
E.g. for investigation or development or manual maintenance work
765 118 okurz
766
```
767
ssh osd "sudo salt-key -y -d $hostname"
768
ssh $hostname "sudo systemctl disable --now telegraf openqa-worker-auto-restart@\*"
769
```
770
771
## Bring back machines into production
772
773
```
774 124 dheidler
ssh osd "sudo salt-key -a $hostname && sudo salt --state-output=changes $hostname state.apply"
775 118 okurz
```
776
777
Depending on your actions further manual cleanup might be necessary, e.g. `ssh $hostname "sudo systemctl unmask telegraf salt-minion"`
778 117 okurz
779 122 okurz
## Backup
780
781 134 okurz
Both openqa.opensuse.org and openqa.suse.de run on virtual machine clusters that provide redundancy and differential backup using snapshotting of the involved storage. SUSE-IT currently provides backups going back up to 3 days with two daily backups conducted at 23:10Z and 11:00Z. With this it is possible in cases of catastrophic data loss to recover (raise ticket over https://sd.suse.com in that case). Additionally 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. Fixed assets and testresults are backed up on storage.qa.suse.de (see https://gitlab.suse.de/openqa/salt-states-openqa/-/merge_requests/612)
782 122 okurz
783 139 okurz
### openQA database backups
784
785
Database backups of o3+osd are available on backup.qa.suse.de, acessible over ssh, same credentials as for the OSD infrastructure
786
787 144 livdywan
### Fallback deployment on AWS
788
789
To get an instance running from a backup in case of a disaster, one can be created on AWS with this configuration:
790 149 tinita
791
#### Launch instance
792
793 155 tinita
##### Web Interface, from scratch (only if necessary, otherwise just use the template below)
794 149 tinita
795 144 livdywan
- Ensure your region is **Frankfurt, Germany**
796
- Pick a **t3.large** with `openSUSE Leap` on AWS Marketplace
797 146 mkittler
- Add two disks
798
    - 10 GiB for the root filesystem should be sufficient (can be easily extended later if needed)
799
    - The OSD database alone needs > 30 GiB and results plus assets will also need a lot (e.g. > 4 GiB for TW snapshot ISO) so take at least 100 GiB for the 2nd drive
800 144 livdywan
- The security group needs to include ssh and http
801
- Add `openqa_created_by`, `openqa_ttl` and `team:qa-tools` tags
802 149 tinita
803
##### Launch from a template
804
805 151 tinita
Note: When you modify the template (creating a new version), be sure to set the new version as the default.
806
807 155 tinita
- Go to the [openQA-webUI-openSUSE-Leap](https://eu-central-1.console.aws.amazon.com/ec2/v2/home?region=eu-central-1#LaunchTemplateDetails:launchTemplateId=lt-002dfbcbd2f818e4c) Template
808 154 tinita
- Select "Actions - Launch instance from template"
809 149 tinita
- Choose your key pair
810
- Click "Launch instance"
811 1 alarrosa
812
###### Command line
813 151 tinita
814 156 tinita
For configuring aws cli, see [below](https://progress.opensuse.org/projects/openqav3/wiki/Wiki#Configure-aws-cli)
815
816
[aws run-instances docs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html)
817 149 tinita
818
    aws ec2 run-instances --launch-template LaunchTemplateId=lt-002dfbcbd2f818e4c --key-name <your-keyname>
819 150 tinita
    # or
820
    aws ec2 run-instances --launch-template LaunchTemplateName=openQA-webUI-openSUSE-Leap --key-name <your-keyname>
821 149 tinita
822
For this you have to create a key pair first, if you haven't done so.
823
Save the result and look for the `InstanceId`.
824 144 livdywan
825
#### Transfer keys
826
827
Since an instance is always created with a single key, public keys of all users need to be deployed by whoever owns that key.
828
829
**Note**: `osd2` refers to the instance created above. Replace with the instance IP or add an alias to your SSH config.
830
831
    ssh openqa.suse.de "sudo su -c 'cat /home/*/.ssh/authorized_keys'" | ssh ec2-user@osd2 "cat - >> ~/.ssh/authorized_keys"
832
833
#### Bootstrapping
834
835
```
836
ssh osd2
837 169 osukup
sudo su
838 145 mkittler
parted --script /dev/nvme1n1 mklabel gpt && parted --script /dev/nvme1n1 mkpart ext4 4096s 100%
839
mkfs.ext4 /dev/nvme1n1p1
840 160 osukup
vim /etc/fstab # add mount to fstab
841 145 mkittler
mkdir /space && mount /dev/nvme1n1p1 /space
842 158 okurz
mkdir -p /space/pgsql/data
843
mkdir -p /var/lib/pgsql
844
ln -s /space/pgsql/data /var/lib/pgsql/data
845 169 osukup
zypper in postgresql-server # needed for user.group
846
chown -R postgres.postgres /space/pgsql # without correct group postgresql.service fails
847
mkdir -p /space/openqa
848
mkdir -p /var/lib/openqa
849
mount /space/openqa /var/lib/openq -o bind # open also requires a lot of space 
850 161 osukup
curl -s https://raw.githubusercontent.com/os-autoinst/openQA/master/script/openqa-bootstrap | bash -x
851 152 tinita
852
ssh -A backup.qa.suse.de
853 145 mkittler
rsync --progress /home/rsnapshot/alpha.0/openqa.suse.de/var/lib/openqa/SQL-DUMPS/2022-02-08.dump ec2-user@osd2:/tmp
854 1 alarrosa
855
ssh osd2
856 147 mkittler
sudo -u postgres createdb -O geekotest openqa-osd # create pristine db for OSD import (to avoid conflicts with existing data)
857 1 alarrosa
sudo -u geekotest pg_restore -d openqa-osd /tmp/2022-02-08.dump # import data, will take a while (22m is a realistic time)
858 153 tinita
vim /etc/openqa/openqa.ini # change auth from Fake to OpenID
859 1 alarrosa
vim /etc/openqa/database.ini # change database to openqa-osd
860 158 okurz
systemctl restart openqa-webui
861 1 alarrosa
```
862 155 tinita
863
##### Configure aws cli
864
865
You can use the command
866
867
    aws configure
868
869
but it doesn't actually help you with the possible values, so you can just create the file yourself like this:
870
871
    % cat ~/.aws/config
872
    [default]
873
    region = eu-central-1
874
    output = json
875 157 tinita
    % cat ~/.aws/credentials
876
    [default]
877
    aws_access_key_id = ABCDE
878 155 tinita
    aws_secret_access_key = FGHIJ
879 144 livdywan
880 109 okurz
## Best practices for infrastructure work
881 107 okurz
882
* Same as in OSD deployment we should look for failed grafana alerts if users report something suspicious
883
* Collect all the information between "last good" and "first bad" and then also find the git diff in openqa/salt-states-openqa
884
* 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
885
* Keep salt states to describe what should *not* be there
886
* Try out older btrfs snapshots in systems for crosschecking and boot with disabled salt. In the kernel cmdline append `systemd.mask=salt-minion.service`
887
* Team should conduct a work backlog check on a daily base, e.g. look for urgent tickets related to infrastructure problems
888 143 okurz
* For hardware replacement, create EngInfra ticket for coordination, order replacement on private expenses and get reimbursed using https://intra.suse.net/company/company-news/department/finance/claim-expenses/claim-expenses/ or have order placed with the help of line managers, let the components be delivered to the according place, e.g. SUSE Nuremberg datacenter and inform EngInfra in ticket to have them conduct the physical component replacement
889 148 livdywan
* Prefer `reload` over `restart` where available e.g. `systemctl reload postgres` - in general `systemctl cat postgres` will show available commands for any service
890 116 okurz
* Test reboot stability of machines with commands like in https://progress.opensuse.org/issues/78010#note-31 e.g.
891
892
```
893
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
894
```