-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add release doc * Update the `make prepare-release` command to properly set BUNDLE and CATALOG images * Add olm installation and make targets `make local-setup install-olm deploy-catalog`
- Loading branch information
Showing
7 changed files
with
156 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| apiVersion: operators.coreos.com/v1alpha1 | ||
| kind: CatalogSource | ||
| metadata: | ||
| name: dns-operator-catalog | ||
| spec: | ||
| sourceType: grpc | ||
| image: quay.io/kuadrant/dns-operator-catalog:latest | ||
| displayName: DNS Operators | ||
| publisher: grpc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Adds namespace to all resources. | ||
| namespace: dns-operator-system | ||
|
|
||
| resources: | ||
| - namespace.yaml | ||
| - operatorgroup.yaml | ||
| - catalogsource.yaml | ||
| - subscription.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| apiVersion: v1 | ||
| kind: Namespace | ||
| metadata: | ||
| labels: | ||
| control-plane: controller-manager | ||
| name: system |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| apiVersion: operators.coreos.com/v1 | ||
| kind: OperatorGroup | ||
| metadata: | ||
| name: dns-operator |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| apiVersion: operators.coreos.com/v1alpha1 | ||
| kind: Subscription | ||
| metadata: | ||
| name: dns-operator | ||
| spec: | ||
| source: dns-operator-catalog | ||
| sourceNamespace: dns-operator-system | ||
| name: dns-operator | ||
| channel: "alpha" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| ## Release | ||
|
|
||
| ### New Major.Minor version | ||
|
|
||
| 1. Create a new minor release branch from the HEAD of main: | ||
| ```sh | ||
| git checkout -b release-0.2 | ||
| ``` | ||
| 2. Run prepare release: | ||
| ```sh | ||
| make prepare-release IMG_TAG=release-0.2 VERSION=0.2.0-dev CHANNELS=alpha REPLACES_VERSION=0.1.0 | ||
| ``` | ||
| 3. Verify local changes, commit and push: | ||
| ```sh | ||
| git add . | ||
| git commit -m "prepare-release: release-0.2" | ||
| git push upstream release-0.2 | ||
| ``` | ||
| 4. Verify that the build [image workflow](https://github.com/Kuadrant/dns-operator/actions/workflows/build-images.yaml) is triggered and completes for the new branch | ||
|
|
||
| 5. Do any final testing and bug fixing against the release branch, see [Verify OLM Deployment](#verify-olm-deployment) | ||
|
|
||
| 6. Run prepare release for final version | ||
| ```sh | ||
| make prepare-release VERSION=0.2.0 CHANNELS=stable REPLACES_VERSION=0.1.0 | ||
| ``` | ||
| 7. Verify local changes, commit, push and tag: | ||
| ```sh | ||
| git add . | ||
| git commit -m "prepare-release: v0.2.0" | ||
| git tag v0.2.0 | ||
| git push upstream release-0.2 | ||
| git push upstream v0.2.0 | ||
| ``` | ||
| 8. Verify that the build [image workflow](https://github.com/Kuadrant/dns-operator/actions/workflows/build-images.yaml) is triggered and completes for the new tag | ||
|
|
||
| 9. Verify the new version can be installed from the catalog image, see [Verify OLM Deployment](#verify-olm-deployment) | ||
|
|
||
| 10. Release to the [community operator index catalogs](#community-operator-index-catalogs). | ||
|
|
||
| ### New Patch version | ||
|
|
||
| 1. Checkout minor release branch: | ||
| ```sh | ||
| git checkout release-0.2 | ||
| ``` | ||
| 2. Run prepare release: | ||
| ```sh | ||
| make prepare-release VERSION=0.2.1 CHANNELS=stable REPLACES_VERSION=0.2.0 | ||
| ``` | ||
| 3. Verify local changes, commit and push: | ||
| ```sh | ||
| git add . | ||
| git commit -m "prepare-release: v0.2.1" | ||
| git tag v0.2.1 | ||
| git push upstream release-0.2 | ||
| git push upstream v0.2.1 | ||
| ``` | ||
| 4. Verify that the build [image workflow](https://github.com/Kuadrant/dns-operator/actions/workflows/build-images.yaml) is triggered and completes for the new tag | ||
|
|
||
| 5. Verify the new version can be installed from the catalog image, see [Verify OLM Deployment](#verify-olm-deployment) | ||
|
|
||
| 6. Release to the [community operator index catalogs](#community-operator-index-catalogs). | ||
|
|
||
| ### Verify OLM Deployment | ||
|
|
||
| 1. Deploy the OLM catalog image: | ||
| ```sh | ||
| make local-setup install-olm deploy-catalog | ||
| ``` | ||
|
|
||
| 2. Wait for deployment: | ||
| ```sh | ||
| kubectl -n dns-operator-system wait --timeout=60s --for=condition=Available deployments --all | ||
| deployment.apps/dns-operator-controller-manager condition met | ||
| ``` | ||
|
|
||
| 3. Check the logs: | ||
| ```sh | ||
| kubectl -n dns-operator-system logs -f deployment/dns-operator-controller-manager | ||
| ``` | ||
|
|
||
| 4. Check the version: | ||
| ```sh | ||
| $ kubectl -n dns-operator-system get deployment dns-operator-controller-manager --show-labels | ||
| NAME READY UP-TO-DATE AVAILABLE AGE LABELS | ||
| dns-operator-controller-manager 1/1 1 1 5m42s app.kubernetes.io/component=manager,app.kubernetes.io/created-by=dns-operator, | ||
| app.kubernetes.io/instance=controller-manager,app.kubernetes.io/managed-by=kustomize,app.kubernetes.io/name=deployment,app.kubernetes.io/part-of=dns-operator, | ||
| control-plane=dns-operator-controller-manager,olm.deployment-spec-hash=1jPe8AuMpSKHh51nnDs4j25ZgoUrKhF45EP0Wa,olm.managed=true,olm.owner.kind=ClusterServiceVersion, | ||
| olm.owner.namespace=dns-operator-system,olm.owner=dns-operator.v0.2.0-dev,operators.coreos.com/dns-operator.dns-operator-system= | ||
| ``` | ||
|
|
||
| ### Community Operator Index Catalogs | ||
|
|
||
| - [Operatorhub Community Operators](https://github.com/k8s-operatorhub/community-operators/tree/main/operators/dns-operator) | ||
| - [Openshift Community Operators](https://github.com/redhat-openshift-ecosystem/community-operators-prod/tree/main/operators/dns-operator) |