Jump to: navigation, search

StarlingX/Release Plan

< StarlingX
Revision as of 18:48, 13 December 2018 by Ghada.khalil (talk | contribs)


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 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/2018.10 release branch will be initially tagged as 2018.10.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, StarlingX releases will align with openstack releases. StarlingX will have two releases a year, following a cycle-trailing model relative to openstack core releases.
    • The goal is to release the StarlingX release 6 weeks (to be confirmed based on the January StarlingX planning session in Chandler) after the corresponding openstack release.
    • Background: During the Openstack Berlin Summit in Nov 2019, 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/YYYY.MM[.n]
    • 'r/' is the branch name prefix (release)
    • .n is a sequence number appended if more than one branch is created in a given month
  • Release Candidate is tagged as YYYY.MM.rcX
  • Release is tagged as YYYY.MM.0

Informal Monthly Milestones

  • Informal milestones to be created for a pre-defined sanity/regression test cycle.
  • Milestone is tagged as YYYY.MM.bN, where YYYY.MM is the year/month of the milestone date, and N is >=1 and incremented should there ever need to be multiple milestones in the same month.

NOTE: Milestones were originally branched similar to releases with a prefix of 'm/'. This is no longer done following the 2018.10 release.

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.
  • 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)


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
    • Feature Development underway
    • TBD: others? Doc deliverables? Test Automation deliverables?
  • Milestone-3:
    • Feature Freeze: All Feature Code Submitted and Feature Testing Complete
    • No blocking issues from Automated Sanity and Regression
    • Release Test Plan Defined (any specific test automation deliverables?)
    • Preliminary Documentation Available
    • TBD: any criteria for # of open bugs for the milestone declaration?
  • 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. (To be confirmed with Dean)
    • 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.
  • 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 12 months. This allows 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


Version Milestone-1 Milestone-2 Milestone-3 RC1 Release Date End of Life Date
2018.10.0 N/A N/A Sep 26 2018 Sep 28 2018 Oct 24 2018 N/A
2019.05.0 Jan 14-18 2019 Feb 18-22 2019 Apr 8-12 2019 Apr 29-May 3 2019 May 20-24 2019 May 2020

Note: The 2019.05.0 dates will be confirmed at milestone-1 based on the StarlingX Planning session in Chandler.

Release Team

  • For team members and other information, visit the StarlingX Releases sub-project wiki page here