diff --git a/docs/konflux-onboarding.md b/docs/konflux-onboarding.md index fc318c36..6c9dded5 100644 --- a/docs/konflux-onboarding.md +++ b/docs/konflux-onboarding.md @@ -63,8 +63,8 @@ Since bundle images are not rebuilt when they are pushed to another registry, we An OLM catalog describes the operators that are available for installation, their dependencies, and their upgrade compatibility. [File-based catalogs (FBC)s](https://olm.operatorframework.io/docs/reference/file-based-catalogs/) are the latest iteration of OLM's catalog format. While it is possible to manage your catalog file directly, there are two different [catalog templates](https://olm.operatorframework.io/docs/reference/catalog-templates/) that OPM provides to simplify the management based on a set of bundle references: -* [`basic template](https://olm.operatorframework.io/docs/reference/catalog-templates/#basic-template): This schema enables you to have full control of the graph by adding any valid [FBC schema](https://olm.operatorframework.io/docs/reference/file-based-catalogs/#olm-defined-schemas) components while only specifying the bundle image references. This results in a much more compact document. -* [`semver template`](https://olm.operatorframework.io/docs/reference/catalog-templates/#semver-template): This schema enables the auto-generation of channels adhering to [Semantic Versioning](https://semver.org/) (semver) guidelines and consistent with best practices on [channel naming](https://olm.operatorframework.io/docs/best-practices/channel-naming/#naming). This template is even simpler that the basic template is likely not possible to use if you are migrating to FBC from another catalog. If channel names and edges/nodes are misaligned from a previous catalog, it may be possible to make consumers stranded on the current version without an upgrade path. +* [`basic template`](https://olm.operatorframework.io/docs/reference/catalog-templates/#basic-template): This schema enables you to have full control of the graph by adding any valid [FBC schema](https://olm.operatorframework.io/docs/reference/file-based-catalogs/#olm-defined-schemas) components while only specifying the bundle image references. This results in a much more compact document. +* [`semver template`](https://olm.operatorframework.io/docs/reference/catalog-templates/#semver-template): This schema enables the auto-generation of channels adhering to [Semantic Versioning](https://semver.org/) (semver) guidelines and consistent with best practices on [channel naming](https://olm.operatorframework.io/docs/best-practices/channel-naming/#naming). This template is even simpler that the basic template, but is likely not possible to use if you are migrating to FBC from another catalog. If channel names and edges/nodes are misaligned from a previous catalog, it may be possible to make consumers stranded on the current version without an upgrade path. FBC components and their validation are uniquely different from that of normal container images, so a [dedicated pipeline](https://konflux-ci.dev/docs/advanced-how-tos/building-olm/#building-the-file-based-catalog) is provided with appropriate build-time checks. While operators and their bundles can often be supported on multiple platform (for example Red Hat OpenShift) versions, separate catalogs will often be generated for each platform version. Since there are often multiple streams/versions of bundle images that need to be referenced in the FBC components, it will likely be beneficial to isolate all FBC components in their own application. In this sample repository, however, we will include it in the same application as we will only illustrate generating a FBC for a single version of Red Hat OpenShift.