StableKernelMaintenance

Differences between revisions 5 and 6
Revision 5 as of 2009-04-22 11:26:01
Size: 8609
Editor: p5B2E7BFE
Comment:
Revision 6 as of 2009-09-04 15:46:05
Size: 10069
Editor: p5B2E6F9D
Comment:
Deletions are marked like this. Additions are marked like this.
Line 18: Line 18:
StableReleaseUpdates with a kernel specific part described KernelUpdates. There is one special case for stable kernel tree updates from upstream (described below).

  * Every SRU needs a bug. Patches are sent to kernel mailing list and have to get at least one ''ACK'' (maybe 2 with the current team size).

  * All patches should be signed-off-by the person who did the patch.
StableReleaseUpdates with a kernel specific part described KernelUpdates.

  * Every SRU needs a bug. Patches are sent to kernel mailing list and have to get at least two ''ACK''s from other senior kernel developers (those in the kernel_cdev group on zinc).

  * All patches should be signed-off-by the person who did the patch. The developer who is committing the final patch, also needs to add his SOB.
Line 30: Line 30:
  * SRU justification is added to bug and nomination for releases are used to track progress for each release (if appropriate).   * SRU justification is added to bug report and nomination for releases are used to track progress for each release (if appropriate).
Line 34: Line 34:
  * The milestone is set for the next official update release.

'''SRUs from the stable kernel tree'''

