v1alpha4

package
v0.0.0-...-40841d9 Latest Latest
Warning

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

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

Documentation

Overview

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

Index

Constants

View Source 
const (
	// ContainerProvisionedCondition documents the status of the provisioning of the container
	// generated by a DockerMachine.
	//
	// NOTE: When the container provisioning starts the process completes almost immediately and within
	// the same reconciliation, so the user will always see a transition from Wait to Provisioned without
	// having evidence that the operation is started/is in progress.
	ContainerProvisionedCondition clusterv1.ConditionType = "ContainerProvisioned"

	// WaitingForClusterInfrastructureReason (Severity=Info) documents a DockerMachine waiting for the cluster
	// infrastructure to be ready before starting to create the container that provides the DockerMachine
	// infrastructure.
	WaitingForClusterInfrastructureReason = "WaitingForClusterInfrastructure"

	// WaitingForBootstrapDataReason (Severity=Info) documents a DockerMachine waiting for the bootstrap
	// script to be ready before starting to create the container that provides the DockerMachine infrastructure.
	WaitingForBootstrapDataReason = "WaitingForBootstrapData"

	// ContainerProvisioningFailedReason (Severity=Warning) documents a DockerMachine controller detecting
	// an error while provisioning the container that provides the DockerMachine infrastructure; those kind of
	// errors are usually transient and failed provisioning are automatically re-tried by the controller.
	ContainerProvisioningFailedReason = "ContainerProvisioningFailed"
)
View Source 
const (
	// BootstrapExecSucceededCondition provides an observation of the DockerMachine bootstrap process.
	// 	It is set based on successful execution of bootstrap commands and on the existence of
	//	the /run/cluster-api/bootstrap-success.complete file.
	// The condition gets generated after ContainerProvisionedCondition is True.
	//
	// NOTE as a difference from other providers, container provisioning and bootstrap are directly managed
	// by the DockerMachine controller (not by cloud-init).
	BootstrapExecSucceededCondition clusterv1.ConditionType = "BootstrapExecSucceeded"

	// BootstrappingReason documents (Severity=Info) a DockerMachine currently executing the bootstrap
	// script that creates the Kubernetes node on the newly provisioned machine infrastructure.
	BootstrappingReason = "Bootstrapping"

	// BootstrapFailedReason documents (Severity=Warning) a DockerMachine controller detecting an error while
	// bootstrapping the Kubernetes node on the machine just provisioned; those kind of errors are usually
	// transient and failed bootstrap are automatically re-tried by the controller.
	BootstrapFailedReason = "BootstrapFailed"
)
View Source 
const (
	// LoadBalancerAvailableCondition documents the availability of the container that implements the cluster load balancer.
	//
	// NOTE: When the load balancer provisioning starts the process completes almost immediately and within
	// the same reconciliation, so the user will always see a transition from no condition to available without
	// having evidence that the operation is started/is in progress.
	LoadBalancerAvailableCondition clusterv1.ConditionType = "LoadBalancerAvailable"

	// LoadBalancerProvisioningFailedReason (Severity=Warning) documents a DockerCluster controller detecting
	// an error while provisioning the container that provides the cluster load balancer.; those kind of
	// errors are usually transient and failed provisioning are automatically re-tried by the controller.
	LoadBalancerProvisioningFailedReason = "LoadBalancerProvisioningFailed"
)
View Source 
const (
	// ClusterFinalizer allows DockerClusterReconciler to clean up resources associated with DockerCluster before
	// removing it from the apiserver.
	ClusterFinalizer = "dockercluster.infrastructure.cluster.x-k8s.io"
)
View Source 
const (
	// MachineFinalizer allows ReconcileDockerMachine to clean up resources associated with AWSMachine before
	// removing it from the apiserver.
	MachineFinalizer = "dockermachine.infrastructure.cluster.x-k8s.io"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "infrastructure.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 APIEndpoint 

type APIEndpoint struct {
	// Host is the hostname on which the API server is serving.
	Host string `json:"host"`

	// Port is the port on which the API server is serving.
	Port int `json:"port"`
}

APIEndpoint represents a reachable Kubernetes API endpoint.

func (*APIEndpoint) DeepCopy 

func (in *APIEndpoint) DeepCopy() *APIEndpoint

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

func (*APIEndpoint) DeepCopyInto 

func (in *APIEndpoint) DeepCopyInto(out *APIEndpoint)

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

type DockerCluster 

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

	Spec   DockerClusterSpec   `json:"spec,omitempty"`
	Status DockerClusterStatus `json:"status,omitempty"`
}

DockerCluster is the Schema for the dockerclusters API.

func (*DockerCluster) DeepCopy 

func (in *DockerCluster) DeepCopy() *DockerCluster

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

func (*DockerCluster) DeepCopyInto 

