kind: sigs.k8s.io/kind/pkg/internal/apis/config Index | Files | Directories

package config

import "sigs.k8s.io/kind/pkg/internal/apis/config"

Package config implements the current apiVersion of the `kind` Config along with some common abstractions

+k8s:deepcopy-gen=package +k8s:conversion-gen=sigs.k8s.io/kind/pkg/internal/apis/config +k8s:defaulter-gen=TypeMeta

Index

Package Files

convert_v1alpha3.go convert_v1alpha4.go default.go doc.go types.go validate.go zz_generated.deepcopy.go

func SetDefaultsCluster Uses

func SetDefaultsCluster(obj *Cluster)

SetDefaultsCluster sets uninitialized fields to their default value.

func SetDefaultsNode Uses

func SetDefaultsNode(obj *Node)

SetDefaultsNode sets uninitialized fields to their default value.

type Cluster Uses

type Cluster struct {
    // 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

    // Networking contains cluster wide network settings
    Networking Networking

    // KubeadmConfigPatches are applied to the generated kubeadm config as
    // strategic merge patches to `kustomize build` internally
    // https://github.com/kubernetes/community/blob/a9cf5c8f3380bb52ebe57b1e2dbdec136d8dd484/contributors/devel/sig-api-machinery/strategic-merge-patch.md
    // This should be an inline yaml blob-string
    KubeadmConfigPatches []string

    // KubeadmConfigPatchesJSON6902 are applied to the generated kubeadm config
    // as patchesJson6902 to `kustomize build`
    KubeadmConfigPatchesJSON6902 []PatchJSON6902
}

Cluster contains kind cluster configuration

func Convertv1alpha3 Uses

func Convertv1alpha3(in *v1alpha3.Cluster) *Cluster

Convertv1alpha3 converts a v1alpha3 cluster to a cluster at the internal API version

func Convertv1alpha4 Uses

func Convertv1alpha4(in *v1alpha4.Cluster) *Cluster

Convertv1alpha4 converts a v1alpha4 cluster to a cluster at the internal API version

func (*Cluster) DeepCopy Uses

func (in *Cluster) DeepCopy() *Cluster

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

func (*Cluster) DeepCopyInto Uses

func (in *Cluster) DeepCopyInto(out *Cluster)

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

func (*Cluster) Validate Uses

func (c *Cluster) Validate() error

Validate returns a ConfigErrors with an entry for each problem with the config, or nil if there are none

type ClusterIPFamily Uses

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"
)

type Mount Uses

type Mount struct {
    // Path of the mount within the container.
    ContainerPath string
    // 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
    // If set, the mount is read-only.
    Readonly bool
    // If set, the mount needs SELinux relabeling.
    SelinuxRelabel bool
    // Requested propagation mode.
    Propagation MountPropagation
}

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 serlialzed 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 Uses

func (in *Mount) DeepCopy() *Mount

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

func (*Mount) DeepCopyInto Uses

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

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

type MountPropagation Uses

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 Uses

type Networking struct {
    // IPFamily is the network cluster model, currently it can be ipv4 or ipv6
    IPFamily ClusterIPFamily
    // APIServerPort is the listen port on the host for the Kubernetes API Server
    // Defaults to a random port on the host
    APIServerPort int32
    // 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
    // PodSubnet is the CIDR used for pod IPs
    // kind will select a default if unspecified
    PodSubnet string
    // ServiceSubnet is the CIDR used for services VIPs
    // kind will select a default if unspecified
    ServiceSubnet string
    // 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
}

Networking contains cluster wide network settings

func (*Networking) DeepCopy Uses

func (in *Networking) DeepCopy() *Networking

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

func (*Networking) DeepCopyInto Uses

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 Uses

type Node struct {
    // Role defines the role of the node in the in the Kubernetes cluster
    // created by kind
    //
    // Defaults to "control-plane"
    Role NodeRole

    // Image is the node image to use when creating this node
    // If unset a default image will be used, see defaults.Image
    Image string

    // ExtraMounts describes additional mount points for the node container
    // These may be used to bind a hostPath
    ExtraMounts []Mount

    // ExtraPortMappings describes additional port mappings for the node container
    // binded to a host Port
    ExtraPortMappings []PortMapping
}

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 Uses

func (in *Node) DeepCopy() *Node

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

func (*Node) DeepCopyInto Uses

func (in *Node) DeepCopyInto(out *Node)

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

func (*Node) Validate Uses

func (n *Node) Validate() error

Validate returns a ConfigErrors with an entry for each problem with the Node, or nil if there are none

type NodeRole Uses

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 Uses

type PatchJSON6902 struct {
    // these fields specify the patch target resource
    Group   string
    Version string
    Kind    string
    // Patch should contain the contents of the json patch as a string
    Patch string
}

PatchJSON6902 represents an inline kustomize json 6902 patch https://tools.ietf.org/html/rfc6902

func (*PatchJSON6902) DeepCopy Uses

func (in *PatchJSON6902) DeepCopy() *PatchJSON6902

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

func (*PatchJSON6902) DeepCopyInto Uses

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 Uses

type PortMapping struct {
    // Port within the container.
    ContainerPort int32
    // Port on the host.
    HostPort int32
    // TODO: add protocol (tcp/udp) and port-ranges
    ListenAddress string
    // Protocol (TCP/UDP)
    Protocol PortMappingProtocol
}

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 Uses

func (in *PortMapping) DeepCopy() *PortMapping

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

func (*PortMapping) DeepCopyInto Uses

func (in *PortMapping) DeepCopyInto(out *PortMapping)

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

type PortMappingProtocol Uses

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"
)

Directories

PathSynopsis
encodingPackage encoding implements utilities for decoding from yaml the `kind` Config
fuzzer

Package config imports 5 packages (graph) and is imported by 11 packages. Updated 2019-11-13. Refresh now. Tools for package owners.