Documentation
¶
Overview ¶
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/cluster/config +k8s:defaulter-gen=TypeMeta
Index ¶
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: runtime.APIVersionInternal} // 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 )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type Config ¶
type Config struct {
metav1.TypeMeta
// Image is the node image to use when running the cluster
// TODO(bentheelder): split this into image and tag?
Image string
// 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
// KubeadmConfigPatchesJSON6902 are applied to the generated kubeadm config
// as patchesJson6902 to `kustomize build`
KubeadmConfigPatchesJSON6902 []kustomize.PatchJSON6902
// ControlPlane holds config for the control plane node
ControlPlane *ControlPlane
}
Config contains cluster creation config This is the current internal config type used by cluster Other API versions can be converted to this struct with Convert()
func (*Config) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Config.
func (*Config) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Config) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ControlPlane ¶
type ControlPlane struct {
// NodeLifecycle contains LifecycleHooks for phases of node provisioning
NodeLifecycle *NodeLifecycle
}
ControlPlane holds configurations specific to the control plane nodes (currently the only node).
func (*ControlPlane) DeepCopy ¶
func (in *ControlPlane) DeepCopy() *ControlPlane
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ControlPlane.
func (*ControlPlane) DeepCopyInto ¶
func (in *ControlPlane) DeepCopyInto(out *ControlPlane)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LifecycleHook ¶
type LifecycleHook struct {
// Name is used to improve logging (optional)
Name string
// Command is the command to run on the node
Command []string
// MustSucceed - if true then the hook / command failing will cause
// cluster creation to fail, otherwise the error will just be logged and
// the boot process will continue
MustSucceed bool
}
LifecycleHook represents a command to run at points in the node lifecycle
func (*LifecycleHook) DeepCopy ¶
func (in *LifecycleHook) DeepCopy() *LifecycleHook
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LifecycleHook.
func (*LifecycleHook) DeepCopyInto ¶
func (in *LifecycleHook) DeepCopyInto(out *LifecycleHook)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NodeLifecycle ¶
type NodeLifecycle struct {
// PreBoot hooks run before starting systemd
PreBoot []LifecycleHook
// PreKubeadm hooks run immediately before `kubeadm`
PreKubeadm []LifecycleHook
// PostKubeadm hooks run immediately after `kubeadm`
PostKubeadm []LifecycleHook
// PostSetup hooks run after any standard `kind` setup on the node
PostSetup []LifecycleHook
}
NodeLifecycle contains LifecycleHooks for phases of node provisioning Within each phase these hooks run in the order specified
func (*NodeLifecycle) DeepCopy ¶
func (in *NodeLifecycle) DeepCopy() *NodeLifecycle
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeLifecycle.
func (*NodeLifecycle) DeepCopyInto ¶
func (in *NodeLifecycle) DeepCopyInto(out *NodeLifecycle)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package encoding implements utilities for decoding from yaml the `kind` Config
|
Package encoding implements utilities for decoding from yaml the `kind` Config |
|
Package v1alpha1 implements the v1alpha1 apiVersion of the `kind` Config +k8s:deepcopy-gen=package +k8s:conversion-gen=sigs.k8s.io/kind/pkg/cluster/config/ +k8s:defaulter-gen=TypeMeta
|
Package v1alpha1 implements the v1alpha1 apiVersion of the `kind` Config +k8s:deepcopy-gen=package +k8s:conversion-gen=sigs.k8s.io/kind/pkg/cluster/config/ +k8s:defaulter-gen=TypeMeta |