func (in *DockerCluster) DeepCopyInto(out *DockerCluster)

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

func (*DockerCluster) DeepCopyObject 

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

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

func (*DockerCluster) GetConditions 

func (c *DockerCluster) GetConditions() clusterv1.Conditions

GetConditions returns the set of conditions for this object.

func (*DockerCluster) SetConditions 

func (c *DockerCluster) SetConditions(conditions clusterv1.Conditions)

SetConditions sets the conditions on this object.

type DockerClusterList 

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

DockerClusterList contains a list of DockerCluster.

func (*DockerClusterList) DeepCopy 

func (in *DockerClusterList) DeepCopy() *DockerClusterList

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

func (*DockerClusterList) DeepCopyInto 

func (in *DockerClusterList) DeepCopyInto(out *DockerClusterList)

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

func (*DockerClusterList) DeepCopyObject 

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

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

type DockerClusterSpec 

type DockerClusterSpec struct {

	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
	// +optional
	ControlPlaneEndpoint APIEndpoint `json:"controlPlaneEndpoint"`

	// FailureDomains are not usulaly defined on the spec.
	// The docker provider is special since failure domains don't mean anything in a local docker environment.
	// Instead, the docker cluster controller will simply copy these into the Status and allow the Cluster API
	// controllers to do what they will with the defined failure domains.
	// +optional
	FailureDomains clusterv1.FailureDomains `json:"failureDomains,omitempty"`
}

DockerClusterSpec defines the desired state of DockerCluster.

func (*DockerClusterSpec) DeepCopy 

func (in *DockerClusterSpec) DeepCopy() *DockerClusterSpec

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

func (*DockerClusterSpec) DeepCopyInto 

func (in *DockerClusterSpec) DeepCopyInto(out *DockerClusterSpec)

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

type DockerClusterStatus 

type DockerClusterStatus struct {
	// Ready denotes that the docker cluster (infrastructure) is ready.
	Ready bool `json:"ready"`

	// FailureDomains don't mean much in CAPD since it's all local, but we can see how the rest of cluster API
	// will use this if we populate it.
	FailureDomains clusterv1.FailureDomains `json:"failureDomains,omitempty"`

	// Conditions defines current service state of the DockerCluster.
	// +optional
	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
}

DockerClusterStatus defines the observed state of DockerCluster.

func (*DockerClusterStatus) DeepCopy 

func (in *DockerClusterStatus) DeepCopy() *DockerClusterStatus

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

func (*DockerClusterStatus) DeepCopyInto 

func (in *DockerClusterStatus) DeepCopyInto(out *DockerClusterStatus)

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

type DockerMachine 

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

	Spec   DockerMachineSpec   `json:"spec,omitempty"`
	Status DockerMachineStatus `json:"status,omitempty"`
}

DockerMachine is the Schema for the dockermachines API.

func (*DockerMachine) DeepCopy 

func (in *DockerMachine) DeepCopy() *DockerMachine

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

func (*DockerMachine) DeepCopyInto 

func (in *DockerMachine) DeepCopyInto(out *DockerMachine)

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

func (*DockerMachine) DeepCopyObject 

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

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

func (*DockerMachine) GetConditions 

func (c *DockerMachine) GetConditions() clusterv1.Conditions

GetConditions returns the set of conditions for this object.

func (*DockerMachine) SetConditions 

func (c *DockerMachine) SetConditions(conditions clusterv1.Conditions)

SetConditions sets the conditions on this object.

type DockerMachineList 

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

DockerMachineList contains a list of DockerMachine.

func (*DockerMachineList) DeepCopy 

func (in *DockerMachineList) DeepCopy() *DockerMachineList

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

func (*DockerMachineList) DeepCopyInto 

func (in *DockerMachineList) DeepCopyInto(out *DockerMachineList)

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

func (*DockerMachineList) DeepCopyObject 

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

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

type DockerMachineSpec 

type DockerMachineSpec struct {
	// ProviderID will be the container name in ProviderID format (docker:////<containername>)
	// +optional
	ProviderID *string `json:"providerID,omitempty"`

	// CustomImage allows customizing the container image that is used for
	// running the machine
	// +optional
	CustomImage string `json:"customImage,omitempty"`

	// PreLoadImages allows to pre-load images in a newly created machine. This can be used to
	// speed up tests by avoiding e.g. to download CNI images on all the containers.
	// +optional
	PreLoadImages []string `json:"preLoadImages,omitempty"`

	// ExtraMounts describes additional mount points for the node container
	// These may be used to bind a hostPath
	// +optional
	ExtraMounts []Mount `json:"extraMounts,omitempty"`

	// Bootstrapped is true when the kubeadm bootstrapping has been run
	// against this machine
	// +optional
	Bootstrapped bool `json:"bootstrapped,omitempty"`
}

