|Line 97:||Line 97:|
== Karma requirements for Critical Path updates ==
== Karma requirements for Critical Path updates ==
Critical Path updates require a karma sum of +2
Critical Path updates require a karma sum of +2 or can be pushed after a 14-day wait if they have received no negative karma. See the [[Updates_Policy]] for details: the Updates Policy page is always the canonical source for update karma requirements.
== Possible workflows with the karma system ==
== Possible workflows with the karma system ==
Revision as of 20:17, 7 August 2018
- 1 Scope of this document
- 2 Targeted Audience
- 3 What is Bodhi
- 4 Workflow
- 5 Karma
- 6 How to help test important updates using Bodhi
- 7 Questions and Answers
- 8 Enhancement suggestions
Scope of this document
This document provides an introduction explaining what is Bodhi and its uses in real-time. This document is a work in progress and hence it currently targets end-users, however, this document may be updated periodically to target everyone.
This document is targeted towards both end users and Fedora developers
What is Bodhi
Bodhi pronounced as bo-dee is a Buddhist term for the wisdom by which one attains enlightenment. Bodhi is a modular web-based system that facilitates the process of publishing package updates for Fedora. Bodhi is the application that manages updates for Fedora releases. It maintains a single stage of repositories by adding/updating/removing packages. It can be used to create or modify updates and overrides.
Advantages of Bodhi
- Provides an intuitive interface for developers and release engineers to manage pushing out package updates for multiple version releases.
- Helps in delivering quality packages and repository sustainment with automated testing.
- Helps Community testers to get involved in the testing of the package updates and provide quality feedback which would reach the packagers/developers.
- Provides a modular framework that will allow future integrations to various other QA and developer tools.
- Announces the arrival of New packages entering the collection.
- The reasons for an update can be communicated to end users.
- Generates extended update metadata which is parsed client-side by yum.
- Allows security updates to be seen by users as a separate channel, with links to the security advisories.
- Accommodates automated testing for updates before the latter are released.
- Provides pre-release test updates for end users and QA folks who wish to test these updates.
It is always recommended that you test your package locally to the best of your ability before pushing it into a release.
You can submit updates to Bodhi in the following ways:
- or, you can run the following from the git branch of your package:
$ fedpkg update
You can see a menu on the left:
Select New Update for the appropriate release and type the name of the package that you would like to update. A list should appear with all of the possible builds for this package, if not then you can type the full name-version-release manually. Select the build that is going to be a potential update. You will be able to specify if the package is bugfix, an enhancement, or a security update. You can also specify any bugzilla bugs related to this update and provide any end user notes. By default, bodhi will close all associated bugs when the update is marked as stable, which can be toggled upon creation.
Once submitted to Bodhi, packages move through the following states:
- PENDING - Your update has not yet been pushed to the testing or stable repositories.
- TESTING - Your package is in the updates-testing repository for people to test.
- TESTING/BATCHED - Your package is ready to go stable, and will wait until the next Tuesday's update batch to be marked for stable.
- TESTING/STABLE - Your package is ready to go stable, and will wait until the next daily update push.
- STABLE - Your package has been released to the main updates repository.
- OBSOLETE - Your package has been obsoleted by a different update
Once your update is submitted to bodhi, it will enter the Pending state. Bodhi will perform some sanity checks on your update request. Is your package built and available in koji? Is it tagged as an updates candidate for the release you wish to make it available for? The update path for your package will also be checked at this point to make sure you don't release a newer version of a package on an older release. Your update must not break the upgrade path or it will be rejected.
You will be notified by email when your update has been signed and pushed, and a package update notification will also be sent to fedora-package-announce or fedora-test-list depending on its status.
While in the updates-testing repository you may get feedback, both positive and negative. Once enough feedback is generated, you can use the bodhi interface to release your update by clicking 'Mark as Stable', or remove it using 'Delete'.
If you chose to use the 'karma automatism' feature when submitting your update, it will automatically be pushed or unpushed based on the feedback from testers. This feature can be disabled if you wish to push your update to the stable repository manually. By default, if your update achieves a karma of 3, it will automatically be pushed to stable and will be unpushed if it reaches -3.
Testing also has two possible substates, both expressed as the "request", that occur when your package is ready to go to stable. These are documented in the next two sections.
The "batched" state means that the package is ready to go to stable and is waiting until the next Tuesday when Bodhi will automatically switch the request to "stable" at 03:00 UTC. All non-urgent and non-newpackage updates will automatically move to this state when they hit the karma threshold if they have autokarma enabled, and non-autokarma updates that meet the requirements will present a "Push to Batched" button to the maintainers. The update remains in the testing repository while it is in this state.
The second request state is "stable", and means that the package will be sent out to the stable repositories the next time a Release Engineer runs the daily updates push command. The update will remain in the testing repository during this state.
Developers are encouraged to use the batched update state for updates that are not severe as it reduces the update churn for Fedora's end users and also improves the speed of most of Bodhi's daily pushes (except for the larger Tuesday pushes, of course). However, it remains the maintainer's option to choose when they use the "Push to Stable" button, which will remain available to them.
After your package is marked as stable, a request will get sent to the RelEng team and it will be signed and pushed out to the main released updates repository. Upon completion, bodhi will optionally close all associated bugs, send out update notices to the appropriate mailing lists, and will notify everyone associated with the update.
When submitting a new version of a package, bodhi will automatically obsolete any pending or testing updates that do not have an active push request. Once obsoleted, your new update will inherit the old updates Bugs and Notes.
Bodhi Karma is a simple +1/-1 voting system that allows for testers to provide feedback as to whether a given update works or not. The karma of a given update is the sum of the karma of all of its comments. A guide for providing feedback on updates is available at QA:Update_feedback_guidelines.
Karma requirements for Critical Path updates
Critical Path updates require a karma sum of +2 or can be pushed after a 14-day wait if they have received no negative karma. See the Updates_Policy for details: the Updates Policy page is always the canonical source for update karma requirements.
Possible workflows with the karma system
When submitting an update, you can tell bodhi to automatically push it to stable once it has reached a given karma threshold. This threshold defaults to +3 for marking an update as "stable", and -3 for marking it as "unstable". These defaults are obviously not suitable for all updates, so the maintainer may configure these values as they wish.
Maintainers can disable the automatic pushing and manually submit their update to the stable repository once they deem it appropriate. Updates to non-Critical Path packages must either have a karma sum of at least +1 or have been in updates-testing for 7 days with no negative feedback before they can be pushed manually. See the canonical Updates_Policy for further details.
How to help test important updates using Bodhi
For instructions on when to leave positive, negative, neutral or no feedback on an update, see here.
Using the bodhi web interface
You con optionally pass in a specific 'release'.
Using the bodhi command-line client
Bodhi version 2
Bodhi 2 is included in Fedora >= 26. If you are on a Fedora release older than Fedora 26, you can install bodhi 2 from Copr.
See Bodhi/bodhi-client on how to use the command line interface.
Bodhi version 1
See bodhi-client on how to use the command line interface.
bodhi --testable --critpath --type=security
bodhi --testable --type=security
Submit a update:
$ bodhi --new --release F7 --type bugfix bodhi-0.4.2-1.fc7
Using the Fedora Community dashboard
Using the fedora-easy-karma tool
Questions and Answers
1. Q: What versions of Fedora and EPEL use or will use Bodhi? A: Fedora utilizes Bodhi as of Fedora 7. EPEL now utilizes Koji and Bodhi.
2. Q: Won't this slow down development / rawhide packages? A: bodhi will NOT be used for development / rawhide. Package builds there will (usually) be available in the next rawhide push. The exception being periods where there is a freeze in effect.
3. Q: Why do we need bodhi? What was wrong with just always pushing updates right out? A: There are lots of advantages to an updates system like bodhi, see Advantages of Bodhi.
4. Q: Is there a command line interface to bodhi? Do I have to have web access? A: The bodhi-client package is available.
5. Q: I want to push my package directly out, bypassing testing. A: You need to get permission from FESCo for this.
6. Q: What do I put in the "Notes" section of an update? A: It's up to you as maintainer. Consider that end users would like to know why they just downloaded this update. Does it add anything? Fix a bug? If it's a new package, consider adding in a copy of the description so end users will know what it is.
7. Q: Are we going to have any rule for how long things should be in updates-testing? How much QA? How many good/bad? A: Right now bodhi will automatically stabalize updates once they reach a karma of 3. Releng and security team members have full control of the updates, as well as the person that submits them.
Proposed addition to New on the need and steps for ensuring that a package and its dependencies are pushed together as one unit.
There are cases where a package depends on one or more other packages and one must ensure that the package along with the packages it depends on are pushed to stable, or testing, as one unit. If the dependent package gets pushed ahead of the others this would cause unresolved dependencies at update time.
To give a concrete example: nss was split into three stand-alone packages, nss, nss-softokn, and nss-util. nss depends on nss-softokn and both nss and nss-soktokn depend on nss-util. They all in turn depend on nspr. nss-softokn is updated independently of, and less frequently than, nss whereas the nss-util package is usually updated in synchrony with nss. If several of these are updated they must be pushed as a unit.
Via the Bodhi Web interface: At the point of adding our package build to the update, add also any rebuilds of packages this one depends on. This ensures that the package and its dependencies are submitted as one unit.
Via the command line interface: you can do it also by adding all needed builds
If the package has a dependency on another package maintained by someone else one still make a bundle, e.g., firefox, xulrunner, and the nss packages are sometimes released together as a "bundle" in Bodhi.