Skip to content

LogicalCluster

LogicalCluster CRD schema reference (group core.kcp.io)

LogicalCluster describes the current logical cluster. It is used to authorize requests to the logical cluster and to track state. A LogicalCluster is always named "cluster".
Full name:
logicalclusters.core.kcp.io
Group:
core.kcp.io
Singular name:
logicalcluster
Plural name:
logicalclusters
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

.metadata.name

string

.spec

object

LogicalClusterSpec is the specification of the LogicalCluster resource.

.spec.directlyDeletable

boolean

DirectlyDeletable indicates that this logical cluster can be directly deleted by the user from within by deleting the LogicalCluster object.

.spec.initializers

array

initializers are set on creation by the system and copied to status when initialization starts.

.spec.initializers[*]

string

LogicalClusterInitializer is a unique string corresponding to a logical cluster initialization controller.

.spec.owner

object

owner is a reference to a resource controlling the life-cycle of this logical cluster. On deletion of the LogicalCluster, the finalizer core.kcp.io/logicalcluster is removed from the owner.

When this object is deleted, but the owner is not deleted, the owner is deleted too.

.spec.owner.apiVersion

string Required

apiVersion is the group and API version of the owner.

.spec.owner.cluster

string Required

cluster is the logical cluster in which the owner is located.

.spec.owner.name

string Required

name is the name of the owner.

.spec.owner.namespace

string

namespace is the optional namespace of the owner.

.spec.owner.resource

string Required

resource is API resource to access the owner.

.spec.owner.uid

string Required

UID is the UID of the owner.

.status

object

LogicalClusterStatus communicates the observed state of the Workspace.

.status.URL

string

url is the address under which the Kubernetes-cluster-like endpoint can be found. This URL can be used to access the logical cluster with standard Kubernetes client libraries and command line tools.

.status.conditions

array

Current processing state of the LogicalCluster.

.status.conditions[*]

object

Condition defines an observation of a object operational state.

.status.conditions[*].lastTransitionTime

string Required

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.

.status.conditions[*].message

string

A human readable message indicating details about the transition. This field may be empty.

.status.conditions[*].reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

.status.conditions[*].severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

.status.conditions[*].status

string Required

Status of the condition, one of True, False, Unknown.

.status.conditions[*].type

string Required

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.initializers

array

initializers are set on creation by the system and must be cleared by a controller before the logical cluster can be used. The LogicalCluster object will stay in the phase “Initializing” state until all initializers are cleared.

.status.initializers[*]

string

LogicalClusterInitializer is a unique string corresponding to a logical cluster initialization controller.

.status.phase

string

Phase of the logical cluster (Initializing, Ready).