Updating operator description

Signed-off-by: Varad Ahirwadkar <[email protected]>
ocp-power-automation · Dec 2, 2024 · 9dfbc9a · 9dfbc9a
1 parent 4aad833
commit 9dfbc9a
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 17 deletions.
diff --git a/api/v1alpha1/rsct_types.go b/api/v1alpha1/rsct_types.go
@@ -38,6 +38,8 @@ type RSCTSpec struct {
 type RSCTStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
+
+	// State reflects current observed state of RSCT resource
 	State *string `json:"state,omitempty"`
 }
 

diff --git a/bundle.Dockerfile b/bundle.Dockerfile
@@ -10,6 +10,11 @@ LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.34.1
 LABEL operators.operatorframework.io.metrics.mediatype.v1=metrics+v1
 LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v4
 
+# Labels for testing.
+LABEL operators.operatorframework.io.test.mediatype.v1=scorecard+v1
+LABEL operators.operatorframework.io.test.config.v1=tests/scorecard/
+
 # Copy files to locations specified by labels.
 COPY bundle/manifests /manifests/
 COPY bundle/metadata /metadata/
+COPY bundle/tests/scorecard /tests/scorecard/
diff --git a/bundle/manifests/rsct-operator.clusterserviceversion.yaml b/bundle/manifests/rsct-operator.clusterserviceversion.yaml
@@ -23,17 +23,18 @@ metadata:
       ]
     capabilities: Basic Install
     categories: OpenShift Optional
-    containerImage: ghcr.io/ocp-power-automation/rsct-operator:latest
-    createdAt: "2024-11-18T09:20:10Z"
-    description: Deploys RSCT daemonset on all nodes of an OpenShift cluster
+    containerImage: ghcr.io/ocp-power-automation/rsct-operator:0.0.1-alpha2
+    createdAt: "2024-12-02T05:22:21Z"
+    description: Deploys RSCT daemonset on all ppc64le architecture nodes of an OpenShift
+      or Kubernetes cluster.
     operators.operatorframework.io/builder: operator-sdk-v1.34.1
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v4
     repository: https://github.com/ocp-power-automation/rsct-operator
     support: IBM
   labels:
     operatorframework.io/arch.amd64: supported
     operatorframework.io/arch.ppc64le: supported
-  name: rsct-operator.v0.0.1
+  name: rsct-operator.v0.0.1-alpha2
   namespace: rsct-operator-system
 spec:
   apiservicedefinitions: {}
@@ -44,8 +45,18 @@ spec:
       kind: RSCT
       name: rscts.rsct.ibm.com
       version: v1alpha1
