ClusterVersionOperator [operator.openshift.io/v1alpha1] - Operator APIs | API reference

Specification
- .spec
- .status
API endpoints

Description

ClusterVersionOperator holds cluster-wide information about the Cluster Version Operator.

Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.

Type

object

Required

metadata
spec

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	spec is the specification of the desired behavior of the Cluster Version Operator.
`status`	`object`	status is the most recently observed status of the Cluster Version Operator.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec is the specification of the desired behavior of the Cluster Version Operator.

status

object

status is the most recently observed status of the Cluster Version Operator.

.spec

Description: spec is the specification of the desired behavior of the Cluster Version Operator.
Type: object

Property Type Description

Property	Type	Description
`operatorLogLevel`	`string`	operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".

operatorLogLevel

string

operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.

Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".

.status

Description: status is the most recently observed status of the Cluster Version Operator.
Type: object

Property Type Description

Property	Type	Description
`observedGeneration`	`integer`	observedGeneration represents the most recent generation observed by the operator and specifies the version of the spec field currently being synced.

observedGeneration

integer

observedGeneration represents the most recent generation observed by the operator and specifies the version of the spec field currently being synced.

API endpoints

The following API endpoints are available:

/apis/operator.openshift.io/v1alpha1/clusterversionoperators
- DELETE: delete collection of ClusterVersionOperator
- GET: list objects of kind ClusterVersionOperator
- POST: create a ClusterVersionOperator
/apis/operator.openshift.io/v1alpha1/clusterversionoperators/{name}
- DELETE: delete a ClusterVersionOperator
- GET: read the specified ClusterVersionOperator
- PATCH: partially update the specified ClusterVersionOperator
- PUT: replace the specified ClusterVersionOperator
/apis/operator.openshift.io/v1alpha1/clusterversionoperators/{name}/status
- GET: read status of the specified ClusterVersionOperator
- PATCH: partially update status of the specified ClusterVersionOperator
- PUT: replace status of the specified ClusterVersionOperator

/apis/operator.openshift.io/v1alpha1/clusterversionoperators

HTTP method: DELETE
Description: delete collection of ClusterVersionOperator

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind ClusterVersionOperator

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterVersionOperatorList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ClusterVersionOperator

Table 3. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 4. Body parameters
Parameter	Type	Description
`body`	`ClusterVersionOperator` schema

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterVersionOperator` schema
201 - Created	`ClusterVersionOperator` schema
202 - Accepted	`ClusterVersionOperator` schema
401 - Unauthorized	Empty

/apis/operator.openshift.io/v1alpha1/clusterversionoperators/{name}

Table 6. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ClusterVersionOperator

HTTP method: DELETE
Description: delete a ClusterVersionOperator

Table 7. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ClusterVersionOperator

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterVersionOperator` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ClusterVersionOperator

Table 10. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterVersionOperator` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ClusterVersionOperator

Table 12. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. Body parameters
Parameter	Type	Description
`body`	`ClusterVersionOperator` schema

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterVersionOperator` schema
201 - Created	`ClusterVersionOperator` schema
401 - Unauthorized	Empty

/apis/operator.openshift.io/v1alpha1/clusterversionoperators/{name}/status

Table 15. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ClusterVersionOperator

HTTP method: GET
Description: read status of the specified ClusterVersionOperator

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterVersionOperator` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified ClusterVersionOperator

Table 17. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterVersionOperator` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified ClusterVersionOperator

Table 19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 20. Body parameters
Parameter	Type	Description
`body`	`ClusterVersionOperator` schema

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterVersionOperator` schema
201 - Created	`ClusterVersionOperator` schema
401 - Unauthorized	Empty