OperatorCondition [operators.coreos.com/v2]

Description

OperatorCondition is a Custom Resource of type OperatorCondition which is used to convey information to OLM about the state of an operator.

Type

`object`

Required

• metadata

Specification

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	OperatorConditionSpec allows an operator to report state to OLM and provides cluster admin with the ability to manually override state reported by the operator.
status	object	OperatorConditionStatus allows OLM to convey which conditions have been observed.

.spec

Description

OperatorConditionSpec allows an operator to report state to OLM and provides cluster admin with the ability to manually override state reported by the operator.

Type

`object`

Property	Type	Description
conditions	array
conditions[]	object	Condition contains details for one aspect of the current state of this API Resource.
deployments	array (string)
overrides	array
overrides[]	object	Condition contains details for one aspect of the current state of this API Resource.
serviceAccounts	array (string)

.spec.conditions

Description

Type

`array`

.spec.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource.

Type

`object`

Required

• lastTransitionTime
• message
• reason
• status
• type

Property	Type	Description
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	string	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	string	reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	string	status of the condition, one of True, False, Unknown.
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.

.spec.overrides

Description

Type

`array`

.spec.overrides[]

Description

Condition contains details for one aspect of the current state of this API Resource.

Type

`object`

Required

• message
• reason
• status
• type

Property	Type	Description
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	string	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	string	reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	string	status of the condition, one of True, False, Unknown.
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.

.status

Description

OperatorConditionStatus allows OLM to convey which conditions have been observed.

Type

`object`

Property	Type	Description
conditions	array
conditions[]	object	Condition contains details for one aspect of the current state of this API Resource.

.status.conditions

Description

Type

`array`

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource.

Type

`object`

Required

• lastTransitionTime
• message
• reason
• status
• type

Property	Type	Description
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	string	message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason	string	reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status	string	status of the condition, one of True, False, Unknown.
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.

API endpoints

The following API endpoints are available:

• /apis/operators.coreos.com/v2/operatorconditions
  • GET: list objects of kind OperatorCondition
• /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions
  • DELETE: delete collection of OperatorCondition
  • GET: list objects of kind OperatorCondition
  • POST: create an OperatorCondition
• /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}
  • DELETE: delete an OperatorCondition
  • GET: read the specified OperatorCondition
  • PATCH: partially update the specified OperatorCondition
  • PUT: replace the specified OperatorCondition
• /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}/status
  • GET: read status of the specified OperatorCondition
  • PATCH: partially update status of the specified OperatorCondition
  • PUT: replace status of the specified OperatorCondition

/apis/operators.coreos.com/v2/operatorconditions

HTTP method

`GET`

Description

list objects of kind OperatorCondition

HTTP responses

HTTP code	Reponse body
200 - OK	OperatorConditionList schema
401 - Unauthorized	Empty

/apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions

HTTP method

`DELETE`

Description

delete collection of OperatorCondition

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list objects of kind OperatorCondition

HTTP responses

HTTP code	Reponse body
200 - OK	OperatorConditionList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create an OperatorCondition

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.

Body parameters

Parameter	Type	Description
body	OperatorCondition schema

HTTP responses

HTTP code	Reponse body
200 - OK	OperatorCondition schema
201 - Created	OperatorCondition schema
202 - Accepted	OperatorCondition schema
401 - Unauthorized	Empty

/apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the OperatorCondition

HTTP method

`DELETE`

Description

delete an OperatorCondition

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

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified OperatorCondition

HTTP responses

HTTP code	Reponse body
200 - OK	OperatorCondition schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified OperatorCondition

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.

HTTP responses

HTTP code	Reponse body
200 - OK	OperatorCondition schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified OperatorCondition

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.

Body parameters

Parameter	Type	Description
body	OperatorCondition schema

HTTP responses

HTTP code	Reponse body
200 - OK	OperatorCondition schema
201 - Created	OperatorCondition schema
401 - Unauthorized	Empty

/apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}/status

Global path parameters

Parameter	Type	Description
name	string	name of the OperatorCondition

HTTP method

`GET`

Description

read status of the specified OperatorCondition

HTTP responses

HTTP code	Reponse body
200 - OK	OperatorCondition schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified OperatorCondition

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.

HTTP responses

HTTP code	Reponse body
200 - OK	OperatorCondition schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified OperatorCondition

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.

Body parameters

Parameter	Type	Description
body	OperatorCondition schema

HTTP responses

HTTP code	Reponse body
200 - OK	OperatorCondition schema
201 - Created	OperatorCondition schema
401 - Unauthorized	Empty