rdoinfo is a git repository containing information about current RDO releases, packages, maintainers and more. Currently main YAML files, rdo.yml, deps.yaml, tags.yaml, buildsys-tags.yaml contains:
- rdo.yml contains information of RDO releases, OpenStack packages included in RDO Trunk
- repositories and package configurations used by these packages.
- deps.yml contains metadata for general purpose dependencies which are external requirements
- for OpenStack services and don't exist in CentOS core repositories. These packages are included in RDO CloudSIG repos.
- buildsys-tags.yaml are used to specify the tagged builds in RDO CloudSIG repos for each
- tag in CentOS Build System (CBS). It contains a set of mappings where the key is the CBS tag name and the value is the package NVR included in the tag.
- tags.yaml attribute is used by the RDO Trunk builders to determine which releases we need
- to build a package for, and if we need to use some release-specific information for a project.
NOTE: buildsys-tags.yaml and tags.yaml are just importing metadata from other files which contains buildsys-tags and tags info for packages.
rdoinfo repository have two main directories:
buildsys-tags are used to specify the tagged builds in RDO CloudSIG repos for each tag in CentOS Build System (CBS). In this dir, all files have specific convention: cloud centOS release number -openstack- release - phase where:
- centOS release number - since Yoga release, it's be 9s only
- release - official Openstack release name as Antelope, Bobcat, etc. Available Openstack release names you can find here [1].
- phase - name of fallowing phase:
- candidate phase is assigned to packages to be rebuilt in CBS but not pushed to any RDO repository.
- el8s-build (only available for Train to Yoga) and el9s-build (only available for Yoga and newer releases) is assigned to packages that only required to build other packages but are not a runtime requirement for any other package.
- testing means that the package is used in deployments using RDO Trunk repo and published in a testing repo, but not official CloudSIG repository.
- release is used for packages built and on the end for sending them to
- the Cloud SIG repo.
- In addition to the release names, we can use some special tag:
- version-locked is used to prevent our periodic jobs from proposing updates to the source-branch tag in projects managed by the upper-constraints file.
- under-review is used for packages that should be built by DLRN, but not
- included in DLRN trunk repos.
Example what metadata is set in buildsys-tags/* files will be explained below.
- tags in this directory, all files contains metadata for under-development OpenStack release.
- Each file have one of the following convention:
- release is the name of Openstack release
- release-uc all projects with in the files, pins to the source-branch of all projects
- included in Openstack upper-constraints to the versions in that file. In other words, -uc tag is for the current development release with all dependencies that are set to version defined in upper-constraints file.
Example what metadata is set in tags/* yaml files will be explained below.
rdoinfo python module provided in this repo is needed for parsing and validating the info file.
Each file has its use. Below are examples of metadata per yaml file.
For rdo.yaml file:
release:
...
- name: caracal
status: development
branch: rpm-master
identifier: "2024.1"
tags_map: separated_buildreqs
repos:
- name: el9s
buildsys: cbs/cloud9s-openstack-caracal-el9s
buildsys-tags:
- cloud9s-openstack-caracal-el9s-build
- cloud9s-openstack-caracal-candidate
- cloud9s-openstack-caracal-testing
distrepos:
- name: RDO Caracal el9s
url: http://mirror.stream.centos.org/SIGs/9-stream/cloud/x86_64/openstack-caracal/
- name: CentOS Stream 9 BaseOS
url: http://mirror.stream.centos.org/9-stream/BaseOS/x86_64/os/
- name: CentOS Stream 9 AppStream
url: http://mirror.stream.centos.org/9-stream/AppStream/x86_64/os/
- name: CentOS Stream 9 HighAvailability
url: http://mirror.stream.centos.org/9-stream/HighAvailability/x86_64/os/
- name: CentOS Stream 9 CRB
...
package-default:
name: python-%(project)s
distgit: ssh://pkgs.fedoraproject.org/python-%(project)s.git
patches: http://review.rdoproject.org/r/openstack/%(project)s.git
master-distgit: https://github.com/rdo-packages/%(project)s-distgit.git
tags:
caracal-uc:
bobcat:
antelope:
zed:
...
package-configs:
somepackage:
name: openstack-%(project)s
upstream: https://opendev.org/openstack/%(project)s
distgit: https://github.com/rdo-packages/%(project)s-distgit.git
patches: http://review.rdoproject.org/r/openstack/%(project)s.git
master-distgit: https://github.com/rdo-packages/%(project)s-distgit.git
review-patches: ssh://review.rdoproject.org:29418/openstack/%(project)s.git
review-origin: ssh://review.rdoproject.org:29418/openstack/%(project)s-distgit.git
component: common
maintainers:
- null@rdoproject.org
packages:
# OpenStack Puppet Modules
- project: puppet-aodh
conf: rpmfactory-puppet
...
components:
- name: common
- name: computeFollowing attributes are assigned to rdo.yaml file:
- release section - phase means that is published in the official CloudSIG repository.
This phase is only available after a RDO version has been officially released not for the one currently under development.
- name: Openstack release name
- branch: project distgit branch
- identifier: release year-based identifier (since antelope)
- tags_map: possible value separated_buildreqs and unified_buildreqs;
- option helps to build legacy packages before Rocky OS release with proper tag. More info [9]
- repos defines main repo name, CBS [2] build target tags, repository url for built packages
- package-default section - default information. If package doesn't include that data, it will be set from this section
- name: package name
- distgit: package distgit repo that include spec files, startup scripts, etc.
- patches: RDO repository that contains required patches for building package
- master-distgit: upstream repository url. For example: base on that repository, some scripts
- will get informations to checkout on current master commit [10].
- tags: available tags in distgit repository. Usually are named as Openstack releases.
- package-configs section - main package metadata that will be used later in packages section
- name: package name
- upstream: upstream repository url
- distgit: package distgit repo that include spec files, startup scripts, etc.
- patches: RDO repository that contains required patches for building package
- master-distgit: upstream repository url. For example: base on that repository, some scripts
- will get informations to checkout on current master commit [10].
- review-patches: the RDO project git repository url for package fixes
- review-origin: the RDO project package distgit git repository
- component: it defines package role
- maintainers: responsible person for update and fix building issues
- packages: section - defines all available packages to build
- conf: is defining which package-config should be used for building
components section - names of available package role
For deps.yml file:
package-configs:
fedora-dependency:
# This is the conf for dependencies rebuilt from Fedora distgit
# and using cbs-tags for automatic tagging
distgit: https://src.fedoraproject.org/git/rpms/%(project)s.git
patches:
master-distgit: https://src.fedoraproject.org/git/rpms/%(project)s.git
review-patches:
review-origin:
tags:
dependency:
maintainers:
- nobody@rdoproject.org
...
packages:
- project: python-sphinx
name: python-sphinx
conf: rdo-dependency
upstream: https://github.com/sphinx-doc/sphinxFollowing attributes are assigned to config in package-config:
- distgit: git repository containing the distgit for the package, used by dlrn rdoinfo driver.
- patches: git repository containing patches applied on packaging
- master-distgit: upstream repository url. For example: base on that repository, some scripts
- will get informations to checkout on current master commit [10].
- review-patches: git repository for gerrit reviews for patches applied on packaging
- review-origin: git repository for gerrit reviews on distgit
- tags: tag name to checkout before packaging
- maintainers: username and email of person responsible for the package
And for the packages: * project: project name * name: package name * conf: package configuration informations; it is defined in package-configs key * upstream: official project url
For buildsys-tags/* file:
packages:
...
- project: ansible-role-chrony
buildsys-tags:
cloud7-openstack-train-testing: ansible-role-chrony-1.0.1-1.el7Following attributes are assigned for e.g. buildsys-tags/cloud7-openstack-train-testing.yml
- project package project name
- buildsys-tags name of CBS [3] build tag
For tags/train.yaml file:
packages:
- project: ansible-role-chrony
tags:
train:
...
Following attributes are assigned for e.g.: train.yaml file:- project: package project name
- tags: Openstack release name
DLRN can build packages using different upstream branches, not only master. For example, we have DLRN workers building packages for the Train and Stein releases. That allows us to test each commit landing to stable/train and stable/stein before it is part of a release. [4] Before packaging, all described yaml files are merged into one using rdo-full.yml file, so after that DLRN is able to get all required informations (more info in verify.py file).
rdoinfo is managed using [RDO SoftwareFactory instance] [7]. In order to modify it you need to [login using your github account] [8]. Once your account is created:
Clone the rdoinfo repository:
Edit the rdo.yml or deps.yml files with the required changes.
Run tox -e validate command for basic sanity check.
Use git review to propose a change.
rdoinfo is a dynamic information source so you probably want some mechanism to sync latest from github and import the rdoinfo parser module in order to have up-to-date RDO information.
See rdoinfo/__init__.py:parse_info_file function or verify.py script to get an idea what's going on.
All rdoinfo tools are using another tool: distroinfo which is a python module for parsing, validating and querying distribution/packaging metadata stored in human readable and reviewable text/YAML files [11]. Earlier, RDO project was using a tool called rdopkg [5]. More informations how to use distroinfo module, you can find here [12].
| [1] | http://releases.openstack.org/ |
| [2] | https://cbs.centos.org/ |
| [3] | https://github.com/softwarefactory-project/DLRN |
| [4] | https://www.rdoproject.org/what/dlrn/ |
| [5] | (1, 2) https://github.com/redhat-openstack/rdopkg |
| [6] | https://github.com/openstack-packages/DLRN |
| [7] | https://review.rdoproject.org/r/#/q/project:rdoinfo |
| [8] | https://review.rdoproject.org/auth/logout |
| [9] | https://softwarefactory-project.io/r/#/c/11864/ |
| [10] | (1, 2, 3) https://github.com/softwarefactory-project/DLRN/blob/master/dlrn/drivers/local.py#L90 |
| [11] | (1, 2) https://github.com/softwarefactory-project/distroinfo |
| [12] | https://github.com/softwarefactory-project/distroinfo#usage |