Operator represents a cluster operator.
Operator represents a cluster operator.
object
Property | Type | Description |
---|---|---|
|
|
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 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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
OperatorSpec defines the desired state of Operator |
|
|
OperatorStatus defines the observed state of an Operator and its components |
OperatorStatus defines the observed state of an Operator and its components
object
Property | Type | Description |
---|---|---|
|
|
Components describes resources that compose the operator. |
Components describes resources that compose the operator.
object
labelSelector
Property | Type | Description |
---|---|---|
|
|
LabelSelector is a label query over a set of resources used to select the operator’s components |
|
|
Refs are a set of references to the operator’s component resources, selected with LabelSelector. |
|
|
RichReference is a reference to a resource, enriched with its status conditions. |
LabelSelector is a label query over a set of resources used to select the operator’s components
object
Property | Type | Description |
---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
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. |
matchExpressions is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
Property | Type | Description |
---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
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. |
Refs are a set of references to the operator’s component resources, selected with LabelSelector.
array
RichReference is a reference to a resource, enriched with its status conditions.
object
Property | Type | Description |
---|---|---|
|
|
API version of the referent. |
|
|
Conditions represents the latest state of the component. |
|
|
Condition represent the latest available observations of an component’s state. |
|
|
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. TODO: this design is not final and this field is subject to change in the future. |
|
|
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
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 of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
Conditions represents the latest state of the component.
array
Condition represent the latest available observations of an component’s state.
object
status
type
Property | Type | Description |
---|---|---|
|
|
Last time the condition transitioned from one status to another. |
|
|
Last time the condition was probed |
|
|
A human readable message indicating details about the transition. |
|
|
The reason for the condition’s last transition. |
|
|
Status of the condition, one of True, False, Unknown. |
|
|
Type of condition. |
The following API endpoints are available:
/apis/operators.coreos.com/v1/operators
DELETE
: delete collection of Operator
GET
: list objects of kind Operator
POST
: create an Operator
/apis/operators.coreos.com/v1/operators/{name}
DELETE
: delete an Operator
GET
: read the specified Operator
PATCH
: partially update the specified Operator
PUT
: replace the specified Operator
/apis/operators.coreos.com/v1/operators/{name}/status
GET
: read status of the specified Operator
PATCH
: partially update status of the specified Operator
PUT
: replace status of the specified Operator