Skip to content

Location

Location CRD schema reference (group scheduling.kcp.io)

Location represents a set of instances of a scheduling resource type acting a target of scheduling. The location is chosen by the user (in the future) through a Placement object, while the instance is chosen by the scheduler depending on considerations like load or available resources, or further node selectors specified by the user.
Full name:
locations.scheduling.kcp.io
Group:
scheduling.kcp.io
Singular name:
location
Plural name:
locations
Scope:
Cluster
Versions:
v1alpha1

Version v1alpha1

Properties

.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

object

.spec

object

LocationSpec holds the desired state of the Location.

.spec.availableSelectorLabels

array

availableSelectorLabels is a list of labels that can be used to select an instance at this location in a placement object.

.spec.availableSelectorLabels[*]

object

AvailableSelectorLabel specifies a label with key name and possible values.

.spec.availableSelectorLabels[*].description

string

description is a human readable description of the label.

.spec.availableSelectorLabels[*].key

string Required

key is the name of the label.

.spec.availableSelectorLabels[*].values

array Required

values are the possible values for this labels.

.spec.availableSelectorLabels[*].values[*]

string

LabelValue specifies a value of a label.

.spec.description

string

description is a human-readable description of the location.

.spec.instanceSelector

object

instanceSelector chooses the instances that will be part of this location. Note that these labels are not what is shown in the Location objects to the user. Depending on context, both will match or won’t match.

.spec.instanceSelector.matchExpressions

array

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

.spec.instanceSelector.matchExpressions[*]

object

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

.spec.instanceSelector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.instanceSelector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.instanceSelector.matchExpressions[*].values

array

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.

.spec.instanceSelector.matchExpressions[*].values[*]

string

.spec.instanceSelector.matchLabels

object

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

object Required

resource is the group-version-resource of the instances that are subject to this location.

.spec.resource.group

string

group is the name of an API group.

.spec.resource.resource

string Required

resource is the name of the resource.

.spec.resource.version

string Required

version is the version of the API.

.status

object

LocationStatus defines the observed state of Location.

.status.availableInstances

integer

available is the number of actual instances that are available at this location.

.status.instances

integer

instances is the number of actual instances at this location.