Step by step RDO release guide
Creating a new release in RDO is a complex process with multiple dependencies. This overview provides users and contributors information on what leads up to a release and what detailed steps are to be performed before a new release. Not all steps are frozen in the sequence, but our experience shows that this is the most efficient way of working and some steps may be done in parallel.
These steps follow the processes found in OpenStack releases - typically for the cycle-with-intermediary type of releasing - which is repeatable every 6 months. First there are provided non-client libraries, followed by client libraries, then services and lastly there are provided release-trailing deliverables.
1. Create CBS tags for next release
At the very beginning, a new CBS tag for the next release should be created. This is needed before performing a switch to the new master. This operation is performed by creating a bug on pagure.io/centos-infra. An example can be found here.
2. Create a DLRN builder for the new OpenStack release in RDO Trunk servers.
Prepare new DLRN trunk builder.
DLRN builder is an instance used to build RDO Trunk repos (follow articles about RDO Trunk repos and RDO CloudSIG repos). Before we start working on new packages, we have to set the builder. The first step is a change in rdo-infra/ansible-role-dlrn, where we define new repositories for the builder, as an example. The second step is to define the new builder in sf-infra. A patch to sf-infra will to depend on the previous one from ansible-role-dlrn.
Before starting the building process, some steps have to be performed on the builder:
- Create the database, users and tables
- Set up authentication from trunk-centos8.rdoproject.org host to trunk.rdoproject.org
- Synchronize deps
Once the DLRN builder is ready, the bootstrap process can be started. This process is about building all DLRN packages in the proper sequence. Building is automated, but due to dependencies it may need to be restarted several times, and sometimes requires fixes in spec files.
Enable usual operations for the new DLRN Trunk builder
The new builder, to be fully operated, needs to have enabled operations which were not possible before bootstrapping. Examples can be found in sf-infra and ansible-role-dlrn.
This operation enables building new packages in the builders with any new commit in the projects (operated by cron), enables triggering automated gerrit reviews in case of FTBFS and sets the new builder visible on trunk.rdoproject.org website.
Enable distgit CBS builds for next release branch
When reviews appear in the new release branch, appropriate jobs and builds have to be triggered.
3. Requirement check - reqcheck
Most of the projects we are packaging are constantly being developed on, so their requirements can change - added, removed, in the new version or constrained. This check is being done manually, using the rdopkg reqcheck tool. First libraries and client packages are rechecked, then the core packages (like openstack-nova).
Even though the process seems to be not complicated, the appearing issues are often connected with missing dependencies. An example requirement check can be found here.
4. Build libs, clients and core projects in CloudSIG repos on CBS.
Once the requirement check is completes, the next step can be performed - building. To proceed with this, the new releases has to be created upstream. This step requires following steps:
- Cut rpm-master branch of distgit repo to create the <release>-rdo branch. This can be done with branching script from releng tooling, as an example, or manually by modifying config repo.
- Submit review with new version - a helpful script.
5. Pin, branch and build non-OpenStack puppet modules in CloudSIG repos
Non-OpenStack modules have to be pinned to the last promoted hash at branching time, since they don't follow the OpenStack lifecycle and RDO stable releases do not follow the master branches for them. The package has to be built based on the commit snapshot. This operation is done with the cooperation of the Puppet OpenStack team - these modules can be pinned after p-o-i team confirmation.
- Pin non OpenStack puppet modules, as example, using releng script.
- Cut branches, as in this review.
- Build, with releng script.
6. Move master RDO Trunk to next release tags
Rdoinfo buildsys-tags and tags can be moved to the next-release after openstack/requirements is branched. As in review and review. This action has to be coordinated with the reviews mentioned in the "Prepare new DLRN trunk builder" section above.
7. Branch OpenStack puppet modules and build them in CloudSIG repos
There is a bot which will automatically send the update reviews, when the tagged releases are created upstream. To trigger this step, we have to branch the distgit projects before the upstream p-o-i project creates the releases for the OpenStack puppet modules.
8. Pin, branch and build tempest and tempest plugins in CloudSIG repos
Following steps are required to perform this operation:
- Branch and build the tempest package with bootstrap mode enabled, as here
- Disable the bootstrap mode without bumping release, to have other Openstack-tempest packages in RDO Trunk - example
- Cut branches, as in this review
- Pin tempest plugins in rdoinfo
- Review automatically created reviews
- Update version of tempest plugin project
9. Create the puppet promotion pipeline
The Puppet promotion pipelines have to be defined as in patchset. Tests can be performed using testinfo. Newly defined jobs have to be assigned to the project - example.
10. Create the next release branch for dependencies
As development of dependencies is still ongoing, the new branch has to be prepared for featuring builds - as in this review.
New branches have to be created in the upstream requirements repo to complete this task.
11. Add support of the new release in ansible-role-weirdo-puppet-openstack
This is an example review of this operation.
12. Create the rdo-release RPM
Following step needs to be performed:
- Create next release branch in distgit repo, as in example
- Edit specification file
- Trigger CBS build
- Publish the RPM on repos.fedorapeople.org
More details about used commands can be found in task description.
13. Create weirdo jobs to promote to -release tag
The following jobs have to be defined in rdo-jobs repo. Such jobs will be triggered whenever promoting the package to -release tag.
14. Add the new release to dashboards
Currently there are three dashboards to update with new release:
- rdo-dev dashboard
- Promotion dashboard
- FTBFS dashboard
15. Create the new centos-release-openstack-
To prepare for final release, the new release rpm has to be created for CentOS CloudSIG in extras9s-extras-common-el9s, and later tagged in extras9s-extras-common-testing, -release, and finally build.
16. Promote GA builds to -testing and -release
The final step to publish the next RDO release is performed by review as following one and another, which can be done only after completing previous step.
17. Enable remaining monitoring on Grafana
Also monitoring, other than dashboards, should be activated for the new release: Prometheus and Grafana.
18. Unpin non OpenStack puppet modules and tempest plugins in master release
After the release, these projects can go back to active master. To do so, they have to be unpinned in rdoinfo.