ClusterOperator [config.openshift.io/v1]

    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.

    Type

    Required

    • spec

    .spec

    Description

    spec holds configuration that could apply to any operator.

    Type

    object

    .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

    .status.conditions

    Description

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

    Type

    array

    .status.conditions[]

    Description

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

    Type

    object

    Required

    • lastTransitionTime

    • status

    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.

    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.

    .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

    .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.

    .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

    .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

    API endpoints

    The following API endpoints are available:

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

      • : delete collection of ClusterOperator

      • GET: list objects of kind 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

    Table 1. Global guery parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete collection of ClusterOperator

    Table 2. Query parameters
    ParameterTypeDescription

    allowWatchBookmarks

    boolean

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    watch

    boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    Table 3. HTTP responses
    HTTP codeReponse body

    200 - OK

    401 - Unauthorized

    Empty

    HTTP method

    GET

    Description

    list objects of kind ClusterOperator

    Table 4. Query parameters
    ParameterTypeDescription

    allowWatchBookmarks

    boolean

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    watch

    boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    Table 5. HTTP responses
    HTTP codeReponse body

    200 - OK

    ClusterOperatorList config.openshift.io/v1

    401 - Unauthorized

    Empty

    HTTP method

    POST

    Description

    create a ClusterOperator

    Table 6. 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

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    Table 7. Body parameters
    ParameterTypeDescription

    body

    ClusterOperator config.openshift.io/v1

    Table 9. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the ClusterOperator

    Table 10. Global guery parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    DELETE

    Description

    delete a ClusterOperator

    Table 11. 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

    gracePeriodSeconds

    integer

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    orphanDependents

    boolean

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    propagationPolicy

    string

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

    Table 12. Body parameters
    ParameterTypeDescription

    body

    Table 13. HTTP responses
    HTTP codeReponse body

    200 - OK

    Status meta/v1

    202 - Accepted

    401 - Unauthorized

    Empty

    HTTP method

    GET

    Description

    read the specified ClusterOperator

    Table 14. Query parameters
    ParameterTypeDescription

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    Table 15. HTTP responses
    HTTP codeReponse body

    200 - OK

    401 - Unauthorized

    Empty

    HTTP method

    PATCH

    Description

    partially update the specified ClusterOperator

    Table 16. 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

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    Table 17. Body parameters
    ParameterTypeDescription

    body

    Table 18. HTTP responses
    HTTP codeReponse body

    200 - OK

    ClusterOperator config.openshift.io/v1

    401 - Unauthorized

    Empty

    HTTP method

    PUT

    Description

    replace the specified ClusterOperator

    Table 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

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    Table 21. HTTP responses
    HTTP codeReponse body

    200 - OK

    ClusterOperator config.openshift.io/v1

    201 - Created

    401 - Unauthorized

    Empty

    Table 22. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the ClusterOperator

    Table 23. Global guery parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    GET

    Description

    read status of the specified ClusterOperator

    Table 24. Query parameters
    ParameterTypeDescription

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    Table 25. HTTP responses
    HTTP codeReponse body

    200 - OK

    401 - Unauthorized

    Empty

    HTTP method

    PATCH

    Description

    partially update status of the specified ClusterOperator

    Table 26. 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

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    Table 27. Body parameters
    ParameterTypeDescription

    body

    Table 28. HTTP responses
    HTTP codeReponse body

    200 - OK

    ClusterOperator config.openshift.io/v1

    401 - Unauthorized

    Empty

    HTTP method

    PUT

    Description

    replace status of the specified ClusterOperator

    Table 29. 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

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    Table 30. Body parameters
    ParameterTypeDescription

    body

    ClusterOperator config.openshift.io/v1

    Table 31. HTTP responses
    HTTP codeReponse body

    200 - OK

    201 - Created

    401 - Unauthorized

    Empty