Skip to content

Commit 9cb6545

Browse files
ppc64le-cloud-botppc64le-cloud-bot
authored
Merge pull request #70 from varad-ahirwadkar/update-doc
Updating operator's documentation
2 parents 93e18d5 + 14a5449 commit 9cb6545

File tree

8 files changed

+56
-21
lines changed

8 files changed

+56
-21
lines changed

‎api/v1alpha1/rsct_types.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ type RSCTSpec struct {
3838
type RSCTStatus struct {
3939
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
4040
// Important: Run "make" to regenerate code after modifying this file
41+
42+
// State reflects current observed state of RSCT resource
4143
State *string `json:"state,omitempty"`
4244
}
4345

‎bundle.Dockerfile‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.34.1
1010
LABEL operators.operatorframework.io.metrics.mediatype.v1=metrics+v1
1111
LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v4
1212

13+
# Labels for testing.
14+
LABEL operators.operatorframework.io.test.mediatype.v1=scorecard+v1
15+
LABEL operators.operatorframework.io.test.config.v1=tests/scorecard/
16+
1317
# Copy files to locations specified by labels.
1418
COPY bundle/manifests /manifests/
1519
COPY bundle/metadata /metadata/
20+
COPY bundle/tests/scorecard /tests/scorecard/

‎bundle/manifests/rsct-operator.clusterserviceversion.yaml‎

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,19 @@ metadata:
2222
}
2323
]
2424
capabilities: Basic Install
25-
categories: OpenShift Optional
26-
containerImage: ghcr.io/ocp-power-automation/rsct-operator:latest
27-
createdAt: "2024-11-18T09:20:10Z"
28-
description: Deploys RSCT daemonset on all nodes of an OpenShift cluster
25+
categories: Monitoring
26+
containerImage: ghcr.io/ocp-power-automation/rsct-operator:0.0.1-alpha2
27+
createdAt: "2024-12-10T05:23:35Z"
28+
description: Deploys the RSCT DaemonSet on all ppc64le architecture nodes of Kubernetes
29+
and OpenShift clusters.
2930
operators.operatorframework.io/builder: operator-sdk-v1.34.1
3031
operators.operatorframework.io/project_layout: go.kubebuilder.io/v4
3132
repository: https://github.com/ocp-power-automation/rsct-operator
3233
support: IBM
3334
labels:
3435
operatorframework.io/arch.amd64: supported
3536
operatorframework.io/arch.ppc64le: supported
36-
name: rsct-operator.v0.0.1
37+
name: rsct-operator.v0.0.1-alpha2
3738
namespace: rsct-operator-system
3839
spec:
3940
apiservicedefinitions: {}
@@ -44,8 +45,16 @@ spec:
4445
kind: RSCT
4546
name: rscts.rsct.ibm.com
4647
version: v1alpha1
47-
description: Deploys custom resource RSCT on all nodes of an OpenShift cluster.
48-
displayName: RSCT Operator for IBM Power Virtual Server
48+
description: "Deploys RSCT daemonset on all ppc64le architecture nodes of an Kubernetes
49+
and OpenShift cluster.\n\n### Prerequisite for OpenShift cluster\n- Create a catalog
50+
source using `quay.io/operatorhubio/catalog:latest` in `openshift-marketplace`
51+
namespace. \n- Use `rsct-operator-system` namespace for RSCT deployment.\n\n###
52+
Follow this document to deploy the RSCT operator on OpenShift cluster \n- [RSCT
53+
Deployment on OpenShift Clusters](https://github.com/ocp-power-automation/rsct-operator/blob/main/docs/Install.md)\n\n###
54+
In the Custom Resource Definition,\n- The RSCT image can be configured in the
55+
spec:\n```\nspec:\n image: quay.io/powercloud/rsct-ppc64le:latest\n```\nDefault
56+
image is `quay.io/powercloud/rsct-ppc64le:latest`"
57+
displayName: RSCT Operator for IBM Power Systems
4958
icon:
5059
- base64data: PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNTguNTEgMjU4LjUxIj48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2QxZDFkMTt9LmNscy0ye2ZpbGw6IzhkOGQ4Zjt9PC9zdHlsZT48L2RlZnM+PHRpdGxlPkFzc2V0IDQ8L3RpdGxlPjxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPjxnIGlkPSJMYXllcl8xLTIiIGRhdGEtbmFtZT0iTGF5ZXIgMSI+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMTI5LjI1LDIwQTEwOS4xLDEwOS4xLDAsMCwxLDIwNi40LDIwNi40LDEwOS4xLDEwOS4xLDAsMSwxLDUyLjExLDUyLjExLDEwOC40NSwxMDguNDUsMCwwLDEsMTI5LjI1LDIwbTAtMjBoMEM1OC4xNiwwLDAsNTguMTYsMCwxMjkuMjVIMGMwLDcxLjA5LDU4LjE2LDEyOS4yNiwxMjkuMjUsMTI5LjI2aDBjNzEuMDksMCwxMjkuMjYtNTguMTcsMTI5LjI2LTEyOS4yNmgwQzI1OC41MSw1OC4xNiwyMDAuMzQsMCwxMjkuMjUsMFoiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xNzcuNTQsMTAzLjQxSDE0MS42NkwxNTQuOSw2NS43NmMxLjI1LTQuNC0yLjMzLTguNzYtNy4yMS04Ljc2SDEwMi45M2E3LjMyLDcuMzIsMCwwLDAtNy40LDZsLTEwLDY5LjYxYy0uNTksNC4xNywyLjg5LDcuODksNy40LDcuODloMzYuOUwxMTUuNTUsMTk3Yy0xLjEyLDQuNDEsMi40OCw4LjU1LDcuMjQsOC41NWE3LjU4LDcuNTgsMCwwLDAsNi40Ny0zLjQ4TDE4NCwxMTMuODVDMTg2Ljg2LDEwOS4yNCwxODMuMjksMTAzLjQxLDE3Ny41NCwxMDMuNDFaIi8+PC9nPjwvZz48L3N2Zz4=
5160
mediatype: image/svg+xml
@@ -191,7 +200,7 @@ spec:
191200
- --leader-elect
192201
command:
193202
- /manager
194-
image: ghcr.io/ocp-power-automation/rsct-operator:latest
203+
image: ghcr.io/ocp-power-automation/rsct-operator:0.0.1-alpha2
195204
livenessProbe:
196205
httpGet:
197206
path: /healthz
@@ -272,13 +281,17 @@ spec:
272281
- rmc
273282
- power
274283
links:
275-
- name: Rsct Operator
284+
- name: RSCT Operator
276285
url: https://github.com/ocp-power-automation/rsct-operator
277286
maintainers:
278287
- email: [email protected]
279288
name: Michael Turek
289+
- email: [email protected]
290+
name: Varad Ahirwadkar
291+
- email: [email protected]
292+
name: Manjunath Kumatagi
280293
maturity: alpha
281294
minKubeVersion: 1.25.0
282295
provider:
283296
name: IBM
284-
version: 0.0.1
297+
version: 0.0.1-alpha2

‎bundle/manifests/rsct.ibm.com_rscts.yaml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@ spec:
4848
description: RSCTStatus defines the observed state of RSCT
4949
properties:
5050
state:
51-
description: |-
52-
state reflects current observed state of RSCT resource
51+
description: State reflects current observed state of RSCT resource
5352
type: string
5453
type: object
5554
type: object

‎bundle/metadata/annotations.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,7 @@ annotations:
88
operators.operatorframework.io.metrics.builder: operator-sdk-v1.34.1
99
operators.operatorframework.io.metrics.mediatype.v1: metrics+v1
1010
operators.operatorframework.io.metrics.project_layout: go.kubebuilder.io/v4
11+
12+
# Annotations for testing.
13+
operators.operatorframework.io.test.mediatype.v1: scorecard+v1
14+
operators.operatorframework.io.test.config.v1: tests/scorecard/

‎config/crd/bases/rsct.ibm.com_rscts.yaml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@ spec:
4848
description: RSCTStatus defines the observed state of RSCT
4949
properties:
5050
state:
51-
description: |-
52-
state reflects current observed state of RSCT resource
51+
description: State reflects current observed state of RSCT resource
5352
type: string
5453
type: object
5554
type: object

‎config/manager/kustomization.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ kind: Kustomization
1313
images:
1414
- name: controller
1515
newName: ghcr.io/ocp-power-automation/rsct-operator
16-
newTag: latest
16+
newTag: 0.0.1-alpha2

‎config/manifests/bases/rsct-operator.clusterserviceversion.yaml‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ metadata:
44
annotations:
55
alm-examples: '[]'
66
capabilities: Basic Install
7-
categories: OpenShift Optional
8-
containerImage: ghcr.io/ocp-power-automation/rsct-operator:latest
9-
description: Deploys RSCT daemonset on all nodes of an OpenShift cluster
7+
categories: Monitoring
8+
containerImage: ghcr.io/ocp-power-automation/rsct-operator:0.0.1-alpha2
9+
description: Deploys the RSCT DaemonSet on all ppc64le architecture nodes of Kubernetes
10+
and OpenShift clusters.
1011
repository: https://github.com/ocp-power-automation/rsct-operator
1112
support: IBM
1213
labels:
@@ -23,8 +24,16 @@ spec:
2324
kind: RSCT
2425
name: rscts.rsct.ibm.com
2526
version: v1alpha1
26-
description: Deploys custom resource RSCT on all nodes of an OpenShift cluster.
27-
displayName: RSCT Operator for IBM Power Virtual Server
27+
description: "Deploys RSCT daemonset on all ppc64le architecture nodes of an Kubernetes
28+
and OpenShift cluster.\n\n### Prerequisite for OpenShift cluster\n- Create a catalog
29+
source using `quay.io/operatorhubio/catalog:latest` in `openshift-marketplace`
30+
namespace. \n- Use `rsct-operator-system` namespace for RSCT deployment.\n\n###
31+
Follow this document to deploy the RSCT operator on OpenShift cluster \n- [RSCT
32+
Deployment on OpenShift Clusters](https://github.com/ocp-power-automation/rsct-operator/blob/main/docs/Install.md)\n\n###
33+
In the Custom Resource Definition,\n- The RSCT image can be configured in the
34+
spec:\n```\nspec:\n image: quay.io/powercloud/rsct-ppc64le:latest\n```\nDefault
35+
image is `quay.io/powercloud/rsct-ppc64le:latest`"
36+
displayName: RSCT Operator for IBM Power Systems
2837
icon:
2938
- base64data: PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNTguNTEgMjU4LjUxIj48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2QxZDFkMTt9LmNscy0ye2ZpbGw6IzhkOGQ4Zjt9PC9zdHlsZT48L2RlZnM+PHRpdGxlPkFzc2V0IDQ8L3RpdGxlPjxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPjxnIGlkPSJMYXllcl8xLTIiIGRhdGEtbmFtZT0iTGF5ZXIgMSI+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMTI5LjI1LDIwQTEwOS4xLDEwOS4xLDAsMCwxLDIwNi40LDIwNi40LDEwOS4xLDEwOS4xLDAsMSwxLDUyLjExLDUyLjExLDEwOC40NSwxMDguNDUsMCwwLDEsMTI5LjI1LDIwbTAtMjBoMEM1OC4xNiwwLDAsNTguMTYsMCwxMjkuMjVIMGMwLDcxLjA5LDU4LjE2LDEyOS4yNiwxMjkuMjUsMTI5LjI2aDBjNzEuMDksMCwxMjkuMjYtNTguMTcsMTI5LjI2LTEyOS4yNmgwQzI1OC41MSw1OC4xNiwyMDAuMzQsMCwxMjkuMjUsMFoiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xNzcuNTQsMTAzLjQxSDE0MS42NkwxNTQuOSw2NS43NmMxLjI1LTQuNC0yLjMzLTguNzYtNy4yMS04Ljc2SDEwMi45M2E3LjMyLDcuMzIsMCwwLDAtNy40LDZsLTEwLDY5LjYxYy0uNTksNC4xNywyLjg5LDcuODksNy40LDcuODloMzYuOUwxMTUuNTUsMTk3Yy0xLjEyLDQuNDEsMi40OCw4LjU1LDcuMjQsOC41NWE3LjU4LDcuNTgsMCwwLDAsNi40Ny0zLjQ4TDE4NCwxMTMuODVDMTg2Ljg2LDEwOS4yNCwxODMuMjksMTAzLjQxLDE3Ny41NCwxMDMuNDFaIi8+PC9nPjwvZz48L3N2Zz4=
3039
mediatype: image/svg+xml
@@ -48,11 +57,15 @@ spec:
4857
- rmc
4958
- power
5059
links:
51-
- name: Rsct Operator
60+
- name: RSCT Operator
5261
url: https://github.com/ocp-power-automation/rsct-operator
5362
maintainers:
5463
- email: [email protected]
5564
name: Michael Turek
65+
- email: [email protected]
66+
name: Varad Ahirwadkar
67+
- email: [email protected]
68+
name: Manjunath Kumatagi
5669
maturity: alpha
5770
minKubeVersion: 1.25.0
5871
provider:

0 commit comments

Comments
 (0)