Skip to content
This repository has been archived by the owner on Oct 7, 2024. It is now read-only.

Commit

Permalink
Release 1.0.2 (#188)
Browse files Browse the repository at this point in the history
Resolves: #187

Signed-off-by: Sergio Arroutbi <sarroutb@redhat.com>
  • Loading branch information
sarroutbi authored Oct 20, 2023
1 parent 6c29eea commit 46f0645
Show file tree
Hide file tree
Showing 13 changed files with 53 additions and 58 deletions.
2 changes: 2 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ CLI
CodeReady
CRC
CRD
CVE
cve
finalizer
finalizers
Github
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# To re-generate a bundle for another specific version without changing the standard setup, you can:
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
VERSION ?= 1.0.1
VERSION ?= 1.0.2

# CHANNELS define the bundle channels used in the bundle.
# Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")
Expand Down
81 changes: 41 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ Tang operator-bundle are:
- v0.0.28: Code refactor
- v1.0.0: GA release candidate
- v1.0.1: new GA release candidate. Update Go version (1.16->1.21) and dependencies
- v1.0.2: new GA release candidate. Fix CVE-2023-39325

## Installation

Expand All @@ -105,23 +106,23 @@ operator-sdk installation is described in the [Links](#links) section.

In order to deploy the latest version of the Tang operator, check latest released
version in the [Versions](#versions) section, and install the appropriate version
bundle. For example, in case latest version is **1.0.1**, the command to execute
bundle. For example, in case latest version is **1.0.2**, the command to execute
will be:

```bash
$ operator-sdk run bundle quay.io/sec-eng-special/tang-operator-bundle:v1.0.1 --index-image=quay.io/operator-framework/opm:v1.23.0
INFO[0008] Successfully created registry pod: quay-io-sec-eng-special-tang-operator-bundle-v1.0.1
$ operator-sdk run bundle quay.io/sec-eng-special/tang-operator-bundle:v1.0.2 --index-image=quay.io/operator-framework/opm:v1.23.0
INFO[0008] Successfully created registry pod: quay-io-sec-eng-special-tang-operator-bundle-v1.0.2
INFO[0009] Created CatalogSource: tang-operator-catalog
INFO[0009] OperatorGroup "operator-sdk-og" created
INFO[0009] Created Subscription: tang-operator-v1.0.1-sub
INFO[0011] Approved InstallPlan install-lqf9f for the Subscription: tang-operator-v1.0.1-sub
INFO[0009] Created Subscription: tang-operator-v1.0.2-sub
INFO[0011] Approved InstallPlan install-lqf9f for the Subscription: tang-operator-v1.0.2-sub
INFO[0011] Waiting for ClusterServiceVersion to reach 'Succeeded' phase
INFO[0012] Waiting for ClusterServiceVersion "default/tang-operator.v1.0.1"
INFO[0018] Found ClusterServiceVersion "default/tang-operator.v1.0.1" phase: Pending
INFO[0020] Found ClusterServiceVersion "default/tang-operator.v1.0.1" phase: InstallReady
INFO[0021] Found ClusterServiceVersion "default/tang-operator.v1.0.1" phase: Installing
INFO[0031] Found ClusterServiceVersion "default/tang-operator.v1.0.1" phase: Succeeded
INFO[0031] OLM has successfully installed "tang-operator.v1.0.1"
INFO[0012] Waiting for ClusterServiceVersion "default/tang-operator.v1.0.2"
INFO[0018] Found ClusterServiceVersion "default/tang-operator.v1.0.2" phase: Pending
INFO[0020] Found ClusterServiceVersion "default/tang-operator.v1.0.2" phase: InstallReady
INFO[0021] Found ClusterServiceVersion "default/tang-operator.v1.0.2" phase: Installing
INFO[0031] Found ClusterServiceVersion "default/tang-operator.v1.0.2" phase: Succeeded
INFO[0031] OLM has successfully installed "tang-operator.v1.0.2"
```
To install latest multi-arch image, execute:
```bash
Expand All @@ -137,10 +138,10 @@ your cluster takes long time to deploy. To do so, the option **--timeout** can b
used (if not used, default time is 2m, which stands for two minutes):

```bash
$ operator-sdk run bundle --timeout 3m quay.io/sec-eng-special/tang-operator-bundle:v1.0.1 --index-image=quay.io/operator-framework/opm:v1.23.0
INFO[0008] Successfully created registry pod: quay-io-sec-eng-special-tang-operator-bundle-v1.0.1
$ operator-sdk run bundle --timeout 3m quay.io/sec-eng-special/tang-operator-bundle:v1.0.2 --index-image=quay.io/operator-framework/opm:v1.23.0
INFO[0008] Successfully created registry pod: quay-io-sec-eng-special-tang-operator-bundle-v1.0.2
...
INFO[0031] OLM has successfully installed "tang-operator.v1.0.1"
INFO[0031] OLM has successfully installed "tang-operator.v1.0.2"
```

Additionally, correct Tang operator installation can be observed if an output like
Expand All @@ -150,7 +151,7 @@ the following is observed when prompting for installed pods:
$ oc get pods
NAME READY STATUS RESTARTS AGE
dbbd1837106ec169542546e7ad251b95d27c3542eb0409c1e 0/1 Completed 0 82s
quay-io-tang-operator-bundle-v1.0.1 1/1 Running 0 90s
quay-io-tang-operator-bundle-v1.0.2 1/1 Running 0 90s
tang-operator-controller-manager-5c9488d8dd-mgmsf 2/2 Running 0 52s
```

Expand Down Expand Up @@ -197,19 +198,19 @@ to be released, it is recommended to increase version appropriately.
In this case, same version is used. Last released version can be observed in
[Versions](#versions) section.

To summarize, taking into account that the last released version is **v1.0.1**,
To summarize, taking into account that the last released version is **v1.0.2**,
compilation can be done with next command:

```bash
$ make docker-build docker-push IMG="quay.io/sec-eng-special/tang-operator:v1.0.1"
$ make docker-build docker-push IMG="quay.io/sec-eng-special/tang-operator:v1.0.2"
...
Successfully built 4a88ba8e6426
Successfully tagged sec-eng-special/tang-operator:v1.0.1
docker push sec-eng-special/tang-operator:v1.0.1
Successfully tagged sec-eng-special/tang-operator:v1.0.2
docker push sec-eng-special/tang-operator:v1.0.2
The push refers to repository [quay.io/sec-eng-special/tang-operator]
79109912085a: Pushed
417cb9b79ade: Layer already exists
v1.0.1: digest: sha256:c97bed08ab71556542602b008888bdf23ce4afd86228a07 size: 739
v1.0.2: digest: sha256:c97bed08ab71556542602b008888bdf23ce4afd86228a07 size: 739
```

In case a new release is planned to be done, the steps to follow will be:
Expand All @@ -225,15 +226,15 @@ index 9a41c6a..db12a82 100644
@@ -3,7 +3,7 @@
# To re-generate a bundle for another specific version without changing the
# standard setup, you can:
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=1.0.1)
# - use environment variables to overwrite this value (e.g export VERSION=1.0.1)
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=1.0.2)
# - use environment variables to overwrite this value (e.g export VERSION=1.0.2)
-VERSION ?= 0.0.27
+VERSION ?= 1.0.1
+VERSION ?= 1.0.2
```

Apart from previous changes, it is recommended to generate a "latest" tag for tang-operator bundle:
```bash
$ docker tag quay.io/sec-eng-special/tang-operator-bundle:v1.0.1 quay.io/sec-eng-special/tang-operator-bundle:latest
$ docker tag quay.io/sec-eng-special/tang-operator-bundle:v1.0.2 quay.io/sec-eng-special/tang-operator-bundle:latest
$ docker push quay.io/sec-eng-special/tang-operator-bundle:latest
```

Expand All @@ -243,14 +244,14 @@ Compile Tang operator code, specifying new version,
by using **make docker-build** command:

```bash
$ make docker-build docker-push IMG="quay.io/sec-eng-special/tang-operator:v1.0.1"
$ make docker-build docker-push IMG="quay.io/sec-eng-special/tang-operator:v1.0.2"
...
Successfully tagged sec-eng-special/tang-operator:v1.0.1
docker push sec-eng-special/tang-operator:v1.0.1
Successfully tagged sec-eng-special/tang-operator:v1.0.2
docker push sec-eng-special/tang-operator:v1.0.2
The push refers to repository [quay.io/sec-eng-special/tang-operator]
9ff8a4099c67: Pushed
417cb9b79ade: Layer already exists
v1.0.1: digest: sha256:01620ab19faae54fb382a2ff285f589cf0bde6e168f14f07 size: 739
v1.0.2: digest: sha256:01620ab19faae54fb382a2ff285f589cf0bde6e168f14f07 size: 739
```

- <ins>Bundle push</ins>:
Expand All @@ -260,15 +261,15 @@ the bundle with **make bundle**, specifying appropriate image,
and push it with **make bundle-build bundle-push**:

```bash
$ make bundle IMG="quay.io/sec-eng-special/tang-operator:v1.0.1"
$ make bundle-build bundle-push BUNDLE_IMG="quay.io/sec-eng-special/tang-operator-bundle:v1.0.1"
$ make bundle IMG="quay.io/sec-eng-special/tang-operator:v1.0.2"
$ make bundle-build bundle-push BUNDLE_IMG="quay.io/sec-eng-special/tang-operator-bundle:v1.0.2"
...
docker push sec-eng-special/tang-operator-bundle:v1.0.1
docker push sec-eng-special/tang-operator-bundle:v1.0.2
The push refers to repository [quay.io/sec-eng-special/tang-operator-bundle]
02e3768cfc56: Pushed
df0c8060d328: Pushed
84774958bcf4: Pushed
v1.0.1: digest: sha256:925c2f844f941db2b53ce45cba9db7ee0be613321da8f0f05d size: 939
v1.0.2: digest: sha256:925c2f844f941db2b53ce45cba9db7ee0be613321da8f0f05d size: 939
make[1]: Leaving directory '/home/user/RedHat/TASKS/TANG_OPERATOR/tang-operator'
```

Expand Down Expand Up @@ -308,15 +309,15 @@ In order to cross compile tang-operator, prepend **GOARCH** with required archit
**make docker-build**:

```bash
$ GOARCH=ppc64le make docker-build docker-push IMG="quay.io/sec-eng-special/tang-operator:v1.0.1"
$ GOARCH=ppc64le make docker-build docker-push IMG="quay.io/sec-eng-special/tang-operator:v1.0.2"
...
Successfully built 4a88ba8e6426
Successfully tagged sec-eng-special/tang-operator:v1.0.1
docker push sec-eng-special/tang-operator:v1.0.1
Successfully tagged sec-eng-special/tang-operator:v1.0.2
docker push sec-eng-special/tang-operator:v1.0.2
The push refers to repository [quay.io/sec-eng-special/tang-operator]
79109912085a: Pushed
417cb9b79ade: Layer already exists
v1.0.1: digest: sha256:c97bed08ab71556542602b008888bdf23ce4afd86228a07 size: 739
v1.0.2: digest: sha256:c97bed08ab71556542602b008888bdf23ce4afd86228a07 size: 739
```

## Cleanup
Expand All @@ -326,9 +327,9 @@ recommended way:

```bash
$ operator-sdk cleanup tang-operator
INFO[0001] subscription "tang-operator-v1.0.1-sub" deleted
INFO[0001] subscription "tang-operator-v1.0.2-sub" deleted
INFO[0001] customresourcedefinition "tangservers.daemons.redhat.com" deleted
INFO[0002] clusterserviceversion "tang-operator.v1.0.1" deleted
INFO[0002] clusterserviceversion "tang-operator.v1.0.2" deleted
INFO[0002] catalogsource "tang-operator-catalog" deleted
INFO[0002] operatorgroup "operator-sdk-og" deleted
INFO[0002] Operator "tang-operator" uninstalled
Expand Down Expand Up @@ -399,11 +400,11 @@ NOTE: CI/CD is in a continuous "work in progress" state

## Scorecard

Execution of operator-sdk scorecard tests are passing completely in version v1.0.1.
Execution of operator-sdk scorecard tests are passing completely in version v1.0.2.
In order to execute these tests, run next command:

```bash
$ operator-sdk scorecard -w 60s quay.io/sec-eng-special/tang-operator-bundle:v1.0.1
$ operator-sdk scorecard -w 60s quay.io/sec-eng-special/tang-operator-bundle:v1.0.2
...
Results:
Name: olm-status-descriptors
Expand Down
2 changes: 1 addition & 1 deletion bundle.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ LABEL operators.operatorframework.io.bundle.manifests.v1=manifests/
LABEL operators.operatorframework.io.bundle.metadata.v1=metadata/
LABEL operators.operatorframework.io.bundle.package.v1=tang-operator
LABEL operators.operatorframework.io.bundle.channels.v1=alpha
LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.28.1
LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.32.0
LABEL operators.operatorframework.io.metrics.mediatype.v1=metrics+v1
LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v3

Expand Down
1 change: 0 additions & 1 deletion bundle/manifests/daemons.redhat.com_tangservers.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
apiVersion: v1
kind: Service
metadata:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
apiVersion: v1
data:
controller_manager_config.yaml: |
---
apiVersion: controller-runtime.sigs.k8s.io/v1alpha1
kind: ControllerManagerConfig
health:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
Expand Down
11 changes: 5 additions & 6 deletions bundle/manifests/tang-operator.clusterserviceversion.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
apiVersion: operators.coreos.com/v1alpha1
kind: ClusterServiceVersion
metadata:
Expand Down Expand Up @@ -26,10 +25,10 @@ metadata:
}
]
capabilities: Basic Install
createdAt: "2023-10-09T13:22:34Z"
operators.operatorframework.io/builder: operator-sdk-v1.28.1
createdAt: "2023-10-20T11:58:09Z"
operators.operatorframework.io/builder: operator-sdk-v1.32.0
operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
name: tang-operator.v1.0.1
name: tang-operator.v1.0.2
namespace: placeholder
spec:
apiservicedefinitions: {}
Expand Down Expand Up @@ -322,7 +321,7 @@ spec:
- --leader-elect
command:
- /manager
image: quay.io/sec-eng-special/tang-operator:v1.0.1
image: quay.io/sec-eng-special/tang-operator:v1.0.2
livenessProbe:
httpGet:
path: /healthz
Expand Down Expand Up @@ -405,4 +404,4 @@ spec:
maturity: alpha
provider:
name: Red Hat
version: 1.0.1
version: 1.0.2
3 changes: 1 addition & 2 deletions bundle/metadata/annotations.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
annotations:
# Core bundle annotations.
operators.operatorframework.io.bundle.mediatype.v1: registry+v1
operators.operatorframework.io.bundle.manifests.v1: manifests/
operators.operatorframework.io.bundle.metadata.v1: metadata/
operators.operatorframework.io.bundle.package.v1: tang-operator
operators.operatorframework.io.bundle.channels.v1: alpha
operators.operatorframework.io.metrics.builder: operator-sdk-v1.28.1
operators.operatorframework.io.metrics.builder: operator-sdk-v1.32.0
operators.operatorframework.io.metrics.mediatype.v1: metrics+v1
operators.operatorframework.io.metrics.project_layout: go.kubebuilder.io/v3

Expand Down
1 change: 0 additions & 1 deletion bundle/tests/scorecard/config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
apiVersion: scorecard.operatorframework.io/v1alpha3
kind: Configuration
metadata:
Expand Down
3 changes: 1 addition & 2 deletions config/manager/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
resources:
- manager.yaml

Expand All @@ -14,4 +13,4 @@ kind: Kustomization
images:
- name: controller
newName: quay.io/sec-eng-special/tang-operator
newTag: v1.0.1
newTag: v1.0.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
apiVersion: operators.coreos.com/v1alpha1
kind: ClusterServiceVersion
metadata:
Expand Down

0 comments on commit 46f0645

Please sign in to comment.