Skip to content

Commit e65fd12

Browse files
committed
config/v1/cluster_operator improve documentation
Signed-off-by: Frank Villaro-Dixon <[email protected]>
1 parent f5e205b commit e65fd12

File tree

6 files changed

+12
-15
lines changed

6 files changed

+12
-15
lines changed

config/v1/types_cluster_operator.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,9 @@ import (
99
// +genclient:nonNamespaced
1010
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
1111

12-
// ClusterOperator is the Custom Resource object which holds the current state
13-
// of an operator. This object is used by operators to convey their state to
14-
// the rest of the cluster.
15-
//
12+
// ClusterOperator holds the status of a core or optional OpenShift component
13+
// managed by the Cluster Version Operator (CVO). This object is used by
14+
// operators to convey their state to the rest of the cluster.
1615
// Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
1716
// +openshift:compatibility-gen:level=1
1817
// +openshift:api-approved.openshift.io=https://github.com/openshift/api/pull/497

config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator_01_clusteroperators.crd.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,9 @@ spec:
4242
schema:
4343
openAPIV3Schema:
4444
description: |-
45-
ClusterOperator is the Custom Resource object which holds the current state
46-
of an operator. This object is used by operators to convey their state to
47-
the rest of the cluster.
48-
45+
ClusterOperator holds the status of a core or optional OpenShift component
46+
managed by the Cluster Version Operator (CVO). This object is used by
47+
operators to convey their state to the rest of the cluster.
4948
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
5049
properties:
5150
apiVersion:

config/v1/zz_generated.featuregated-crd-manifests/clusteroperators.config.openshift.io/AAA_ungated.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,9 @@ spec:
4545
schema:
4646
openAPIV3Schema:
4747
description: |-
48-
ClusterOperator is the Custom Resource object which holds the current state
49-
of an operator. This object is used by operators to convey their state to
50-
the rest of the cluster.
51-
48+
ClusterOperator holds the status of a core or optional OpenShift component
49+
managed by the Cluster Version Operator (CVO). This object is used by
50+
operators to convey their state to the rest of the cluster.
5251
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
5352
properties:
5453
apiVersion:

config/v1/zz_generated.swagger_doc_generated.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi/generated_openapi/zz_generated.openapi.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5147,7 +5147,7 @@
51475147
}
51485148
},
51495149
"com.github.openshift.api.config.v1.ClusterOperator": {
5150-
"description": "ClusterOperator is the Custom Resource object which holds the current state of an operator. This object is used by operators to convey their state to the rest of the cluster.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
5150+
"description": "ClusterOperator holds the status of a core or optional OpenShift component managed by the Cluster Version Operator (CVO). This object is used by operators to convey their state to the rest of the cluster. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
51515151
"type": "object",
51525152
"required": [
51535153
"metadata",

0 commit comments

Comments
 (0)