Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the apps v1 API group +k8s:deepcopy-gen=package,register +groupName=apps.open-cluster-management.io
Package v1 contains API Schema definitions for the apps v1 API group +k8s:deepcopy-gen=package,register +groupName=apps.open-cluster-management.io
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type ClusterConditionFilter
- type GenericClusterReference
- type GenericPlacementFields
- type Placement
- type PlacementDecision
- type PlacementRule
- type PlacementRuleList
- type PlacementRuleSpec
- type PlacementRuleStatus
- type ResourceHint
- type ResourceType
- type SelectionOrder
Constants ¶
const ( // SchedulerNameDefault tells using default scheduler (mcm) SchedulerNameDefault = "default" // SchedulerNameMCM tells using mcm as scheduler SchedulerNameMCM = "mcm" // UserIdentityAnnotation is user identity annotation UserIdentityAnnotation = "open-cluster-management.io/user-identity" // UserGroupAnnotation is user group annotation UserGroupAnnotation = "open-cluster-management.io/user-group" )
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "apps.open-cluster-management.io", Version: "v1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme adds to the SchemeBuilder AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type ClusterConditionFilter ¶
type ClusterConditionFilter struct {
// +optional
Type string `json:"type,omitempty"`
// +optional
Status metav1.ConditionStatus `json:"status,omitempty"`
}
ClusterConditionFilter defines filter to filter cluster condition
func (*ClusterConditionFilter) DeepCopy ¶
func (in *ClusterConditionFilter) DeepCopy() *ClusterConditionFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterConditionFilter.
func (*ClusterConditionFilter) DeepCopyInto ¶
func (in *ClusterConditionFilter) DeepCopyInto(out *ClusterConditionFilter)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GenericClusterReference ¶
type GenericClusterReference struct {
Name string `json:"name"`
}
GenericClusterReference - in alignment with kubefed
func (*GenericClusterReference) DeepCopy ¶
func (in *GenericClusterReference) DeepCopy() *GenericClusterReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenericClusterReference.
func (*GenericClusterReference) DeepCopyInto ¶
func (in *GenericClusterReference) DeepCopyInto(out *GenericClusterReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GenericPlacementFields ¶
type GenericPlacementFields struct {
Clusters []GenericClusterReference `json:"clusters,omitempty"`
ClusterSelector *metav1.LabelSelector `json:"clusterSelector,omitempty"`
}
GenericPlacementFields - in alignment with kubefed
func (*GenericPlacementFields) DeepCopy ¶
func (in *GenericPlacementFields) DeepCopy() *GenericPlacementFields
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenericPlacementFields.
func (*GenericPlacementFields) DeepCopyInto ¶
func (in *GenericPlacementFields) DeepCopyInto(out *GenericPlacementFields)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Placement ¶
type Placement struct {
// Specify either a list of clusters or a cluster label selector for selecting multiple clusters
GenericPlacementFields `json:",inline"`
// Specify a placement reference for selecting clusters
PlacementRef *corev1.ObjectReference `json:"placementRef,omitempty"`
// It indicates a standalone subscription if the Local pointer is set to be true
Local *bool `json:"local,omitempty"`
}
+k8s:deepcopy-gen:nonpointer-interfaces=true Placement field to be referenced in specs, align with Fedv2, add placementref
func (*Placement) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Placement.
func (*Placement) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlacementDecision ¶
type PlacementDecision struct {
ClusterName string `json:"clusterName,omitempty"`
ClusterNamespace string `json:"clusterNamespace,omitempty"`
}
PlacementDecision defines the decision made by controller
func (*PlacementDecision) DeepCopy ¶
func (in *PlacementDecision) DeepCopy() *PlacementDecision
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlacementDecision.
func (*PlacementDecision) DeepCopyInto ¶
func (in *PlacementDecision) DeepCopyInto(out *PlacementDecision)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlacementRule ¶
type PlacementRule struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PlacementRuleSpec `json:"spec"`
Status PlacementRuleStatus `json:"status,omitempty"`
}
PlacementRule is the Schema for the placementrules API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="Replicas",type="integer",JSONPath=".spec.clusterReplicas"
func (*PlacementRule) DeepCopy ¶
func (in *PlacementRule) DeepCopy() *PlacementRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlacementRule.
func (*PlacementRule) DeepCopyInto ¶
func (in *PlacementRule) DeepCopyInto(out *PlacementRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PlacementRule) DeepCopyObject ¶
func (in *PlacementRule) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlacementRuleList ¶
type PlacementRuleList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []PlacementRule `json:"items"`
}
PlacementRuleList contains a list of PlacementRule
func (*PlacementRuleList) DeepCopy ¶
func (in *PlacementRuleList) DeepCopy() *PlacementRuleList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlacementRuleList.
func (*PlacementRuleList) DeepCopyInto ¶
func (in *PlacementRuleList) DeepCopyInto(out *PlacementRuleList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PlacementRuleList) DeepCopyObject ¶
func (in *PlacementRuleList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlacementRuleSpec ¶
type PlacementRuleSpec struct {
// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
// Important: Run "make" to regenerate code after modifying this file
// +optional
// schedulerName, default to use mcm controller
SchedulerName string `json:"schedulerName,omitempty"`
// +optional
// number of replicas Application wants to
ClusterReplicas *int32 `json:"clusterReplicas,omitempty"`
// +optional
GenericPlacementFields `json:",inline"`
// +optional
ClusterConditions []ClusterConditionFilter `json:"clusterConditions,omitempty"`
// +optional
// Select Resource
ResourceHint *ResourceHint `json:"resourceHint,omitempty"`
// +optional
// Set Policy Filters
Policies []corev1.ObjectReference `json:"policies,omitempty"`
}
PlacementRuleSpec defines the desired state of PlacementRule
func (*PlacementRuleSpec) DeepCopy ¶
func (in *PlacementRuleSpec) DeepCopy() *PlacementRuleSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlacementRuleSpec.
func (*PlacementRuleSpec) DeepCopyInto ¶
func (in *PlacementRuleSpec) DeepCopyInto(out *PlacementRuleSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlacementRuleStatus ¶
type PlacementRuleStatus struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "make" to regenerate code after modifying this file
Decisions []PlacementDecision `json:"decisions,omitempty"`
}
PlacementRuleStatus defines the observed state of PlacementRule
func (*PlacementRuleStatus) DeepCopy ¶
func (in *PlacementRuleStatus) DeepCopy() *PlacementRuleStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlacementRuleStatus.
func (*PlacementRuleStatus) DeepCopyInto ¶
func (in *PlacementRuleStatus) DeepCopyInto(out *PlacementRuleStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceHint ¶
type ResourceHint struct {
Type ResourceType `json:"type,omitempty"`
Order SelectionOrder `json:"order,omitempty"`
}
ResourceHint is used to sort the output
func (*ResourceHint) DeepCopy ¶
func (in *ResourceHint) DeepCopy() *ResourceHint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceHint.
func (*ResourceHint) DeepCopyInto ¶
func (in *ResourceHint) DeepCopyInto(out *ResourceHint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceType ¶
type ResourceType string
ResourceType defines types can be sorted
const ( ResourceTypeNone ResourceType = "" ResourceTypeCPU ResourceType = "cpu" ResourceTypeMemory ResourceType = "memory" )
These are valid conditions of a cluster.
type SelectionOrder ¶
type SelectionOrder string
SelectionOrder is the type for Nodes
const ( SelectionOrderNone SelectionOrder = "" SelectionOrderDesc SelectionOrder = "desc" SelectionOrderAsce SelectionOrder = "asc" )
These are valid conditions of a cluster.
Source Files