Skip to content

Commit

Permalink
SDCICD-1338: custom task to generate OLM catalog
Browse files Browse the repository at this point in the history
Add a new custom task to generate the OLM catalog based on a bundle
image. This creates the Dockerfile and generates the catalog contents by
adding a single bundle and a single channel entry for that bundle to the
catalog with a skip range to the latest version. OLM can then be treated
in such a way that it will always upgrade to the latest version
available in the catalog.

following the documentation[1] for creating raw FBCs

[1]: https://olm.operatorframework.io/docs/tasks/creating-a-catalog/#catalog-creation-with-raw-file-based-catalogs

PR #1153 will be used to generate the bundle that is fed into this task
as a parameter. SRE-P operators are maintained without actively
versioning or managing upgrade graphs; the latest version is always the
version that should be running.

Signed-off-by: Brady Pratt <[email protected]>
  • Loading branch information
jbpratt committed Jul 22, 2024
1 parent 3118a13 commit e2c8fdb
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 0 deletions.
17 changes: 17 additions & 0 deletions task/opm-render-bundles/0.1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# opm-render-bundles task

Create a catalog index and render the provided bundles into it

## Parameters
|name|description|default value|required|
|---|---|---|---|
|binary-image|Image in which to build catalog|registry.redhat.io/openshift4/ose-operator-registry:latest|false|
|bundle-image|Comma separated list of bundles to add||true|
|operator-name|Name of the Operator||true|
|operator-version|Version of the Operator||true|
|default-channel|The channel that subscriptions will default to if unspecified|stable|false|

## Workspaces
|name|description|optional|
|---|---|---|
|source|Workspace with the source code|false|
61 changes: 61 additions & 0 deletions task/opm-render-bundles/0.1/opm-render-bundles.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
name: opm-render-bundles
spec:
description: Create a catalog index and render the provided bundles into it
params:
- name: binary-image
description: Image in which to build catalog
default: registry.redhat.io/openshift4/ose-operator-registry:latest
- name: bundle-image
description: Comma separated list of bundles to add
- name: operator-name
description: Name of the Operator
- name: operator-version
description: Version of the Operator
- name: default-channel
description: The channel that subscriptions will default to if unspecified
default: stable
workspaces:
- name: source
description: Workspace with the source code
steps:
- name: opm-render-bundles
image: "registry.redhat.io/openshift4/ose-operator-registry:latest"
workingDir: $(workspaces.source.path)/source
securityContext:
runAsUser: 0
capabilities:
add:
- SETFCAP
script: |
#!/usr/bin/env bash
set -xe
mkdir -p catalog/
opm generate dockerfile catalog/ --binary-image=$(params.binary-image)
opm init $(params.operator-name) \
--default-channel=$(params.default-channel) \
--description=./README.md \
--output=yaml > catalog/operator.yaml
opm render $(params.bundle-image) --output=yaml >> catalog/operator.yaml
cat << EOF >> catalog/operator.yaml
---
schema: olm.channel
package: $(params.operator-name)
name: $(params.default-channel)
entries:
- name: $(params.operator-name).$(params.operator-version)
skipRange: ">=0.0.1 <$(params.operator-version)"
EOF
cat catalog/operator.yaml
opm validate catalog
6 changes: 6 additions & 0 deletions task/opm-render-bundles/OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
approvers:
- jbpratt
- gurnben
reviewers:
- jbpratt
- gurnben

0 comments on commit e2c8fdb

Please sign in to comment.