kind: sigs.k8s.io/kind/pkg/cluster/config/v1alpha3 Index | Files

package v1alpha3

import "sigs.k8s.io/kind/pkg/cluster/config/v1alpha3"

Package v1alpha3 implements the v1alpha3 apiVersion of kind's cluster configuration

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

Index

Package Files

default.go doc.go register.go types.go zz_generated.conversion.go zz_generated.deepcopy.go zz_generated.default.go

Constants

const GroupName = "kind.sigs.k8s.io"

GroupName is the group name used in this package.

Variables

var (
    // SchemeGroupVersion is group version used to register these objects.
    SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha3"}
    // SchemeBuilder is a type to collect functions that add data to an API
    // object through a scheme.
    SchemeBuilder runtime.SchemeBuilder

    // AddToScheme applies all the stored functions in the localSchemeBuilder
    // to the scheme.
    AddToScheme = localSchemeBuilder.AddToScheme
)

func Convert_config_Cluster_To_v1alpha3_Cluster Uses

func Convert_config_Cluster_To_v1alpha3_Cluster(in *config.Cluster, out *Cluster, s conversion.Scope) error

Convert_config_Cluster_To_v1alpha3_Cluster is an autogenerated conversion function.

func Convert_config_Networking_To_v1alpha3_Networking Uses

func Convert_config_Networking_To_v1alpha3_Networking(in *config.Networking, out *Networking, s conversion.Scope) error

Convert_config_Networking_To_v1alpha3_Networking is an autogenerated conversion function.

func Convert_config_Node_To_v1alpha3_Node Uses

func Convert_config_Node_To_v1alpha3_Node(in *config.Node, out *Node, s conversion.Scope) error

Convert_config_Node_To_v1alpha3_Node is an autogenerated conversion function.

func Convert_v1alpha3_Cluster_To_config_Cluster Uses

func Convert_v1alpha3_Cluster_To_config_Cluster(in *Cluster, out *config.Cluster, s conversion.Scope) error

Convert_v1alpha3_Cluster_To_config_Cluster is an autogenerated conversion function.

func Convert_v1alpha3_Networking_To_config_Networking Uses

func Convert_v1alpha3_Networking_To_config_Networking(in *Networking, out *config.Networking, s conversion.Scope) error

Convert_v1alpha3_Networking_To_config_Networking is an autogenerated conversion function.

func Convert_v1alpha3_Node_To_config_Node Uses

func Convert_v1alpha3_Node_To_config_Node(in *Node, out *config.Node, s conversion.Scope) error

Convert_v1alpha3_Node_To_config_Node is an autogenerated conversion function.

func RegisterConversions Uses

func RegisterConversions(s *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDefaults Uses

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func SetDefaults_Cluster Uses

func SetDefaults_Cluster(obj *Cluster)

SetDefaults_Cluster sets uninitialized fields to their default value.

func SetDefaults_Node Uses

func SetDefaults_Node(obj *Node)

SetDefaults_Node sets uninitialized fields to their default value.

func SetObjectDefaults_Cluster Uses

func SetObjectDefaults_Cluster(in *Cluster)

type Cluster Uses

type Cluster struct {
    // TypeMeta representing the type of the object and its API schema version.
    metav1.TypeMeta `json:",inline"`

    // 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 `json:"nodes,omitempty"`

    // Networking contains cluster wide network settings
    Networking Networking `json:"networking,omitempty"`

    // KubeadmConfigPatches are applied to the generated kubeadm config as
    // strategic merge patches to `kustomize build` internally
    // https://github.com/kubernetes/community/blob/master/contributors/devel/strategic-merge-patch.md
    // This should be an inline yaml blob-string
    KubeadmConfigPatches []string `json:"kubeadmConfigPatches,omitempty"`

    // KubeadmConfigPatchesJSON6902 are applied to the generated kubeadm config
    // as patchesJson6902 to `kustomize build`
    KubeadmConfigPatchesJSON6902 []kustomize.PatchJSON6902 `json:"kubeadmConfigPatchesJson6902,omitempty"`
}

Cluster contains kind cluster configuration

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) DeepCopyObject Uses

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

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

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

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

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 `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 `json:"image,omitempty"`

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

    // ExtraPortMappings describes additional port mappings for the node container
    // binded to a host Port
    ExtraPortMappings []cri.PortMapping `json:"extraPortMappings,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 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.

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

Package v1alpha3 imports 9 packages (graph) and is imported by 2 packages. Updated 2019-07-18. Refresh now. Tools for package owners.