DockerMachineSpec defines the desired state of DockerMachine.

func (*DockerMachineSpec) DeepCopy 

func (in *DockerMachineSpec) DeepCopy() *DockerMachineSpec

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

func (*DockerMachineSpec) DeepCopyInto 

func (in *DockerMachineSpec) DeepCopyInto(out *DockerMachineSpec)

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

type DockerMachineStatus 

type DockerMachineStatus struct {
	// Ready denotes that the machine (docker container) is ready
	// +optional
	Ready bool `json:"ready"`

	// LoadBalancerConfigured denotes that the machine has been
	// added to the load balancer
	// +optional
	LoadBalancerConfigured bool `json:"loadBalancerConfigured,omitempty"`

	// Addresses contains the associated addresses for the docker machine.
	// +optional
	Addresses []clusterv1.MachineAddress `json:"addresses,omitempty"`

	// Conditions defines current service state of the DockerMachine.
	// +optional
	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
}

DockerMachineStatus defines the observed state of DockerMachine.

func (*DockerMachineStatus) DeepCopy 

func (in *DockerMachineStatus) DeepCopy() *DockerMachineStatus

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

func (*DockerMachineStatus) DeepCopyInto 

func (in *DockerMachineStatus) DeepCopyInto(out *DockerMachineStatus)

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

type DockerMachineTemplate 

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

	Spec DockerMachineTemplateSpec `json:"spec,omitempty"`
}

DockerMachineTemplate is the Schema for the dockermachinetemplates API.

func (*DockerMachineTemplate) DeepCopy 

func (in *DockerMachineTemplate) DeepCopy() *DockerMachineTemplate

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

func (*DockerMachineTemplate) DeepCopyInto 

func (in *DockerMachineTemplate) DeepCopyInto(out *DockerMachineTemplate)

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

func (*DockerMachineTemplate) DeepCopyObject 

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

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

func (*DockerMachineTemplate) SetupWebhookWithManager 

func (m *DockerMachineTemplate) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*DockerMachineTemplate) ValidateCreate 

func (m *DockerMachineTemplate) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type.

func (*DockerMachineTemplate) ValidateDelete 

func (m *DockerMachineTemplate) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type.

func (*DockerMachineTemplate) ValidateUpdate 

func (m *DockerMachineTemplate) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type.

type DockerMachineTemplateList 

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

DockerMachineTemplateList contains a list of DockerMachineTemplate.

func (*DockerMachineTemplateList) DeepCopy 

func (in *DockerMachineTemplateList) DeepCopy() *DockerMachineTemplateList

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

func (*DockerMachineTemplateList) DeepCopyInto 

func (in *DockerMachineTemplateList) DeepCopyInto(out *DockerMachineTemplateList)

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

func (*DockerMachineTemplateList) DeepCopyObject 

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

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

type DockerMachineTemplateResource 

type DockerMachineTemplateResource struct {
	// Spec is the specification of the desired behavior of the machine.
	Spec DockerMachineSpec `json:"spec"`
}

DockerMachineTemplateResource describes the data needed to create a DockerMachine from a template.

func (*DockerMachineTemplateResource) DeepCopy 

func (in *DockerMachineTemplateResource) DeepCopy() *DockerMachineTemplateResource

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

func (*DockerMachineTemplateResource) DeepCopyInto 

func (in *DockerMachineTemplateResource) DeepCopyInto(out *DockerMachineTemplateResource)

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

type DockerMachineTemplateSpec 

type DockerMachineTemplateSpec struct {
	Template DockerMachineTemplateResource `json:"template"`
}

DockerMachineTemplateSpec defines the desired state of DockerMachineTemplate.

func (*DockerMachineTemplateSpec) DeepCopy 

func (in *DockerMachineTemplateSpec) DeepCopy() *DockerMachineTemplateSpec

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

func (*DockerMachineTemplateSpec) DeepCopyInto 

func (in *DockerMachineTemplateSpec) DeepCopyInto(out *DockerMachineTemplateSpec)

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

type Mount 

type Mount struct {
	// Path of the mount within the container.
	ContainerPath string `json:"containerPath,omitempty"`

	// Path of the mount on the host. If the hostPath doesn't exist, then runtimes
	// should report error. If the hostpath is a symbolic link, runtimes should
	// follow the symlink and mount the real destination to container.
	HostPath string `json:"hostPath,omitempty"`

	// If set, the mount is read-only.
	// +optional
	Readonly bool `json:"readOnly,omitempty"`
}

Mount specifies a host volume to mount into a container. This is a simplified version of kind v1alpha4.Mount types.

func (*Mount) DeepCopy 

func (in *Mount) DeepCopy() *Mount

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

func (*Mount) DeepCopyInto 

func (in *Mount) DeepCopyInto(out *Mount)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.