Skip to content

WIP: Add docs for publishing FBC in new Openshift version #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
grzpiotrowski wants to merge 1 commit into
base: main
Choose a base branch
from
+40 −0
Draft

WIP: Add docs for publishing FBC in new Openshift version #558

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/konflux-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,46 @@ Once the bundle is released to the stage registry, add it to the FBC catalog tem

Create a PR with the updated catalog templates and generated catalogs, and merge it into `main` — the catalog directory only exists on `main`, not on release branches.

#### Create FBC Catalog for new Openshift version

If the FBC catalog does not yet exist for a given OCP version, follow these steps to create it:

1. **Add catalog files in external-dns-operator repository**

Create the following files for the new OCP version (e.g., `v4.22`):
- `catalog/v4.22/catalog-template.yaml` - The FBC catalog template
- `Containerfile.external-dns-operator-catalog-v4-22` - The catalog Containerfile

Reference PR: [#322](https://github.com/openshift/external-dns-operator/pull/322) shows an example of adding catalogs for v4.19 and v4.20.

2. **Generate the catalog**

Run the catalog generation command for the new version:
```bash
OCP_VERSION=4.22 make generate-catalog
```

3. **Create Konflux resources in konflux-release-data repository**

In the [konflux-release-data](https://gitlab.cee.redhat.com/releng/konflux-release-data) repository, create the following resources for the new FBC version:
- Konflux Application
- Component with the `fbc-builder` pipeline type and referencing the `external-dns-operator-catalog-v4-22` Containerfile.
- ReleasePlanAdmission (for stage ang production)
- ReleasePlan (for stage and production)

Reference MR: [!17707](https://gitlab.cee.redhat.com/releng/konflux-release-data/-/merge_requests/17707) shows an example of adding Konflux resources for FBC v4.22.

4. **Merge .tekton files generated by ArgoCD**
After the new resource definitions are merged in `konflux-release-data`, ArgoCD automatically creates `.tekton` files for the new FBC version to be merged into the [.tekton](https://github.com/openshift/external-dns-operator/tree/main/.tekton) directory in the `external-dns-operator` repository.

5. **Create Releases for the new catalog**

Once the Konflux resources are in place and the catalog PR is merged:
- Create a Release CR for the **stage** registry to test the catalog
- After validation, create a Release CR for the **production** registry

The release process follows the same pattern as described in [Release FBC to Production Operator Index](#release-fbc-to-production-operator-index).

### Test index images

Once the FBC update PR is merged, releases are automatically created. The release artifacts contain index images that can be used by QE to validate the release on different OCP versions.
Expand Down