- Table of contents
- QE tools - Team description
- Team responsibilities
- Out of scope
- Our common userbase
- How we work
- What we expect from team members
- Common tasks for team members
- How we work on our backlog
- Team meetings
- Onboarding for new joiners
- Alert handling
- Collaboration best practices
- Things to try
- Literature references
- Team-internal Hack Week (or Hackweek)
- Change announcements
QE tools - Team description¶
"The easiest way to provide complete quality for your software"
We provide the most complete free-software system-level testing solution to ensure high quality of operating systems, complete software stacks and multi-machine services for software distribution builders, system integration engineers and release teams. We continuously develop, maintain and release our software to be readily used by anyone while we offer a friendly community to support you in your needs. We maintain the main public and SUSE internal openQA server as well as supporting tools in the surrounding ecosystem.
- Develop and maintain upstream openQA including the backend os-autoinst
- Administration of openqa.suse.de (osd) and workers (But not physical hardware, as these belong to the departments that purchased them and we merely facilitate)
- Helps administrating and maintaining openqa.opensuse.org (o3), including coordination of efforts aiming at solving problems affecting o3
- Develop and maintain SUSE maintenance QA tools (template generator aka. "teregen", MTUI, qem-bot, etc., e.g. from https://confluence.suse.com/display/maintenanceqa/Toolchain+for+maintenance+quality+engineering)
- Help with the investigation of specific issues, especially when they are likely related to generic or backend problems
- Support colleagues, team members and open source community
Out of scope¶
- Maintenance and recurring review of individual tests
- Maintenance of physical hardware
- Maintenance of special worker addendums needed for tests, e.g. external hypervisor hosts for s390x, powerVM, xen, hyperv, IPMI, VMWare (Clarification: We maintain the code for all backends but we are no experts in specific domains. So we always try to help but it's a case by case decision based on what we realistically can provide based on our competence.)
- Ticket triaging of http://progress.opensuse.org/projects/openqatests/
- Setup of configuration for individual products to test, e.g. new job groups in openQA
- Feature development within the backend for single teams (commonly provided by teams themselves)
Our common userbase¶
Known users of our products: Most SUSE QA engineers, SUSE SLE release managers and release engineers, every SLE developer submitting "submit requests" in OBS/IBS where product changes are tested as part of the "staging" process before changes are accepted in either SLE or openSUSE (staging tests must be green before packages are accepted), same for all openSUSE contributors submitting to either openSUSE:Factory (for Tumbleweed, SLE, future Leap versions) or Leap, other GNU/Linux distributions like Fedora https://openqa.fedoraproject.org/ , Debian https://openqa.debian.net/ , https://openqa.qubes-os.org/ , https://openqa.endlessm.com/ , the GNOME project https://openqa.gnome.org, https://www.codethink.co.uk/articles/2021/automated-linux-kernel-testing/, https://en.euro-linux.com/blog/openqa-or-how-we-test-eurolinux/, openSUSE KDE contributors (with their own workflows, https://openqa.opensuse.org/group_overview/23 ), openSUSE GNOME contributors (https://openqa.opensuse.org/group_overview/35 ), OBS developers (https://openqa.opensuse.org/parent_group_overview/7#grouped_by_build) , wicked developers (https://gitlab.suse.de/wicked-maintainers/wicked-ci#openqa), and of course our team itself for "openQA-in-openQA Tests" :) https://openqa.opensuse.org/group_overview/24
Keep in mind: "Users of openQA" and talking about "openSUSE release managers and engineers" means SUSE employees but also employees of other companies, also development partners of SUSE.
In summary our products, for example openQA, are a critical part of many development processes hence outages and regressions are disruptive and costly. Hence we need to ensure a high quality in production hence we practice DevOps with a slight tendency to a conservative approach for introducing changes while still ensuring a high development velocity.
How we work¶
The QE Tools team is following the DevOps approach working using a lightweight Agile approach also inspired by Extreme Programming and Kanban and of course the original http://agilemanifesto.org/. We plan and track our works using tickets on https://progress.opensuse.org . We pick tickets based on priority and planning decisions. We use weekly meetings as checkpoints for progress and also track cycle and lead times to crosscheck progress against expectations.
- tools team - backlog: The complete backlog of the team
- tools team - backlog, high-level view: A high-level view of the backlog, all epics and higher (an "epic" includes multiple stories)
- tools team - backlog, top-level view: A top-level view of the backlog, only sagas and higher (a "saga" is bigger than an epic and can include multiple epics, i.e. "epic of epics")
- tools team - what members of the team are working on: To check progress and know what the team is currently occupied with
- tools team - closed within last 60 days: What was recently resolved
Be aware: Custom queries in the right-hand sidebar of individual projects, e.g. https://progress.opensuse.org/projects/openqav3/issues , show queries with the same name but are limited to the scope of the specific projects so can show only a subset of all relevant tickets.
What we expect from team members¶
- Actively show visible contributions to our products every workday (pull requests, code review, ticket updates in decending priority, i.e. if you are very active in pull requests + code review ticket updates are much less important)
- Be responsive over usual communication platforms and channels (user questions, team discussions)
- Stick to our rules (this wiki, SLOs, alert handling)
Common tasks for team members¶
This is a list of common tasks that we follow, e.g. reviewing daily based on individual steps in the DevOps Process
- State daily learning and planned tasks in internal chat room
- Review backlog for time-critical, triage new tickets, pick tickets from backlog; see https://progress.opensuse.org/projects/qa/wiki#How-we-work-on-our-backlog
- Coordinate on the agile board https://progress.opensuse.org/agile/board?query_id=711
- See project specific contribution instructions
- Provide peer-review following https://github.com/notifications based on projects within the scope of https://github.com/os-autoinst with the exception of test code repositories, especially https://github.com/os-autoinst/openQA, https://github.com/os-autoinst/os-autoinst, https://github.com/os-autoinst/scripts, https://github.com/os-autoinst/os-autoinst-distri-openQA, https://github.com/os-autoinst/openqa-trigger-from-obs, https://github.com/os-autoinst/openqa_review as well as other projects like https://github.com/openSUSE/Mojo-IOLoop-ReadWriteProcess and https://gitlab.suse.de/qa-maintenance/openQABot
- See project specific contribution instructions
- Monitor failures on https://travis-ci.org/ relying on https://build.opensuse.org/package/show/devel:openQA/os-autoinst_dev for os-autoinst (email notifications)
- Monitor failures on https://app.circleci.com/pipelines/github/os-autoinst/openQA?branch=master relying on https://build.opensuse.org/project/show/devel:openQA:ci for openQA (email notifications)
- By default we use the rolling-release model for all projects unless specified otherwise
- Monitor devel:openQA on OBS (all packages and all subprojects) for failures, ensure packages are published on http://download.opensuse.org/repositories/devel:/openQA/, ensure to be added as a Maintainer for that project (members need to be added individually, you can ask existing team members, e.g. the SM)
- Monitor http://jenkins.qa.suse.de/view/openQA-in-openQA/ for the openQA-in-openQA Tests and automatic submissions of os-autoinst and openQA to openSUSE:Factory through https://build.opensuse.org/project/show/devel:openQA:tested
- o3 is automatically deployed (daily), see https://progress.opensuse.org/projects/openqav3/wiki/Wiki#Automatic-update-of-o3
- osd is automatically deployed (multiple times per week), monitor https://gitlab.suse.de/openqa/osd-deployment/pipelines and watch for notification email to firstname.lastname@example.org
- Apply infrastructure changes from https://gitlab.suse.de/openqa/salt-states-openqa (osd) or manually over sshd (o3)
- Monitor for backup, see https://gitlab.suse.de/qa-sle/backup-server-salt config changes in salt (osd), backups, job group configuration changes
- Ensure old unused/non-matching needles are cleaned up (osd+o3), see #73387
- Maintain https://gitlab.suse.de/qa-maintenance/qamops and https://confluence.suse.com/display/maintenanceqa/qam.suse.de
- React on alerts from stats.openqa-monitor.qa.suse.de (emails on email@example.com and login via LDAP credentials, you must be an editor to edit panels and hooks via the web UI)
- Look for incomplete jobs or scheduled not being worked on o3 and osd (API or webUI) - see also #81058 for power
- React on alerts from https://gitlab.suse.de/openqa/auto-review/, https://gitlab.suse.de/openqa/openqa-review/, https://gitlab.suse.de/openqa/monitor-o3 (subscribe to projects for notifications)
- Be responsive on #opensuse-factory (irc://irc.libera.chat/opensuse-factory, formerly irc://chat.freenode.net/opensuse-factory) for help, support and collaboration (Unless you have a better solution it is suggested to use Element.io for a sustainable presence; you also need a registered IRC account, formerly freenode) note don't use matrix features on irc!
- Be responsive on #qa-tools in Rocket.Chat for internal coordination and alarm handling, fallback to #suse-qe-tools:opensuse.org (matrix) as backup if other channels are temporarily down, alternatively public channels on matrix/ IRC if the topics are not confidential
- Be responsive on #testing for help, support and collaboration
- Be responsive on mailing lists firstname.lastname@example.org and email@example.com (see https://en.opensuse.org/openSUSE:Mailing_lists_subscription)
- Be responsive in https://matrix.to/#/#openqa:opensuse.org or the bridged room #openqa on https://discord.gg/opensuse if you have a discord account
How we work on our backlog¶
- "due dates" are only used as exception or reminders. Commonly the due-date is set automatically to 14 days in the future as soon as a non-low ticket is picked up. That period is roughly the median cycle time which we want to stay well below. And on top, to prevent redmine sending a reminder and the backlog status to flag issues the ticket should be resolved before the due-date, at least a day but possibly a reminder is sent out even on the last day before so better resolve on the second to last day. Of course, even better to always try to finish as soon as possible, well before the due date.
- every team member can pick up tickets themselves
- everybody can set priority, PO can help to resolve conflicts
- consider the ready, not assigned/blocked/low query as preferred. It is suggested to pick up tickets based on priority. "Workable" tickets are often convenient and hence preferred.
- ask questions in tickets, even potentially "stupid" questions, oftentimes descriptions are unclear and should be improved
- There are "low-level infrastructure tasks" only conducted by some team members, the "DevOps" aspect does not include that but focusses on the joint development and operation of our main products
- Consider tickets with the subject keyword or tag "learning" as good learning opportunities for people new to a certain area. Experts in the specific area should prefer helping others but not work on the ticket
- For tickets which are out of the scope of the team remove from backlog, delegate to corresponding teams or persons but be nice and supportive, e.g. SUSE-IT, EngInfra also see SLA, test maintainer, QE-LSG PrjMgr/mgmt
- For EngInfra tickets
- Ensure there's a ticket for it in openQA Infrastructure
Eng-Infraunder Select a system
[openqa] …in the subject
- Reference the progress ticket
- Share the ticket with "OSD Admins" (or after the ticket was created then Share with
OSD Admins(the icon with two figures, not a single gray avatar)
- Use the tracker ticket for internal notes
- Make sure the severity and impact of the issue is explicitly mentioned in the EngInfra ticket, e.g. what business related workflows are impacted
- Keep in mind limited capacity of EngInfra (as of 2022-02)
- Whenever we apply changes to the infrastructure we should have a ticket
- Refactoring and general improvements are conducted while we work on features or regression fixes
- For every regression or bigger issue that we encounter try to come up with at least two improvements, e.g. the actual issue is fixed and similar cases are prevented in the future with better tests and optionally also monitoring is improved
- For critical issues and very big problems especially when we were informed by users about outages collect "lessons learned", e.g. in notes in the ticket or a meeting with minutes in the ticket, consider https://en.wikipedia.org/wiki/Five_whys and answer at least the following questions: "User impact, outwards-facing communication and mitigation, upstream improvement ideas, Why did the issue appear, can we reduce our detection time, can we prevent similar issues in the future, what can we improve technically, what can we improve in our processes". Also see https://youtu.be/_Dv4M39Arec
- okurz proposes to use "#NoEstimates". Though that topic is controversial and often misunderstood. https://ronjeffries.com/xprog/articles/the-noestimates-movement/ describes it nicely :) Hence tickets should be evenly sized and no estimation numbers should be provided on tickets
- If you really want you can look at the burndown chart (some people wish to have this) but we consider it unnecessary due to the continuous development, not a project with defined end. Also an agile board is available but likely due to problems within the redmine installation ordering cards is not reliable.
- Write to firstname.lastname@example.org as well for critical changes as well as chat channels
- Everyone should propose reverts of features if we find problems that can not be immediately fixed or worked around in production
Definition of DONE¶
Also see https://web.archive.org/web/20110308065330/http://www.allaboutagile.com/definition-of-done-10-point-checklist/ and https://web.archive.org/web/20170214020537/https://www.scrumalliance.org/community/articles/2008/september/what-is-definition-of-done-(dod)
- Code changes are made available via a pull request on a version control repository, e.g. github for openQA
- Guidelines for git commits have been followed
- Code has been reviewed (e.g. in the github PR)
- Depending on criticality/complexity/size/feature: A local verification test has been run, e.g. post link to a local openQA machine or screenshot or logfile (especially also for hardware-related changes, e.g. in os-autoinst backend)
- For regressions: A regression fix is provided, flaws in the design, monitoring, process have been considered
- Potentially impacted package builds have been considered, e.g. openSUSE Tumbleweed and Leap, Fedora, etc.
- Code has been merged (either by reviewer or "mergify" bot or reviewee after 'LGTM' from others)
- Code has been deployed to osd and o3 (monitor automatic deployment, apply necessary config or infrastructure changes)
Definition of READY for new features¶
The following points should be considered before a new feature ticket is READY to be implemented:
- Follow the ticket template from https://progress.opensuse.org/projects/openqav3/wiki/#Feature-requests
- A clear motivation or user expressing a wish is available
- Acceptance criteria are stated (see ticket template) or use
<nr>hours for tasks that should be limited in time, e.g. a research task with
[timeboxed:20h] research …
- add tasks as a hint where to start
WIP-limits (reference "Kanban development")¶
- global limit of 10 tickets, and 3 tickets per person respectively In Progress
- limit of 20 tickets per person in Feedback
Target numbers or "guideline", "should be", in priorities¶
- New, untriaged QA (openQA, etc.): 0 (daily) . Every ticket should have a target version, e.g. "Ready" for QE tools team, "future" if unplanned, others for other teams
- Untriaged "tools" tagged: 0 (daily) . Every ticket should have a target version, e.g. "Ready" for QE tools team, "future" if unplanned, others for other teams
- Workable (properly defined): 10-40 . Enough tickets to reflect a proper plan but not too many to limit unfinished data (see "waste")
- Overall backlog length: ideally less than 100 . Similar as for "Workable". Enough tickets to reflect a proper roadmap as well as give enough flexibility for all unfinished work but limited to a feasible number that can still be overlooked by the team without loosing overview. One more reason for a maximum of 100 are that pagination in redmine UI allows to show only up to 100 issues on one page at a time, same for redmine API access.
- Within due-date: 0 (daily/weekly) . We should take due-dates serious, finish tickets fast and at the very least update tickets with an explanation why the due-date could not be hold and update to a reasonable time in the future based on usual cycle time expectations
SLOs (service level objectives)¶
for picking up tickets based on priority, first goal is "urgency removal":
aim for cycle time of individual tickets (not epics or sagas): 1h-2w
reference for SLOs and related topics: https://sre.google/sre-book/table-of-contents/
When we prioritize tickets we assess:
- What the main use cases of openQA are among all users, be it SUSE QA engineers, other SUSE employees, openSUSE contributors as well as any other outside user of openQA
- We try to understand how many persons and products are affected by feature requests as well as regressions (or "concrete bugs" as the ticket category is called within the openQA Project) and prioritize issues affecting more persons and products and use cases over limited issues
- We prioritize regressions higher than work on (new) feature requests
- If a workaround or alternative exists then this lowers priority. We prioritize tasks that need deep understanding of the architecture and an efficient low-level implementation over convenience additions that other contributors are more likely to be able to implement themselves.
Periodic backlog refinement¶
These queries can be used to help organize our work efficiently
- QE tools team - backlog - sorted by update time ensure all tickets are reasonably up-to-date and don't keep hanging around
- QE tools team - due date forecast prevent running into due-dates proactively
- QE tools team - backlog, non-reactive, needs parent ensure all our (non-reactive) work is linked to higher-level planning as motivation
It's good practice to keep an eye on the queries to anticipate blockers. All team members are encouraged to utilize them and they are useful as part of the Scrum Master's daily routine as well as moderation duty.
Note that due dates should provide a hint as to when a ticket will be resolved but they need to be realistic. Availability, reviews and deployment need to be factored in as well since typically a ticket will be in Feedback before it can be resolved. If in doubt the Due date should be extended with an accompanying message like "Outstanding branches still need to be reviewed" or simply "Bumping the due date because of availability".
- Daily: Use (internal) chat actively, e.g. formulate your findings or achievements and plans for the day, "think out loud" while working on individual problems. Optionally join m.o.o/suse_qa_tools every Monday, Tuesday and Thursday 1030-1045 CET/CEST
- Goal: Emergency responses, clarify next steps or blockers on current work items, asking and answering questions on tickets that would be ignored otherwise, ticket estimations (after the regular daily) (compare to Daily Scrum)
- Ticket estimations: Every Thursday 1110-1210 CET/CEST in m.o.o/suse_qa_tools Estimate t-shirt sizes for our non-estimated tickets.
- Goal: Ensure tickets are workable. Refine and split tickets for larger estimates.
- Midweekly unblock: Every Wednesday 1110-1210 CET/CEST in m.o.o/suse_qa_tools.
- Goal: Discuss tasks in progress in more detail, unblock currently assigned tasks and tasks avoided for longer (see Periodic backlog refinement)
- Mob session: Every Thursday 1330-1630 CET/CEST in m.o.o/suse_qa_tools. Optional, can be skipped if there are no suitable tasks pending
- Goal: Through mobbing follow-up on tasks which are stuck, too frightening, too difficult to solve alone.
- Weekly coordination: Every Friday 1110-1140(-1210) CET/CEST in m.o.o/suse_qa_tools. Community members and guests are particularly welcome to join this meeting.
- Fortnightly Retrospective: Friday 1140-1210 CET/CEST every odd week, same room as the weekly meeting. On these days the weekly has hard time limit of 1110-1140.
- Virtual coffee: Weekly every Monday 1100-1120 CET/CEST, same room as the weekly.
- Goal: Connect and bond as a team, understand each other (compare to Informal Communication in an all-remote environment)
- Workshop: Friday 0900-0950 CET/CEST every week in m.o.o/suse_qa_tools especially for community members and users! We will run this every week with the plan to move to a fortnightly cadence every even week.
- Goal: Demonstrate new and important features, explain already existing, but less well-known features, and discuss questions from the user community. All your questions are welcome!
- Announcements: Drop a reminder with a teaser in #testing.
- Recordings: Consider recording, e.g. using OBS, and upload to youtube, link on topics link. SUSE internal topics can be published on http://streaming.nue.suse.com/i/QE-Tools-Workshops/ by ssh-uploading to email@example.com:~/i/QE-Tools-Workshops/ (get your SSH key added by existing team members, e.g. okurz)
- Content: See topics!
NOTICE: We're are currently using meet.opensuse.org (m.o.o). As fallback on problems use fallback
Weekly moderation duty¶
We see mandatory daily video calls as an effective measure but we don't want to enforce the team to do this unless we have to. To ensure that we have daily updates next to the Alert duty we have the rotating role of "moderation duty". The person doing alert duty in the next week has "moderation duty". The duty consists of ensuring How we work on tickets, in particular:
- On a daily base ensure that we have an update from every team member that is expected to be present this day. If a person actively contributes to the daily meeting in video call or provided an update related to backlog tasks in chat then this is already ensured.
- Hand over to the next person during the weekly, going by the order of team members in the wiki
- Asks for standin on unavailabilities
We expect that this of course is an additional task with the corresponding time investment. The expected time invested per day is in the range of 3-15m, not more, so accounting for 15m-1h15m during duty week. Even in the worst case of a 30h part time worker investing said 15m every day that accounts for only 5% of weekly work time so no significant impact on contributions is expected.
Best practices for meetings¶
- Meetings concerning the whole team are moderated by the scrum master by default, who should join the call early and verify that the meeting itself and any tools used are working or e.g. advise the use of the fallback option.
- We would prefer UTC for meeting times to be globally fair but as many other SUSE meetings are bound to European time we need to stick to that as well.
- It is recommended to use the Jitsi Audio-feedback feature, blue/green circles depending on microphone volume. Everybody should ensure that at least "two green balls" show up
- Hand signals over video can be used, e.g. "waving/circling hands": "I am lost, please bring me into discussion again"; "T-Sign": "I need a break"; "Raised hand": "I would like to speak"
- Discuss topics relevant for all within the common meetings, continue discussions pro-actively over asynchronous communication, e.g. tickets, as well as conduct topic centered follow-up meetings with only relevant attendees
- Reminders in Slack correct for summer/winter time automatically but if you make changes on them the time might be shifted by one hour e.g. if you scheduled a reminder on 10:30 am CEST, it will become 9:30 CET after the switch
- Use https://etherpad.opensuse.org/p/suse_qe_tools for collaborative editing and put the content back into tickets or wikis
- SUSE QE Tools roadmap: Recent achievements, mid-term plan and future outlook. Every first Friday every month (Idea based on discussion between okurz and vpelcak 2021-02-09)
- (find older workshop topics and recordings on our SUSE QE Tools Workshop Archive
- 2022-01-07: skipped due to holiday
- 2022-01-14: open conversation (cdywan)
- 2022-01-21: DONE One year of SUSE QE Tools Workshop! Let's celebrate the success and have a good plan for the future (okurz)
- 2022-01-28: DONE auto-review with force-result (tinita)
- 2022-02-04: DONE SUSE QE Tools roadmap - 2022-02 (okurz)
- 2022-02-11: DONE openQA feature: Retry of jobs based on test variables (#104007) (okurz)
- 2022-02-18: DONE Scaling up: openQA result archiving and more (#64746) (mkittler)
- 2022-02-25: DONE lightning talk session - present your own topics, 5 mins top for each! (your favorite, least-favorite openQA feature, an unsolved problem you want to present) put your topic proposal on https://etherpad.opensuse.org/p/suse_qa_tools_workshop_lightning_talks
- 2022-03-04: DONE SUSE QE Tools roadmap - 2022-03 (okurz)
- 2022-03-11: DONE How to check availability of ssh and other services (cdywan)
- 2022-03-18: DONE How to report tickets, investigate issues, etc. (okurz)
- 2022-03-25: DONE The "TODO"-functionality on openQA (#93246) (okurz)
- 2022-04-01: DONE SUSE QE Tools roadmap - 2022-04 (okurz)
- 2022-04-08: DONE Follow-Up to: How to report tickets - find improvements (okurz)
- 2022-04-15: skipped due to holiday
- 2022-04-22: DONE qem-bot+qem-dashboard gitlab CI workflows (jbaier_cz)
- 2022-04-29: DONE Triggering multiple openQA jobs with the jobs POST route (#71809) (mkittler)
- 2022-05-06: DONE SUSE QE Tools roadmap - 2022-05 (mkittler, cdywan)
- 2022-05-13: DONE Needling best practices (okurz)
- 2022-05-20: DONE proposal by ybonatakis: openQA test failure debugging group therapy session (ybonatakis) (no recording available)
- 2022-05-27: skipped due to public holiday in many areas the day before
- 2022-06-03: skipped due to openSUSE Conference
- 2022-06-10: DONE Perl workshop 2022 report (tinita)
- 2022-06-17: DONE openQA test review best practices and recent related feature development (okurz)
- 2022-06-24: DONE proposal by okurz: Best practices for handling openqa-review reminder comments about still failing tests (#110917) (okurz)
- 2022-07-01: skipped due to SUSE Hack Week
- 2022-07-08: Lessons-learned from "openqa.suse.de is not reachable anymore, response times > 30s, 2022-06-20" #112718 (okurz)
proposal by okurz: How we review openQA test results, by SUSE QE teams: Who volunteers from each team to present? Propose a speaker and a date! Do small lightning talks!
periodic proposal by okurz: How to report tickets, investigate issues, etc. (#104805)
general proposal: if there are no further topics make it an "open conversation", at least from time to time :)
feedback from yearly workshop review: run it every second week but maybe longer, more interactive, more technical sessions, about backends and more openQA internals, from jlausuch: maybe understanding how svirt backend boots VMs in s390x, VMWare, etc? Highlight the differences between how qemu backend spawns VMs and how others do
Note: Everybody should feel welcome to add topic proposals here or approach us with ideas or requests.
- For every meeting, regular or one-off, desired attendants should be invited to make sure a slot blocked in their calendar and reminders with the correct local time will show up when it's time to join the meeting
- Create a new event, for example in Thunderbird via the Calendar tab or
New > Eventvia the menu.
- Select individual attendants via their respective email addresses .g. Invite attendees in Thunderbird
- Specify the time of the meeting
- Set a schedule to repeat the event if applicable.
- Add a location, e.g. https://meet.opensuse.org/suse_qa_tools
- Don't worry if any of the details might change - you can update the invitation later and participants will be notified.
- Prefer new events if the time and date change
- Create a new event, for example in Thunderbird via the Calendar tab or
- See the respective meeting for regular actions such as communication via chat
The team is comprised of engineers from different teams, some only partially available:
- Cris Dywan (Scrum Master) cdywan / @kalikiana
- Oliver Kurz (Product Owner) okurz / @okurz
- Marius Kittler mkittler / @Martchus
- Sebastian Riedel (only bug fixing and feature development) kraih / @kraih July 18-August 19 Temporarily working on other projects
- Nick Singer (only OPS) nicksinger / @nicksinger
- Tina Müller (Part time (35h)) tinita / @perlpunk
- Jan Baier (part time, QEM-dedicated work areas) jbaier_cz / @baierjan
- Ondřej Súkup (dedicated work areas) osukup / @mimi1vx
Onboarding for new joiners¶
- For mentors: https://plan.io/blog/hire-remote-developers/
- Request to get added to the tools team on GitHub and subscribe to notifications for projects within that organization
- Subscribe to notifications of the Mojo-IOLoop-ReadWriteProcess project on GitHub as it is also closely related to openQA development
- Login at stats.openqa-monitor.qa.suse.de with NIS/LDAP credentials and ask to be given the admin role
- Watch this wiki page (click "Watch" button on top of this page)
- Subscribe to firstname.lastname@example.org, email@example.com, firstname.lastname@example.org and email@example.com
- Join #suse-qe-tools:opensuse.org (matrix) and team-qa-tools on Slack
- Request to join devel:openQA on OBS and check that you have
New comment for request created,
New comment for project created,
New comment for package createdenabled for
Maintainer of the targetin your OBS notification settings (staging bot writes reminder comments on open reviews)
- Add devel:openQA on OBS to your watchlist
- Connect to
#opensuse-factoryon libera.chat, see "Common tasks for team members - Monitor" above
- Request admin access on osd and o3
- Request to get added to the QA project in Progress and enable notifications for the openQA project in your account settings
- Request to get added to the openqa team in GitLab
- Add your ssh key to https://gitlab.suse.de/openqa/salt-pillars-openqa/-/blob/master/sshd/users.sls with a merge request
- Add your ssh key to gitlab.suse.de/qa-maintenance/qamops/-/blob/master/ansible/books/vars/main.yml with a merge request
- Ask an existing admin, e.g. other members of the team, to add your username and ssh key to o3, see https://progress.opensuse.org/projects/openqav3/wiki/#SSH-configuration
- Ensure you are subscribed to all projects referenced in https://progress.opensuse.org/projects/qa/wiki#Common-tasks-for-team-members
Ensure you have access to https://gitlab.suse.de/OPS-Service/monitoring (create EngInfra ticket otherwise) and add yourself in https://gitlab.suse.de/OPS-Service/monitoring/-/tree/master/icinga/shared/contacts to receive monitoring informationEngInfra does not grant access to additional people currently. That might change again in the future.
- Ask for access to the vacations calendar (on demand, via invitation)
- Watch qa-tools-backlog-assistant and choose All Activity
- Ensure you can access thruk.suse.de via NIS/LDAP credentials
- Create a ticket on sd.suse.com to be added to the Jira SD group "OSD Admins" and the Slack group "@qa-tools"
When someone leaves the team the following steps should be taken
- Conduct a team-internal exit-interview (Learn about what was good, what can be improved, what to learn)
- Remove from https://github.com/orgs/os-autoinst/teams/tools-team . Optionally add the people still as contributors with additional priviledges to individual projects
- Remove from team calendars
- "if it hurts, do it more often": https://www.martinfowler.com/bliki/FrequencyReducesDifficulty.html
- Reduce Mean-time-to-Detect (MTTD) and Mean-time-to-Recovery
- React on any alert or report of an outage
- If users report outages of components of our infrastructure
- Consider forming a task force and work together
- Inform the affected users about the impact, mitigation/workarounds and ETA for resolution
- For each failing alert, e.g. grafana
- Create a ticket for the issue (with a tag "alert"; create ticket unless the alert is trivial to resolve and needs no improvement; if an alert is unhandled for at least 4h then a ticket must be created; even create a ticket if alerts turn to "ok" to prevent these issues in the future and to improve the alter)
- Link the corresponding grafana panel in the ticket
- Respond to the notification email with a link to the ticket or forward the email to a corresponding mailing list, e.g. firstname.lastname@example.org or email@example.com (Caveat: firstname.lastname@example.org as sender seems to be able to receive emails and swallow them without any useful response or error message)
- Optional: Inform in chat
- Optional: Add "annotation" in corresponding grafana panel with a link to the corresponding ticket
- Pause the alert if you think further alerting the team does not help (e.g. you can work on fixing the problem, alert is non-critical but problem can not be fixed within minutes)
- If you consider an alert non-actionable then change it accordingly
- If you do not know how to handle an alert ask the team for help
- We must always strive for an accepted hypothesis when we want to change alerts or call an issue resolved
- After resolving the issue add explanation in ticket, unpause alert and verify it going to "ok" again, resolve ticket
Gitlab Pipeline Notifications¶
Currently, the following projects are configured to write an email to email@example.com if a pipeline fails:
The configuration can be found by going to Settings > Integrations > Pipeline Status Emails (for any new projects the plugin will need to be enabled first)
There's no way to subscribe as a user - instead an email address must be added
Weekly alert duty¶
We all should react on alert but additionally we can have one person on "alert duty" for one week each to ensure quicker reaction times when other team members are focussed on development work. For this the person on duty should do the following:
- React quickly (e.g. within two hours) on any unhandled alerts
- Hand over to the next person after the weekly, going by the order of team members in the wiki
- Asks for standin on unavailabilities
Collaboration best practices¶
Sometimes there are pull requests that are based on other pull requests. Person X reviews PR 1 and Person Y reviews PR 2, but they share the same commit. As a result we have more work for all. For a best practice it is recommended to
- Include keywords in the PR subject line, e.g. "Part 2: … - based on #". Example: https://github.com/os-autoinst/openQA/pull/4473
- Include the list of base pull request(s) in the PR description. Keep in mind that pull request links in github only seem to be properly rendered as preview links when included in a Markdown list, e.g.
Based on * #1234
- Mark the dependant pull request as draft until the base pull request is approved or merged
See #105244 for the motivation for these best practices
Things to try¶
- Everybody can be "Product Owner" or "Scrum Master" or "Admin" or "Developer" for some time to get the different perspective
- From time to time ask stakeholders for their list of priorities regarding our tasks
- Seelect mob-programming tasks in unblock meetings to deep-dive in dedicated meeting
Previously the former QA tools team used target versions "Ready" (to be planned into individual milestone periods or sprints), "Current Sprint" and "Done". However the team never really did use proper time-limited sprints so the distinction was rather vague. After having tickets "Resolved" after some time the PO or someone else would also update the target version to "Done" to signal that the result has been reviewed. This was causing a lot of ticket update noise for not much value considering that the Definition-of-Done when properly followed already has rather strict requirements on when something can be considered really "Resolved" hence the team eventually decided to not use the "Done" target version anymore. Since about 2019-05 (and since okurz is doing more backlog management) the team uses priorities more as well as the status "Workable" together with an explicit team member list for "What the team is working on" to better visualize what is making team members busy regardless of what was "officially" planned to be part of the team's work. So we closed the target version. On 2020-07-03 okurz subsequently closed "Current Sprint" as also this one was in most cases equivalent to just picking an assignee for a ticket or setting to "In Progress". We can just distinguish between "(no version)" meaning untriaged, "Ready" meaning tools team should consider picking up these issues and "future" meaning that there is no plan for this to be picked up. Everything else is defined by status and priority.
In 2020-10-27 we discussed together to find out the history of the team. We clarified that the team started out as a not well defined "Dev+Ops" team. "team responsibilities" have been mainly unchanged since at least beginning of 2019. We agreed that learning from users and production about our "Dev" contributions is good, so this part of "Ops" is responsibility of everyone.
Also see #73060 for more details about how the responsibilities were setup.
Team-internal Hack Week (or Hackweek)¶
Rules of the game¶
- Regular meetings with the exception of the Weekly are cancelled
- Look into future tickets or other projects that relate to our usual work
- Backlog priorities are not enforced, short of emergency responses
- The challenge has to be solved the previous week, weekly to weekly
Extra-ordinary "hack-week" 2020-W51¶
SUSE QE Tools plans to have an internal "hack-week": Condition: We close 30 tickets from our backlog within the time frame 2020-12-03 until 2020-12-11 start of weekly meeting. No cheating! :) See this query. During week 2020-W51 everyone is allowed to work on any hack-week project, it should just have a reasonable, "explainable" connection to our normal work. okurz volunteers to take over ops-duty for the week.
Result during meeting 2020-12-11: We missed the goal (by a slight amount) but we are motivated to try again in the next year :) Everybody, put some easy tickets aside for the next time!
Extra-ordinary "hack-week" 2021-W8¶
Similar as our attempt for 2020-W51 with same rules, except condition: We close 30 tickets from our backlog within the time frame 2021-02-05 until 2021-02-19 start of weekly meeting. No cheating! See this query.
Result during meeting 2021-02-19: We missed the goal (25/30 tickets resolved) but again we are open to try again, maybe after next SUSE hack week.
Extra-ordinary "hack-week" 2022-W9¶
Same as in before, similar condition: We close 30 tickets from our backlog within the time frame 2022-02-18 until 2022-02-25 start of weekly meeting. No cheating! See this query.
For new, cool features or disruptive changes consider providing according notifications to our common userbase as well as potential future users, for example create post on firstname.lastname@example.org , link to post on email@example.com , invite for workshop, #opensuse-factory (IRC) (irc://irc.libera.chat/opensuse-factory), #testing (Slack)