Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the platform v1alpha1 API group +kubebuilder:object:generate=true +groupName=platform.kratix.io
Index ¶
- Constants
- Variables
- type Cluster
- type ClusterList
- type ClusterSpec
- type ClusterStatus
- type Manifest
- type Promise
- type PromiseList
- type PromiseSpec
- type PromiseStatus
- type Work
- type WorkList
- type WorkPlacement
- type WorkPlacementList
- type WorkPlacementSpec
- type WorkPlacementStatus
- type WorkSpec
- type WorkStatus
- type WorkerClusterResource
- type WorkloadTemplate
Constants ¶
const RESOURCE_REQUEST_REPLICAS = 1
const WORKER_RESOURCE_REPLICAS = -1
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "platform.kratix.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type Cluster ¶
type Cluster struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ClusterSpec `json:"spec,omitempty"` Status ClusterStatus `json:"status,omitempty"` }
Cluster is the Schema for the clusters API
func (*Cluster) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cluster.
func (*Cluster) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Cluster) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterList ¶
type ClusterList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Cluster `json:"items"` }
ClusterList contains a list of Cluster
func (*ClusterList) DeepCopy ¶
func (in *ClusterList) DeepCopy() *ClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterList.
func (*ClusterList) DeepCopyInto ¶
func (in *ClusterList) DeepCopyInto(out *ClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterList) DeepCopyObject ¶
func (in *ClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterSpec ¶
type ClusterSpec struct { // Unique identifier of a Cluster Id string `json:"id"` BucketPath string `json:"bucketPath"` }
ClusterSpec defines the desired state of Cluster
func (*ClusterSpec) DeepCopy ¶
func (in *ClusterSpec) DeepCopy() *ClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpec.
func (*ClusterSpec) DeepCopyInto ¶
func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatus ¶
type ClusterStatus struct { }
ClusterStatus defines the observed state of Cluster
func (*ClusterStatus) DeepCopy ¶
func (in *ClusterStatus) DeepCopy() *ClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterStatus.
func (*ClusterStatus) DeepCopyInto ¶
func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Manifest ¶
type Manifest struct { // +kubebuilder:validation:EmbeddedResource // +kubebuilder:pruning:PreserveUnknownFields unstructured.Unstructured `json:",inline"` }
Manifest represents a resource to be deployed on worker cluster
func (*Manifest) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Manifest.
func (*Manifest) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Promise ¶
type Promise struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PromiseSpec `json:"spec,omitempty"` Status PromiseStatus `json:"status,omitempty"` }
Promise is the Schema for the promises API
func (*Promise) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Promise.
func (*Promise) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Promise) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PromiseList ¶
type PromiseList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Promise `json:"items"` }
PromiseList contains a list of Promise
func (*PromiseList) DeepCopy ¶
func (in *PromiseList) DeepCopy() *PromiseList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PromiseList.
func (*PromiseList) DeepCopyInto ¶
func (in *PromiseList) DeepCopyInto(out *PromiseList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PromiseList) DeepCopyObject ¶
func (in *PromiseList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PromiseSpec ¶
type PromiseSpec struct { // X's CustomResourceDefinition to create the X-aaS offering // // +kubebuilder:pruning:PreserveUnknownFields // +kubebuilder:validation:EmbeddedResource XaasCrd runtime.RawExtension `json:"xaasCrd,omitempty"` // Array of Image tags to transform from input request custom resource to output resource(s) XaasRequestPipeline []string `json:"xaasRequestPipeline,omitempty"` WorkerClusterResources []WorkerClusterResource `json:"workerClusterResources,omitempty"` ClusterSelector map[string]string `json:"clusterSelector,omitempty"` }
PromiseSpec defines the desired state of Promise
func (*PromiseSpec) DeepCopy ¶
func (in *PromiseSpec) DeepCopy() *PromiseSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PromiseSpec.
func (*PromiseSpec) DeepCopyInto ¶
func (in *PromiseSpec) DeepCopyInto(out *PromiseSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PromiseStatus ¶
type PromiseStatus struct { }
PromiseStatus defines the observed state of Promise
func (*PromiseStatus) DeepCopy ¶
func (in *PromiseStatus) DeepCopy() *PromiseStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PromiseStatus.
func (*PromiseStatus) DeepCopyInto ¶
func (in *PromiseStatus) DeepCopyInto(out *PromiseStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Work ¶
type Work struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec WorkSpec `json:"spec,omitempty"` Status WorkStatus `json:"status,omitempty"` }
Work is the Schema for the works API
func (*Work) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Work.
func (*Work) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Work) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Work) HasClusterSelector ¶
func (*Work) IsResourceRequest ¶
func (*Work) IsWorkerResource ¶
type WorkList ¶
type WorkList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Work `json:"items"` }
WorkList contains a list of Work
func (*WorkList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkList.
func (*WorkList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkPlacement ¶
type WorkPlacement struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec WorkPlacementSpec `json:"spec,omitempty"` Status WorkPlacementStatus `json:"status,omitempty"` }
WorkPlacement is the Schema for the workplacements API
func (*WorkPlacement) DeepCopy ¶
func (in *WorkPlacement) DeepCopy() *WorkPlacement
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkPlacement.
func (*WorkPlacement) DeepCopyInto ¶
func (in *WorkPlacement) DeepCopyInto(out *WorkPlacement)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkPlacement) DeepCopyObject ¶
func (in *WorkPlacement) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkPlacementList ¶
type WorkPlacementList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []WorkPlacement `json:"items"` }
WorkPlacementList contains a list of WorkPlacement
func (*WorkPlacementList) DeepCopy ¶
func (in *WorkPlacementList) DeepCopy() *WorkPlacementList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkPlacementList.
func (*WorkPlacementList) DeepCopyInto ¶
func (in *WorkPlacementList) DeepCopyInto(out *WorkPlacementList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WorkPlacementList) DeepCopyObject ¶
func (in *WorkPlacementList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WorkPlacementSpec ¶
type WorkPlacementSpec struct { // The unique identifier of the Work parent WorkName string `json:"workName,omitempty"` TargetClusterName string `json:"targetClusterName,omitempty"` }
WorkPlacementSpec defines the desired state of WorkPlacement
func (*WorkPlacementSpec) DeepCopy ¶
func (in *WorkPlacementSpec) DeepCopy() *WorkPlacementSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkPlacementSpec.
func (*WorkPlacementSpec) DeepCopyInto ¶
func (in *WorkPlacementSpec) DeepCopyInto(out *WorkPlacementSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkPlacementStatus ¶
type WorkPlacementStatus struct { }
WorkPlacementStatus defines the observed state of WorkPlacement
func (*WorkPlacementStatus) DeepCopy ¶
func (in *WorkPlacementStatus) DeepCopy() *WorkPlacementStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkPlacementStatus.
func (*WorkPlacementStatus) DeepCopyInto ¶
func (in *WorkPlacementStatus) DeepCopyInto(out *WorkPlacementStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkSpec ¶
type WorkSpec struct { // Workload represents the manifest workload to be deployed on worker cluster Workload WorkloadTemplate `json:"workload,omitempty"` // ClusterSelector is the selector to use for selecting the worker cluster ClusterSelector map[string]string `json:"clusterSelector,omitempty"` // -1 denotes Cluster Worker Resources, 1 denotes Resource Request Replicas int `json:"replicas,omitempty"` }
WorkSpec defines the desired state of Work
func (*WorkSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkSpec.
func (*WorkSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkStatus ¶
type WorkStatus struct { }
WorkStatus defines the observed state of Work
func (*WorkStatus) DeepCopy ¶
func (in *WorkStatus) DeepCopy() *WorkStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkStatus.
func (*WorkStatus) DeepCopyInto ¶
func (in *WorkStatus) DeepCopyInto(out *WorkStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkerClusterResource ¶
type WorkerClusterResource struct { // Manifests represents a list of kubernetes resources to be deployed on the worker cluster. // +optional // +kubebuilder:validation:EmbeddedResource // +kubebuilder:pruning:PreserveUnknownFields unstructured.Unstructured `json:",inline"` }
Resources represents the manifest workload to be deployed on worker cluster
func (*WorkerClusterResource) DeepCopy ¶
func (in *WorkerClusterResource) DeepCopy() *WorkerClusterResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkerClusterResource.
func (*WorkerClusterResource) DeepCopyInto ¶
func (in *WorkerClusterResource) DeepCopyInto(out *WorkerClusterResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkloadTemplate ¶
type WorkloadTemplate struct { // Manifests represents a list of kuberenetes resources to be deployed on the worker cluster. // +optional Manifests []Manifest `json:"manifests,omitempty"` }
WorkloadTemplate represents the manifest workload to be deployed on worker cluster
func (*WorkloadTemplate) DeepCopy ¶
func (in *WorkloadTemplate) DeepCopy() *WorkloadTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkloadTemplate.
func (*WorkloadTemplate) DeepCopyInto ¶
func (in *WorkloadTemplate) DeepCopyInto(out *WorkloadTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.