From a3e464490a5f628b0a934ec8679608a65d18d0e0 Mon Sep 17 00:00:00 2001 From: Mike Spreitzer Date: Sat, 12 Jun 2021 00:56:35 -0400 Subject: [PATCH] Fix some typos and omissions in kubeadm APIs --- cmd/kubeadm/app/apis/kubeadm/types.go | 6 ++++++ cmd/kubeadm/app/apis/kubeadm/v1beta2/doc.go | 2 +- cmd/kubeadm/app/apis/kubeadm/v1beta2/types.go | 6 ++++++ cmd/kubeadm/app/apis/kubeadm/v1beta3/doc.go | 2 +- cmd/kubeadm/app/apis/kubeadm/v1beta3/types.go | 6 ++++++ 5 files changed, 20 insertions(+), 2 deletions(-) diff --git a/cmd/kubeadm/app/apis/kubeadm/types.go b/cmd/kubeadm/app/apis/kubeadm/types.go index 39539b774a4..c0eb0506074 100644 --- a/cmd/kubeadm/app/apis/kubeadm/types.go +++ b/cmd/kubeadm/app/apis/kubeadm/types.go @@ -131,6 +131,8 @@ type ClusterConfiguration struct { // ControlPlaneComponent holds settings common to control plane component of the cluster type ControlPlaneComponent struct { // ExtraArgs is an extra set of flags to pass to the control plane component. + // A key in this map is the flag name as it appears on the + // command line except without leading dash(es). // TODO: This is temporary and ideally we would like to switch all components to // use ComponentConfig + ConfigMaps. ExtraArgs map[string]string @@ -213,6 +215,8 @@ type NodeRegistrationOptions struct { // KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file // kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap // Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. + // A key in this map is the flag name as it appears on the + // command line except without leading dash(es). KubeletExtraArgs map[string]string // IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. @@ -276,6 +280,8 @@ type LocalEtcd struct { // ExtraArgs are extra arguments provided to the etcd binary // when run inside a static pod. + // A key in this map is the flag name as it appears on the + // command line except without leading dash(es). ExtraArgs map[string]string // ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert. diff --git a/cmd/kubeadm/app/apis/kubeadm/v1beta2/doc.go b/cmd/kubeadm/app/apis/kubeadm/v1beta2/doc.go index e95959cc973..4d86d91dbbb 100644 --- a/cmd/kubeadm/app/apis/kubeadm/v1beta2/doc.go +++ b/cmd/kubeadm/app/apis/kubeadm/v1beta2/doc.go @@ -121,7 +121,7 @@ limitations under the License. // including settings for: // // - Networking, that holds configuration for the networking topology of the cluster; use it e.g. to customize -// node subnet or services subnet. +// pod subnet or services subnet. // // - Etcd configurations; use it e.g. to customize the local etcd or to configure the API server // for using an external etcd cluster. diff --git a/cmd/kubeadm/app/apis/kubeadm/v1beta2/types.go b/cmd/kubeadm/app/apis/kubeadm/v1beta2/types.go index d8d07f70cba..15c535f49f4 100644 --- a/cmd/kubeadm/app/apis/kubeadm/v1beta2/types.go +++ b/cmd/kubeadm/app/apis/kubeadm/v1beta2/types.go @@ -116,6 +116,8 @@ type ClusterConfiguration struct { // ControlPlaneComponent holds settings common to control plane component of the cluster type ControlPlaneComponent struct { // ExtraArgs is an extra set of flags to pass to the control plane component. + // A key in this map is the flag name as it appears on the + // command line except without leading dash(es). // TODO: This is temporary and ideally we would like to switch all components to // use ComponentConfig + ConfigMaps. ExtraArgs map[string]string `json:"extraArgs,omitempty"` @@ -207,6 +209,8 @@ type NodeRegistrationOptions struct { // KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file // kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap // Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. + // A key in this map is the flag name as it appears on the + // command line except without leading dash(es). KubeletExtraArgs map[string]string `json:"kubeletExtraArgs,omitempty"` // IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered. @@ -268,6 +272,8 @@ type LocalEtcd struct { // ExtraArgs are extra arguments provided to the etcd binary // when run inside a static pod. + // A key in this map is the flag name as it appears on the + // command line except without leading dash(es). ExtraArgs map[string]string `json:"extraArgs,omitempty"` // ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert. diff --git a/cmd/kubeadm/app/apis/kubeadm/v1beta3/doc.go b/cmd/kubeadm/app/apis/kubeadm/v1beta3/doc.go index ce88587586f..59928d1ffd5 100644 --- a/cmd/kubeadm/app/apis/kubeadm/v1beta3/doc.go +++ b/cmd/kubeadm/app/apis/kubeadm/v1beta3/doc.go @@ -120,7 +120,7 @@ limitations under the License. // including settings for: // // - Networking, that holds configuration for the networking topology of the cluster; use it e.g. to customize -// node subnet or services subnet. +// pod subnet or services subnet. // // - Etcd configurations; use it e.g. to customize the local etcd or to configure the API server // for using an external etcd cluster. diff --git a/cmd/kubeadm/app/apis/kubeadm/v1beta3/types.go b/cmd/kubeadm/app/apis/kubeadm/v1beta3/types.go index c45bff745c4..dea4e8edc12 100644 --- a/cmd/kubeadm/app/apis/kubeadm/v1beta3/types.go +++ b/cmd/kubeadm/app/apis/kubeadm/v1beta3/types.go @@ -133,6 +133,8 @@ type ClusterConfiguration struct { // ControlPlaneComponent holds settings common to control plane component of the cluster type ControlPlaneComponent struct { // ExtraArgs is an extra set of flags to pass to the control plane component. + // A key in this map is the flag name as it appears on the + // command line except without leading dash(es). // TODO: This is temporary and ideally we would like to switch all components to // use ComponentConfig + ConfigMaps. // +optional @@ -214,6 +216,8 @@ type NodeRegistrationOptions struct { // KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file // kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config-1.X ConfigMap // Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. + // A key in this map is the flag name as it appears on the + // command line except without leading dash(es). // +optional KubeletExtraArgs map[string]string `json:"kubeletExtraArgs,omitempty"` @@ -287,6 +291,8 @@ type LocalEtcd struct { // ExtraArgs are extra arguments provided to the etcd binary // when run inside a static pod. + // A key in this map is the flag name as it appears on the + // command line except without leading dash(es). // +optional ExtraArgs map[string]string `json:"extraArgs,omitempty"`