v1alpha1

type ClusterRing struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Spec contains the specification of the desired behavior of the ClusterRing.
	// +optional
	Spec ClusterRingSpec `json:"spec,omitempty"`
	// Status contains the most recently observed status of the ClusterRing.
	// +optional
	Status ClusterRingStatus `json:"status,omitempty"`
}

type ClusterRingList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`
	// Items is the list of ClusterRings.
	Items []ClusterRing `json:"items"`
}

type ClusterRingSpec struct {
	// Resources specifies the list of resources that are distributed across shards in this ClusterRing.
	// +optional
	// +listType=map
	// +listMapKey=group
	// +listMapKey=resource
	Resources []RingResource `json:"resources,omitempty"`
	// NamespaceSelector overwrites the webhook configs' namespaceSelector.
	// If set, this selector should exclude the kube-system and sharding-system namespaces.
	// If omitted, the default namespaceSelector from the SharderConfig is used.
	// Note: changing/unsetting this selector will not remove labels from objects in namespaces that were previously
	// included.
	// +optional
	NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty"`
}

type ClusterRingStatus struct {
	// The generation observed by the ClusterRing controller.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// Shards is the total number of shards of this ring.
	Shards int32 `json:"shards"`
	// AvailableShards is the total number of available shards of this ring.
	AvailableShards int32 `json:"availableShards"`
	// Conditions represents the observations of a foo's current state.
	// Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
	// +listType=map
	// +listMapKey=type
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type RingResource struct {
	// GroupResource specifies the resource that is distributed across shards in a ring.
	// This resource is the controller's main resource, i.e., the resource of which it updates the object status.
	metav1.GroupResource `json:",inline"`

	// ControlledResources are additional resources that are distributed across shards in the ClusterRing.
	// These resources are controlled by the controller's main resource, i.e., they have an owner reference with
	// controller=true back to the GroupResource of this RingResource.
	// Typically, the controller also watches objects of this resource and enqueues the owning object (of the main
	// resource) whenever the status of a controlled object changes.
	// +optional
	// +listType=map
	// +listMapKey=group
	// +listMapKey=resource
	ControlledResources []metav1.GroupResource `json:"controlledResources,omitempty"`
}