-  description: Deploys custom resource RSCT on all nodes of an OpenShift cluster.
-  displayName: RSCT Operator for IBM Power Virtual Server
+  description: "RSCT Operator\nDeploys RSCT daemonset on all ppc64le architecture
+    nodes of an Kubernetes and OpenShift cluster.\n\n### Prerequisite for OpenShift
+    cluster\n- Create a catalog source using `quay.io/operatorhubio/catalog:latest`
+    in `openshift-marketplace` namespace. \n- Use `rsct-operator-system` namespace
+    for RSCT deployment.\n\n###  Create the Custom Resource Definition\nAfter deploying
+    the operator, you must create a RSCT object. The following example will create
+    RSCT instance.\n```\napiVersion: rsct.ibm.com/v1alpha1\nkind: RSCT\nmetadata:\n
+    \ name: rsct\n  namespace: rsct-operator-system\nspec: \n  image: quay.io/powercloud/rsct-ppc64le:latest\n```\n\nIn
+    the `spec`:\n- image: This is the RSCT image. Default image is `quay.io/powercloud/rsct-ppc64le:latest`\n\n**Note**:
+    If RSCT is already configured on a node, the RSCT DaemonSet pods may not function
+    properly."
+  displayName: RSCT Operator for IBM Power Systems
   icon:
   - base64data: PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNTguNTEgMjU4LjUxIj48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2QxZDFkMTt9LmNscy0ye2ZpbGw6IzhkOGQ4Zjt9PC9zdHlsZT48L2RlZnM+PHRpdGxlPkFzc2V0IDQ8L3RpdGxlPjxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPjxnIGlkPSJMYXllcl8xLTIiIGRhdGEtbmFtZT0iTGF5ZXIgMSI+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMTI5LjI1LDIwQTEwOS4xLDEwOS4xLDAsMCwxLDIwNi40LDIwNi40LDEwOS4xLDEwOS4xLDAsMSwxLDUyLjExLDUyLjExLDEwOC40NSwxMDguNDUsMCwwLDEsMTI5LjI1LDIwbTAtMjBoMEM1OC4xNiwwLDAsNTguMTYsMCwxMjkuMjVIMGMwLDcxLjA5LDU4LjE2LDEyOS4yNiwxMjkuMjUsMTI5LjI2aDBjNzEuMDksMCwxMjkuMjYtNTguMTcsMTI5LjI2LTEyOS4yNmgwQzI1OC41MSw1OC4xNiwyMDAuMzQsMCwxMjkuMjUsMFoiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xNzcuNTQsMTAzLjQxSDE0MS42NkwxNTQuOSw2NS43NmMxLjI1LTQuNC0yLjMzLTguNzYtNy4yMS04Ljc2SDEwMi45M2E3LjMyLDcuMzIsMCwwLDAtNy40LDZsLTEwLDY5LjYxYy0uNTksNC4xNywyLjg5LDcuODksNy40LDcuODloMzYuOUwxMTUuNTUsMTk3Yy0xLjEyLDQuNDEsMi40OCw4LjU1LDcuMjQsOC41NWE3LjU4LDcuNTgsMCwwLDAsNi40Ny0zLjQ4TDE4NCwxMTMuODVDMTg2Ljg2LDEwOS4yNCwxODMuMjksMTAzLjQxLDE3Ny41NCwxMDMuNDFaIi8+PC9nPjwvZz48L3N2Zz4=
     mediatype: image/svg+xml
@@ -191,7 +202,7 @@ spec:
                 - --leader-elect
                 command:
                 - /manager
-                image: ghcr.io/ocp-power-automation/rsct-operator:latest
+                image: ghcr.io/ocp-power-automation/rsct-operator:0.0.1-alpha2
                 livenessProbe:
                   httpGet:
                     path: /healthz
@@ -281,4 +292,4 @@ spec:
   minKubeVersion: 1.25.0
   provider:
     name: IBM
-  version: 0.0.1
+  version: 0.0.1-alpha2
diff --git a/bundle/manifests/rsct.ibm.com_rscts.yaml b/bundle/manifests/rsct.ibm.com_rscts.yaml
@@ -48,8 +48,7 @@ spec:
             description: RSCTStatus defines the observed state of RSCT
             properties:
               state:
-                description: |-
-                  state reflects current observed state of RSCT resource
+                description: State reflects current observed state of RSCT resource
                 type: string
             type: object
         type: object

diff --git a/bundle/metadata/annotations.yaml b/bundle/metadata/annotations.yaml
@@ -8,3 +8,7 @@ annotations:
   operators.operatorframework.io.metrics.builder: operator-sdk-v1.34.1
   operators.operatorframework.io.metrics.mediatype.v1: metrics+v1
   operators.operatorframework.io.metrics.project_layout: go.kubebuilder.io/v4
+
+  # Annotations for testing.
+  operators.operatorframework.io.test.mediatype.v1: scorecard+v1
+  operators.operatorframework.io.test.config.v1: tests/scorecard/
diff --git a/config/crd/bases/rsct.ibm.com_rscts.yaml b/config/crd/bases/rsct.ibm.com_rscts.yaml
@@ -48,8 +48,7 @@ spec:
             description: RSCTStatus defines the observed state of RSCT
             properties:
               state:
-                description: |-
-                  state reflects current observed state of RSCT resource
+                description: State reflects current observed state of RSCT resource
                 type: string
             type: object
         type: object

diff --git a/config/manager/kustomization.yaml b/config/manager/kustomization.yaml
@@ -13,4 +13,4 @@ kind: Kustomization
 images:
 - name: controller
   newName: ghcr.io/ocp-power-automation/rsct-operator
-  newTag: latest
+  newTag: 0.0.1-alpha2
diff --git a/config/manifests/bases/rsct-operator.clusterserviceversion.yaml b/config/manifests/bases/rsct-operator.clusterserviceversion.yaml
@@ -5,8 +5,9 @@ metadata:
     alm-examples: '[]'
     capabilities: Basic Install
     categories: OpenShift Optional
