Skip to content
Snippets Groups Projects
Commit 7e7c00e9 authored by Alexandre Lossent's avatar Alexandre Lossent
Browse files

Fix CATALOG_BASE_IMG doc

parent d2bd986d
No related branches found
No related tags found
1 merge request!6Helm operator alex doc
Pipeline #3840440 passed
......@@ -78,6 +78,7 @@ OLM Deployment (staging):
# Set CATALOG_BASE_IMG to an existing catalog image tag to add $BUNDLE_IMGS to that image.
# Use staging tag for staging clusters
CATALOG_IMG: ${IMAGE_TAG_BASE}-catalog:staging
CATALOG_BASE_IMG: '""' # for very first version, then use the value below for following versions
# CATALOG_BASE_IMG: ${IMAGE_TAG_BASE}-catalog:staging
# PRODUCTION #
......@@ -97,6 +98,7 @@ OLM Deployment (production):
# Set CATALOG_BASE_IMG to an existing catalog image tag to add $BUNDLE_IMGS to that image.
# Use latest tag for production clusters
CATALOG_IMG: ${IMAGE_TAG_BASE}-catalog:latest
CATALOG_BASE_IMG: '""' # for very first version, then use the value below for following versions
# CATALOG_BASE_IMG: ${IMAGE_TAG_BASE}-catalog:latest
```
......@@ -187,7 +187,7 @@ When committing the first version of the operator, there is no existing catalog
...
```
* Comment the `CATALOG_BASE_IMG` variable out under the `.gitlab-ci.yml` file (within the docker container for developing, use `unset CATALOG_BASE_IMG`).
* Set the `CATALOG_BASE_IMG` variable to `""` under the `.gitlab-ci.yml` file (within the docker container for developing, use `unset CATALOG_BASE_IMG`).
```yaml
---
......@@ -195,12 +195,13 @@ When committing the first version of the operator, there is no existing catalog
VERSION: 0.0.1
...
# Set CATALOG_BASE_IMG to an existing catalog image tag to add $BUNDLE_IMGS to that image.
CATALOG_BASE_IMG: '""' # for very first version, then use the one below for following versions
# CATALOG_BASE_IMG: ${IMAGE_TAG_BASE}-catalog:latest
```
* Run `make bundle` once to initialize the clusterserviceversion file
* Ensure removing the `metadata.annotations.olm.skipRange` value under `config\manifests\bases\<operator-name>.clusterserviceversion.yaml`.
* Ensure removing the annotation `olm.skipRange` value under `config\manifests\bases\<operator-name>.clusterserviceversion.yaml`.
### Committing changes for sucessive versions of the operator
......@@ -222,7 +223,7 @@ When committing the first version of the operator, there is no existing catalog
...
```
* Ensure the `CATALOG_BASE_IMG` variable is not commented out under the `.gitlab-ci.yaml` file.
* Ensure the `CATALOG_BASE_IMG` variable is not commented out under the `.gitlab-ci.yml` file.
```yaml
---
......@@ -233,7 +234,8 @@ When committing the first version of the operator, there is no existing catalog
CATALOG_BASE_IMG: ${IMAGE_TAG_BASE}-catalog:latest
```
* Ensure updating the `metadata.annotations.olm.skipRange` value under `config\manifests\bases\<operator-name>.clusterserviceversion.yaml`. E.g. if new `VERSION` is `0.0.3`, `metadata.annotations.olm.skipRange` MUST be `<0.0.3`.
* Set the annotation `olm.skipRange` value under `config\manifests\bases\<operator-name>.clusterserviceversion.yaml`. E.g. if new `VERSION` is `0.0.3`, annotation `olm.skipRange` MUST be `<0.0.3`.
Ref: <https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/how-to-update-operators.md#skiprange>
Finally, commit the changes and let the CI do the work for us, i.e., to build and push both the bundle and the catalog, this last containing the bundle we have generated to the appropriate production clusters.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment