v1

Documentation

Overview

Package v1 contains API Schema definitions for the cluster CIDR v1 API group.

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type ClusterCIDR
  • func (in *ClusterCIDR) DeepCopy() *ClusterCIDR
  • func (in *ClusterCIDR) DeepCopyInto(out *ClusterCIDR)
  • func (in *ClusterCIDR) DeepCopyObject() runtime.Object
  • func (in *ClusterCIDR) Default()
• type ClusterCIDRList
  • func (in *ClusterCIDRList) DeepCopy() *ClusterCIDRList
  • func (in *ClusterCIDRList) DeepCopyInto(out *ClusterCIDRList)
  • func (in *ClusterCIDRList) DeepCopyObject() runtime.Object
• type ClusterCIDRSpec
  • func (in *ClusterCIDRSpec) DeepCopy() *ClusterCIDRSpec
  • func (in *ClusterCIDRSpec) DeepCopyInto(out *ClusterCIDRSpec)

Variables

var (
	// SchemeBuilder initializes a scheme builder
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: clustercidr.GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ClusterCIDR

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

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

ClusterCIDR represents a single configuration for per-Node Pod CIDR allocations when the MultiCIDRRangeAllocator is enabled (see the config for kube-controller-manager). A cluster may have any number of ClusterCIDR resources, all of which will be considered when allocating a CIDR for a Node. A ClusterCIDR is eligible to be used for a given Node when the node selector matches the node in question and has free CIDRs to allocate. In case of multiple matching ClusterCIDR resources, the allocator will attempt to break ties using internal heuristics, but any ClusterCIDR whose node selector matches the Node may be used. +kubebuilder:object:root=true +kubebuilder:resource:scope=Cluster +genclient +genclient:noStatus +genclient:nonNamespaced +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ClusterCIDR) DeepCopy

func (in *ClusterCIDR) DeepCopy() *ClusterCIDR

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

func (*ClusterCIDR) DeepCopyInto

func (in *ClusterCIDR) DeepCopyInto(out *ClusterCIDR)

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

func (*ClusterCIDR) DeepCopyObject

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

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

func (*ClusterCIDR) Default

func (in *ClusterCIDR) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type.

type ClusterCIDRList

type ClusterCIDRList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// items is the list of ClusterCIDRs.
	Items []ClusterCIDR `json:"items"`
}

ClusterCIDRList contains a list of ClusterCIDRs. +kubebuilder:object:root=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ClusterCIDRList) DeepCopy

func (in *ClusterCIDRList) DeepCopy() *ClusterCIDRList

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

func (*ClusterCIDRList) DeepCopyInto

func (in *ClusterCIDRList) DeepCopyInto(out *ClusterCIDRList)

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

func (*ClusterCIDRList) DeepCopyObject

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

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

type ClusterCIDRSpec

type ClusterCIDRSpec struct {
	// nodeSelector defines which nodes the config is applicable to.
	// An empty or nil nodeSelector selects all nodes.
	// This field is optional and immutable.
	// +optional
	NodeSelector *api.NodeSelector `json:"nodeSelector,omitempty"`

	// perNodeHostBits defines the number of host bits to be configured per node.
	// A subnet mask determines how much of the address is used for network bits
	// and host bits. For example an IPv4 address of 192.168.0.0/24, splits the
	// address into 24 bits for the network portion and 8 bits for the host portion.
	// To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6).
	// Minimum value is 4 (16 IPs).
	// This field is required and immutable.
	// +kubebuilder:validation:Required
	// +required
	PerNodeHostBits int32 `json:"perNodeHostBits"`

	// ipv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8").
	// At least one of ipv4 and ipv6 must be specified.
	// This field is optional and immutable.
	// +optional
	IPv4 string `json:"ipv4,omitempty"`

	// ipv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64").
	// At least one of ipv4 and ipv6 must be specified.
	// This field is optional and immutable.
	// +optional
	IPv6 string `json:"ipv6,omitempty"`
}

ClusterCIDRSpec defines the desired state of ClusterCIDR.

func (*ClusterCIDRSpec) DeepCopy

func (in *ClusterCIDRSpec) DeepCopy() *ClusterCIDRSpec

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

func (*ClusterCIDRSpec) DeepCopyInto

func (in *ClusterCIDRSpec) DeepCopyInto(out *ClusterCIDRSpec)

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