From 4c421906db36b25e1dc3c5dd79a5bd0686f8caf4 Mon Sep 17 00:00:00 2001 From: rawagner Date: Fri, 26 Apr 2024 12:09:40 +0200 Subject: [PATCH 1/2] Add docs for operator releases --- docs/dev-guide.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 3cd8ad4..0e586b1 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -5,3 +5,32 @@ To deploy the latest vesion of the CLaaS operator, run the following commands: - `make bundle bundle-build bundle-push BUNDLE_IMG="quay.io/$QUAY_USERNAME/cluster-templates-operator-bundle"` - make sure that the repo `quay.io/$QUAY_USERNAME/cluster-templates-operator-bundle` is public - `operator-sdk run bundle quay.io/$QUAY_USERNAME/cluster-templates-operator-bundle:latest --timeout 5m` + +# Releasing a new version to OperatorHub + +CaaS is being released to [K8s Community Operators](https://github.com/k8s-operatorhub/community-operators) and [OpenShift Community Operators](https://github.com/redhat-openshift-ecosystem/community-operators-prod) + +## Preparing a release + +Run `make manifests && make generate && make bundle` which will generate up-to-date manifests in `bundle` folder. + +Update `cluster-aas-operator.clusterserviceversion.yaml` file: + - update `spec.version` field + - update `metadata.name` field + - update container image in `metadata.annotations.containerImage` and `spec.install.spec.deployments.image` + +## Releasing K8s Community Operator + +- clone [K8s Community Operators](https://github.com/k8s-operatorhub/community-operators) +- add new folder to `operators/cluster-aas-operator`. Folder name will be a new version name. +- Copy the bundle manifests +- Create a PR for the repo. + + +## Releasing OpenShift Community Operator + +- clone [OpenShift Community Operators](https://github.com/redhat-openshift-ecosystem/community-operators-prod) +- add new folder to `operators/cluster-aas-operator`. Folder name will be a new version name. +- Copy the bundle manifests +- Add `com.redhat.openshift.versions: ` annotation to `metadata/annotations.yaml` +- Create a PR for the repo. \ No newline at end of file From 2e5e8820ac2fbc8154165c08826bc4a39146c82d Mon Sep 17 00:00:00 2001 From: rawagner Date: Fri, 21 Jun 2024 18:01:51 +0200 Subject: [PATCH 2/2] Update community operator release docs --- docs/dev-guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 0e586b1..aa1691d 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -24,6 +24,8 @@ Update `cluster-aas-operator.clusterserviceversion.yaml` file: - clone [K8s Community Operators](https://github.com/k8s-operatorhub/community-operators) - add new folder to `operators/cluster-aas-operator`. Folder name will be a new version name. - Copy the bundle manifests +- Since on vanilla k8s environment, `service.beta.openshift.io/serving-cert-secret-name` is not available, the bundle manifests have to be updated: + - remove `volumeMount`, `volume`, `--tls-cert-file` and `--tls-private-key-file` from `cluster-aas-operator.clusterserviceversion.yaml` spec. Otherwise the controller pod will wait for `secret` to be created and mounted. Which never happens and pod gets stuck. - Create a PR for the repo.