v1alpha1

type Endpoint struct {
	// url is the virtual workspace URL serving this endpoint.
	//
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:format:URL
	// +required
	URL string `json:"url"`

	// shards says which shards this URL serves.
	//
	// Saying nothing -- the zero value -- means the URL was composed for one
	// specific shard and is matched by URL prefix instead, which is what kcp's
	// own controllers publish. A status should not mix the two: either every
	// endpoint says which shards it is for, or none does.
	//
	// +optional
	Shards EndpointSelector `json:"shards,omitempty"`
}

type EndpointSelector struct {
	// matchAll says this URL serves every shard: one virtual workspace for the
	// whole installation, which is what a provider running a single virtual
	// workspace publishes.
	//
	// +optional
	MatchAll bool `json:"matchAll,omitempty"`

	// selector picks the shards this URL serves by matching against shard
	// labels. Every shard labels itself with its own name, so a single shard is
	// selected with matchLabels: {name: <shard>}, and groupings such as a region
	// use whatever labels the installation puts on its shards -- the same ones
	// Partition and PartitionSet select by.
	//
	// The most specific selector that matches a shard wins, so a URL for a
	// region overrides one for the whole installation where the region applies.
	//
	// +optional
	Selector *v1.LabelSelector `json:"selector,omitempty"`
}

type LogicalCluster struct {
	v1.TypeMeta `json:",inline"`
	// +optional
	v1.ObjectMeta `json:"metadata,omitempty"`
	// +optional
	Spec LogicalClusterSpec `json:"spec,omitempty"`
	// +optional
	Status LogicalClusterStatus `json:"status,omitempty"`
}

type LogicalClusterInitializer string

type LogicalClusterList struct {
	v1.TypeMeta `json:",inline"`
	v1.ListMeta `json:"metadata"`

	Items []LogicalCluster `json:"items"`
}

type LogicalClusterOwner struct {
	// apiVersion is the group and API version of the owner.
	//
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Pattern=`^([^/]+/)?[^/]+$`
	APIVersion string `json:"apiVersion"`

	// resource is API resource to access the owner.
	//
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Resource string `json:"resource"`

	// name is the name of the owner.
	//
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Name string `json:"name"`

	// namespace is the optional namespace of the owner.
	//
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// cluster is the logical cluster in which the owner is located.
	//
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Cluster string `json:"cluster"`

	// UID is the UID of the owner.
	//
	// +required
	// +kubebuilder:validation:Required
	UID types.UID `json:"uid"`
}

type LogicalClusterPhaseType string

type LogicalClusterSpec struct {
	// DirectlyDeletable indicates that this logical cluster can be directly deleted by the user
	// from within by deleting the LogicalCluster object.
	//
	// +optional
	// +kubebuilder:default=false
	DirectlyDeletable bool `json:"directlyDeletable,omitempty"`

	// 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.
	//
	// +optional
	Owner *LogicalClusterOwner `json:"owner,omitempty"`

	// createdBy is the user who owns this logical cluster. This is the user who
	// created the workspace.
	//
	// +optional
	CreatedBy *OwnerUserInfo `json:"createdBy,omitempty"`

	// initializers are set on creation by the system and copied to status when
	// initialization starts.
	//
	// +optional
	Initializers []LogicalClusterInitializer `json:"initializers,omitempty"`

	// Terminators are set on creation by the system and copied to status when
	// termination starts.
	//
	// +optional
	Terminators []LogicalClusterTerminator `json:"terminators,omitempty"`
}

type LogicalClusterStatus struct {
	// 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.
	//
	// +kubebuilder:format:uri
	URL string `json:"URL,omitempty"`

	// Phase of the logical cluster (Initializing, Ready).
	//
	// +kubebuilder:default=Scheduling
	Phase LogicalClusterPhaseType `json:"phase,omitempty"`

	// Current processing state of the LogicalCluster.
	// +optional
	Conditions conditionsv1alpha1.Conditions `json:"conditions,omitempty"`

	// 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.
	//
	// +optional
	Initializers []LogicalClusterInitializer `json:"initializers,omitempty"`

	// Terminators are set on creation by the system and must be cleared
	// by a controller before the logical cluster can be deleted. The LogicalCluster object
	// will stay in the phase "Terminating" until all terminator are cleared.
	//
	// +optional
	Terminators []LogicalClusterTerminator `json:"terminators,omitempty"`
}

type LogicalClusterTerminator string

type OwnerUserInfo struct {
	// username is the name of the user.
	//
	// +optional
	Username string `json:"username,omitempty"`

	// groups is the list of groups the user belongs to.
	//
	// +optional
	Groups []string `json:"groups,omitempty"`

	// uid is a unique identifier for the user.
	//
	// +optional
	UID string `json:"uid,omitempty"`

	// extra contains additional information provided by the authenticator.
	//
	// +optional
	Extra map[string]authenticationv1.ExtraValue `json:"extra,omitempty"`
}

type Shard struct {
	v1.TypeMeta `json:",inline"`
	// +optional
	v1.ObjectMeta `json:"metadata,omitempty"`

	// +optional
	Spec ShardSpec `json:"spec,omitempty"`

	// +optional
	Status ShardStatus `json:"status,omitempty"`
}

type ShardList struct {
	v1.TypeMeta `json:",inline"`
	v1.ListMeta `json:"metadata"`

	Items []Shard `json:"items"`
}

type ShardSpec struct {
	// baseURL is the address of the kcp shard for direct connections, e.g. by some
	// front-proxy doing the fan-out to the shards.
	//
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Format=uri
	// +kubebuilder:validation:MinLength=1
	BaseURL string `json:"baseURL"`

	// externalURL is the externally visible address presented to users in Workspace URLs.
	// Changing this will break all existing logical clusters on that shard, i.e. existing
	// kubeconfigs of clients will be invalid. Hence, when changing this value, the old
	// URL used by clients must keep working.
	//
	// The external address will not be unique if a front-proxy does a fan-out to
	// shards, but all logical cluster clients will talk to the front-proxy. In that case,
	// put the address of the front-proxy here.
	//
	// Note that movement of shards is only possible (in the future) between shards
	// that share a common external URL.
	//
	// This will be defaulted to the value of the baseURL.
	//
	// +optional
	// +kubebuilder:validation:Format=uri
	// +kubebuilder:validation:MinLength=1
	ExternalURL string `json:"externalURL,omitempty"`

	// virtualWorkspaceURL is the address of the virtual workspace apiserver associated with this shard.
	// It can be a direct address, an address of a front-proxy or even an address of an LB.
	// As of today this address is assigned to APIExports.
	//
	// This will be defaulted to the value of the baseURL.
	//
	// +optional
	// +kubebuilder:validation:Format=uri
	// +kubebuilder:validation:MinLength=1
	VirtualWorkspaceURL string `json:"virtualWorkspaceURL,omitempty"`
}

type ShardStatus struct {
	// Set of integer resources that logical clusters can be scheduled into
	// +optional
	Capacity corev1.ResourceList `json:"capacity,omitempty"`

	// Current processing state of the Shard.
	// +optional
	Conditions v1alpha1.Conditions `json:"conditions,omitempty"`
}