v1alpha4

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 8, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package v1alpha4 contains API Schema definitions for the controlplane v1alpha4 API group. +kubebuilder:object:generate=true +groupName=controlplane.cluster.x-k8s.io

Index

Constants

View Source
const (
	// NestedControlPlaneFinalizer is added to the NestedControlPlane to allow
	// nested deletions to happen before the object is cleaned up.
	NestedControlPlaneFinalizer = "nested.controlplane.cluster.x-k8s.io"
)

Variables

View Source
var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "controlplane.cluster.x-k8s.io", Version: "v1alpha4"}

	// 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 ComponentKind

type ComponentKind string

ComponentKind defines the available kinds.

const (
	// APIServer defines the Kind name for the apiserver.
	APIServer ComponentKind = "NestedAPIServer"
	// Etcd defines the Kind name for the etcd.
	Etcd ComponentKind = "NestedEtcd"
	// ControllerManager defines the kind name for the controller-manager.
	ControllerManager ComponentKind = "NestedControllerManager"
)

type ComponentPhase

type ComponentPhase string

ComponentPhase defines the state of the component.

const (
	// Ready defines that the component is available and control plane can
	// continue provisioning.
	Ready ComponentPhase = "Ready"

	// Unready defines that the component is unavailable.
	Unready ComponentPhase = "Unready"
)

type NestedAPIServer

type NestedAPIServer struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   NestedAPIServerSpec   `json:"spec,omitempty"`
	Status NestedAPIServerStatus `json:"status,omitempty"`
}

NestedAPIServer is the Schema for the nestedapiservers API.

func (*NestedAPIServer) CommonSpec

func (c *NestedAPIServer) CommonSpec() addonv1alpha1.CommonSpec

CommonSpec returns the addons spec of the object allowing common funcs like Channel & Version to be usable.

func (*NestedAPIServer) ComponentName

func (c *NestedAPIServer) ComponentName() string

ComponentName returns the name of the component for use with addonv1alpha1.CommonObject.

func (*NestedAPIServer) DeepCopy

func (in *NestedAPIServer) DeepCopy() *NestedAPIServer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedAPIServer.

func (*NestedAPIServer) DeepCopyInto

func (in *NestedAPIServer) DeepCopyInto(out *NestedAPIServer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NestedAPIServer) DeepCopyObject

func (in *NestedAPIServer) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*NestedAPIServer) GetCommonStatus

func (c *NestedAPIServer) GetCommonStatus() addonv1alpha1.CommonStatus

GetCommonStatus will return the common status for checking is a component was successfully deployed.

func (*NestedAPIServer) PatchSpec

func (c *NestedAPIServer) PatchSpec() addonv1alpha1.PatchSpec

PatchSpec returns the patches to be applied.

func (*NestedAPIServer) SetCommonStatus

func (c *NestedAPIServer) SetCommonStatus(s addonv1alpha1.CommonStatus)

SetCommonStatus will set the status so that abstract representations can set Ready and Phases.

type NestedAPIServerList

type NestedAPIServerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []NestedAPIServer `json:"items"`
}

NestedAPIServerList contains a list of NestedAPIServer.

func (*NestedAPIServerList) DeepCopy

func (in *NestedAPIServerList) DeepCopy() *NestedAPIServerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedAPIServerList.

func (*NestedAPIServerList) DeepCopyInto

func (in *NestedAPIServerList) DeepCopyInto(out *NestedAPIServerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NestedAPIServerList) DeepCopyObject

