Search

Chapter 5. ClusterOperator [config.openshift.io/v1]

download PDF
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. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type
object
Required
  • spec

5.1. Specification

PropertyTypeDescription

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 holds configuration that could apply to any operator.

status

object

status holds the information about the state of an operator. It is consistent with status information across the Kubernetes ecosystem.

5.1.1. .spec

Description
spec holds configuration that could apply to any operator.
Type
object

5.1.2. .status

Description
status holds the information about the state of an operator. It is consistent with status information across the Kubernetes ecosystem.
Type
object
PropertyTypeDescription

conditions

array

conditions describes the state of the operator’s managed and monitored components.

conditions[]

object

ClusterOperatorStatusCondition represents the state of the operator’s managed and monitored components.

extension

``

extension contains any additional status information specific to the operator which owns this status object.

relatedObjects

array

relatedObjects is a list of objects that are "interesting" or related to this operator. Common uses are: 1. the detailed resource driving the operator 2. operator namespaces 3. operand namespaces

relatedObjects[]

object

ObjectReference contains enough information to let you inspect or modify the referred object.

versions

array

versions is a slice of operator and operand version tuples. Operators which manage multiple operands will have multiple operand entries in the array. Available operators must report the version of the operator itself with the name "operator". An operator reports a new "operator" version when it has rolled out the new version to all of its operands.

versions[]

object

 

5.1.3. .status.conditions

Description
conditions describes the state of the operator’s managed and monitored components.
Type
array

5.1.4. .status.conditions[]

Description
ClusterOperatorStatusCondition represents the state of the operator’s managed and monitored components.
Type
object
Required
  • lastTransitionTime
  • status
  • type
PropertyTypeDescription

lastTransitionTime

string

lastTransitionTime is the time of the last update to the current status property.

message

string

message provides additional information about the current condition. This is only to be consumed by humans. It may contain Line Feed characters (U+000A), which should be rendered as new lines.

reason

string

reason is the CamelCase reason for the condition’s current status.

status

string

status of the condition, one of True, False, Unknown.

type

string

type specifies the aspect reported by this condition.

5.1.5. .status.relatedObjects

Description
relatedObjects is a list of objects that are "interesting" or related to this operator. Common uses are: 1. the detailed resource driving the operator 2. operator namespaces 3. operand namespaces
Type
array

5.1.6. .status.relatedObjects[]

Description
ObjectReference contains enough information to let you inspect or modify the referred object.
Type
object
Required
  • group
  • name
  • resource
PropertyTypeDescription

group

string

group of the referent.

name

string

name of the referent.

namespace

string

namespace of the referent.

resource

string

resource of the referent.

5.1.7. .status.versions

Description
versions is a slice of operator and operand version tuples. Operators which manage multiple operands will have multiple operand entries in the array. Available operators must report the version of the operator itself with the name "operator". An operator reports a new "operator" version when it has rolled out the new version to all of its operands.
Type
array

5.1.8. .status.versions[]

Description
Type
object
Required
  • name
  • version
PropertyTypeDescription

name

string

name is the name of the particular operand this version is for. It usually matches container images, not operators.

version

string

version indicates which version of a particular operand is currently being managed. It must always match the Available operand. If 1.0.0 is Available, then this must indicate 1.0.0 even if the operator is trying to rollout 1.1.0

5.2. API endpoints

The following API endpoints are available:

  • /apis/config.openshift.io/v1/clusteroperators

    • DELETE: delete collection of ClusterOperator
    • GET: list objects of kind ClusterOperator
    • POST: create a ClusterOperator
  • /apis/config.openshift.io/v1/clusteroperators/{name}

    • DELETE: delete a ClusterOperator
    • GET: read the specified ClusterOperator
    • PATCH: partially update the specified ClusterOperator
    • PUT: replace the specified ClusterOperator
  • /apis/config.openshift.io/v1/clusteroperators/{name}/status

    • GET: read status of the specified ClusterOperator
    • PATCH: partially update status of the specified ClusterOperator
    • PUT: replace status of the specified ClusterOperator

5.2.1. /apis/config.openshift.io/v1/clusteroperators

HTTP method
DELETE
Description
delete collection of ClusterOperator
Table 5.1. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind ClusterOperator
Table 5.2. HTTP responses
HTTP codeReponse body

200 - OK

ClusterOperatorList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a ClusterOperator
Table 5.3. Query parameters
ParameterTypeDescription

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 5.4. Body parameters
ParameterTypeDescription

body

ClusterOperator schema

 
Table 5.5. HTTP responses
HTTP codeReponse body

200 - OK

ClusterOperator schema

201 - Created

ClusterOperator schema

202 - Accepted

ClusterOperator schema

401 - Unauthorized

Empty

5.2.2. /apis/config.openshift.io/v1/clusteroperators/{name}

Table 5.6. Global path parameters
ParameterTypeDescription

name

string

name of the ClusterOperator

HTTP method
DELETE
Description
delete a ClusterOperator
Table 5.7. Query parameters
ParameterTypeDescription

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 5.8. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified ClusterOperator
Table 5.9. HTTP responses
HTTP codeReponse body

200 - OK

ClusterOperator schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified ClusterOperator
Table 5.10. Query parameters
ParameterTypeDescription

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 5.11. HTTP responses
HTTP codeReponse body

200 - OK

ClusterOperator schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified ClusterOperator
Table 5.12. Query parameters
ParameterTypeDescription

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 5.13. Body parameters
ParameterTypeDescription

body

ClusterOperator schema

 
Table 5.14. HTTP responses
HTTP codeReponse body

200 - OK

ClusterOperator schema

201 - Created

ClusterOperator schema

401 - Unauthorized

Empty

5.2.3. /apis/config.openshift.io/v1/clusteroperators/{name}/status

Table 5.15. Global path parameters
ParameterTypeDescription

name

string

name of the ClusterOperator

HTTP method
GET
Description
read status of the specified ClusterOperator
Table 5.16. HTTP responses
HTTP codeReponse body

200 - OK

ClusterOperator schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified ClusterOperator
Table 5.17. Query parameters
ParameterTypeDescription

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 5.18. HTTP responses
HTTP codeReponse body

200 - OK

ClusterOperator schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified ClusterOperator
Table 5.19. Query parameters
ParameterTypeDescription

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 5.20. Body parameters
ParameterTypeDescription

body

ClusterOperator schema

 
Table 5.21. HTTP responses
HTTP codeReponse body

200 - OK

ClusterOperator schema

201 - Created

ClusterOperator schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.