Ceph-CSI Stream is the Red Hat downstream project that contains the pre-release state of Ceph-CSI as used in the OpenShift Data Foundation product.

This GitHub repository contains branches for different product versions.

All changes in this repository are backports from the upstream project. There should be no functional changes (only process/CI/building/..) in this repository compared to the upstream project. Fixes for any of the release branches should first land in the devel branch before they may be backported to the release branch. A backport for the oldest release should also be backported to all the newer releases in order to prevent re-introducing a bug when a user updates.

Syncing branches (including the devel branch) from upstream should be done with a Pull-Request. To create a PR that syncs the latest changes from ceph/ceph-csi:devel into the devel branch, click here.

Once a PR has been merged in the devel branch that fixes an issue, a new PR with the backport can be created. The easiest way is to use a command like

/cherry-pick release-4.9

The openshift-cherrypick-robot will automatically create a new PR for the selected branch.

Once the product planning enters feature freeze, only backports with related Bugzilla references will be allowed to get merged.

To assist developers, there are several Pull Request templates available. It is recommended to use these links when creating a new Pull Request:

• backport: ?template=redhat-backport.md
• downstream-only: ?template=redhat-downstream-only.md
• sync: or add ?template=redhat-sync.md

The ?template=... appendix can be used when creating the Pull Requests through other means than the links above. By appending the ?template=... keyword to the Pull Request URL, the template gets included automatically.

For working with the downstream tools, like OpenShift CI, there are a few changes required that are not suitable for the upstream Ceph-CSI project.

1. OWNERS file: added with maintainers for reviewing and approving PRs
2. OWNERS_ALIASES file: members of the Ceph-CSI team
3. redhat/ directory: additional files (like this README.md)
4. redhat/Containerfile: used to build the quay.io/ocs-dev/ceph-csi image
5. .github/PULL_REQUEST_TEMPLATE/redhat-*: guidance for creating PRs

OpenShift CI (Prow) is used for testing the changes that land in this GitHub repository. The configuration of the jobs can be found in the OpenShift Release repository.

Images that have been built from a PR that was merged will get automatically pushed into the Qoay.io registry. The configuration for the mirroring job is part of the OpenShift Release repository.

When a new release is planned, the mirroring will need to have the new branch and tags listed as well.

Consumption of these images does not require any permissions, the images can be pulled with podman like:

podman pull quay.io/ocs-dev/ceph-csi:latest

PRs that need a Bugzilla reference are handled by the Bugzilla Plugin which runs as part of Prow. The configuration gates the requirement on BZs to be linked, before the tests will pass and the PR can be merged. Once a branch is added to the GitHub repository, the configuration needs adaption for the new branch as well.