Skip to content

Latest commit

 

History

History
142 lines (105 loc) · 5.52 KB

release-checklists.rst

File metadata and controls

142 lines (105 loc) · 5.52 KB
Raw

Release checklists

Dev Kickoff

These steps should be taken when starting a new major release, just after the previous release has been tagged (vX.2.0) and that tag has been merged back into master.

X is the release we are just starting development on. X-1 is the one that was just released (X-1).2.0.

Versions and tags

  • [x] Update CMakeLists.txt VERSION (right at the top to X.0.0)
  • [x] Update src/librbd/CMakeLists.txt VERSION (librbd target at the bottom to 1.X.0)
  • [x] Update src/ceph_release with the new release name, number, and type ('dev')
  • [ ] Initial tag vX.0.0 (so that we can distinguish from (and sort
    after) the backported (X-1).2.Z versions.

### Notes on tagging * Tags must be annonated as CMake determines CEPH_GIT_NICE_VER by calling git describe --always. * vX.0.0 are special ones in the sense they are pushed manually (unlike v.X.2.n which are handled by Jenkins). * vX.0.0 should point to a commit before the first one in a kickoff branch.

Define release names and constants

Make sure X (and, ideally, X+1) is defined:

  • [x] src/common/ceph_releases.h (ceph_release_t)
  • [x] src/common/ceph_strings.cc (ceph_release_name())
  • [x] src/include/rados.h (CEPH_RELEASE_* and MAX)
  • [x] src/include/rbd/librbd.h (LIBRBD_VER_MINOR to X)
  • [x] src/mon/mon_types.h (ceph::features::mon::FEATURE_* and related structs and helpers; note that monmaptool CLI test output will need adjustment)
  • [x] src/mds/cephfs_features.h (CEPHFS_CURRENT_RELEASE)

Scripts

  • [ ] src/script/backport-resolve-issue (releases(), ver_to_release()... but for X-1)
  • [ ] src/script/ceph-release-notes (X-1)
  • [ ] ceph-build.git scripts/build_utils.sh release_from_version()

Misc

  • [ ] update src/ceph-volume/ceph_volume/__init__.py (__release__)
  • [ ] update src/tools/monmaptool.cc (min_mon_release and corresponding output in src/test/cli/monmaptool)
  • [ ] update src/cephadm/cephadm (DEFAULT_IMAGE_RELEASE to X)

Docs

  • [ ] Remove doc/releases/*.rst. This should leave behind doc/releases/releases.yml which is used for doc building purposes.
  • [ ] Cherry-pick 8cf9ad62949516666ad0f2c0bb7726ef68e4d666 ("doc: add releases links to toc"). There will be trivial conflicts.
  • [ ] Add redirect for new major release at RTD.

Feature bits

  • [x] ensure that SERVER_X is defined
  • [ ] change any features DEPRECATED in release X-3 are now marked RETIRED.
  • [ ] look for features that (1) were present in X-2 and (2) have no client dependency and mark them DEPRECATED as of X.

Compatsets

  • [ ] mon/Monitor.h (CEPH_MON_FEATURE_INCOMPAT_X)
  • [ ] mon/Monitor.cc (include in get_supported_features())
  • [ ] mon/Monitor.cc (apply_monmap_to_compatset_features())
  • [ ] mon/Monitor.cc (calc_quorum_requirements())
  • [ ] test/cli/monmaptool/feature-set-unset-list.t (supported, persistent)

Mon

  • [ ] qa/standalone/mon/misc adjust TEST_mon_features (add X cases and adjust --mon-debug-no-require-X)
  • [ ] qa/standalone/mon/misc bump up jqfilter='.monmap.features.persistent | length == N' to N+1
  • [ ] mon/MgrMonitor.cc adjust always_on_modules
  • [ ] common/options/global.yaml.in define mon_debug_no_require_X
  • [ ] common/options/global.yaml.in remove mon_debug_no_require_X-2
  • [ ] mon/OSDMonitor.cc create_initial: adjust new require_osd_release, and add associated mon_debug_no_require_X
  • [ ] mon/OSDMonitor.cc preprocess_boot: adjust "disallow boot of " condition to disallow X if require_osd_release < X-2.
  • [ ] mon/OSDMonitor.cc: adjust "osd require-osd-release" to (1) allow setting X, and (2) check that all mons and OSDs have X
  • [ ] mon/MonCommands.h: adjust "osd require-osd-release" allows options to include X
  • [ ] qa/workunits/cephtool/test.sh: adjust require-osd-release test

Code cleanup

  • [ ] search code for "after X-1" or "X" for conditional checks
  • [ ] search code for X-2 and X-3 (CEPH_FEATURE_SERVER_* and ceph_release_t::*)
  • [ ] search code for require_osd_release
  • [ ] search code for min_mon_release

QA suite

  • [ ] create qa/suites/upgrade/(X-1)-x
  • [ ] remove qa/suites/upgrade/(X-3)-x-*
  • [ ] create qa/releases/X.yaml
  • [ ] create qa/suites/rados/thrash-old-clients/1-install/(X-1).yaml

ceph-build

In the ceph/ceph-build.git repo:

  • [ ] add the version -> X mapping (release_from_version() in scripts/build_utils.sh)
  • [ ] add the option for X (case $RELEASE_BRANCH in ceph-dev-build/build/build_osc)
  • [ ] add the option for X (case $RELEASE_BRANCH in ceph-dev-build/build/setup_osc)
  • [ ] grep for previous release and add relevant build targets (e.g. for reef ceph/ceph-build#2076 and ceph/ceph-build#2119)

After dev freeze

First release candidate

  • [ ] src/ceph_release: change type to rc
  • [ ] opt-in to all telemetry channels, generate telemetry reports, and verify no sensitive details (like pools names) are collected

First stable release

  • [ ] src/ceph_release: change type stable
  • [ ] generate new object corpus for encoding/decoding tests - see :doc:`corpus`
  • [ ] src/cephadm/cephadm: update LATEST_STABLE_RELEASE