Document FBC catalog builds and OLM v1 testing workflows#598
Conversation
…v1 guidance Agent-Logs-Url: https://github.com/kaovilai/ci-docs/sessions/a7d2c42f-700b-42bc-8e1d-88c828c0ca61 Co-authored-by: kaovilai <[email protected]>
Agent-Logs-Url: https://github.com/kaovilai/ci-docs/sessions/a7d2c42f-700b-42bc-8e1d-88c828c0ca61 Co-authored-by: kaovilai <[email protected]>
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hector-vido, kaovilai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
| FROM quay.io/operator-framework/opm:latest AS builder | ||
| ARG BUNDLE_IMG | ||
| RUN mkdir /catalog && \ | ||
| opm render ${BUNDLE_IMG} --output=yaml > /catalog/catalog.yaml && \ | ||
| opm validate /catalog | ||
|
|
||
| FROM scratch | ||
| COPY --from=builder /catalog /catalog | ||
| ENTRYPOINT ["/bin/opm"] | ||
| CMD ["serve", "/catalog"] |
There was a problem hiding this comment.
This will fail for a few reasons:
- A minimum valid FBC has
olm.package,olm.channel, andolm.bundle.opm render <bundleImage>only producesolm.bundle. FROM scratch, but then/bin/opm serve /catalogwill fail because scratch doesn't contain an opm binary.- You need
LABEL operators.operatorframework.io.index.configs.v1=/catalog
Also, note that opm serve is only necessary for OLMv0 when using a CatalogSource that does not define spec.grpcPodConfig.extractContent
Otherwise OLMv0+spec.grpcPodConfig.extractContent and OLMv1 can use catalog images with just:
FROM scratch
COPY <catalogDir> /catalog
LABEL operators.operatorframework.io.index.configs.v1=/catalog
| pollIntervalMinutes: 1 | ||
| {{< / highlight >}} | ||
|
|
||
| **2. Installer ServiceAccount and ClusterRoleBinding** — OLM v1 requires an explicit service account: |
There was a problem hiding this comment.
For now. We're working on dropping this requirement.
Agent-Logs-Url: https://github.com/kaovilai/ci-docs/sessions/c97b41be-f3c9-4957-8fdb-c6f04249318b Co-authored-by: kaovilai <[email protected]>
|
New changes are detected. LGTM label has been removed. |
Agent-Logs-Url: https://github.com/kaovilai/ci-docs/sessions/c97b41be-f3c9-4957-8fdb-c6f04249318b Co-authored-by: kaovilai <[email protected]>
|
@kaovilai: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Summary
This PR updates the operator testing documentation to cover three installation paths: FBC catalog images (recommended), operator-sdk bundle path (transitional), and the new OLM v1 ClusterExtension path for OCP 4.18+.
Changes
opm render, including Dockerfile example and ci-operator configurationwindows-conf-operator-olmv1as a working exampleMotivation
The deprecated ci-operator-built index image approach doesn't work with file-based catalogs (4.11+) or OLM v1 (4.18+). This documentation helps teams migrate to supported patterns and adopt OLM v1 for new clusters.