Documentation
¶
Overview ¶
Package v1alpha4 implements the v1alpha4 apiVersion of kind's cluster configuration
+k8s:deepcopy-gen=package
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SetDefaultsCluster ¶
func SetDefaultsCluster(obj *Cluster)
SetDefaultsCluster sets uninitialized fields to their default value.
func SetDefaultsNode ¶
func SetDefaultsNode(obj *Node)
SetDefaultsNode sets uninitialized fields to their default value.
Types ¶
type Cluster ¶
type Cluster struct {
TypeMeta `yaml:",inline" json:",inline"`
// The cluster name.
// Optional, this will be overridden by --name / KIND_CLUSTER_NAME
Name string `yaml:"name,omitempty" json:"name,omitempty"`
// Nodes contains the list of nodes defined in the `kind` Cluster
// If unset this will default to a single control-plane node
// Note that if more than one control plane is specified, an external
// control plane load balancer will be provisioned implicitly
Nodes []Node `yaml:"nodes,omitempty" json:"nodes,omitempty"`
// Networking contains cluster wide network settings
Networking Networking `yaml:"networking,omitempty" json:"networking,omitempty"`
// FeatureGates contains a map of Kubernetes feature gates to whether they
// are enabled. The feature gates specified here are passed to all Kubernetes components as flags or in config.
//
// https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/
FeatureGates map[string]bool `yaml:"featureGates,omitempty" json:"featureGates,omitempty"`
// RuntimeConfig Keys and values are translated into --runtime-config values for kube-apiserver, separated by commas.
//
// Use this to enable alpha APIs.
RuntimeConfig map[string]string `yaml:"runtimeConfig,omitempty" json:"runtimeConfig,omitempty"`
// KubeadmConfigPatches are applied to the generated kubeadm config as
// merge patches. The `kind` field must match the target object, and
// if `apiVersion` is specified it will only be applied to matching objects.
//
// This should be an inline yaml blob-string
//
// https://tools.ietf.org/html/rfc7386
//
// The cluster-level patches are applied before the node-level patches.
KubeadmConfigPatches []string `yaml:"kubeadmConfigPatches,omitempty" json:"kubeadmConfigPatches,omitempty"`
// KubeadmConfigPatchesJSON6902 are applied to the generated kubeadm config
// as JSON 6902 patches. The `kind` field must match the target object, and
// if group or version are specified it will only be objects matching the
// apiVersion: group+"/"+version
//
// Name and Namespace are now ignored, but the fields continue to exist for
// backwards compatibility of parsing the config. The name of the generated
// config was/is always fixed as is the namespace so these fields have
// always been a no-op.
//
// https://tools.ietf.org/html/rfc6902
//
// The cluster-level patches are applied before the node-level patches.
KubeadmConfigPatchesJSON6902 []PatchJSON6902 `yaml:"kubeadmConfigPatchesJSON6902,omitempty" json:"kubeadmConfigPatchesJSON6902,omitempty"`
// ContainerdConfigPatches are applied to every node's containerd config
// in the order listed.
// These should be toml stringsto be applied as merge patches
ContainerdConfigPatches []string `yaml:"containerdConfigPatches,omitempty" json:"containerdConfigPatches,omitempty"`
// ContainerdConfigPatchesJSON6902 are applied to every node's containerd config
// in the order listed.
// These should be YAML or JSON formatting RFC 6902 JSON patches
ContainerdConfigPatchesJSON6902 []string `yaml:"containerdConfigPatchesJSON6902,omitempty" json:"containerdConfigPatchesJSON6902,omitempty"`
}
Cluster contains kind cluster configuration
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.
type ClusterIPFamily ¶
type ClusterIPFamily string
ClusterIPFamily defines cluster network IP family
const ( // IPv4Family sets ClusterIPFamily to ipv4 IPv4Family ClusterIPFamily = "ipv4" // IPv6Family sets ClusterIPFamily to ipv6 IPv6Family ClusterIPFamily = "ipv6" // DualStackFamily sets ClusterIPFamily to dual DualStackFamily ClusterIPFamily = "dual" )
type Mount ¶
type Mount struct {
// Path of the mount within the container.
ContainerPath string `yaml:"containerPath,omitempty" 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 `yaml:"hostPath,omitempty" json:"hostPath,omitempty"`
// If set, the mount is read-only.
Readonly bool `yaml:"readOnly,omitempty" json:"readOnly,omitempty"`
// If set, the mount needs SELinux relabeling.
SelinuxRelabel bool `yaml:"selinuxRelabel,omitempty" json:"selinuxRelabel,omitempty"`
// Requested propagation mode.
Propagation MountPropagation `yaml:"propagation,omitempty" json:"propagation,omitempty"`
}
Mount specifies a host volume to mount into a container. This is a close copy of the upstream cri Mount type see: k8s.io/kubernetes/pkg/kubelet/apis/cri/runtime/v1alpha2 It additionally serializes the "propagation" field with the string enum names on disk as opposed to the int32 values, and the serialized field names have been made closer to core/v1 VolumeMount field names In yaml this looks like:
containerPath: /foo hostPath: /bar readOnly: true selinuxRelabel: false propagation: None
Propagation may be one of: None, HostToContainer, Bidirectional
func (*Mount) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Mount.
func (*Mount) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Mount) UnmarshalYAML ¶
UnmarshalYAML implements custom decoding YAML https://godoc.org/gopkg.in/yaml.v3
type MountPropagation ¶
type MountPropagation string
MountPropagation represents an "enum" for mount propagation options, see also Mount.
const ( // MountPropagationNone specifies that no mount propagation // ("private" in Linux terminology). MountPropagationNone MountPropagation = "None" // MountPropagationHostToContainer specifies that mounts get propagated // from the host to the container ("rslave" in Linux). MountPropagationHostToContainer MountPropagation = "HostToContainer" // MountPropagationBidirectional specifies that mounts get propagated from // the host to the container and from the container to the host // ("rshared" in Linux). MountPropagationBidirectional MountPropagation = "Bidirectional" )
type Networking ¶
type Networking struct {
// IPFamily is the network cluster model, currently it can be ipv4 or ipv6
IPFamily ClusterIPFamily `yaml:"ipFamily,omitempty" json:"ipFamily,omitempty"`
// APIServerPort is the listen port on the host for the Kubernetes API Server
// Defaults to a random port on the host obtained by kind
//
// NOTE: if you set the special value of `-1` then the node backend
// (docker, podman...) will be left to pick the port instead.
// This is potentially useful for remote hosts, BUT it means when the container
// is restarted it will be randomized. Leave this unset to allow kind to pick it.
APIServerPort int32 `yaml:"apiServerPort,omitempty" json:"apiServerPort,omitempty"`
// APIServerAddress is the listen address on the host for the Kubernetes
// API Server. This should be an IP address.
//
// Defaults to 127.0.0.1
APIServerAddress string `yaml:"apiServerAddress,omitempty" json:"apiServerAddress,omitempty"`
// PodSubnet is the CIDR used for pod IPs
// kind will select a default if unspecified
PodSubnet string `yaml:"podSubnet,omitempty" json:"podSubnet,omitempty"`
// ServiceSubnet is the CIDR used for services VIPs
// kind will select a default if unspecified for IPv6
ServiceSubnet string `yaml:"serviceSubnet,omitempty" json:"serviceSubnet,omitempty"`
// If DisableDefaultCNI is true, kind will not install the default CNI setup.
// Instead the user should install their own CNI after creating the cluster.
DisableDefaultCNI bool `yaml:"disableDefaultCNI,omitempty" json:"disableDefaultCNI,omitempty"`
// KubeProxyMode defines if kube-proxy should operate in iptables or ipvs mode
// Defaults to 'iptables' mode
KubeProxyMode ProxyMode `yaml:"kubeProxyMode,omitempty" json:"kubeProxyMode,omitempty"`
// DNSSearch defines the DNS search domain to use for nodes. If not set, this will be inherited from the host.
DNSSearch *[]string `yaml:"dnsSearch,omitempty" json:"dnsSearch,omitempty"`
}
Networking contains cluster wide network settings
func (*Networking) DeepCopy ¶
func (in *Networking) DeepCopy() *Networking
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Networking.
func (*Networking) DeepCopyInto ¶
func (in *Networking) DeepCopyInto(out *Networking)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Node ¶
type Node struct {
// Role defines the role of the node in the Kubernetes cluster
// created by kind
//
// Defaults to "control-plane"
Role NodeRole `yaml:"role,omitempty" json:"role,omitempty"`
// Image is the node image to use when creating this node
// If unset a default image will be used, see defaults.Image
Image string `yaml:"image,omitempty" json:"image,omitempty"`
// Labels are the labels with which the respective node will be labeled
Labels map[string]string `yaml:"labels,omitempty" json:"labels,omitempty"`
// TODO: cri-like types should be inline instead
// ExtraMounts describes additional mount points for the node container
// These may be used to bind a hostPath
ExtraMounts []Mount `yaml:"extraMounts,omitempty" json:"extraMounts,omitempty"`
// ExtraPortMappings describes additional port mappings for the node container
// binded to a host Port
ExtraPortMappings []PortMapping `yaml:"extraPortMappings,omitempty" json:"extraPortMappings,omitempty"`
// KubeadmConfigPatches are applied to the generated kubeadm config as
// merge patches. The `kind` field must match the target object, and
// if `apiVersion` is specified it will only be applied to matching objects.
//
// This should be an inline yaml blob-string
//
// https://tools.ietf.org/html/rfc7386
//
// The node-level patches will be applied after the cluster-level patches
// have been applied. (See Cluster.KubeadmConfigPatches)
KubeadmConfigPatches []string `yaml:"kubeadmConfigPatches,omitempty" json:"kubeadmConfigPatches,omitempty"`
// KubeadmConfigPatchesJSON6902 are applied to the generated kubeadm config
// as JSON 6902 patches. The `kind` field must match the target object, and
// if group or version are specified it will only be objects matching the
// apiVersion: group+"/"+version
//
// Name and Namespace are now ignored, but the fields continue to exist for
// backwards compatibility of parsing the config. The name of the generated
// config was/is always fixed as is the namespace so these fields have
// always been a no-op.
//
// https://tools.ietf.org/html/rfc6902
//
// The node-level patches will be applied after the cluster-level patches
// have been applied. (See Cluster.KubeadmConfigPatchesJSON6902)
KubeadmConfigPatchesJSON6902 []PatchJSON6902 `yaml:"kubeadmConfigPatchesJSON6902,omitempty" json:"kubeadmConfigPatchesJSON6902,omitempty"`
}
Node contains settings for a node in the `kind` Cluster. A node in kind config represent a container that will be provisioned with all the components required for the assigned role in the Kubernetes cluster
func (*Node) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Node.
func (*Node) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NodeRole ¶
type NodeRole string
NodeRole defines possible role for nodes in a Kubernetes cluster managed by `kind`
const ( // ControlPlaneRole identifies a node that hosts a Kubernetes control-plane. // NOTE: in single node clusters, control-plane nodes act also as a worker // nodes, in which case the taint will be removed. see: // https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/#control-plane-node-isolation ControlPlaneRole NodeRole = "control-plane" // WorkerRole identifies a node that hosts a Kubernetes worker WorkerRole NodeRole = "worker" )
type PatchJSON6902 ¶
type PatchJSON6902 struct {
// these fields specify the patch target resource
Group string `yaml:"group" json:"group"`
Version string `yaml:"version" json:"version"`
Kind string `yaml:"kind" json:"kind"`
// Patch should contain the contents of the json patch as a string
Patch string `yaml:"patch" json:"patch"`
}
PatchJSON6902 represents an inline kustomize json 6902 patch https://tools.ietf.org/html/rfc6902
func (*PatchJSON6902) DeepCopy ¶
func (in *PatchJSON6902) DeepCopy() *PatchJSON6902
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PatchJSON6902.
func (*PatchJSON6902) DeepCopyInto ¶
func (in *PatchJSON6902) DeepCopyInto(out *PatchJSON6902)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PortMapping ¶
type PortMapping struct {
// Port within the container.
ContainerPort int32 `yaml:"containerPort,omitempty" json:"containerPort,omitempty"`
// Port on the host.
//
// If unset, a random port will be selected.
//
// NOTE: if you set the special value of `-1` then the node backend
// (docker, podman...) will be left to pick the port instead.
// This is potentially useful for remote hosts, BUT it means when the container
// is restarted it will be randomized. Leave this unset to allow kind to pick it.
HostPort int32 `yaml:"hostPort,omitempty" json:"hostPort,omitempty"`
// TODO: add protocol (tcp/udp) and port-ranges
ListenAddress string `yaml:"listenAddress,omitempty" json:"listenAddress,omitempty"`
// Protocol (TCP/UDP/SCTP)
Protocol PortMappingProtocol `yaml:"protocol,omitempty" json:"protocol,omitempty"`
}
PortMapping specifies a host port mapped into a container port. In yaml this looks like:
containerPort: 80 hostPort: 8000 listenAddress: 127.0.0.1 protocol: TCP
func (*PortMapping) DeepCopy ¶
func (in *PortMapping) DeepCopy() *PortMapping
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PortMapping.
func (*PortMapping) DeepCopyInto ¶
func (in *PortMapping) DeepCopyInto(out *PortMapping)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PortMapping) UnmarshalYAML ¶
func (p *PortMapping) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements custom decoding YAML https://godoc.org/gopkg.in/yaml.v3
type PortMappingProtocol ¶
type PortMappingProtocol string
PortMappingProtocol represents an "enum" for port mapping protocol options, see also PortMapping.
const ( // PortMappingProtocolTCP specifies TCP protocol PortMappingProtocolTCP PortMappingProtocol = "TCP" // PortMappingProtocolUDP specifies UDP protocol PortMappingProtocolUDP PortMappingProtocol = "UDP" // PortMappingProtocolSCTP specifies SCTP protocol PortMappingProtocolSCTP PortMappingProtocol = "SCTP" )
type ProxyMode ¶ added in v0.9.0
type ProxyMode string
ProxyMode defines a proxy mode for kube-proxy
type TypeMeta ¶
type TypeMeta struct {
Kind string `yaml:"kind,omitempty" json:"kind,omitempty"`
APIVersion string `yaml:"apiVersion,omitempty" json:"apiVersion,omitempty"`
}
TypeMeta partially copies apimachinery/pkg/apis/meta/v1.TypeMeta No need for a direct dependence; the fields are stable.
func (*TypeMeta) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TypeMeta.
func (*TypeMeta) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files