Categorysigs.k8s.io/cluster-apibootstrapkubeadmtypes
package
1.9.5
Repository: https://github.com/kubernetes-sigs/cluster-api.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
12
Dependents
5
Files
185 SLOC

# README

Kubeadm types

These types were copied in from kubernetes/kubernetes.

The types found in kubernetes/kubernetes are incompatible with [email protected].

[email protected] requires that all fields of all embedded types have json struct tags and kubeadm types are missing a few.

If the kubeadm types ever escape kubernetes/kubernetes then we will adopt those assuming the types do all have json struct tags.

# Packages

Package upstreamv1beta1 contains a mirror of kubeadm API v1beta1 API, required because it is not possible to import k/K.
Package upstreamv1beta2 contains a mirror of kubeadm API v1beta2 API, required because it is not possible to import k/K.
Package upstreamv1beta3 contains a mirror of kubeadm API v1beta3 API, required because it is not possible to import k/K.
Package upstreamv1beta4 contains a mirror of kubeadm API v1beta4 API, required because it is not possible to import k/K.

# Functions

KubeVersionToKubeadmAPIGroupVersion maps a Kubernetes version to the correct Kubeadm API Group supported.
MarshalClusterConfigurationForVersion converts a Cluster API ClusterConfiguration type to the kubeadm API type for the given Kubernetes Version.
MarshalClusterStatusForVersion converts a Cluster API ClusterStatus type to the kubeadm API type for the given Kubernetes Version.
MarshalInitConfigurationForVersion converts a Cluster API InitConfiguration type to the kubeadm API type for the given Kubernetes Version.
MarshalJoinConfigurationForVersion converts a Cluster API JoinConfiguration type to the kubeadm API type for the given Kubernetes Version.
UnmarshalClusterConfiguration tries to translate a Kubeadm API yaml back to the Cluster API ClusterConfiguration type.
UnmarshalClusterStatus tries to translate a Kubeadm API yaml back to the Cluster API ClusterStatus type.
UnmarshalInitConfiguration tries to translate a Kubeadm API yaml back to the InitConfiguration type.
UnmarshalJoinConfiguration tries to translate a Kubeadm API yaml back to the JoinConfiguration type.

# Interfaces

ConvertibleFromClusterConfiguration defines capabilities of a type that during conversions gets values from ClusterConfiguration.
ConvertibleToClusterConfiguration defines capabilities of a type that during conversions sets values to ClusterConfiguration.