diff --git a/docs/konflux-onboarding.md b/docs/konflux-onboarding.md index 45d4d08a..c3ee202d 100644 --- a/docs/konflux-onboarding.md +++ b/docs/konflux-onboarding.md @@ -41,7 +41,7 @@ We onboarded the bundle component after the first two components were built. The If all of your components are not building properly when you onboard new components, you may see some failures in the onboarding PR. For example, we saw a failure in the [onboarding PR](https://github.com/konflux-ci/olm-operator-konflux-sample/pull/5) due to another component being built. That issue was being worked on in [another PR in parallel](https://github.com/konflux-ci/olm-operator-konflux-sample/pull/4) and had not yet been merged. Another case where the PRs can indicate failure from other components is if the IntegrationTestScenarios (ITS) are reporting an error. Since the ITS is run against a snapshot of all components in an application, a failure in one (for example an enterprise contract violation) will report back on a PR for any component in the application. If you do not want to override the CI failures to merge, then you will need to ensure that the base reference is properly building before onboarding a new component. -**CAUTION:** When adding the bundle image, you will need to establish a process for maintianing the ClusterServiceVersion. This includes ensuring that `spec.relatedImages` is complete with all sha digest references for all images that may be required to install the operator which enables the images to be mirrored for a disconnected installation of the operator. You can either do this manually, with your own script, or with a tool like [operator-manifest-tools](https://github.com/operator-framework/operator-manifest-tools/blob/main/docs/operator-manifest-tools_pinning_replace.md) or[operator-manifest](https://github.com/containerbuildsystem/operator-manifest#pull-specifications). [PR#82](https://github.com/konflux-ci/olm-operator-konflux-sample/pull/82) is an example of updating these with a script. +**CAUTION:** When adding the bundle image, you will need to establish a process for maintianing the ClusterServiceVersion. This includes ensuring that `spec.relatedImages` is complete with all sha digest references for all images that may be required to install the operator which enables the images to be mirrored for a disconnected installation of the operator. You can either do this manually, with your own script, or with a tool like [operator-manifest-tools](https://github.com/operator-framework/operator-manifest-tools/blob/main/docs/operator-manifest-tools_pinning_replace.md) or [operator-manifest](https://github.com/containerbuildsystem/operator-manifest#pull-specifications). [PR#82](https://github.com/konflux-ci/olm-operator-konflux-sample/pull/82) is an example of updating these with a script. ## Maintain the pipeline task references