Since the process for stable kernel updates ([[http://lwn.net/Articles/126915/|LWN article]])
is very similar to our SRU process and there have been quite a number of bugs
that have been solved by finally finding out that there has been a fix in
the stable tree, those patches will be added as soon as a new stable tree release
is published (see the RFC about this at [[https://wiki.ubuntu.com/KernelTeam/RFC|the RFC page]]).

The process for this looks like this:

  * Stable release updates from the kernel.org stable kernel that matches the kernel version will qualify as SRU updates. There will be one LP bug to track the merge.

  * The merge has to be announced on the kernel-team mailing list and should also be ''ACK''ed by at least one (two) members of the kernel team.

  * Updates resulting from stable tree imports should be kept at least 2 weeks in -proposed before moving to -updates. Any change or regression in the stable tree resets the counter.

  * Regressions (if there are any) will be tracked in separate LP bugs.
  * The milestone is set for the next official update release only for bugs that are important (iow when you want to be chased by a release manager if that patch fails to get included).
Line 72: Line 53:
  * ['''TBD'''] verification of the vulnerability (if possible)
    ''this would be good but requires automated tests''

Proposed work flow for security updates with unreleased or pending -proposed
updates:

  * create a branch based on the last official (-updates/-security) release

  * add fixes and do the release from this branch

  * after release (and after gathering the ABI files) merge back to main tree.

This makes sure the version of the security release can be checked out
and based upon.
  * Kees has a little test script in bazar which is good for testing: {{{
bzr branch lp:~ubuntu-bugcontrol/qa-regression-testing/master qa-regression-testing
cd qa-regression-testing/scripts
sudo apt-get install build-essential python-unit sudo libcap2-bin lsb-release
./test-kernel-security.py -v
}}}

Work flow for security updates with unreleased or pending -proposed updates:

 * create a branch based on the last official (-updates/-security) release

 * add fixes and do the release from this branch

 * after the security release is final and if there was a release in proposed, create a new branch which is based on the last proposed release, merge back the security branch and prepare everything for a rebuild (fix up ABI files and the changelog).

 * Finally check out the master branch, merge back either the security or proposed branch and fix up the ABI and changelog.

This makes sure the version of the security release can be checked out and based upon.
Line 88: Line 73:

==== Versioning ====

A general rule is that the security release has to be a higher version/release number than anything else. This causes some headaches if there is a proposed version not yet moved into updates, especially if this is an ABI bumper.

 1. If there is no kernel package in proposed, the security release just gets the next release number. Should the security release require an ABI bump, this is also done like normally.
 1. If there is a kernel in proposed, the security release gets the next number that would follow it.
 1. Should this proposed kernel be an ABI bumper, then the security release has to match that ABI number and the rebuild of proposed needs to bump the ABI again.

The following examples try to illustrate the version handling:

{{{
Updates: 1.1 --+-------------------------+--
Proposed: \-- 1.2 -------+-- 1.4 --/
Security: \-------- 1.3 /

Updates: 1.1 --+--------------------------+--
Proposed: \-- 2.2 ---------+-- 3.4 --/
Security: \-------- 2.3 --/
}}}

In any case where there was a proposed kernel pending and it has to be rebuild with the security patches included, the changelog will be modified to include all changes that have been recorded by proposed uploads which have not been moved to updates, as the new release and the old ones get dropped. Here an example. Given there have been two uploads to proposed accumulated but not moved to updates. The changlog would look like this:

{{{
linux (2.6.24-1.3) hardy-proposed ...
  - item 3
linux (2.6.24-1.2) hardy-proposed ...
  - item 2
  - item 1
linux (2.6.24-1.1) hardy ...
  - in updates
}}}

Then a security release comes and takes precedence. After that has been released we prepare a new upload to proposed and the changelog looks like that:

{{{
linux (2.6.24-1.5) hardy-proposed ...
  - item 3
  - item 2
  - item 1
linux (2.6.24-1.4) hardy-security ...
  - security update
linux (2.6.24-1.1) hardy ...
  - in updates
}}}
Line 132: Line 162:
      Bug: #0815       BugLink: http://bugs.launchpad.net/bugs/<bugnumber>
Line 177: Line 207:
  * The ABI files have to be fetched. Would it make sense to get them, then change the release tag to that state? Better would be to get those from test builds. Currently the only problem is HPPA (no host).

  * The creation of the new release uses ''whoami'' and stuff. Might be better to take DEBNAME and DEBEMAIL...
  * The ABI files have to be fetched when starting a new release. The buildscript build-getabis can be used to fetch the ABI files from the builders. So one has not to wait until the upload is complete.

This document is intended to document the processes involved in the maintenance of stable (after release) kernel trees. Those should be independent of a specific release. If not, this should be noted on the specific description.

Post-release updates

SRUs/bugs

Stable release updates will be done after the initial release. To prevent regressions there are a more formal process involved in getting new patches included. The process is described in general at StableReleaseUpdates with a kernel specific part described KernelUpdates.

  • Every SRU needs a bug. Patches are sent to kernel mailing list and have to get at least two ACKs from other senior kernel developers (those in the kernel_cdev group on zinc).

  • All patches should be signed-off-by the person who did the patch. The developer who is committing the final patch, also needs to add his SOB.
  • Patches from upstream should not change the submitter's reference. They should be cherry-picked or exported and then re-imported (git format-patch and git-am. Personally I do a

    git format-patch -s <sha> -1
    then add bug and/or CVE references and then import the resulting patch (the -s automatically adds a signed-of-by line).
  • Changes that require an kABI bump should be marked by adding "BumpABI: yes" to the git message. This is a manual process but makes life simpler of someone asks why the ABI has been bumped.
  • SRU justification is added to bug report and nomination for releases are used to track progress for each release (if appropriate).
  • ubuntu-sru has to get subscribed
  • The milestone is set for the next official update release only for bugs that are important (iow when you want to be chased by a release manager if that patch fails to get included).

CVEs/security updates

Current contact: Kees Cook

CVE updates usually are done in batches (except for very critical problems). There is a list of CVEs and all currently maintained releases have to be checked for possible vulnerabilities.

The patchsets are prepared by one member of the stable maintenance team but not pushed if any of the patches still is embargoed.

  • test builds must be done at least for i386 and amd64
  • test packages and upload sources are provided on an internal server (e.g. chinstrap).
  • boot tests should be done for i386 (and amd64)
  • Kees has a little test script in bazar which is good for testing:

    bzr branch lp:~ubuntu-bugcontrol/qa-regression-testing/master qa-regression-testing
    cd qa-regression-testing/scripts
    sudo apt-get install build-essential python-unit sudo libcap2-bin lsb-release
    ./test-kernel-security.py -v

Work flow for security updates with unreleased or pending -proposed updates:

  • create a branch based on the last official (-updates/-security) release
  • add fixes and do the release from this branch
  • after the security release is final and if there was a release in proposed, create a new branch which is based on the last proposed release, merge back the security branch and prepare everything for a rebuild (fix up ABI files and the changelog).
  • Finally check out the master branch, merge back either the security or proposed branch and fix up the ABI and changelog.

This makes sure the version of the security release can be checked out and based upon.

Note: Had to use "git push origin master" to get merges visible.

Versioning

A general rule is that the security release has to be a higher version/release number than anything else. This causes some headaches if there is a proposed version not yet moved into updates, especially if this is an ABI bumper.

  1. If there is no kernel package in proposed, the security release just gets the next release number. Should the security release require an ABI bump, this is also done like normally.
  2. If there is a kernel in proposed, the security release gets the next number that would follow it.
  3. Should this proposed kernel be an ABI bumper, then the security release has to match that ABI number and the rebuild of proposed needs to bump the ABI again.

The following examples try to illustrate the version handling:

Updates:  1.1 --+-------------------------+--
Proposed:        \-- 1.2 -------+-- 1.4 --/
Security:         \-------- 1.3 /

Updates:  1.1 --+--------------------------+--
Proposed:       \-- 2.2 ---------+-- 3.4 --/
Security:        \-------- 2.3 --/

In any case where there was a proposed kernel pending and it has to be rebuild with the security patches included, the changelog will be modified to include all changes that have been recorded by proposed uploads which have not been moved to updates, as the new release and the old ones get dropped. Here an example. Given there have been two uploads to proposed accumulated but not moved to updates. The changlog would look like this:

linux (2.6.24-1.3) hardy-proposed ...
  - item 3
linux (2.6.24-1.2) hardy-proposed ...
  - item 2
  - item 1
linux (2.6.24-1.1) hardy ...
  - in updates

Then a security release comes and takes precedence. After that has been released we prepare a new upload to proposed and the changelog looks like that:

linux (2.6.24-1.5) hardy-proposed ...
  - item 3
  - item 2
  - item 1
linux (2.6.24-1.4) hardy-security ...
  - security update
linux (2.6.24-1.1) hardy ...
  - in updates

Updates to custom binaries (virtual/openvz/...)

Custom binary builds are usually community maintained and not as critical as the main kernel flavours. Nevertheless updates should follow a certain pattern to be clearly documented.

  • Get triggered by a community member (usually kernel-team mailing list)
  • Open a LP bug for SRU documentation
  • Create a branch and pull/cerry-pick
  • Do a test build
  • Publish the SRU request on the kernel-team list. References to patches as gitweb links since patches might be big.

Test builds

Either in a PPA or on the porter machines. HPPA is a problem due to hardware access.

Release

Pre-release tasks

A new upload is prepared by editing/creating the changelog (KernelMaintenance)

  • Use chroots to create the uploads (because scripts depend on certain environments)
  • The insertchanges target does not always work properly, especially on older releases. Always make sure to check the generated file.

  • Are there duplicate/unwanted entries?
  • Has every entry a bug reference?
    • Ubuntu patches (UBUNTU keyword prefixed) automatically get this if they contained a Bug keyword in the description. Some of the build environments have been updated to do the same for upstream patches with a Bug entry.

    • Patches from upstream did not (but do with updated scripts and if they include a Bug keyword.

    • CVEs should have the CVE-xxxx-xxxx number in their description
      •       UBUNTU: Fix stupid bug
        
              BugLink: http://bugs.launchpad.net/bugs/<bugnumber>
              CVE-2008-0815
  • The changelog keeps order of uploads, git log the order of check-ins but this cannot always be honoured. The make process cannot handle complicated forth and back of ABI releases. But in general the sequence of the changelog reflects the upload history

On updates the command for generating the source package should include the -v option (and have the orig.tar.gz, to do only diff uploads). If the the orig.tar.gz file is placed into the directory above the kernel tree, this will be done automagically.

dpkg-buildpackage -S -rfakeroot -I.git -I.gitignore -i'\.git.*' \
       -v<version>

A note to <version>: this should be the last relevant version uploaded. So for uploads to -proposed this should be the last version uploaded to updates. Updates to security should probably be done the same way, but since -security is moved to -updates rather quickly, both will be the same version anyway.

The actual release

The release is done by uploading the source packages to special servers. If the kernel ABI has changed, LUM, LBM and LRM must be uploaded with updated version/ABI numbers as well. Also the linux-meta package must be updated and uploaded (after the other packages are done).

  • The upload target differs, depending on the type of upload:
    • -security uploads go to security.ubuntu.com (jackass) while

    • -proposed uploads go to upload.ubuntu.com

  • The packages have to be signed by someone with the upload rights and the uploaded packages will be invisible until they are ACCEPTED

    • For -security uploads the contacts are kees or jdstrand. For those the status is even invisible after acceptance.

    • For -proposed uploads the packages have to be accepted by either slangasek or pitty (or cjwatson(?))

  • If the kABI changed note the reasoning on the stable kernel ABI wiki page. This must also be announced by mails to

  • Somehow also keep track of the changes in supported hardware to gather this for releases.

Post-release tasks

As described in KernelMaintenance. Thoughts on that:

  • The ABI files have to be fetched when starting a new release. The buildscript build-getabis can be used to fetch the ABI files from the builders. So one has not to wait until the upload is complete.

KernelTeam/StableKernelMaintenance (last edited 2016-07-07 19:32:24 by kamalmostafa)