This is a shorthand list of items we are needing to cover for migrating from fedmsg to fedora-messaging in Fedora Infrastructure for the Fiscal Year 2020.
Point of contact: Aurelien Bompard
Why?
Fedmsg has a number of issues but the main one is that it is unreliable. Since critical elements of our CI pipeline (and general infrastructure) are depending on it, it is important to migrate to fedora-messaging to solve that issue.
This is also why the migration to fedora-messaging needs to happen before the Gating Rawhide initiative goes to production (development can start, though).
What?
About 30+ apps require changes. The most critical ones are:
- bodhi
- koji
- greenwave
- waiverdb
- pagure
- centos infrastructure CI
- openqa
- anitya & the-new-hotness
Migrating to fedora-messaging will also allow us to define schemas for our data, use versions on the topic to avoid breakage in the message consumers, and rethink the topic to make them more useful with the routing capabilities we have. However, these tasks are out of scope for this initiative, for time/resources reasons.
The other applications will be migrated at a slower pace throughout FY20.
When?
- Critical applications: by 2019-06-01
- Other applications: 2020-03-31
Who?
The people involved will be abompard and the owner of each app (be it for writing the migration or for reviewing and testing it).
How?
We will start with the application that are most critical (see above).
The changes from fedmsg to fedora-messaging are usually similar in each application, so it can be a great opportunity for pair programming between abompard and the app owners.
It is however more complex to migrate an app that has consumers, because a new systemd service file must be written (and maybe a new script). In fedmsg only a class had to be defined and the system's fedmsg-hub daemon would pick it up. It's no longer how consumers work in fedora-messaging.
The staging and production networks are ready for fedora-messaging, so the migration and testing can start immediately.
Since this is a significant change from a deployment point of view, app owners may decide to change their major version number, but this decision is left to them.
Status
The migration status can be:
- todo: no step has been taken yet
- date set: a date has been decided for the pair programming session
- in dev: a branch has been made and the code migration is in progress
- PR ready: the code migration is done and under review
- merged: the main branch is migrated
- staging: the new code is deployed to staging and under test
- production: the migrated app is running in production
- Bodhi: PR ready
- Koji: todo
- Greenwave: todo
- WaiverDB: todo
- Resultsdb todo
- Pagure: todo
- Centos Infrastructure CI: todo
- OpenQA: todo
- Anitya: PR ready
- The-New-Hotness: in dev
Details per-app
Bodhi
The producing side on the server is already migrated to fedora-messaging. Some PRs are left to merge: consumers , message schemas.
The migration to Fedora Messaging should be available in Bodhi 4.0
Koji
Koji sends fedmsgs via a plugin, this plugin should be migrated. I did not find any upstream source control for the koji plugin, unless I'm mistaken it only lives in the Infra Ansible repository.
i created a space on Pagure to have a proper git, tracker, releases, tags, etc. : https://pagure.io/koji-fedmsg-plugin/
Tasks:
- Replace the
fedmsg_koji_instancetemplate variable by a configuration file. - Migrate to Fedora Messaging
- Create the proper python distribution boilerplate
- Publish on PyPI
- Add unit tests
- Add documentation
- Create an RPM (or choose an alternate deployment mode)
- Update the Infra Ansible
- Test on staging
- Deploy to production
Greenwave
Source code: https://pagure.io/greenwave
Greenwave has 2 consumers (ResultsDB and WaiverDB) and produces one message topic. The fedmsg config is used to store the consumers' configuration. There are only 2 calls to fedmsg.publish.
Tasks:
- Write a fedora-messaging consumer class and two handling classes (or functions) for the two message types.
- Update the unit tests
- Create a systemd unit file
- Update the installation system (python setup.py, spec file, Dockerfile, ansible infra)
- Update the documentation
- Test on staging
- Deploy to production
WaiverDB
Source code: https://pagure.io/waiverdb
WaiverDB only produces one message topic. It does not use the fedmsg configuration to store its own configuration. There's only one call to fedmsg.publish.
Tasks:
- Migrate to Fedora Messaging
- Update the unit tests
- Update the installation system (spec file, Infra Ansible)
- Update the documentation
- Test on staging
- Deploy to production.
ResultsDB
Source code: https://pagure.io/taskotron/resultsdb
ResultsDB only produces one message topic. There are only 2 calls to fedmsg.publish.
Tasks:
- Migrate to Fedora Messaging
- Update the unit tests
- Update the installation system (spec file, Infra Ansible)
- Update the documentation
- Test on staging
- Deploy to production.
Pagure
Source code: https://pagure.io/pagure/
Pagure only produces messages, calls to fedmsg.publish are centralized, and fedmsg.config is not used to store app configuration.
Tasks:
- Migrate to Fedora Messaging
- Update the unit tests
- Update the installation system (spec file, Infra Ansible)
- Update the documentation
- Test on staging
- Deploy to production.
CentOS Infrastructure CI
OpenQA
Source code: https://pagure.io/fedora-qa/fedora_openqa
Consumers for the folowing topics:
- org.fedoraproject.*.openqa.job.done
- org.fedoraproject.*.pungi.compose.status.change
- org.fedoraproject.*.bodhi.update.request.testing
- org.fedoraproject.*.bodhi.update.edit
The fedmsg configuration is only used to decide which consumer to enable.
Tasks:
- Write a fedora-messaging consumer class and as many handling classes (or functions) as necessary.
- Update the unit tests
- Create a systemd unit file
- Update the installation system (spec file, ansible infra)
- Update the documentation
- Test on staging
- Deploy to production
Anitya
Owner: Michal Konečný
Source code: https://github.com/release-monitoring/anitya
In current state Anitya is consuming and publishing various topics. Publishing only in future (See bellow).
PR with first draft of publishing migration to fedora messaging https://github.com/release-monitoring/anitya/pull/570. This PR will be merged shortly.
Anitya consumes libraries.io topics. However this will be removed and the SSE consumer will be part of Anitya instead of standalone application (It is the only application that is actually listening to libraries.io publisher). After this change Anitya will not consume any topics.
The-New-Hotness
Owner: Michal Konečný
Source code: https://github.com/fedora-infra/the-new-hotness
The-new-hotness is consuming and publishing few topics.