From 14a5449aff50c252dd0f7e645ecc6f49e23bf1a2 Mon Sep 17 00:00:00 2001 From: Varad Ahirwadkar Date: Sun, 1 Dec 2024 22:34:28 +0530 Subject: [PATCH] Updating operator description Signed-off-by: Varad Ahirwadkar --- api/v1alpha1/rsct_types.go | 2 ++ bundle.Dockerfile | 5 +++ .../rsct-operator.clusterserviceversion.yaml | 33 +++++++++++++------ bundle/manifests/rsct.ibm.com_rscts.yaml | 3 +- bundle/metadata/annotations.yaml | 4 +++ config/crd/bases/rsct.ibm.com_rscts.yaml | 3 +- config/manager/kustomization.yaml | 2 +- .../rsct-operator.clusterserviceversion.yaml | 25 ++++++++++---- 8 files changed, 56 insertions(+), 21 deletions(-) diff --git a/api/v1alpha1/rsct_types.go b/api/v1alpha1/rsct_types.go index 10aa070..bd20004 100644 --- 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 index 15318fe..c4f6798 100644 --- 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 index b0c2359..cb835f2 100644 --- a/bundle/manifests/rsct-operator.clusterserviceversion.yaml +++ b/bundle/manifests/rsct-operator.clusterserviceversion.yaml @@ -22,10 +22,11 @@ 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 + categories: Monitoring + containerImage: ghcr.io/ocp-power-automation/rsct-operator:0.0.1-alpha2 + createdAt: "2024-12-10T05:23:35Z" + description: Deploys the RSCT DaemonSet on all ppc64le architecture nodes of Kubernetes + and OpenShift clusters. 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 @@ -33,7 +34,7 @@ metadata: 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,16 @@ 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: "Deploys 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### + Follow this document to deploy the RSCT operator on OpenShift cluster \n- [RSCT + Deployment on OpenShift Clusters](https://github.com/ocp-power-automation/rsct-operator/blob/main/docs/Install.md)\n\n### + In the Custom Resource Definition,\n- The RSCT image can be configured in the + spec:\n```\nspec:\n image: quay.io/powercloud/rsct-ppc64le:latest\n```\nDefault + image is `quay.io/powercloud/rsct-ppc64le:latest`" + displayName: RSCT Operator for IBM Power Systems icon: - base64data: PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNTguNTEgMjU4LjUxIj48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2QxZDFkMTt9LmNscy0ye2ZpbGw6IzhkOGQ4Zjt9PC9zdHlsZT48L2RlZnM+PHRpdGxlPkFzc2V0IDQ8L3RpdGxlPjxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPjxnIGlkPSJMYXllcl8xLTIiIGRhdGEtbmFtZT0iTGF5ZXIgMSI+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMTI5LjI1LDIwQTEwOS4xLDEwOS4xLDAsMCwxLDIwNi40LDIwNi40LDEwOS4xLDEwOS4xLDAsMSwxLDUyLjExLDUyLjExLDEwOC40NSwxMDguNDUsMCwwLDEsMTI5LjI1LDIwbTAtMjBoMEM1OC4xNiwwLDAsNTguMTYsMCwxMjkuMjVIMGMwLDcxLjA5LDU4LjE2LDEyOS4yNiwxMjkuMjUsMTI5LjI2aDBjNzEuMDksMCwxMjkuMjYtNTguMTcsMTI5LjI2LTEyOS4yNmgwQzI1OC41MSw1OC4xNiwyMDAuMzQsMCwxMjkuMjUsMFoiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xNzcuNTQsMTAzLjQxSDE0MS42NkwxNTQuOSw2NS43NmMxLjI1LTQuNC0yLjMzLTguNzYtNy4yMS04Ljc2SDEwMi45M2E3LjMyLDcuMzIsMCwwLDAtNy40LDZsLTEwLDY5LjYxYy0uNTksNC4xNywyLjg5LDcuODksNy40LDcuODloMzYuOUwxMTUuNTUsMTk3Yy0xLjEyLDQuNDEsMi40OCw4LjU1LDcuMjQsOC41NWE3LjU4LDcuNTgsMCwwLDAsNi40Ny0zLjQ4TDE4NCwxMTMuODVDMTg2Ljg2LDEwOS4yNCwxODMuMjksMTAzLjQxLDE3Ny41NCwxMDMuNDFaIi8+PC9nPjwvZz48L3N2Zz4= mediatype: image/svg+xml @@ -191,7 +200,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 @@ -272,13 +281,17 @@ spec: - rmc - power links: - - name: Rsct Operator + - name: RSCT Operator url: https://github.com/ocp-power-automation/rsct-operator maintainers: - email: mjturek@us.ibm.com name: Michael Turek + - email: varad.ahirwadkar1@ibm.com + name: Varad Ahirwadkar + - email: mkumatag@in.ibm.com + name: Manjunath Kumatagi maturity: alpha 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 index c15c7f8..7f8db6a 100644 --- 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 index 30fa94b..1a3174b 100644 --- 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 index 711828d..f3add2c 100644 --- 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 index 61f1d41..99204ba 100644 --- 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 index 250ca43..33775c9 100644 --- a/config/manifests/bases/rsct-operator.clusterserviceversion.yaml +++ b/config/manifests/bases/rsct-operator.clusterserviceversion.yaml @@ -4,9 +4,10 @@ metadata: annotations: 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 + categories: Monitoring + containerImage: ghcr.io/ocp-power-automation/rsct-operator:0.0.1-alpha2 + description: Deploys the RSCT DaemonSet on all ppc64le architecture nodes of Kubernetes + and OpenShift clusters. repository: https://github.com/ocp-power-automation/rsct-operator support: IBM labels: @@ -23,8 +24,16 @@ 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: "Deploys 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### + Follow this document to deploy the RSCT operator on OpenShift cluster \n- [RSCT + Deployment on OpenShift Clusters](https://github.com/ocp-power-automation/rsct-operator/blob/main/docs/Install.md)\n\n### + In the Custom Resource Definition,\n- The RSCT image can be configured in the + spec:\n```\nspec:\n image: quay.io/powercloud/rsct-ppc64le:latest\n```\nDefault + image is `quay.io/powercloud/rsct-ppc64le:latest`" + displayName: RSCT Operator for IBM Power Systems icon: - base64data: PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNTguNTEgMjU4LjUxIj48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2QxZDFkMTt9LmNscy0ye2ZpbGw6IzhkOGQ4Zjt9PC9zdHlsZT48L2RlZnM+PHRpdGxlPkFzc2V0IDQ8L3RpdGxlPjxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPjxnIGlkPSJMYXllcl8xLTIiIGRhdGEtbmFtZT0iTGF5ZXIgMSI+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMTI5LjI1LDIwQTEwOS4xLDEwOS4xLDAsMCwxLDIwNi40LDIwNi40LDEwOS4xLDEwOS4xLDAsMSwxLDUyLjExLDUyLjExLDEwOC40NSwxMDguNDUsMCwwLDEsMTI5LjI1LDIwbTAtMjBoMEM1OC4xNiwwLDAsNTguMTYsMCwxMjkuMjVIMGMwLDcxLjA5LDU4LjE2LDEyOS4yNiwxMjkuMjUsMTI5LjI2aDBjNzEuMDksMCwxMjkuMjYtNTguMTcsMTI5LjI2LTEyOS4yNmgwQzI1OC41MSw1OC4xNiwyMDAuMzQsMCwxMjkuMjUsMFoiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xNzcuNTQsMTAzLjQxSDE0MS42NkwxNTQuOSw2NS43NmMxLjI1LTQuNC0yLjMzLTguNzYtNy4yMS04Ljc2SDEwMi45M2E3LjMyLDcuMzIsMCwwLDAtNy40LDZsLTEwLDY5LjYxYy0uNTksNC4xNywyLjg5LDcuODksNy40LDcuODloMzYuOUwxMTUuNTUsMTk3Yy0xLjEyLDQuNDEsMi40OCw4LjU1LDcuMjQsOC41NWE3LjU4LDcuNTgsMCwwLDAsNi40Ny0zLjQ4TDE4NCwxMTMuODVDMTg2Ljg2LDEwOS4yNCwxODMuMjksMTAzLjQxLDE3Ny41NCwxMDMuNDFaIi8+PC9nPjwvZz48L3N2Zz4= mediatype: image/svg+xml @@ -48,11 +57,15 @@ spec: - rmc - power links: - - name: Rsct Operator + - name: RSCT Operator url: https://github.com/ocp-power-automation/rsct-operator maintainers: - email: mjturek@us.ibm.com name: Michael Turek + - email: varad.ahirwadkar1@ibm.com + name: Varad Ahirwadkar + - email: mkumatag@in.ibm.com + name: Manjunath Kumatagi maturity: alpha minKubeVersion: 1.25.0 provider: