OperatorGroup [operators.coreos.com/v1]

Description

OperatorGroup is the unit of multitenancy for OLM managed operators. It constrains the installation of operators in its namespace to a specified set of target namespaces.

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	OperatorGroupSpec is the spec for an OperatorGroup resource.
status	object	OperatorGroupStatus is the status for an OperatorGroupResource.

.spec

Description

OperatorGroupSpec is the spec for an OperatorGroup resource.

Type

`object`

Property	Type	Description
selector	object	Selector selects the OperatorGroup’s target namespaces.
serviceAccountName	string	ServiceAccountName is the admin specified service account which will be used to deploy operator(s) in this operator group.
staticProvidedAPIs	boolean	Static tells OLM not to update the OperatorGroup’s providedAPIs annotation
targetNamespaces	array (string)	TargetNamespaces is an explicit set of namespaces to target. If it is set, Selector is ignored.
upgradeStrategy	string	UpgradeStrategy defines the upgrade strategy for operators in the namespace. There are currently two supported upgrade strategies: Default: OLM will only allow clusterServiceVersions to move to the replacing phase from the succeeded phase. This effectively means that OLM will not allow operators to move to the next version if an installation or upgrade has failed. TechPreviewUnsafeFailForward: OLM will allow clusterServiceVersions to move to the replacing phase from the succeeded phase or from the failed phase. Additionally, OLM will generate new installPlans when a subscription references a failed installPlan and the catalog has been updated with a new upgrade for the existing set of operators. WARNING: The TechPreviewUnsafeFailForward upgrade strategy is unsafe and may result in unexpected behavior or unrecoverable data loss unless you have deep understanding of the set of operators being managed in the namespace.

.spec.selector

Description

Selector selects the OperatorGroup’s target namespaces.

Type

`object`

Property	Type	Description
matchExpressions	array	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions[]	object	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
matchLabels	object (string)	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.selector.matchExpressions

Description

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type

`array`

.spec.selector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

`object`

Required

• key
• operator

Property	Type	Description
key	string	key is the label key that the selector applies to.
operator	string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	array (string)	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.status

Description

OperatorGroupStatus is the status for an OperatorGroupResource.

Type

`object`

Required

• lastUpdated

Property	Type	Description
conditions	array	Conditions is an array of the OperatorGroup’s conditions.
conditions[]	object	Condition contains details for one aspect of the current state of this API Resource.
lastUpdated	string	LastUpdated is a timestamp of the last time the OperatorGroup’s status was Updated.
namespaces	array (string)	Namespaces is the set of target namespaces for the OperatorGroup.
serviceAccountRef	object	ServiceAccountRef references the service account object specified.

.status.conditions

Description

Conditions is an array of the OperatorGroup’s conditions.

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.

.status.serviceAccountRef

Description

ServiceAccountRef references the service account object specified.

Type

`object`

Property	Type	Description
apiVersion	string	API version of the referent.
fieldPath	string	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kind	string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace	string	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersion	string	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
uid	string	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

API endpoints

The following API endpoints are available:

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

/apis/operators.coreos.com/v1/operatorgroups

HTTP method

`GET`

Description

list objects of kind OperatorGroup

HTTP responses

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

/apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups

HTTP method

`DELETE`

Description

delete collection of OperatorGroup

HTTP responses

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

HTTP method

`GET`

Description

list objects of kind OperatorGroup

HTTP responses

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

HTTP method

`POST`

Description

create an OperatorGroup

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	OperatorGroup schema

HTTP responses

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

/apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the OperatorGroup

HTTP method

`DELETE`

Description

delete an OperatorGroup

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 OperatorGroup

HTTP responses

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

HTTP method

`PATCH`

Description

partially update the specified OperatorGroup

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	OperatorGroup schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified OperatorGroup

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	OperatorGroup schema

HTTP responses

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

/apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}/status

Global path parameters

Parameter	Type	Description
name	string	name of the OperatorGroup

HTTP method

`GET`

Description

read status of the specified OperatorGroup

HTTP responses

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

HTTP method

`PATCH`

Description

partially update status of the specified OperatorGroup

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	OperatorGroup schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified OperatorGroup

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	OperatorGroup schema

HTTP responses

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