-    containerImage: ghcr.io/ocp-power-automation/rsct-operator:latest
-    description: Deploys RSCT daemonset on all nodes of an OpenShift cluster
+    containerImage: ghcr.io/ocp-power-automation/rsct-operator:0.0.1-alpha2
+    description: Deploys RSCT daemonset on all ppc64le architecture nodes of an OpenShift
+      or Kubernetes cluster.
     repository: https://github.com/ocp-power-automation/rsct-operator
     support: IBM
   labels:
@@ -23,8 +24,18 @@ spec:
       kind: RSCT
       name: rscts.rsct.ibm.com
       version: v1alpha1
-  description: Deploys custom resource RSCT on all nodes of an OpenShift cluster.
-  displayName: RSCT Operator for IBM Power Virtual Server
+  description: "RSCT Operator\nDeploys RSCT daemonset on all ppc64le architecture
+    nodes of an Kubernetes and OpenShift cluster.\n\n### Prerequisite for OpenShift
+    cluster\n- Create a catalog source using `quay.io/operatorhubio/catalog:latest`
+    in `openshift-marketplace` namespace. \n- Use `rsct-operator-system` namespace
+    for RSCT deployment.\n\n###  Create the Custom Resource Definition\nAfter deploying
+    the operator, you must create a RSCT object. The following example will create
+    RSCT instance.\n```\napiVersion: rsct.ibm.com/v1alpha1\nkind: RSCT\nmetadata:\n
+    \ name: rsct\n  namespace: rsct-operator-system\nspec: \n  image: quay.io/powercloud/rsct-ppc64le:latest\n```\n\nIn
+    the `spec`:\n- image: This is the RSCT image. Default image is `quay.io/powercloud/rsct-ppc64le:latest`\n\n**Note**:
+    If RSCT is already configured on a node, the RSCT DaemonSet pods may not function
+    properly."
+  displayName: RSCT Operator for IBM Power Systems
   icon:
   - base64data: PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNTguNTEgMjU4LjUxIj48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2QxZDFkMTt9LmNscy0ye2ZpbGw6IzhkOGQ4Zjt9PC9zdHlsZT48L2RlZnM+PHRpdGxlPkFzc2V0IDQ8L3RpdGxlPjxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPjxnIGlkPSJMYXllcl8xLTIiIGRhdGEtbmFtZT0iTGF5ZXIgMSI+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMTI5LjI1LDIwQTEwOS4xLDEwOS4xLDAsMCwxLDIwNi40LDIwNi40LDEwOS4xLDEwOS4xLDAsMSwxLDUyLjExLDUyLjExLDEwOC40NSwxMDguNDUsMCwwLDEsMTI5LjI1LDIwbTAtMjBoMEM1OC4xNiwwLDAsNTguMTYsMCwxMjkuMjVIMGMwLDcxLjA5LDU4LjE2LDEyOS4yNiwxMjkuMjUsMTI5LjI2aDBjNzEuMDksMCwxMjkuMjYtNTguMTcsMTI5LjI2LTEyOS4yNmgwQzI1OC41MSw1OC4xNiwyMDAuMzQsMCwxMjkuMjUsMFoiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xNzcuNTQsMTAzLjQxSDE0MS42NkwxNTQuOSw2NS43NmMxLjI1LTQuNC0yLjMzLTguNzYtNy4yMS04Ljc2SDEwMi45M2E3LjMyLDcuMzIsMCwwLDAtNy40LDZsLTEwLDY5LjYxYy0uNTksNC4xNywyLjg5LDcuODksNy40LDcuODloMzYuOUwxMTUuNTUsMTk3Yy0xLjEyLDQuNDEsMi40OCw4LjU1LDcuMjQsOC41NWE3LjU4LDcuNTgsMCwwLDAsNi40Ny0zLjQ4TDE4NCwxMTMuODVDMTg2Ljg2LDEwOS4yNCwxODMuMjksMTAzLjQxLDE3Ny41NCwxMDMuNDFaIi8+PC9nPjwvZz48L3N2Zz4=
     mediatype: image/svg+xml