func (in *NestedAPIServerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NestedAPIServerSpec

type NestedAPIServerSpec struct {
	// NestedComponentSpec contains the common and user-specified information that are
	// required for creating the component.
	// +optional
	NestedComponentSpec `json:",inline"`
}

NestedAPIServerSpec defines the desired state of NestedAPIServer.

func (*NestedAPIServerSpec) DeepCopy

func (in *NestedAPIServerSpec) DeepCopy() *NestedAPIServerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedAPIServerSpec.

func (*NestedAPIServerSpec) DeepCopyInto

func (in *NestedAPIServerSpec) DeepCopyInto(out *NestedAPIServerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedAPIServerStatus

type NestedAPIServerStatus struct {
	// APIServerService is the reference to the service that expose the APIServer.
	// +optional
	APIServerService *corev1.ObjectReference `json:"apiserverService,omitempty"`

	// CommonStatus allows addons status monitoring.
	addonv1alpha1.CommonStatus `json:",inline"`
}

NestedAPIServerStatus defines the observed state of NestedAPIServer.

func (*NestedAPIServerStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedAPIServerStatus.

func (*NestedAPIServerStatus) DeepCopyInto

func (in *NestedAPIServerStatus) DeepCopyInto(out *NestedAPIServerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedComponentSpec

type NestedComponentSpec struct {
	// NestedComponentSpec defines the common information for creating the
	// component.
	// +optional
	addonv1alpha1.CommonSpec `json:",inline"`

	// PatchSpecs includes the user specified settings.
	// +optional
	addonv1alpha1.PatchSpec `json:",inline"`

	// Resources defines the amount of computing resources that will be used
	// by this component.
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`

	// Replicas defines the number of replicas in the component's workload.
	// +optional
	Replicas int32 `json:"replicas,omitempty"`
}

NestedComponentSpec defines the common fields for nested components.

func (*NestedComponentSpec) DeepCopy

func (in *NestedComponentSpec) DeepCopy() *NestedComponentSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedComponentSpec.

func (*NestedComponentSpec) DeepCopyInto

func (in *NestedComponentSpec) DeepCopyInto(out *NestedComponentSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedControlPlane

type NestedControlPlane struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   NestedControlPlaneSpec   `json:"spec,omitempty"`
	Status NestedControlPlaneStatus `json:"status,omitempty"`
}

NestedControlPlane is the Schema for the nestedcontrolplanes API.

func (*NestedControlPlane) DeepCopy

func (in *NestedControlPlane) DeepCopy() *NestedControlPlane

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControlPlane.

func (*NestedControlPlane) DeepCopyInto

func (in *NestedControlPlane) DeepCopyInto(out *NestedControlPlane)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NestedControlPlane) DeepCopyObject

func (in *NestedControlPlane) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*NestedControlPlane) GetConditions

func (r *NestedControlPlane) GetConditions() clusterv1.Conditions

GetConditions will return the conditions from the status.

func (*NestedControlPlane) GetOwnerCluster

func (r *NestedControlPlane) GetOwnerCluster(ctx context.Context, cli client.Client) (cluster *clusterv1.Cluster, err error)

GetOwnerCluster is a utility to return the owning clusterv1.Cluster.

func (*NestedControlPlane) SetConditions

func (r *NestedControlPlane) SetConditions(conditions clusterv1.Conditions)

SetConditions will reset the conditions to the new ones.

type NestedControlPlaneList

type NestedControlPlaneList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []NestedControlPlane `json:"items"`
}

NestedControlPlaneList contains a list of NestedControlPlane.

func (*NestedControlPlaneList) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControlPlaneList.

func (*NestedControlPlaneList) DeepCopyInto

func (in *NestedControlPlaneList) DeepCopyInto(out *NestedControlPlaneList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NestedControlPlaneList) DeepCopyObject

func (in *NestedControlPlaneList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NestedControlPlaneSpec

type NestedControlPlaneSpec struct {
	// EtcdRef is the reference to the NestedEtcd.
	EtcdRef *corev1.ObjectReference `json:"etcd,omitempty"`

	// APIServerRef is the reference to the NestedAPIServer.
	// +optional
	APIServerRef *corev1.ObjectReference `json:"apiserver,omitempty"`

	// ContollerManagerRef is the reference to the NestedControllerManager.
	// +optional
	ControllerManagerRef *corev1.ObjectReference `json:"controllerManager,omitempty"`
}

NestedControlPlaneSpec defines the desired state of NestedControlPlane.

func (*NestedControlPlaneSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControlPlaneSpec.

func (*NestedControlPlaneSpec) DeepCopyInto

func (in *NestedControlPlaneSpec) DeepCopyInto(out *NestedControlPlaneSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedControlPlaneStatus

type NestedControlPlaneStatus struct {
	// Etcd stores the connection information from the downstream etcd
	// implementation if the NestedEtcd type isn't used this
	// allows other component controllers to fetch the endpoints.
	// +optional
	Etcd *NestedControlPlaneStatusEtcd `json:"etcd,omitempty"`

	// APIServer stores the connection information from the control plane
	// this should contain anything shared between control plane components.
	// +optional
	APIServer *NestedControlPlaneStatusAPIServer `json:"apiserver,omitempty"`

	// Initialized denotes whether or not the control plane finished initializing.
	// +optional
	Initialized bool `json:"initialized"`

	// Ready denotes that the NestedControlPlane API Server is ready to
	// receive requests.
	// +kubebuilder:default=false
	Ready bool `json:"ready"`

	// ErrorMessage indicates that there is a terminal problem reconciling the
	// state, and will be set to a descriptive error message.
	// +optional
	FailureMessage *string `json:"failureMessage,omitempty"`

	// Conditions specifies the conditions for the managed control plane
	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
}

NestedControlPlaneStatus defines the observed state of NestedControlPlane.

func (*NestedControlPlaneStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControlPlaneStatus.

func (*NestedControlPlaneStatus) DeepCopyInto

func (in *NestedControlPlaneStatus) DeepCopyInto(out *NestedControlPlaneStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedControlPlaneStatusAPIServer

type NestedControlPlaneStatusAPIServer struct {
	// ServiceCIDRs which is provided to kube-apiserver and kube-controller-manager.
	// +optional
	ServiceCIDR string `json:"serviceCidr,omitempty"`
}

NestedControlPlaneStatusAPIServer defines the status of the APIServer component, this allows the next set of component controllers to take over the deployment.

func (*NestedControlPlaneStatusAPIServer) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControlPlaneStatusAPIServer.

func (*NestedControlPlaneStatusAPIServer) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedControlPlaneStatusEtcd

type NestedControlPlaneStatusEtcd struct {
	// Addresses defines how to address the etcd instance
	Addresses []NestedEtcdAddress `json:"addresses,omitempty"`
}

NestedControlPlaneStatusEtcd defines the status of the etcd component to allow other component controllers to take over the deployment.

func (*NestedControlPlaneStatusEtcd) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControlPlaneStatusEtcd.

func (*NestedControlPlaneStatusEtcd) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedControllerManager

type NestedControllerManager struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   NestedControllerManagerSpec   `json:"spec,omitempty"`
	Status NestedControllerManagerStatus `json:"status,omitempty"`
}

NestedControllerManager is the Schema for the nestedcontrollermanagers API.

func (*NestedControllerManager) CommonSpec

CommonSpec returns the addons spec of the object allowing common funcs like Channel & Version to be usable.

func (*NestedControllerManager) ComponentName

func (c *NestedControllerManager) ComponentName() string

ComponentName returns the name of the component for use with addonv1alpha1.CommonObject.

func (*NestedControllerManager) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControllerManager.

func (*NestedControllerManager) DeepCopyInto

func (in *NestedControllerManager) DeepCopyInto(out *NestedControllerManager)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NestedControllerManager) DeepCopyObject

func (in *NestedControllerManager) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*NestedControllerManager) GetCommonStatus

func (c *NestedControllerManager) GetCommonStatus() addonv1alpha1.CommonStatus

GetCommonStatus will return the common status for checking is a component was successfully deployed.

func (*NestedControllerManager) PatchSpec

PatchSpec returns the patches to be applied.

func (*NestedControllerManager) SetCommonStatus

func (c *NestedControllerManager) SetCommonStatus(s addonv1alpha1.CommonStatus)

SetCommonStatus will set the status so that abstract representations can set Ready and Phases.

type NestedControllerManagerList

type NestedControllerManagerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []NestedControllerManager `json:"items"`
}

NestedControllerManagerList contains a list of NestedControllerManager.

func (*NestedControllerManagerList) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControllerManagerList.

func (*NestedControllerManagerList) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NestedControllerManagerList) DeepCopyObject

func (in *NestedControllerManagerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NestedControllerManagerSpec

type NestedControllerManagerSpec struct {
	// NestedComponentSpec contains the common and user-specified information
	// that are required for creating the component.
	// +optional
	NestedComponentSpec `json:",inline"`
}

NestedControllerManagerSpec defines the desired state of NestedControllerManager.

func (*NestedControllerManagerSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControllerManagerSpec.

func (*NestedControllerManagerSpec) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedControllerManagerStatus

type NestedControllerManagerStatus struct {
	// CommonStatus allows addons status monitoring.
	addonv1alpha1.CommonStatus `json:",inline"`
}

NestedControllerManagerStatus defines the observed state of NestedControllerManager.

func (*NestedControllerManagerStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedControllerManagerStatus.

func (*NestedControllerManagerStatus) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedEtcd

type NestedEtcd struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   NestedEtcdSpec   `json:"spec,omitempty"`
	Status NestedEtcdStatus `json:"status,omitempty"`
}

NestedEtcd is the Schema for the nestedetcds API.

func (*NestedEtcd) CommonSpec

func (c *NestedEtcd) CommonSpec() addonv1alpha1.CommonSpec

CommonSpec returns the addons spec of the object allowing common funcs like Channel & Version to be usable.

func (*NestedEtcd) ComponentName

func (c *NestedEtcd) ComponentName() string

ComponentName returns the name of the component for use with addonv1alpha1.CommonObject.

func (*NestedEtcd) DeepCopy

func (in *NestedEtcd) DeepCopy() *NestedEtcd

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedEtcd.

func (*NestedEtcd) DeepCopyInto

func (in *NestedEtcd) DeepCopyInto(out *NestedEtcd)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NestedEtcd) DeepCopyObject

func (in *NestedEtcd) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*NestedEtcd) GetCommonStatus

func (c *NestedEtcd) GetCommonStatus() addonv1alpha1.CommonStatus

GetCommonStatus will return the common status for checking is a component was successfully deployed.

func (*NestedEtcd) PatchSpec

func (c *NestedEtcd) PatchSpec() addonv1alpha1.PatchSpec

PatchSpec returns the patches to be applied.

func (*NestedEtcd) SetCommonStatus

func (c *NestedEtcd) SetCommonStatus(s addonv1alpha1.CommonStatus)

SetCommonStatus will set the status so that abstract representations can set Ready and Phases.

type NestedEtcdAddress

type NestedEtcdAddress struct {
	// IP Address of the etcd instance.
	// +optional
	IP string `json:"ip,omitempty"`

	// Hostname of the etcd instance.
	Hostname string `json:"hostname,omitempty"`

	// Port of the etcd instance.
	// +optional
	Port int32 `json:"port"`
}

NestedEtcdAddress defines the observed addresses for etcd.

func (*NestedEtcdAddress) DeepCopy

func (in *NestedEtcdAddress) DeepCopy() *NestedEtcdAddress

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedEtcdAddress.

func (*NestedEtcdAddress) DeepCopyInto

func (in *NestedEtcdAddress) DeepCopyInto(out *NestedEtcdAddress)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedEtcdList

type NestedEtcdList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []NestedEtcd `json:"items"`
}

NestedEtcdList contains a list of NestedEtcd.

func (*NestedEtcdList) DeepCopy

func (in *NestedEtcdList) DeepCopy() *NestedEtcdList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedEtcdList.

func (*NestedEtcdList) DeepCopyInto

func (in *NestedEtcdList) DeepCopyInto(out *NestedEtcdList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NestedEtcdList) DeepCopyObject

func (in *NestedEtcdList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NestedEtcdSpec

type NestedEtcdSpec struct {
	// NestedComponentSpec contains the common and user-specified information
	// that are required for creating the component.
	// +optional
	NestedComponentSpec `json:",inline"`
}

NestedEtcdSpec defines the desired state of NestedEtcd.

func (*NestedEtcdSpec) DeepCopy

func (in *NestedEtcdSpec) DeepCopy() *NestedEtcdSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedEtcdSpec.

func (*NestedEtcdSpec) DeepCopyInto

func (in *NestedEtcdSpec) DeepCopyInto(out *NestedEtcdSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NestedEtcdStatus

type NestedEtcdStatus struct {
	// EtcdDomain defines how to address the etcd instance.
	Addresses []NestedEtcdAddress `json:"addresses,omitempty"`

	// CommonStatus allows addons status monitoring.
	addonv1alpha1.CommonStatus `json:",inline"`
}

NestedEtcdStatus defines the observed state of NestedEtcd.

func (*NestedEtcdStatus) DeepCopy

func (in *NestedEtcdStatus) DeepCopy() *NestedEtcdStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NestedEtcdStatus.

func (*NestedEtcdStatus) DeepCopyInto

func (in *NestedEtcdStatus) DeepCopyInto(out *NestedEtcdStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL