Skip to content

Commit 75ad13b

Browse files
authored
Update olm_manifests.md
1 parent cd27ae2 commit 75ad13b

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

.github/ISSUE_TEMPLATE/olm_manifests.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,47 @@ assignees: ''
77

88
---
99

10+
This is a list of steps you can follow to generate, install and test Operator Lifecycle Management (OLM) manifests for the Stackable Data Platform.
11+
12+
The manigest generation is fully automated for all operators except two: the `secret` and the `listener` operator. These two required manual intervention.
13+
14+
OLM manifests can be generated at any time and for any version of the operators (including `0.0.0-dev`) but it's specially needed after a platform release, to certify the new operator versions.
15+
16+
To generate manifests for a released version of the SDP, ensure that you checkout the appropriate branch of the operator repository and the openshift operator repository.
17+
1018
## Pre-requisites
1119

12-
TODO: stackable-utils, openshift cert repo, etc.
20+
In addition to the usual development tools like `git` and `Python` you need to clone the following repositories, idealy in the same location (this guide assumes `$HOME/repo/stackable`):
21+
22+
* https://github.com/stackabletech/stackable-utils - contains utility scripts that you'll use below
23+
* https://github.com/stackabletech/openshift-certified-operators - a fork used to submit SDP operators for certification
24+
* Operator repositories that you intend to use like:
25+
* https://github.com/stackabletech/airflow-operator/
26+
* https://github.com/stackabletech/druid-operator/
27+
* https://github.com/stackabletech/commons-operator/
28+
* ... and so on
29+
30+
This issue assumes you are generating OLM manifests for a released SDP version with the intention of certifying it. This means:
31+
32+
- [ ] All operator repositories have the required release branch. These releases have been tested and are generally available.
33+
- [ ] All container images have been published to quay.io
34+
1335

1436
## Secret operator
1537

16-
build-manifests.sh
38+
- [ ] Create release branch (from `main`) in the openshift operator repository
39+
40+
cd $HOME/repo/stackable/openshift-certified-operators
41+
git switch -c stackable-secret-24.3.0
42+
43+
- [ ] Generate manifests
44+
45+
./olm/build-manifests.sh -r 24.3.0 -c $HOME/repo/stackable/openshift-certified-operators -o $HOME/repo/stackable/secret-operator
46+
47+
Options:
48+
* `-r 24.3.0` is the SDP release
49+
* `-c $HOME/repo/stackable/openshift-certified-operators` the location of the openshift operator repository
50+
* `-o $HOME/repo/stackable/secret-operator` the location of the secret op
1751

1852
## Listener operator
1953

0 commit comments

Comments
 (0)