Jump to: navigation, search

Difference between revisions of "StarlingX/Release Plan"

m (Release Planning References)
 
(50 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
<big><big> '''Releases''' </big></big>
  
 +
StarlingX is released periodically; one beta release in 2018 and two releases/year starting in 2019.  A release consists of a branch in the source code repositories that enables repeatable builds over time.
 +
----
 +
== Release Definition ==
 +
A StarlingX milestone/release is a tagged branch in the source code repositories that:
 +
* is considered stable and can be used for repeatable builds
 +
* will have no additional features added
 +
* will backport bug fixes for critical/high issues only
 +
* will be maintained in the canonical repositories for a specified minimum period
 +
* The list of repos included is maintained in stx-manifest/default.xml (or similar) for any given release. (Note: this file included non-StarlingX-managed repos, only repos from the "starlingx" and "stx-staging" remotes are included.)
 +
* The actual release is a tag on the corresponding branch, i.e. r/stx.2.0 release branch will be initially tagged as v2.0.0.rc0, the actual release will be tagged as v2.0.0
 +
* In addition to source, the corresponding binaries will be made available on the StarlingX CENGN mirror (see the [[StarlingX/Build#Starling_X_Mirror|the build team page]] for more details).
  
=== Release Plan ===
+
== Release Cadence and Schedule ==
 +
'''Releases are published in a time based fashion:'''
 +
* The initial (beta) StarlingX release was released in October 2018.
 +
* In 2019 and moving forward, StarlingX releases will align with OpenStack releases. StarlingX will have two releases a year, following a cycle-trailing model relative to the OpenStack release cycle.
 +
** The goal is to release StarlingX 4-6 weeks after the corresponding OpenStack release.
 +
** Background: During the OpenStack Berlin Summit in Nov 2018, the StarlingX TSC discussed a proposal to have StarlingX track OpenStack master during the development cycle and align on the latest OpenStack release once available. To support this direction, the StarlingX release cadence was updated accordingly.
  
The community has decided to adapt the quarterly release cadence. We agreed to follow the time-based release process. If your code is ready, it gets released. If it's not ready, you wait for the next release
+
=== Formal Releases ===
 +
* Released two times per year
 +
* Branch name format r/X.0
 +
** 'r/' is the branch name prefix (release)
 +
** 'X' is the major release identifier
 +
* Release Candidate is tagged as vX.Y.Z.rcN
 +
* Release is tagged as vX.Y.Z
  
We are going to support the quarterly release cadence using monthly branches. The branches will be named "stx.<year>.<month>, for example "stx.2018.07" for the branch for July 2018.  We will be pulling branches monthly to allow the project's testing team to have a stable environment to run long duration tests.
+
=== Branch Logistics ===
 +
* StarlingX master builds docker images from OpenStack master during the development cycle
 +
* Once the OpenStack release branch is created (ex: Stein), switch the builds to the release branch
 +
* Once the StarlingX release branch is created, the master StarlingX builds will switch back to OpenStack master in the default.xml manifest
 +
* The StarlingX release branch will continue building from the stable OpenStack release branch (ex: Stein)
 +
* StarlingX maintenance (dot) releases will periodically pick up the latest from the stable OpenStack release branch (ex: Stein)
 +
[[File:Stx-branch-logistics.png]]
  
Each quarter we will use the 2nd month's branch as the branch for the quarterly release. The releases will be named "stx.<year>.<month>.<patch number>, with the patch number starting at zero and increasing with each new patch (fix) on the branch. So the release for Q3 of 2018 will be named "stx.2018.08.0x", where "x" is the number of patches against that branchNote that the release is named after the month the branch was pulled in, not the month the release ships in.
+
== Release Milestones ==
 +
StarlingX follows the OpenStack release milestones. The criteria for each milestone is defined to align more closely with the StarlingX deliverables/development cycle
 +
* Milestone-1:
 +
** Release priorities and major features defined.
 +
** High level resourcing secured.
 +
* Milestone-2:
 +
** Spec freeze; no new specs accepted for the release. The focus is on closing current specs
 +
** Feature plans defined and feature development well underway
 +
** Release test plan defined - including test automation deliverables
 +
* Milestone-3:
 +
** Feature freeze: All feature code merged and feature testing completing within 2 weeks
 +
** No blocking issues from Automated Sanity and Regression
 +
** No critical issues severely impacting system stability or release test activities
 +
** Release regression testing underway
 +
** Documentation plan defined; including a prioritized list of the various documentation items
 +
* RC1 (aka RC period start):
 +
** Release branch created & first release candidate tagged
 +
** RC binaries (and supporting build artifacts) posted on the StarlingX CENGN mirror
 +
*** RC builds will be posted daily on CENGN during the RC period.  
 +
*** The daily builds will not be explicitly tagged until the end of the RC period.   
 +
** Final Release Testing Start
 +
** Only Bug fixes are allowed in the release branch.
 +
*** Bugs fixes must be sourced in master first before getting cherry-picked to the release branch.
 +
** Draft Release Notes available
 +
* Final Release
 +
** Release Testing Complete and Pass Rate meets project criteria (> 95% ?)
 +
** All release gating issues are addressed or reviewed/accepted for deferral
 +
** Release tagged on release branch
 +
** Release binaries (and supporting build artifacts) posted on the StarlingX CENGN mirror
 +
** Final documentation posted on docs.startlingx.io
  
The timeline for Q3 of 2018 looks like this:
+
== Release Maintenance ==
Week of July 9th - pull stx.2018.07 branch for testing
+
* Formal releases are maintained for a minimum of 12 months to maintain support for two previous StarlingX releases.
Week of August 6th - pull stx.2018.08 branch as the Q3 release branch
+
* During the maintenance window, the release team will evaluate monthly whether a maintenance release is required.
Week of September 10th - pull stx.2018.09 branch for testing
+
** The maintenance release will be tagged on the release branch.
 +
** The maintenance release will undergo a mini regression test cycle.
 +
** The corresponding binaries will be posted on the StarlingX CENGN mirror.
 +
* After the 12-month maintenance window, the release will be considered End of Life.
  
Any defects found in a branch should be fixed on master. Fixes needed for a release or to unblock testing shall be cherry picked into the branch as needed.
+
== List of Releases ==
 +
'''Planned'''
 +
{| class="wikitable"
 +
|-
 +
! Version !! Milestone-1 !! Milestone-2 !! Milestone-3 !! RC1 !! Release Date !! End of Life Date
 +
|-
 +
| stx.1.0 || N/A || N/A || Sep 26 2018 || Sep 28 2018 || Oct 24 2018 || N/A
 +
|-
 +
| stx.2.0 || Jan 18 2019 || Apr 29 2019 || June 21 2019 || Aug 5-9 2019 || Aug 30 2019 || Aug 2020
 +
|-
 +
| stx.3.0 || Jul 17 2019 || Sep 19 2019 || Nov 15 2019 || Nov 2? 2019 || Dec 13 2019 || Dec 2020
 +
|}
  
[[File:Stx  Release Plan.png||]]
+
== Release Planning References ==
 +
* For team members and other information, visit the StarlingX Releases sub-project wiki page [https://wiki.openstack.org/wiki/StarlingX/Releases here]
 +
* Release Planning Etherpad: https://etherpad.openstack.org/p/stx-releases
 +
* stx.2.0 Release Plan: [https://docs.google.com/spreadsheets/d/1HUwbsaSerzFRuvXVB_qvoGdI0Chx1YiiA2WYHwvIoYI/edit?usp=sharing here]
 +
* stx.3.0 Release Plan: [https://docs.google.com/spreadsheets/d/1ZFR-9-riwhIwiBYBmWmi1qOVyHtgJ8Xk_FaF2jp5rY0/edit#gid=0 here]
 +
* stx.4.0 Release Plan: [https://docs.google.com/spreadsheets/d/1a93wt0XO0_JvajnPzQwnqFkXfdDysKVnHpbrEc17_yg/edit#gid=0 here]

Latest revision as of 15:20, 20 November 2019

Releases

StarlingX is released periodically; one beta release in 2018 and two releases/year starting in 2019. A release consists of a branch in the source code repositories that enables repeatable builds over time.


Release Definition

A StarlingX milestone/release is a tagged branch in the source code repositories that:

  • is considered stable and can be used for repeatable builds
  • will have no additional features added
  • will backport bug fixes for critical/high issues only
  • will be maintained in the canonical repositories for a specified minimum period
  • The list of repos included is maintained in stx-manifest/default.xml (or similar) for any given release. (Note: this file included non-StarlingX-managed repos, only repos from the "starlingx" and "stx-staging" remotes are included.)
  • The actual release is a tag on the corresponding branch, i.e. r/stx.2.0 release branch will be initially tagged as v2.0.0.rc0, the actual release will be tagged as v2.0.0
  • In addition to source, the corresponding binaries will be made available on the StarlingX CENGN mirror (see the the build team page for more details).

Release Cadence and Schedule

Releases are published in a time based fashion:

  • The initial (beta) StarlingX release was released in October 2018.
  • In 2019 and moving forward, StarlingX releases will align with OpenStack releases. StarlingX will have two releases a year, following a cycle-trailing model relative to the OpenStack release cycle.
    • The goal is to release StarlingX 4-6 weeks after the corresponding OpenStack release.
    • Background: During the OpenStack Berlin Summit in Nov 2018, the StarlingX TSC discussed a proposal to have StarlingX track OpenStack master during the development cycle and align on the latest OpenStack release once available. To support this direction, the StarlingX release cadence was updated accordingly.

Formal Releases

  • Released two times per year
  • Branch name format r/X.0
    • 'r/' is the branch name prefix (release)
    • 'X' is the major release identifier
  • Release Candidate is tagged as vX.Y.Z.rcN
  • Release is tagged as vX.Y.Z

Branch Logistics

  • StarlingX master builds docker images from OpenStack master during the development cycle
  • Once the OpenStack release branch is created (ex: Stein), switch the builds to the release branch
  • Once the StarlingX release branch is created, the master StarlingX builds will switch back to OpenStack master in the default.xml manifest
  • The StarlingX release branch will continue building from the stable OpenStack release branch (ex: Stein)
  • StarlingX maintenance (dot) releases will periodically pick up the latest from the stable OpenStack release branch (ex: Stein)

Stx-branch-logistics.png

Release Milestones

StarlingX follows the OpenStack release milestones. The criteria for each milestone is defined to align more closely with the StarlingX deliverables/development cycle

  • Milestone-1:
    • Release priorities and major features defined.
    • High level resourcing secured.
  • Milestone-2:
    • Spec freeze; no new specs accepted for the release. The focus is on closing current specs
    • Feature plans defined and feature development well underway
    • Release test plan defined - including test automation deliverables
  • Milestone-3:
    • Feature freeze: All feature code merged and feature testing completing within 2 weeks
    • No blocking issues from Automated Sanity and Regression
    • No critical issues severely impacting system stability or release test activities
    • Release regression testing underway
    • Documentation plan defined; including a prioritized list of the various documentation items
  • RC1 (aka RC period start):
    • Release branch created & first release candidate tagged
    • RC binaries (and supporting build artifacts) posted on the StarlingX CENGN mirror
      • RC builds will be posted daily on CENGN during the RC period.
      • The daily builds will not be explicitly tagged until the end of the RC period.
    • Final Release Testing Start
    • Only Bug fixes are allowed in the release branch.
      • Bugs fixes must be sourced in master first before getting cherry-picked to the release branch.
    • Draft Release Notes available
  • Final Release
    • Release Testing Complete and Pass Rate meets project criteria (> 95% ?)
    • All release gating issues are addressed or reviewed/accepted for deferral
    • Release tagged on release branch
    • Release binaries (and supporting build artifacts) posted on the StarlingX CENGN mirror
    • Final documentation posted on docs.startlingx.io

Release Maintenance

  • Formal releases are maintained for a minimum of 12 months to maintain support for two previous StarlingX releases.
  • During the maintenance window, the release team will evaluate monthly whether a maintenance release is required.
    • The maintenance release will be tagged on the release branch.
    • The maintenance release will undergo a mini regression test cycle.
    • The corresponding binaries will be posted on the StarlingX CENGN mirror.
  • After the 12-month maintenance window, the release will be considered End of Life.

List of Releases

Planned

Version Milestone-1 Milestone-2 Milestone-3 RC1 Release Date End of Life Date
stx.1.0 N/A N/A Sep 26 2018 Sep 28 2018 Oct 24 2018 N/A
stx.2.0 Jan 18 2019 Apr 29 2019 June 21 2019 Aug 5-9 2019 Aug 30 2019 Aug 2020
stx.3.0 Jul 17 2019 Sep 19 2019 Nov 15 2019 Nov 2? 2019 Dec 13 2019 Dec 2020

Release Planning References