diff --git a/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md b/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md index c9ca54b122..9c642666f8 100644 --- a/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md +++ b/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md @@ -1,12 +1,10 @@ --- title: cloud-controller-manager -notitle: true +content_template: templates/tool-reference +weight: 28 --- -## cloud-controller-manager - - -### Synopsis +{{% capture synopsis %}} The Cloud controller manager is a daemon that embeds @@ -16,7 +14,9 @@ the cloud specific control loops shipped with Kubernetes. cloud-controller-manager [flags] ``` -### Options +{{% /capture %}} + +{{% capture options %}} @@ -25,6 +25,13 @@ cloud-controller-manager [flags] + + + + + + + @@ -211,7 +218,7 @@ cloud-controller-manager [flags] - + @@ -284,6 +291,20 @@ cloud-controller-manager [flags] + + + + + + + + + + + + + + @@ -312,6 +333,13 @@ cloud-controller-manager [flags] + + + + + + + @@ -417,6 +445,13 @@ cloud-controller-manager [flags] + + + + + + + @@ -442,7 +477,7 @@ cloud-controller-manager [flags] - + @@ -492,3 +527,5 @@ cloud-controller-manager [flags] +{{% /capture %}} + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md b/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md index 7f375ac738..2f6fc89f1c 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md @@ -1,12 +1,10 @@ --- title: kube-apiserver -notitle: true +content_template: templates/tool-reference +weight: 28 --- -## kube-apiserver - - -### Synopsis +{{% capture synopsis %}} The Kubernetes API server validates and configures data @@ -18,7 +16,9 @@ cluster's shared state through which all other components interact. kube-apiserver [flags] ``` -### Options +{{% /capture %}} + +{{% capture options %}}
--add-dir-header
If true, adds the file directory to the header
--allocate-node-cidrs
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (BETA - default=true)
CSIDriverRegistry=true|false (BETA - default=true)
CSIInlineVolume=true|false (ALPHA - default=false)
CSIMigration=true|false (ALPHA - default=false)
CSIMigrationAWS=true|false (ALPHA - default=false)
CSIMigrationGCE=true|false (ALPHA - default=false)
CSIMigrationOpenStack=true|false (ALPHA - default=false)
CSINodeInfo=true|false (BETA - default=true)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomResourcePublishOpenAPI=true|false (ALPHA - default=false)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
CustomResourceWebhookConversion=true|false (ALPHA - default=false)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
ExpandCSIVolumes=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HyperVContainer=true|false (ALPHA - default=false)
KubeletPodResources=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
NodeLease=true|false (BETA - default=true)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (BETA - default=true)
RuntimeClass=true|false (BETA - default=true)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServerSideApply=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StorageVersionHash=true|false (ALPHA - default=false)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportNodePidsLimit=true|false (ALPHA - default=false)
SupportPodPidsLimit=true|false (BETA - default=true)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
ValidateProxyRedirects=true|false (BETA - default=true)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
WinDSR=true|false (ALPHA - default=false)
WinOverlay=true|false (ALPHA - default=false)
WindowsGMSA=true|false (ALPHA - default=false)
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (BETA - default=true)
CSIDriverRegistry=true|false (BETA - default=true)
CSIInlineVolume=true|false (BETA - default=true)
CSIMigration=true|false (ALPHA - default=false)
CSIMigrationAWS=true|false (ALPHA - default=false)
CSIMigrationAzureDisk=true|false (ALPHA - default=false)
CSIMigrationAzureFile=true|false (ALPHA - default=false)
CSIMigrationGCE=true|false (ALPHA - default=false)
CSIMigrationOpenStack=true|false (ALPHA - default=false)
CSINodeInfo=true|false (BETA - default=true)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomResourceDefaulting=true|false (BETA - default=true)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EndpointSlice=true|false (ALPHA - default=false)
EphemeralContainers=true|false (ALPHA - default=false)
EvenPodsSpread=true|false (ALPHA - default=false)
ExpandCSIVolumes=true|false (BETA - default=true)
ExpandInUsePersistentVolumes=true|false (BETA - default=true)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HPAScaleToZero=true|false (ALPHA - default=false)
HyperVContainer=true|false (ALPHA - default=false)
IPv6DualStack=true|false (ALPHA - default=false)
KubeletPodResources=true|false (BETA - default=true)
LegacyNodeRoleBehavior=true|false (ALPHA - default=true)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeDisruptionExclusion=true|false (ALPHA - default=false)
NodeLease=true|false (BETA - default=true)
NonPreemptingPriority=true|false (ALPHA - default=false)
PodOverhead=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
RemainingItemCount=true|false (BETA - default=true)
RemoveSelfLink=true|false (ALPHA - default=false)
RequestManagement=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (BETA - default=true)
RuntimeClass=true|false (BETA - default=true)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServerSideApply=true|false (BETA - default=true)
ServiceLoadBalancerFinalizer=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StartupProbe=true|false (ALPHA - default=false)
StorageVersionHash=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportNodePidsLimit=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (BETA - default=true)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
TopologyManager=true|false (ALPHA - default=false)
ValidateProxyRedirects=true|false (BETA - default=true)
VolumePVCDataSource=true|false (BETA - default=true)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (BETA - default=true)
WatchBookmark=true|false (BETA - default=true)
WinDSR=true|false (ALPHA - default=false)
WinOverlay=true|false (ALPHA - default=false)
WindowsGMSA=true|false (BETA - default=true)
WindowsRunAsUserName=true|false (ALPHA - default=false)
The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.
--leader-elect-resource-name string     Default: "cloud-controller-manager"
The name of resource object that is used for locking during leader election.
--leader-elect-resource-namespace string     Default: "kube-system"
The namespace of resource object that is used for locking during leader election.
--leader-elect-retry-period duration     Default: 2s
If non-empty, use this log file
--log-file-max-size uint     Default: 1800
Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited.
--log-flush-frequency duration     Default: 5s
If true, avoid header prefixes in the log messages
--skip-log-headers
If true, avoid headers when opening log files
--stderrthreshold severity     Default: 2
--tls-min-version string
Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
@@ -27,6 +27,13 @@ kube-apiserver [flags] + + + + + + + @@ -349,13 +356,6 @@ kube-apiserver [flags] - - - - - - - @@ -391,13 +391,6 @@ kube-apiserver [flags] - - - - - - - @@ -444,14 +437,21 @@ kube-apiserver [flags] - + + + + + + + + - + @@ -476,10 +476,10 @@ kube-apiserver [flags] - + - + @@ -570,7 +570,7 @@ kube-apiserver [flags] - + @@ -622,13 +622,6 @@ kube-apiserver [flags] - - - - - - - @@ -643,6 +636,13 @@ kube-apiserver [flags] + + + + + + + @@ -664,6 +664,13 @@ kube-apiserver [flags] + + + + + + + @@ -889,7 +896,7 @@ kube-apiserver [flags] - + @@ -902,6 +909,13 @@ kube-apiserver [flags] + + + + + + + @@ -909,6 +923,13 @@ kube-apiserver [flags] + + + + + + + @@ -948,14 +969,14 @@ kube-apiserver [flags] - + - + @@ -1019,3 +1040,5 @@ kube-apiserver [flags] +{{% /capture %}} + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md b/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md index 96bf082e5a..ea52f59b4f 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md @@ -1,12 +1,10 @@ --- title: kube-controller-manager -notitle: true +content_template: templates/tool-reference +weight: 28 --- -## kube-controller-manager - - -### Synopsis +{{% capture synopsis %}} The Kubernetes controller manager is a daemon that embeds @@ -22,7 +20,9 @@ controller, and serviceaccounts controller. kube-controller-manager [flags] ``` -### Options +{{% /capture %}} + +{{% capture options %}}
--add-dir-header
If true, adds the file directory to the header
--admission-control-config-file string
Path to the file containing Azure container registry configuration information.
--basic-auth-file string
If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.
--bind-address ip     Default: 0.0.0.0
The provider for cloud services. Empty string for no provider.
--cloud-provider-gce-lb-src-cidrs cidrs     Default: 130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
CIDRs opened in GCE firewall for LB traffic proxy & health checks
--contention-profiling
--disable-admission-plugins stringSlice
admission plugins that should be disabled although they are in the default enabled plugins list (NamespaceLifecycle, LimitRanger, ServiceAccount, TaintNodesByCondition, Priority, DefaultTolerationSeconds, DefaultStorageClass, PersistentVolumeClaimResize, MutatingAdmissionWebhook, ValidatingAdmissionWebhook, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.admission plugins that should be disabled although they are in the default enabled plugins list (NamespaceLifecycle, LimitRanger, ServiceAccount, TaintNodesByCondition, Priority, DefaultTolerationSeconds, DefaultStorageClass, StorageObjectInUseProtection, PersistentVolumeClaimResize, MutatingAdmissionWebhook, ValidatingAdmissionWebhook, RuntimeClass, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, RuntimeClass, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.
--egress-selector-config-file string
File with apiserver egress selector configuration.
--enable-admission-plugins stringSlice
admission plugins that should be enabled in addition to default enabled ones (NamespaceLifecycle, LimitRanger, ServiceAccount, TaintNodesByCondition, Priority, DefaultTolerationSeconds, DefaultStorageClass, PersistentVolumeClaimResize, MutatingAdmissionWebhook, ValidatingAdmissionWebhook, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.admission plugins that should be enabled in addition to default enabled ones (NamespaceLifecycle, LimitRanger, ServiceAccount, TaintNodesByCondition, Priority, DefaultTolerationSeconds, DefaultStorageClass, StorageObjectInUseProtection, PersistentVolumeClaimResize, MutatingAdmissionWebhook, ValidatingAdmissionWebhook, RuntimeClass, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, RuntimeClass, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.
--enable-logs-handler     Default: true--enable-inflight-quota-handler
If true, install a /logs handler for the apiserver logs.If true, replace the max-in-flight handler with an enhanced one that queues and dispatches with priority and fairness
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIDriverRegistry=true|false (ALPHA - default=false)
CSINodeInfo=true|false (ALPHA - default=false)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
CustomResourceWebhookConversion=true|false (ALPHA - default=false)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
EvenPodsSpread=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPodResources=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeLease=true|false (ALPHA - default=false)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=true)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (ALPHA - default=false)
RuntimeClass=true|false (ALPHA - default=false)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
ValidateProxyRedirects=true|false (ALPHA - default=false)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (BETA - default=true)
CSIDriverRegistry=true|false (BETA - default=true)
CSIInlineVolume=true|false (BETA - default=true)
CSIMigration=true|false (ALPHA - default=false)
CSIMigrationAWS=true|false (ALPHA - default=false)
CSIMigrationAzureDisk=true|false (ALPHA - default=false)
CSIMigrationAzureFile=true|false (ALPHA - default=false)
CSIMigrationGCE=true|false (ALPHA - default=false)
CSIMigrationOpenStack=true|false (ALPHA - default=false)
CSINodeInfo=true|false (BETA - default=true)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomResourceDefaulting=true|false (BETA - default=true)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EndpointSlice=true|false (ALPHA - default=false)
EphemeralContainers=true|false (ALPHA - default=false)
EvenPodsSpread=true|false (ALPHA - default=false)
ExpandCSIVolumes=true|false (BETA - default=true)
ExpandInUsePersistentVolumes=true|false (BETA - default=true)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HPAScaleToZero=true|false (ALPHA - default=false)
HyperVContainer=true|false (ALPHA - default=false)
IPv6DualStack=true|false (ALPHA - default=false)
KubeletPodResources=true|false (BETA - default=true)
LegacyNodeRoleBehavior=true|false (ALPHA - default=true)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeDisruptionExclusion=true|false (ALPHA - default=false)
NodeLease=true|false (BETA - default=true)
NonPreemptingPriority=true|false (ALPHA - default=false)
PodOverhead=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
RemainingItemCount=true|false (BETA - default=true)
RemoveSelfLink=true|false (ALPHA - default=false)
RequestManagement=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (BETA - default=true)
RuntimeClass=true|false (BETA - default=true)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServerSideApply=true|false (BETA - default=true)
ServiceLoadBalancerFinalizer=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StartupProbe=true|false (ALPHA - default=false)
StorageVersionHash=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportNodePidsLimit=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (BETA - default=true)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
TopologyManager=true|false (ALPHA - default=false)
ValidateProxyRedirects=true|false (BETA - default=true)
VolumePVCDataSource=true|false (BETA - default=true)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (BETA - default=true)
WatchBookmark=true|false (BETA - default=true)
WinDSR=true|false (ALPHA - default=false)
WinOverlay=true|false (ALPHA - default=false)
WindowsGMSA=true|false (BETA - default=true)
WindowsRunAsUserName=true|false (ALPHA - default=false)
List of the preferred NodeAddressTypes to use for kubelet connections.
--kubelet-read-only-port uint     Default: 10255
DEPRECATED: kubelet port.
--kubelet-timeout duration     Default: 5s
If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP.
--livez-grace-period duration
This option represents the maximum amount of time it should take for apiserver to complete its startup sequence and become live. From apiserver's start time to when this amount of time has elapsed, /livez will assume that unfinished post-start hooks will complete successfully and therefore return true.
--log-backtrace-at traceLocation     Default: :0
If non-empty, use this log file
--log-file-max-size uint     Default: 1800
Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited.
--log-flush-frequency duration     Default: 5s
--service-cluster-ip-range ipNet     Default: 10.0.0.0/24--service-cluster-ip-range string     Default: "10.0.0.0/24"
A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range.
--shutdown-delay-duration duration
Time to delay the termination. During that time the server keeps serving requests normally and /healthz returns success, but /readzy immediately returns failure. Graceful termination starts after this delay has elapsed. This can be used to allow load balancer to stop sending traffic to this server.
--skip-headers
If true, avoid header prefixes in the log messages
--skip-log-headers
If true, avoid headers when opening log files
--stderrthreshold severity     Default: 2
--tls-cipher-suites stringSlice
Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHAComma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be use. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA
--tls-min-version string
Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
@@ -31,6 +31,13 @@ kube-controller-manager [flags] + + + + + + + @@ -227,6 +234,13 @@ kube-controller-manager [flags] + + + + + + + @@ -241,6 +255,13 @@ kube-controller-manager [flags] + + + + + + + @@ -280,7 +301,7 @@ kube-controller-manager [flags] - + @@ -325,6 +346,13 @@ kube-controller-manager [flags] + + + + + + + @@ -343,7 +371,7 @@ kube-controller-manager [flags] - + @@ -465,6 +493,20 @@ kube-controller-manager [flags] + + + + + + + + + + + + + + @@ -493,6 +535,13 @@ kube-controller-manager [flags] + + + + + + + @@ -514,6 +563,13 @@ kube-controller-manager [flags] + + + + + + + @@ -717,6 +773,13 @@ kube-controller-manager [flags] + + + + + + + @@ -749,7 +812,7 @@ kube-controller-manager [flags] - + @@ -806,3 +869,5 @@ kube-controller-manager [flags] +{{% /capture %}} + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-proxy.md b/content/en/docs/reference/command-line-tools-reference/kube-proxy.md index 5f88eb917c..d979042056 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-proxy.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-proxy.md @@ -1,12 +1,10 @@ --- title: kube-proxy -notitle: true +content_template: templates/tool-reference +weight: 28 --- -## kube-proxy - - -### Synopsis +{{% capture synopsis %}} The Kubernetes network proxy runs on each node. This @@ -21,7 +19,9 @@ with the apiserver API to configure the proxy. kube-proxy [flags] ``` -### Options +{{% /capture %}} + +{{% capture options %}}
--add-dir-header
If true, adds the file directory to the header
--allocate-node-cidrs
The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load
--concurrent-service-endpoint-syncs int32     Default: 5
The number of service endpoint syncing operations that will be done concurrently. Larger number = faster endpoint slice updating, but more CPU (and network) load. Defaults to 5.
--concurrent-service-syncs int32     Default: 1
The number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) load
--concurrent-statefulset-syncs int32     Default: 5
The number of statefulset objects that are allowed to sync concurrently. Larger number = more responsive statefulsets, but more CPU (and network) load
--concurrent-ttl-after-finished-syncs int32     Default: 5
--controllers stringSlice     Default: [*]
A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'.
All controllers: attachdetach, bootstrapsigner, cloud-node-lifecycle, clusterrole-aggregation, cronjob, csrapproving, csrcleaner, csrsigning, daemonset, deployment, disruption, endpoint, garbagecollector, horizontalpodautoscaling, job, namespace, nodeipam, nodelifecycle, persistentvolume-binder, persistentvolume-expander, podgc, pv-protection, pvc-protection, replicaset, replicationcontroller, resourcequota, root-ca-cert-publisher, route, service, serviceaccount, serviceaccount-token, statefulset, tokencleaner, ttl, ttl-after-finished
Disabled-by-default controllers: bootstrapsigner, tokencleaner
A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'.
All controllers: attachdetach, bootstrapsigner, cloud-node-lifecycle, clusterrole-aggregation, cronjob, csrapproving, csrcleaner, csrsigning, daemonset, deployment, disruption, endpoint, endpointslice, garbagecollector, horizontalpodautoscaling, job, namespace, nodeipam, nodelifecycle, persistentvolume-binder, persistentvolume-expander, podgc, pv-protection, pvc-protection, replicaset, replicationcontroller, resourcequota, root-ca-cert-publisher, route, service, serviceaccount, serviceaccount-token, statefulset, tokencleaner, ttl, ttl-after-finished
Disabled-by-default controllers: bootstrapsigner, endpointslice, tokencleaner
WARNING: Beta feature. If set to true enables NoExecute Taints and will evict all not-tolerating Pod running on Nodes tainted with this kind of Taints.
--endpoint-updates-batch-period duration
The length of endpoint updates batching period. Processing of pod changes will be delayed by this duration to join them with potential upcoming updates and reduce the overall number of endpoints updates. Larger number = higher endpoint programming latency, but lower number of endpoints revision generated
--experimental-cluster-signing-duration duration     Default: 8760h0m0s
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIDriverRegistry=true|false (ALPHA - default=false)
CSINodeInfo=true|false (ALPHA - default=false)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
CustomResourceWebhookConversion=true|false (ALPHA - default=false)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPodResources=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeLease=true|false (ALPHA - default=false)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=true)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (ALPHA - default=false)
RuntimeClass=true|false (ALPHA - default=false)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
ValidateProxyRedirects=true|false (ALPHA - default=false)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (BETA - default=true)
CSIDriverRegistry=true|false (BETA - default=true)
CSIInlineVolume=true|false (BETA - default=true)
CSIMigration=true|false (ALPHA - default=false)
CSIMigrationAWS=true|false (ALPHA - default=false)
CSIMigrationAzureDisk=true|false (ALPHA - default=false)
CSIMigrationAzureFile=true|false (ALPHA - default=false)
CSIMigrationGCE=true|false (ALPHA - default=false)
CSIMigrationOpenStack=true|false (ALPHA - default=false)
CSINodeInfo=true|false (BETA - default=true)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomResourceDefaulting=true|false (BETA - default=true)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EndpointSlice=true|false (ALPHA - default=false)
EphemeralContainers=true|false (ALPHA - default=false)
EvenPodsSpread=true|false (ALPHA - default=false)
ExpandCSIVolumes=true|false (BETA - default=true)
ExpandInUsePersistentVolumes=true|false (BETA - default=true)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HPAScaleToZero=true|false (ALPHA - default=false)
HyperVContainer=true|false (ALPHA - default=false)
IPv6DualStack=true|false (ALPHA - default=false)
KubeletPodResources=true|false (BETA - default=true)
LegacyNodeRoleBehavior=true|false (ALPHA - default=true)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeDisruptionExclusion=true|false (ALPHA - default=false)
NodeLease=true|false (BETA - default=true)
NonPreemptingPriority=true|false (ALPHA - default=false)
PodOverhead=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
RemainingItemCount=true|false (BETA - default=true)
RemoveSelfLink=true|false (ALPHA - default=false)
RequestManagement=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (BETA - default=true)
RuntimeClass=true|false (BETA - default=true)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServerSideApply=true|false (BETA - default=true)
ServiceLoadBalancerFinalizer=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StartupProbe=true|false (ALPHA - default=false)
StorageVersionHash=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportNodePidsLimit=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (BETA - default=true)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
TopologyManager=true|false (ALPHA - default=false)
ValidateProxyRedirects=true|false (BETA - default=true)
VolumePVCDataSource=true|false (BETA - default=true)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (BETA - default=true)
WatchBookmark=true|false (BETA - default=true)
WinDSR=true|false (ALPHA - default=false)
WinOverlay=true|false (ALPHA - default=false)
WindowsGMSA=true|false (BETA - default=true)
WindowsRunAsUserName=true|false (ALPHA - default=false)
The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.
--leader-elect-resource-name string     Default: "kube-controller-manager"
The name of resource object that is used for locking during leader election.
--leader-elect-resource-namespace string     Default: "kube-system"
The namespace of resource object that is used for locking during leader election.
--leader-elect-retry-period duration     Default: 2s
If non-empty, use this log file
--log-file-max-size uint     Default: 1800
Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited.
--log-flush-frequency duration     Default: 5s
The address of the Kubernetes API server (overrides any value in kubeconfig).
--max-endpoints-per-slice int32     Default: 100
The maximum number of endpoints that will be added to an EndpointSlice. More endpoints per slice will result in less endpoint slices, but larger resources. Defaults to 100.
--min-resync-period duration     Default: 12h0m0s
If true, avoid header prefixes in the log messages
--skip-log-headers
If true, avoid headers when opening log files
--stderrthreshold severity     Default: 2
--tls-min-version string
Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
@@ -55,7 +55,7 @@ kube-proxy [flags] - + @@ -111,7 +111,7 @@ kube-proxy [flags] - + @@ -184,6 +184,13 @@ kube-proxy [flags] + + + + + + + @@ -279,7 +286,7 @@ kube-proxy [flags] - + @@ -315,3 +322,5 @@ kube-proxy [flags] +{{% /capture %}} + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md b/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md index 4dc69709dc..ae5819ad5d 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md @@ -1,12 +1,10 @@ --- title: kube-scheduler -notitle: true +content_template: templates/tool-reference +weight: 28 --- -## kube-scheduler - - -### Synopsis +{{% capture synopsis %}} The Kubernetes scheduler is a policy-rich, topology-aware, @@ -21,7 +19,9 @@ through the API as necessary. kube-scheduler [flags] ``` -### Options +{{% /capture %}} + +{{% capture options %}}
--cleanup-ipvs     Default: true
If true make kube-proxy cleanup ipvs rules before running. Default is trueIf true and --cleanup is specified, kube-proxy will also flush IPVS rules, in addition to normal cleanup.
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIDriverRegistry=true|false (ALPHA - default=false)
CSINodeInfo=true|false (ALPHA - default=false)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
CustomResourceWebhookConversion=true|false (ALPHA - default=false)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPodResources=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeLease=true|false (ALPHA - default=false)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=true)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (ALPHA - default=false)
RuntimeClass=true|false (ALPHA - default=false)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
ValidateProxyRedirects=true|false (ALPHA - default=false)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (BETA - default=true)
CSIDriverRegistry=true|false (BETA - default=true)
CSIInlineVolume=true|false (BETA - default=true)
CSIMigration=true|false (ALPHA - default=false)
CSIMigrationAWS=true|false (ALPHA - default=false)
CSIMigrationAzureDisk=true|false (ALPHA - default=false)
CSIMigrationAzureFile=true|false (ALPHA - default=false)
CSIMigrationGCE=true|false (ALPHA - default=false)
CSIMigrationOpenStack=true|false (ALPHA - default=false)
CSINodeInfo=true|false (BETA - default=true)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomResourceDefaulting=true|false (BETA - default=true)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EndpointSlice=true|false (ALPHA - default=false)
EphemeralContainers=true|false (ALPHA - default=false)
EvenPodsSpread=true|false (ALPHA - default=false)
ExpandCSIVolumes=true|false (BETA - default=true)
ExpandInUsePersistentVolumes=true|false (BETA - default=true)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HPAScaleToZero=true|false (ALPHA - default=false)
HyperVContainer=true|false (ALPHA - default=false)
IPv6DualStack=true|false (ALPHA - default=false)
KubeletPodResources=true|false (BETA - default=true)
LegacyNodeRoleBehavior=true|false (ALPHA - default=true)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeDisruptionExclusion=true|false (ALPHA - default=false)
NodeLease=true|false (BETA - default=true)
NonPreemptingPriority=true|false (ALPHA - default=false)
PodOverhead=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
RemainingItemCount=true|false (BETA - default=true)
RemoveSelfLink=true|false (ALPHA - default=false)
RequestManagement=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (BETA - default=true)
RuntimeClass=true|false (BETA - default=true)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServerSideApply=true|false (BETA - default=true)
ServiceLoadBalancerFinalizer=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StartupProbe=true|false (ALPHA - default=false)
StorageVersionHash=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportNodePidsLimit=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (BETA - default=true)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
TopologyManager=true|false (ALPHA - default=false)
ValidateProxyRedirects=true|false (BETA - default=true)
VolumePVCDataSource=true|false (BETA - default=true)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (BETA - default=true)
WatchBookmark=true|false (BETA - default=true)
WinDSR=true|false (ALPHA - default=false)
WinOverlay=true|false (ALPHA - default=false)
WindowsGMSA=true|false (BETA - default=true)
WindowsRunAsUserName=true|false (ALPHA - default=false)
The ipvs scheduler type when proxy mode is ipvs
--ipvs-strict-arp
Enable strict ARP by setting arp_ignore to 1 and arp_announce to 2
--ipvs-sync-period duration     Default: 30s
--proxy-mode ProxyMode
Which proxy mode to use: 'userspace' (older) or 'iptables' (faster) or 'ipvs' (experimental). If blank, use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy.Which proxy mode to use: 'userspace' (older) or 'iptables' (faster) or 'ipvs'. If blank, use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy.
@@ -30,6 +30,13 @@ kube-scheduler [flags] + + + + + + + @@ -153,7 +160,14 @@ kube-scheduler [flags] - + + + + + + + + @@ -226,6 +240,20 @@ kube-scheduler [flags] + + + + + + + + + + + + + + @@ -237,14 +265,14 @@ kube-scheduler [flags] - + - + @@ -268,6 +296,13 @@ kube-scheduler [flags] + + + + + + + @@ -314,7 +349,7 @@ kube-scheduler [flags] - + @@ -380,6 +415,13 @@ kube-scheduler [flags] + + + + + + + @@ -405,7 +447,7 @@ kube-scheduler [flags] - + @@ -462,3 +504,5 @@ kube-scheduler [flags] +{{% /capture %}} + diff --git a/content/en/docs/reference/command-line-tools-reference/kubelet.md b/content/en/docs/reference/command-line-tools-reference/kubelet.md index 1b0201e87f..b9191494d9 100644 --- a/content/en/docs/reference/command-line-tools-reference/kubelet.md +++ b/content/en/docs/reference/command-line-tools-reference/kubelet.md @@ -1,49 +1,33 @@ --- title: kubelet -notitle: true +content_template: templates/tool-reference +weight: 28 --- -## kubelet - - - -### Synopsis +{{% capture synopsis %}} The kubelet is the primary "node agent" that runs on each -node. The kubelet works in terms of a PodSpec. A PodSpec is a YAML or JSON object -that describes a pod. The kubelet takes a set of PodSpecs that are provided through -various mechanisms (primarily through the apiserver) and ensures that the containers -described in those PodSpecs are running and healthy. The kubelet doesn't manage -containers which were not created by Kubernetes. +node. It can register the node with the apiserver using one of: the hostname; a flag to override the hostname; or specific logic for a cloud provider. -Other than from a PodSpec from the apiserver, there are three ways that a container -manifest can be provided to the Kubelet. +The kubelet works in terms of a PodSpec. A PodSpec is a YAML or JSON object +that describes a pod. The kubelet takes a set of PodSpecs that are provided through various mechanisms (primarily through the apiserver) and ensures that the containers described in those PodSpecs are running and healthy. The kubelet doesn't manage containers which were not created by Kubernetes. -File: Path passed as a flag on the command line. Files under this path will be monitored -periodically for updates. The monitoring period is 20s by default and is configurable -via a flag. +Other than from an PodSpec from the apiserver, there are three ways that a container manifest can be provided to the Kubelet. -HTTP endpoint: HTTP endpoint passed as a parameter on the command line. This endpoint -is checked every 20 seconds (also configurable with a flag). +File: Path passed as a flag on the command line. Files under this path will be monitored periodically for updates. The monitoring period is 20s by default and is configurable via a flag. -HTTP server: The kubelet can also listen for HTTP and respond to a simple API -(underspec'd currently) to submit a new manifest. - -#### Pod Lifecycle Event Generator (PLEG) - -The Pod Lifecycle Event Generator is a function of the kubelet that creates a list of -the states for all containers and pods then compares it to the previous states of the -containers and pods in a process called Relisting. This allows the PLEG to know which -pods and containers need to be synced. In versions prior to 1.2, this was accomplished -by polling and was CPU intensive. By changing to this method, this significantly reduced -resource utilization allowing for better container density. +HTTP endpoint: HTTP endpoint passed as a parameter on the command line. This endpoint is checked every 20 seconds (also configurable with a flag). +HTTP server: The kubelet can also listen for HTTP and respond to a simple API (underspec'd currently) to submit a new manifest. ``` kubelet [flags] ``` -### Options +{{% /capture %}} + + +{{% capture options %}}
--add-dir-header
If true, adds the file directory to the header
--address string     Default: "0.0.0.0"
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIDriverRegistry=true|false (ALPHA - default=false)
CSINodeInfo=true|false (ALPHA - default=false)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
CustomResourceWebhookConversion=true|false (ALPHA - default=false)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
EvenPodsSpread=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPodResources=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeLease=true|false (ALPHA - default=false)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=true)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (ALPHA - default=false)
RuntimeClass=true|false (ALPHA - default=false)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
ValidateProxyRedirects=true|false (ALPHA - default=false)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (BETA - default=true)
CSIDriverRegistry=true|false (BETA - default=true)
CSIInlineVolume=true|false (BETA - default=true)
CSIMigration=true|false (ALPHA - default=false)
CSIMigrationAWS=true|false (ALPHA - default=false)
CSIMigrationAzureDisk=true|false (ALPHA - default=false)
CSIMigrationAzureFile=true|false (ALPHA - default=false)
CSIMigrationGCE=true|false (ALPHA - default=false)
CSIMigrationOpenStack=true|false (ALPHA - default=false)
CSINodeInfo=true|false (BETA - default=true)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomResourceDefaulting=true|false (BETA - default=true)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EndpointSlice=true|false (ALPHA - default=false)
EphemeralContainers=true|false (ALPHA - default=false)
EvenPodsSpread=true|false (ALPHA - default=false)
ExpandCSIVolumes=true|false (BETA - default=true)
ExpandInUsePersistentVolumes=true|false (BETA - default=true)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HPAScaleToZero=true|false (ALPHA - default=false)
HyperVContainer=true|false (ALPHA - default=false)
IPv6DualStack=true|false (ALPHA - default=false)
KubeletPodResources=true|false (BETA - default=true)
LegacyNodeRoleBehavior=true|false (ALPHA - default=true)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeDisruptionExclusion=true|false (ALPHA - default=false)
NodeLease=true|false (BETA - default=true)
NonPreemptingPriority=true|false (ALPHA - default=false)
PodOverhead=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
RemainingItemCount=true|false (BETA - default=true)
RemoveSelfLink=true|false (ALPHA - default=false)
RequestManagement=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (BETA - default=true)
RuntimeClass=true|false (BETA - default=true)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServerSideApply=true|false (BETA - default=true)
ServiceLoadBalancerFinalizer=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StartupProbe=true|false (ALPHA - default=false)
StorageVersionHash=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportNodePidsLimit=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (BETA - default=true)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
TopologyManager=true|false (ALPHA - default=false)
ValidateProxyRedirects=true|false (BETA - default=true)
VolumePVCDataSource=true|false (BETA - default=true)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (BETA - default=true)
WatchBookmark=true|false (BETA - default=true)
WinDSR=true|false (ALPHA - default=false)
WinOverlay=true|false (ALPHA - default=false)
WindowsGMSA=true|false (BETA - default=true)
WindowsRunAsUserName=true|false (ALPHA - default=false)
--hard-pod-affinity-symmetric-weight int32     Default: 1
DEPRECATED: RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule corresponding to every RequiredDuringScheduling affinity rule. --hard-pod-affinity-symmetric-weight represents the weight of implicit PreferredDuringScheduling affinity rule. Must be in the range 0-100.This option was moved to the policy configuration file
The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.
--leader-elect-resource-name string     Default: "kube-scheduler"
The name of resource object that is used for locking during leader election.
--leader-elect-resource-namespace string     Default: "kube-system"
The namespace of resource object that is used for locking during leader election.
--leader-elect-retry-period duration     Default: 2s
--lock-object-name string     Default: "kube-scheduler"
DEPRECATED: define the name of the lock object.DEPRECATED: define the name of the lock object. Will be removed in favor of leader-elect-resource-name
--lock-object-namespace string     Default: "kube-system"
DEPRECATED: define the namespace of the lock object.DEPRECATED: define the namespace of the lock object. Will be removed in favor of leader-elect-resource-namespace.
If non-empty, use this log file
--log-file-max-size uint     Default: 1800
Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited.
--log-flush-frequency duration     Default: 5s
--port int     Default: 10251
DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve plain HTTP at all. See --secure-port instead.
If true, avoid header prefixes in the log messages
--skip-log-headers
If true, avoid headers when opening log files
--stderrthreshold severity     Default: 2
--tls-min-version string
Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
@@ -52,11 +36,25 @@ kubelet [flags] + + + + + + + - + + + + + + + + @@ -70,65 +68,63 @@ kubelet [flags] - + - + - + - + - + - + - + - - + - - + - + @@ -156,94 +152,115 @@ kubelet [flags] - + - + - + - + - + - + - + - + - + - + - + - - + + - + - - + + - - - - - - - - + - + + + + + + + + - + - + + + + + + + + - + - + + + + + + + + + + + + + + + @@ -254,84 +271,77 @@ kubelet [flags] - + - - - - - + + - - - - - + - + + + + + + + + - + - + - - - - - + + - - - - - + - + - + @@ -345,35 +355,42 @@ kubelet [flags] - + - + - + - + - + + + + + + + + @@ -387,14 +404,14 @@ kubelet [flags] - + - + @@ -408,77 +425,77 @@ kubelet [flags] - + - + - + - + - + - + - + - + - + - + - + @@ -492,21 +509,14 @@ kubelet [flags] - - - - - + + - - - - - + @@ -530,96 +540,68 @@ kubelet [flags] - - - - - - - - + - + - + - - - - - + + - - - - - + - + - + - + - - + + - + - - - - - - - - - - - - - - - + @@ -633,91 +615,91 @@ kubelet [flags] - + - + - + - + - + - + - + - + - - - - - + + - - - - - + - - + + - + - - + + + + + + + + + - + - + - + - + - + - + @@ -731,10 +713,10 @@ kubelet [flags] - + - + @@ -752,7 +734,7 @@ kubelet [flags] - + @@ -761,6 +743,21 @@ kubelet [flags] + + + + + + + + + + + + + + @@ -780,63 +777,84 @@ kubelet [flags] - + - + - + - + - + - - + + + + + + + + - + - + - + + + + + + + + + + + + + + + - + - + - + @@ -850,63 +868,84 @@ kubelet [flags] - + - + + + + + + + + - + - + + + + + + + + - + - + - + - + - + + + + + + + + - + - + - + @@ -916,11 +955,18 @@ kubelet [flags] + + + + + + + - + @@ -930,6 +976,13 @@ kubelet [flags] + + + + + + + @@ -937,32 +990,39 @@ kubelet [flags] - + + + + + + + + - + - + - + - + - + @@ -976,14 +1036,14 @@ kubelet [flags] - + - + @@ -1004,7 +1064,7 @@ kubelet [flags] - + @@ -1018,7 +1078,21 @@ kubelet [flags] - + + + + + + + + + + + + + + + @@ -1032,112 +1106,127 @@ kubelet [flags] - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + - + - + + + + + + + + + - + @@ -1165,15 +1254,9 @@ kubelet [flags] - + - - - - - - - -
--add-dir-header
If true, adds the file directory to the header
--address 0.0.0.0
The IP address for the Kubelet to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces) (default 0.0.0.0)The IP address for the Kubelet to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces) (default 0.0.0.0) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--allowed-unsafe-sysctls strings
Comma-separated whitelist of unsafe sysctls or unsafe sysctl patterns (ending in *). Use these at your own risk. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--anonymous-auth
Enables anonymous requests to the Kubelet server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated. (default true)Enables anonymous requests to the Kubelet server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated. (default true) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--application-metrics-count-limit int
Max number of application metrics to store (per container) (default 100) Max number of application metrics to store (per container) (default 100) (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--authentication-token-webhook
Use the TokenReview API to determine authentication for bearer tokens.Use the TokenReview API to determine authentication for bearer tokens. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--authentication-token-webhook-cache-ttl duration
The duration to cache responses from the webhook token authenticator. (default 2m0s)The duration to cache responses from the webhook token authenticator. (default 2m0s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--authorization-mode string
Authorization mode for Kubelet server. Valid options are AlwaysAllow or Webhook. Webhook mode uses the SubjectAccessReview API to determine authorization. (default "AlwaysAllow")Authorization mode for Kubelet server. Valid options are AlwaysAllow or Webhook. Webhook mode uses the SubjectAccessReview API to determine authorization. (default "AlwaysAllow") (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--authorization-webhook-cache-authorized-ttl duration
The duration to cache 'authorized' responses from the webhook authorizer. (default 5m0s)The duration to cache 'authorized' responses from the webhook authorizer. (default 5m0s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--authorization-webhook-cache-unauthorized-ttl duration
The duration to cache 'unauthorized' responses from the webhook authorizer. (default 30s)The duration to cache 'unauthorized' responses from the webhook authorizer. (default 30s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--azure-container-registry-config string
Path to the file container Azure container registry configuration information.
--boot-id-file string
Comma-separated list of files to check for boot-id. Use the first one that exists. (default "/proc/sys/kernel/random/boot_id")Comma-separated list of files to check for boot-id. Use the first one that exists. (default "/proc/sys/kernel/random/boot_id") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--cgroup-driver string
Driver that the kubelet uses to manipulate cgroups on the host.Driver that the kubelet uses to manipulate cgroups on the host. Possible values: 'cgroupfs', 'systemd' (default "cgroupfs") (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)/td>
--cgroup-root string
Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--cgroups-per-qos
Enable creation of QoS cgroup hierarchy, if true top level QoS and pod cgroups are created. (default true)Enable creation of QoS cgroup hierarchy, if true top level QoS and pod cgroups are created. (default true) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--chaos-chance float
If > 0.0, introduce random client errors and latency. Intended for testing.
--client-ca-file string
If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--cloud-config string
The path to the cloud provider configuration file.
--cloud-provider string
The provider for cloud services. Specify empty string for running with no cloud provider.The provider for cloud services. Specify empty string for running with no cloud provider. If set, the cloud provider determines the name of the node (consult cloud provider documentation to determine if and how the hostname is used).
--cloud-provider-gce-lb-src-cidrs cidrs
--cluster-dns strings
CIDRs opened in GCE firewall for LB traffic proxy & health checks (default 130.211.0.0/22,35.191.0.0/16,209.85.152.0/22,209.85.204.0/22)Comma-separated list of DNS server IP address. This value is used for containers DNS server in case of Pods with "dnsPolicy=ClusterFirst". Note: all DNS servers appearing in the list MUST serve the same set of records otherwise name resolution within the cluster may not work correctly. There is no guarantee as to which DNS server may be contacted for name resolution. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--cluster-dns stringSlice
--cluster-domain string
Comma-separated list of DNS server IP address.
--cluster-domain string
Domain for this cluster.Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--cni-bin-dir string
The full path of the directory in which to search for CNI plugin binaries. Default: /opt/cni/bin A comma-separated list of full paths of directories in which to search for CNI plugin binaries. This docker-specific flag only works when container-runtime is set to docker. (default "/opt/cni/bin")
--cni-cache-dir string
The full path of the directory in which CNI should store cache files. This docker-specific flag only works when container-runtime is set to docker. (default "/var/lib/cni/cache")
--cni-conf-dir string
The full path of the directory in which to search for CNI config files. Default: /etc/cni/net.d The full path of the directory in which to search for CNI config files. This docker-specific flag only works when container-runtime is set to docker. (default "/etc/cni/net.d")
--config string
The Kubelet will load its initial configuration from this file. The path may be absolute or relative; relative paths start at the Kubelet's current working directory. Omit this flag to use the built-in default configuration values. Command-line flags override configuration from this file.
--container-hints string
location of the container hints file (default "/etc/cadvisor/container_hints.json")location of the container hints file (default "/etc/cadvisor/container_hints.json") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--container-log-max-files int32
Set the maximum number of container log files that can be present for a container. The number must be >= 2. This flag can only be used with --container-runtime=remote. (default 5) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--container-log-max-size string
Set the maximum size (e.g. 10Mi) of container log file before it is rotated. This flag can only be used with --container-runtime=remote. (default "10Mi") (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--container-runtime string
--container-runtime-endpoint string
[Experimental] The endpoint of remote runtime service. Currently unix socket is supported on Linux, and tcp is supported on windows.[Experimental] The endpoint of remote runtime service. Currently unix socket endpoint is supported on Linux, while npipe and tcp endpoints are supported on windows. Examples:'unix:///var/run/dockershim.sock', 'npipe:////./pipe/dockershim' (default "unix:///var/run/dockershim.sock")
--containerd string
containerd endpoint (default "unix:///var/run/containerd.sock")
--containerized containerd endpoint (default "/run/containerd/containerd.sock") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
Experimental support for running kubelet in a container.
--contention-profiling
Enable lock contention profiling, if profiling is enabledEnable lock contention profiling, if profiling is enabled (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--cpu-cfs-quota
Enable CPU CFS quota enforcement for containers that specify CPU limits (default true)Enable CPU CFS quota enforcement for containers that specify CPU limits (default true) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--cpu-cfs-quota-period duration
Sets CPU CFS quota period value, cpu.cfs_period_us, defaults to Linux Kernel default (default 100ms) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--cpu-manager-policy string
CPU Manager policy to use. Possible values: 'none', 'static'. (default "none")CPU Manager policy to use. Possible values: 'none', 'static'. Default: 'none' (default "none") (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--cpu-manager-reconcile-period NodeStatusUpdateFrequency
CPU Manager reconciliation period. Examples: '10s', or '1m'. If not supplied, defaults to NodeStatusUpdateFrequency (default 10s) CPU Manager reconciliation period. Examples: '10s', or '1m'. If not supplied, defaults to NodeStatusUpdateFrequency (default 10s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--docker string
docker endpoint (default "unix:///var/run/docker.sock")
--docker-disable-shared-piddocker endpoint (default "unix:///var/run/docker.sock") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
The Container Runtime Interface (CRI) defaults to using a shared PID namespace for containers in a pod when running with Docker 1.13.1 or higher. Setting this flag reverts to the previous behavior of isolated PID namespaces. This ability will be removed in a future Kubernetes release. (default true)
--docker-endpoint string
Use this for the docker endpoint to communicate with (default "unix:///var/run/docker.sock")Use this for the docker endpoint to communicate with. This docker-specific flag only works when container-runtime is set to docker. (default "unix:///var/run/docker.sock")
--docker-env-metadata-whitelist string
a comma-separated list of environment variable keys that needs to be collected for docker containersa comma-separated list of environment variable keys that needs to be collected for docker containers (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--docker-only
Only report docker containers in addition to root statsOnly report docker containers in addition to root stats (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--docker-tls
use TLS to connect to dockeruse TLS to connect to docker (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--docker-tls-ca string
path to trusted CA (default "ca.pem")path to trusted CA (default "ca.pem") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--docker-tls-cert string
path to client certificate (default "cert.pem")path to client certificate (default "cert.pem") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--docker-tls-key string
path to private key (default "key.pem")path to private key (default "key.pem") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--dynamic-config-dir string
The Kubelet will use this directory for checkpointing downloaded configurations and tracking configuration health. The Kubelet will create this directory if it does not already exist. The path may be absolute or relative; relative paths start at the Kubelet's current working directory. Providing this flag enables dynamic Kubelet configuration. Presently, you must also enable the DynamicKubeletConfig feature gate to pass this flag.The Kubelet will use this directory for checkpointing downloaded configurations and tracking configuration health. The Kubelet will create this directory if it does not already exist. The path may be absolute or relative; relative paths start at the Kubelet's current working directory. Providing this flag enables dynamic Kubelet configuration. The DynamicKubeletConfig feature gate must be enabled to pass this flag; this gate currently defaults to true because the feature is beta.
--enable-cadvisor-json-endpoints
Enable cAdvisor json /spec and /stats/* endpoints. (default true)
--enable-debugging-handlers
Enables server endpoints for log collection and local running of containers and commands (default true)Enables server endpoints for log collection and local running of containers and commands (default true) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--enable-load-reader
Whether to enable cpu load readerWhether to enable cpu load reader (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--enforce-node-allocatable stringSlice
A comma separated list of levels of node allocatable enforcement to be enforced by kubelet. Acceptable options are 'pods', 'system-reserved' & 'kube-reserved'. If the latter two options are specified, '--system-reserved-cgroup' & '--kube-reserved-cgroup' must also be set respectively. See /docs/tasks/administer-cluster/reserve-compute-resources/ for more details. (default [pods])A comma separated list of levels of node allocatable enforcement to be enforced by kubelet. Acceptable options are 'none', 'pods', 'system-reserved', and 'kube-reserved'. If the latter two options are specified, '--system-reserved-cgroup' and '--kube-reserved-cgroup' must also be set, respectively. If 'none' is specified, no additional options should be set. See https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/ for more details. (default [pods]) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--event-burst int32
Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding event-qps. Only used if --event-qps > 0 (default 10)Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding event-qps. Only used if --event-qps > 0 (default 10) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--event-qps int32
If > 0, limit event creations per second to this value. If 0, unlimited. (default 5)If > 0, limit event creations per second to this value. If 0, unlimited. (default 5) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--event-storage-age-limit string
Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types (default "default=0")Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types (default "default=0") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--event-storage-event-limit string
Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types (default "default=0")Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types (default "default=0") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--eviction-hard mapStringString
A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction. (default imagefs.available<15%,memory.available<100Mi,nodefs.available<10%,nodefs.inodesFree<5%)A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction. (default imagefs.available<15%,memory.available<100Mi,nodefs.available<10%,nodefs.inodesFree<5%) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--eviction-max-pod-grace-period int32
Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. If negative, defer to pod specified value. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--eviction-minimum-reclaim mapStringString
A set of minimum reclaims (e.g. imagefs.available=2Gi) that describes the minimum amount of resource the kubelet will reclaim when performing a pod eviction if that resource is under pressure.A set of minimum reclaims (e.g. imagefs.available=2Gi) that describes the minimum amount of resource the kubelet will reclaim when performing a pod eviction if that resource is under pressure. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--eviction-pressure-transition-period duration
Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. (default 5m0s)Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. (default 5m0s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--eviction-soft mapStringString
A set of eviction thresholds (e.g. memory.available<1.5Gi) that if met over a corresponding grace period would trigger a pod eviction.A set of eviction thresholds (e.g. memory.available<1.5Gi) that if met over a corresponding grace period would trigger a pod eviction. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--eviction-soft-grace-period mapStringString
A set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a pod eviction.A set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a pod eviction. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--experimental-allocatable-ignore-eviction
When set to 'true', Hard Eviction Thresholds will be ignored while calculating Node Allocatable. See /docs/tasks/administer-cluster/reserve-compute-resources/ for more details. [default=false]
--experimental-allowed-unsafe-sysctls stringSliceWhen set to 'true', Hard Eviction Thresholds will be ignored while calculating Node Allocatable. See https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/ for more details. [default=false]
Comma-separated whitelist of unsafe sysctls or unsafe sysctl patterns (ending in *). Use these at your own risk.
--experimental-bootstrap-kubeconfig string
deprecated: use --bootstrap-kubeconfig(DEPRECATED: Use --bootstrap-kubeconfig)
[Experimental] Path of mounter binary. Leave empty to use the default mount.
--experimental-qos-reserved mapStringString
A set of ResourceName=Percentage (e.g. memory=50%) pairs that describe how pod resource requests are reserved at the QoS level. Currently only memory is supported. [default=none]
--fail-swap-on
Makes the Kubelet fail to start if swap is enabled on the node.Makes the Kubelet fail to start if swap is enabled on the node. (default true) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AllowExtTrafficLocalEndpoints=true|false
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CSIPersistentVolume=true|false (ALPHA - default=false)
CustomPodDNS=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false
DevicePlugins=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HugePages=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletConfigFile=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (ALPHA - default=false)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (ALPHA - default=false)
PVCProtection=true|false (ALPHA - default=false)
PersistentLocalVolumes=true|false (ALPHA - default=false)
PodPriority=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (ALPHA - default=false)
SupportNodePidsLimit=true|false (BETA - default=true)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
VolumeScheduling=true|false (ALPHA - default=false)
VolumeSubpath=true|false
-
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (BETA - default=true)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (BETA - default=true)
BoundServiceAccountTokenVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true) +
CSIBlockVolume=true|false (BETA - default=true)
CSIDriverRegistry=true|false (BETA - default=true)
CSIInlineVolume=true|false (BETA - default=true)
CSIMigration=true|false (ALPHA - default=false)
CSIMigrationAWS=true|false (ALPHA - default=false)
CSIMigrationAzureDisk=true|false (ALPHA - default=false)
CSIMigrationAzureFile=true|false (ALPHA - default=false)
CSIMigrationGCE=true|false (ALPHA - default=false)
CSIMigrationOpenStack=true|false (ALPHA - default=false)
CSINodeInfo=true|false (BETA - default=true)
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
CustomResourceDefaulting=true|false (BETA - default=true)
DevicePlugins=true|false (BETA - default=true)
DryRun=true|false (BETA - default=true)
DynamicAuditing=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (BETA - default=true)
EndpointSlice=true|false (ALPHA - default=false)
EphemeralContainers=true|false (ALPHA - default=false)
EvenPodsSpread=true|false (ALPHA - default=false)
ExpandCSIVolumes=true|false (BETA - default=true)
ExpandInUsePersistentVolumes=true|false (BETA - default=true)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HPAScaleToZero=true|false (ALPHA - default=false)
HyperVContainer=true|false (ALPHA - default=false)
IPv6DualStack=true|false (ALPHA - default=false)
KubeletPodResources=true|false (BETA - default=true)
LegacyNodeRoleBehavior=true|false (ALPHA - default=true)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
NodeDisruptionExclusion=true|false (ALPHA - default=false)
NodeLease=true|false (BETA - default=true)
NonPreemptingPriority=true|false (ALPHA - default=false)
PodOverhead=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (BETA - default=true)
ProcMountType=true|false (ALPHA - default=false)br/>QOSReserved=true|false (ALPHA - default=false)
RemainingItemCount=true|false (BETA - default=true)
RemoveSelfLink=true|false (ALPHA - default=false)
RequestManagement=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (BETA - default=true)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (BETA - default=true)
RunAsGroup=true|false (BETA - default=true)
RuntimeClass=true|false (BETA - default=true)
SCTPSupport=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (BETA - default=true)
ServerSideApply=true|false (BETA - default=true)
ServiceLoadBalancerFinalizer=true|false (BETA - default=true)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StartupProbe=true|false (ALPHA - default=false)
StorageVersionHash=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportNodePidsLimit=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (BETA - default=true)
Sysctls=true|false (BETA - default=true)
TTLAfterFinished=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (BETA - default=true)
TaintNodesByCondition=true|false (BETA - default=true)
TokenRequest=true|false (BETA - default=true)
TokenRequestProjection=true|false (BETA - default=true)
TopologyManager=true|false (ALPHA - default=false)
ValidateProxyRedirects=true|false (BETA - default=true)
VolumePVCDataSource=true|false (BETA - default=true)
VolumeSnapshotDataSource=true|false (ALPHA - default=false)
VolumeSubpathEnvExpansion=true|false (BETA - default=true)
WatchBookmark=true|false (BETA - default=true)
WinDSR=true|false (ALPHA - default=false)
WinOverlay=true|false (ALPHA - default=false)
WindowsGMSA=true|false (BETA - default=true)
WindowsRunAsUserName=true|false (ALPHA - default=false) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--file-check-frequency duration
Duration between checking config files for new data (default 20s)Duration between checking config files for new data (default 20s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--global-housekeeping-interval duration
Interval between global housekeepings (default 1m0s)
--google-json-key stringInterval between global housekeepings (default 1m0s) (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
The Google Cloud Platform Service Account JSON Key to use for authentication.
--hairpin-mode string
How should the kubelet setup hairpin NAT. This allows endpoints of a Service to loadbalance back to themselves if they should try to access their own Service. Valid values are "promiscuous-bridge", "hairpin-veth" and "none". (default "promiscuous-bridge")How should the kubelet setup hairpin NAT. This allows endpoints of a Service to loadbalance back to themselves if they should try to access their own Service. Valid values are "promiscuous-bridge", "hairpin-veth" and "none". (default "promiscuous-bridge") (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--healthz-bind-address 0.0.0.0
The IP address for the healthz server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces) (default 127.0.0.1)The IP address for the healthz server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces) (default 127.0.0.1) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--healthz-port int32
The port of the localhost healthz endpoint (set to 0 to disable) (default 10248)The port of the localhost healthz endpoint (set to 0 to disable) (default 10248) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--host-ipc-sources stringSlice
-h, --help
Comma-separated list of sources from which the Kubelet allows pods to use the host ipc namespace. (default [*])help for kubelet
--host-network-sources stringSlice
Comma-separated list of sources from which the Kubelet allows pods to use of host network. (default [*])
--host-pid-sources stringSlice
Comma-separated list of sources from which the Kubelet allows pods to use the host pid namespace. (default [*])
--hostname-override string
If non-empty, will use this string as identification instead of the actual hostname.If non-empty, will use this string as identification instead of the actual hostname. If --cloud-provider is set, the cloud provider determines the name of the node (consult cloud provider documentation to determine if and how the hostname is used).
--http-check-frequency duration
Duration between checking http for new data (default 20s)Duration between checking http for new data (default 20s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--image-gc-high-threshold int32
The percent of disk usage after which image garbage collection is always run. (default 85)The percent of disk usage after which image garbage collection is always run. Values must be within the range [0, 100], To disable image garbage collection, set to 100. (default 85) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--image-gc-low-threshold int32
The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. (default 80)The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. Values must be within the range [0, 100] and should not be larger than that of --image-gc-high-threshold. (default 80) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--image-pull-progress-deadline duration
If no pulling progress is made before this deadline, the image pulling will be cancelled. (default 1m0s)If no pulling progress is made before this deadline, the image pulling will be cancelled. This docker-specific flag only works when container-runtime is set to docker. (default 1m0s)
--image-service-endpoint string
[Experimental] The endpoint of remote image service. If not specified, it will be the same with container-runtime-endpoint by default. Currently unix socket is supported on Linux, and tcp is supported on windows.
--init-config-dir string[Experimental] The endpoint of remote image service. If not specified, it will be the same with container-runtime-endpoint by default. Currently unix socket endpoint is supported on Linux, while npipe and tcp endpoints are supported on windows. Examples:'unix:///var/run/dockershim.sock', 'npipe:////./pipe/dockershim'
The Kubelet will look in this directory for the init configuration. The path may be absolute or relative; relative paths start at the Kubelet's current working directory. Omit this argument to use the built-in default configuration values. Presently, you must also enable the KubeletConfigFile feature gate to pass this flag.
--iptables-drop-bit int32
The bit of the fwmark space to mark packets for dropping. Must be within the range [0, 31]. (default 15)The bit of the fwmark space to mark packets for dropping. Must be within the range [0, 31]. (default 15) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--iptables-masquerade-bit int32
The bit of the fwmark space to mark packets for SNAT. Must be within the range [0, 31]. Please match this parameter with corresponding parameter in kube-proxy. (default 14)The bit of the fwmark space to mark packets for SNAT. Must be within the range [0, 31]. Please match this parameter with corresponding parameter in kube-proxy. (default 14) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--keep-terminated-pod-volumes
Keep terminated pod volumes mounted to the node after the pod terminates. Can be useful for debugging volume related issues. (DEPRECATED: will be removed in a future version)
--kube-api-burst int32
Burst to use while talking with kubernetes apiserver (default 10) Burst to use while talking with kubernetes apiserver (default 10) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--kube-api-content-type string
Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf") (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--kube-api-qps int32
QPS to use while talking with kubernetes apiserver (default 5)QPS to use while talking with kubernetes apiserver (default 5) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--kube-reserved mapStringString
A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi,pid=1000) pairs that describe resources reserved for kubernetes system components. Currently cpu, memory, pid, and local ephemeral storage for root file system are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none]A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi) pairs that describe resources reserved for kubernetes system components. Currently cpu, memory and local ephemeral storage for root file system are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none] (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--kube-reserved-cgroup string
Absolute name of the top level cgroup that is used to manage kubernetes components for which compute resources were reserved via '--kube-reserved' flag. Ex. '/kube-reserved'. [default='']Absolute name of the top level cgroup that is used to manage kubernetes components for which compute resources were reserved via '--kube-reserved' flag. Ex. '/kube-reserved'. [default=''] (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--kubelet-cgroups string
Optional absolute name of cgroups to create and run the Kubelet in.Optional absolute name of cgroups to create and run the Kubelet in. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--lock-file string
--log-cadvisor-usage
Whether to log the usage of the cAdvisor containerWhether to log the usage of the cAdvisor container (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
If non-empty, write log files in this directory
--log-file string
If non-empty, use this log file
--log-file-max-size uint
Defines the maximum + size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
--log-flush-frequency duration--machine-id-file string
Comma-separated list of files to check for machine-id. Use the first one that exists. (default "/etc/machine-id,/var/lib/dbus/machine-id")Comma-separated list of files to check for machine-id. Use the first one that exists. (default "/etc/machine-id,/var/lib/dbus/machine-id") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--make-iptables-util-chains
If true, kubelet will ensure iptables utility rules are present on host. (default true)If true, kubelet will ensure iptables utility rules are present on host. (default true) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--manifest-url string
URL for accessing the container manifest URL for accessing additional Pod specifications to run (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--manifest-url-header --manifest-url-header 'a:hello,b:again,c:world' --manifest-url-header 'b:beautiful'
Comma-separated list of HTTP headers to use when accessing the manifest URL. Multiple headers with the same name will be added in the same order provided. This flag can be repeatedly invoked. For example: --manifest-url-header 'a:hello,b:again,c:world' --manifest-url-header 'b:beautiful'Comma-separated list of HTTP headers to use when accessing the url provided to --manifest-url. Multiple headers with the same name will be added in the same order provided. This flag can be repeatedly invoked. For example: --manifest-url-header 'a:hello,b:again,c:world' --manifest-url-header 'b:beautiful' (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--master-service-namespace string
The namespace from which the kubernetes master services should be injected into pods (default "default") (DEPRECATED: This flag will be removed in a future version.)
--max-open-files int
Number of files that can be opened by Kubelet process. (default 1000000)Number of files that can be opened by Kubelet process. (default 1000000) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--max-pods int32
Number of Pods that can run on this Kubelet. (default 110) Number of Pods that can run on this Kubelet. (default 110) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--maximum-dead-containers int32
Maximum number of old instances of containers to retain globally. Each container takes up some disk space. To disable, set to a negative number. (default -1) (DEPRECATED: Use --eviction-hard or --eviction-soft instead. Will be removed in a future version.) + --maximum-dead-containers-per-container int32 Maximum number of old instances to retain per container. Each container takes up some disk space. (default 1) (DEPRECATED: Use --eviction-hard or --eviction-soft instead. Will be removed in a future version.)
--minimum-container-ttl-duration duration
Minimum age for a finished container before it is garbage collected. Examples: '300ms', '10s' or '2h45m' (DEPRECATED: Use --eviction-hard or --eviction-soft instead. Will be removed in a future version.)
--minimum-image-ttl-duration duration
Minimum age for an unused image before it is garbage collected.Minimum age for an unused image before it is garbage collected. Examples: '300ms', '10s' or '2h45m'. (default 2m0s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--network-plugin string
The name of the network plugin to be invoked for various events in kubelet/pod lifecycle The name of the network plugin to be invoked for various events in kubelet/pod lifecycle. This docker-specific flag only works when container-runtime is set to docker.
--network-plugin-mtu int32
The MTU to be passed to the network plugin, to override the default. Set to 0 to use the default 1460 MTU. The MTU to be passed to the network plugin, to override the default. Set to 0 to use the default 1460 MTU. This docker-specific flag only works when container-runtime is set to docker.
--node-labels mapStringString
Labels to add when registering the node in the cluster. Labels to add when registering the node in the cluster. Labels must be key=value pairs separated by ','. Labels in the 'kubernetes.io' namespace must begin with an allowed prefix (kubelet.kubernetes.io, node.kubernetes.io) or be in the specifically allowed set (beta.kubernetes.io/arch, beta.kubernetes.io/instance-type, beta.kubernetes.io/os, failure-domain.beta.kubernetes.io/region, failure-domain.beta.kubernetes.io/zone, failure-domain.kubernetes.io/region, failure-domain.kubernetes.io/zone, kubernetes.io/arch, kubernetes.io/hostname, kubernetes.io/instance-type, kubernetes.io/os)
--node-status-max-images int32
The maximum number of images to report in Node.Status.Images. If -1 is specified, no cap will be applied. (default 50)
--node-status-update-frequency duration
Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. (default 10s)Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. (default 10s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--non-masquerade-cidr string
Traffic to IPs outside this range will use IP masquerade. Set to '0.0.0.0/0' to never masquerade. (default "10.0.0.0/8") (DEPRECATED: will be removed in a future version)
--oom-score-adj int32
The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000] (default -999)The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000] (default -999) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--pod-cidr string
The CIDR to use for pod IP addresses, only used in standalone mode.The CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master. For IPv6, the maximum number of IP's allocated is 65536 (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--pod-infra-container-image string
The image whose network/ipc namespaces containers in each pod will use. (default "k8s.gcr.io/pause:3.1")The image whose network/ipc namespaces containers in each pod will use. This docker-specific flag only works when container-runtime is set to docker. (default "k8s.gcr.io/pause:3.1")
--pod-manifest-path string
Path to the directory containing pod manifest files to run, or the path to a single pod manifest file. Files starting with dots will be ignored.Path to the directory containing static pod files to run, or the path to a single static pod file. Files starting with dots will be ignored. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--pod-max-pids int
Set the maximum number of processes per pod. If -1, the kubelet defaults to the node allocatable pid capacity. (default -1) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--pods-per-core int32
Number of Pods per core that can run on this Kubelet. The total number of Pods on this Kubelet cannot exceed max-pods, so max-pods will be used if this calculation results in a larger number of Pods allowed on the Kubelet. A value of 0 disables this limit.Number of Pods per core that can run on this Kubelet. The total number of Pods on this Kubelet cannot exceed max-pods, so max-pods will be used if this calculation results in a larger number of Pods allowed on the Kubelet. A value of 0 disables this limit. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--port int32
The port for the Kubelet to serve on. (default 10250)The port for the Kubelet to serve on. (default 10250) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--protect-kernel-defaults
Default kubelet behaviour for kernel tuning. If set, kubelet errors if any of kernel tunables is different than kubelet defaults. Default kubelet behaviour for kernel tuning. If set, kubelet errors if any of kernel tunables is different than kubelet defaults. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
Unique identifier for identifying the node in a machine database, i.e cloudprovider
--qos-reserved mapStringString
A set of ResourceName=Percentage (e.g. memory=50%) pairs that describe how pod resource requests are reserved at the QoS level. Currently only memory is supported. Requires the QOSReserved feature gate to be enabled. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--read-only-port int32
The read-only port for the Kubelet to serve on with no authentication/authorization (set to 0 to disable) (default 10255)The read-only port for the Kubelet to serve on with no authentication/authorization (set to 0 to disable) (default 10255) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
If true, when panics occur crash. Intended for testing.
--redirect-container-streaming
Enables container streaming redirect. If false, kubelet will proxy container streaming data between apiserver and container runtime; if true, kubelet will return an http redirect to apiserver, and apiserver will access container runtime directly. The proxy approach is more secure, but introduces some overhead. The redirect approach is more performant, but less secure because the connection between apiserver and container runtime may not be authenticated.
--register-node
Register the node with the apiserver. If --kubeconfig is not provided, this flag is irrelevant, as the Kubelet won't have an apiserver to register with. Default=true. (default true)
--register-schedulable
Register the node as schedulable. Won't have any effect if register-node is false. (default true) (DEPRECATED: will be removed in a future version)
--register-with-taints []api.Taint
Register the node with the given list of taints (comma separated "=:"). No-op if register-node is false.
--registry-burst int32
Maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry-qps. Only used if --registry-qps > 0 (default 10)Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry-qps. Only used if --registry-qps > 0 (default 10) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--registry-qps int32
If > 0, limit registry pull QPS to this value.If > 0, limit registry pull QPS to this value. If 0, unlimited. (default 5) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--resolv-conf string
Resolver configuration file used as the basis for the container DNS resolution configuration. (default "/etc/resolv.conf")Resolver configuration file used as the basis for the container DNS resolution configuration. (default "/etc/resolv.conf") (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--rotate-certificates
Auto rotate the kubelet client certificates by requesting new certificates from the kube-apiserver when the certificate expiration approaches. Auto rotate the kubelet client certificates by requesting new certificates from the kube-apiserver when the certificate expiration approaches. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--rotate-server-certificates
Auto-request and rotate the kubelet serving certificates by requesting new certificates from the kube-apiserver when the certificate expiration approaches. Requires the RotateKubeletServerCertificate feature gate to be enabled, and approval of the submitted CertificateSigningRequest objects.Auto-request and rotate the kubelet serving certificates by requesting new certificates from the kube-apiserver when the certificate expiration approaches. Requires the RotateKubeletServerCertificate feature gate to be enabled, and approval of the submitted CertificateSigningRequest objects. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--runtime-request-timeout duration
Timeout of all runtime requests except long running request - pull, logs, exec and attach. When timeout exceeded, kubelet will cancel the request, throw out an error and retry later. (default 2m0s)Timeout of all runtime requests except long running request - pull, logs, exec and attach. When timeout exceeded, kubelet will cancel the request, throw out an error and retry later. (default 2m0s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--serialize-image-pulls
Pull images one at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Issue #10959 has more details. (default true)Pull images one at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Issue #10959 has more details. (default true) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--skip-headers
If true, avoid header prefixes in the log messages
--skip-log-headers
If true, avoid headers when opening log files
--storage-driver-buffer-duration duration
Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction (default 1m0s)Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction (default 1m0s) (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--storage-driver-db string
database name (default "cadvisor")database name (default "cadvisor") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--storage-driver-host string
database host:port (default "localhost:8086")database host:port (default "localhost:8086") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--storage-driver-password string
database password (default "root")database password (default "root") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--storage-driver-secure
use secure connection with databaseuse secure connection with database (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--storage-driver-table string
table name (default "stats")table name (default "stats") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--storage-driver-user string
database username (default "root") database username (default "root") (DEPRECATED: This is a cadvisor flag that was mistakenly registered with the Kubelet. Due to legacy concerns, it will follow the standard CLI deprecation timeline before being removed.)
--streaming-connection-idle-timeout duration
Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: '5m' (default 4h0m0s)Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: '5m' (default 4h0m0s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--sync-frequency duration
Max period between synchronizing running containers and config (default 1m0s)Max period between synchronizing running containers and config (default 1m0s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--system-cgroups /
Optional absolute name of cgroups in which to place all non-kernel processes that are not already inside a cgroup under /. Empty for no container. Rolling back the flag requires a reboot.Optional absolute name of cgroups in which to place all non-kernel processes that are not already inside a cgroup under /. Empty for no container. Rolling back the flag requires a reboot. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--system-reserved mapStringString
A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi,pid=1000) pairs that describe resources reserved for non-kubernetes components. Currently only cpu, memory, and pid are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none]A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi) pairs that describe resources reserved for non-kubernetes components. Currently only cpu and memory are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none] (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--system-reserved-cgroup string
Absolute name of the top level cgroup that is used to manage non-kubernetes components for which compute resources were reserved via '--system-reserved' flag. Ex. '/system-reserved'. [default='']Absolute name of the top level cgroup that is used to manage non-kubernetes components for which compute resources were reserved via '--system-reserved' flag. Ex. '/system-reserved'. [default=''] (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--tls-cert-file string
File containing x509 Certificate used for serving HTTPS (with intermediate certs, if any, concatenated after server cert). If --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert-dir.File containing x509 Certificate used for serving HTTPS (with intermediate certs, if any, concatenated after server cert). If --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert-dir. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--tls-cipher-suites stringSlice
Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHAComma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--tls-min-version string
Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--tls-private-key-file string
File containing x509 private key matching --tls-cert-file.File containing x509 private key matching --tls-cert-file. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
--topology-manager-policy string
Topology Manager policy to use. Possible values: 'none', 'best-effort', 'restricted', 'single-numa-node'. (default "none") (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
-v, --v Level
log level for V logsnumber for the log level verbosity
--volume-stats-agg-period duration
Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes.Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to 0. (default 1m0s) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
-h, --help
help for kubelet
+ +{{% /capture %}} diff --git a/content/en/docs/reference/kubectl/kubectl.md b/content/en/docs/reference/kubectl/kubectl.md index 04911571fc..1b0dcb0344 100644 --- a/content/en/docs/reference/kubectl/kubectl.md +++ b/content/en/docs/reference/kubectl/kubectl.md @@ -1,12 +1,10 @@ --- title: kubectl -notitle: true +content_template: templates/tool-reference +weight: 28 --- -## kubectl -kubectl controls the Kubernetes cluster manager - -### Synopsis +{{% capture synopsis %}} kubectl controls the Kubernetes cluster manager. @@ -17,7 +15,9 @@ kubectl controls the Kubernetes cluster manager. kubectl [flags] ``` -### Options +{{% /capture %}} + +{{% capture options %}} @@ -26,6 +26,13 @@ kubectl [flags] + + + + + + + @@ -69,7 +76,7 @@ kubectl [flags] - + @@ -118,12 +125,19 @@ kubectl [flags] - + + + + + + + + @@ -145,6 +159,13 @@ kubectl [flags] + + + + + + + @@ -285,6 +306,13 @@ kubectl [flags] + + + + + + + @@ -313,20 +341,6 @@ kubectl [flags] - - - - - - - - - - - - - - @@ -376,6 +390,13 @@ kubectl [flags] + + + + + + + @@ -486,47 +507,52 @@ kubectl [flags] -### SEE ALSO -* [kubectl annotate](/docs/reference/generated/kubectl/kubectl-commands.html#annotate) - Update the annotations on a resource -* [kubectl api-resources](/docs/reference/generated/kubectl/kubectl-commands.html#api-resources) - Print the supported API resources on the server -* [kubectl api-versions](/docs/reference/generated/kubectl/kubectl-commands.html#api-versions) - Print the supported API versions on the server, in the form of "group/version" -* [kubectl apply](/docs/reference/generated/kubectl/kubectl-commands.html#apply) - Apply a configuration to a resource by filename or stdin -* [kubectl attach](/docs/reference/generated/kubectl/kubectl-commands.html#attach) - Attach to a running container -* [kubectl auth](/docs/reference/generated/kubectl/kubectl-commands.html#auth) - Inspect authorization -* [kubectl autoscale](/docs/reference/generated/kubectl/kubectl-commands.html#autoscale) - Auto-scale a Deployment, ReplicaSet, or ReplicationController -* [kubectl certificate](/docs/reference/generated/kubectl/kubectl-commands.html#certificate) - Modify certificate resources. -* [kubectl cluster-info](/docs/reference/generated/kubectl/kubectl-commands.html#cluster-info) - Display cluster info -* [kubectl completion](/docs/reference/generated/kubectl/kubectl-commands.html#completion) - Output shell completion code for the specified shell (bash or zsh) -* [kubectl config](/docs/reference/generated/kubectl/kubectl-commands.html#config) - Modify kubeconfig files -* [kubectl convert](/docs/reference/generated/kubectl/kubectl-commands.html#convert) - Convert config files between different API versions -* [kubectl cordon](/docs/reference/generated/kubectl/kubectl-commands.html#cordon) - Mark node as unschedulable -* [kubectl cp](/docs/reference/generated/kubectl/kubectl-commands.html#cp) - Copy files and directories to and from containers. -* [kubectl create](/docs/reference/generated/kubectl/kubectl-commands.html#create) - Create a resource from a file or from stdin. -* [kubectl delete](/docs/reference/generated/kubectl/kubectl-commands.html#delete) - Delete resources by filenames, stdin, resources and names, or by resources and label selector -* [kubectl describe](/docs/reference/generated/kubectl/kubectl-commands.html#describe) - Show details of a specific resource or group of resources -* [kubectl diff](/docs/reference/generated/kubectl/kubectl-commands.html#diff) - Diff live version against would-be applied version -* [kubectl drain](/docs/reference/generated/kubectl/kubectl-commands.html#drain) - Drain node in preparation for maintenance -* [kubectl edit](/docs/reference/generated/kubectl/kubectl-commands.html#edit) - Edit a resource on the server -* [kubectl exec](/docs/reference/generated/kubectl/kubectl-commands.html#exec) - Execute a command in a container -* [kubectl explain](/docs/reference/generated/kubectl/kubectl-commands.html#explain) - Documentation of resources -* [kubectl expose](/docs/reference/generated/kubectl/kubectl-commands.html#expose) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service -* [kubectl get](/docs/reference/generated/kubectl/kubectl-commands.html#get) - Display one or many resources -* [kubectl kustomize](/docs/reference/generated/kubectl/kubectl-commands.html#kustomize) - Build a kustomization target from a directory or a remote url. -* [kubectl label](/docs/reference/generated/kubectl/kubectl-commands.html#label) - Update the labels on a resource -* [kubectl logs](/docs/reference/generated/kubectl/kubectl-commands.html#logs) - Print the logs for a container in a pod -* [kubectl options](/docs/reference/generated/kubectl/kubectl-commands.html#options) - Print the list of flags inherited by all commands -* [kubectl patch](/docs/reference/generated/kubectl/kubectl-commands.html#patch) - Update field(s) of a resource using strategic merge patch -* [kubectl plugin](/docs/reference/generated/kubectl/kubectl-commands.html#plugin) - Provides utilities for interacting with plugins. -* [kubectl port-forward](/docs/reference/generated/kubectl/kubectl-commands.html#port-forward) - Forward one or more local ports to a pod -* [kubectl proxy](/docs/reference/generated/kubectl/kubectl-commands.html#proxy) - Run a proxy to the Kubernetes API server -* [kubectl replace](/docs/reference/generated/kubectl/kubectl-commands.html#replace) - Replace a resource by filename or stdin -* [kubectl rollout](/docs/reference/generated/kubectl/kubectl-commands.html#rollout) - Manage the rollout of a resource -* [kubectl run](/docs/reference/generated/kubectl/kubectl-commands.html#run) - Run a particular image on the cluster -* [kubectl scale](/docs/reference/generated/kubectl/kubectl-commands.html#scale) - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job -* [kubectl set](/docs/reference/generated/kubectl/kubectl-commands.html#set) - Set specific features on objects -* [kubectl taint](/docs/reference/generated/kubectl/kubectl-commands.html#taint) - Update the taints on one or more nodes -* [kubectl top](/docs/reference/generated/kubectl/kubectl-commands.html#top) - Display Resource (CPU/Memory/Storage) usage. -* [kubectl uncordon](/docs/reference/generated/kubectl/kubectl-commands.html#uncordon) - Mark node as schedulable -* [kubectl version](/docs/reference/generated/kubectl/kubectl-commands.html#version) - Print the client and server version information -* [kubectl wait](/docs/reference/generated/kubectl/kubectl-commands.html#wait) - Experimental: Wait for a specific condition on one or many resources. +{{% /capture %}} + +{{% capture seealso %}} + +* [kubectl annotate](kubectl_annotate.md) - Update the annotations on a resource +* [kubectl api-resources](kubectl_api-resources.md) - Print the supported API resources on the server +* [kubectl api-versions](kubectl_api-versions.md) - Print the supported API versions on the server, in the form of "group/version" +* [kubectl apply](kubectl_apply.md) - Apply a configuration to a resource by filename or stdin +* [kubectl attach](kubectl_attach.md) - Attach to a running container +* [kubectl auth](kubectl_auth.md) - Inspect authorization +* [kubectl autoscale](kubectl_autoscale.md) - Auto-scale a Deployment, ReplicaSet, or ReplicationController +* [kubectl certificate](kubectl_certificate.md) - Modify certificate resources. +* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info +* [kubectl completion](kubectl_completion.md) - Output shell completion code for the specified shell (bash or zsh) +* [kubectl config](kubectl_config.md) - Modify kubeconfig files +* [kubectl convert](kubectl_convert.md) - Convert config files between different API versions +* [kubectl cordon](kubectl_cordon.md) - Mark node as unschedulable +* [kubectl cp](kubectl_cp.md) - Copy files and directories to and from containers. +* [kubectl create](kubectl_create.md) - Create a resource from a file or from stdin. +* [kubectl delete](kubectl_delete.md) - Delete resources by filenames, stdin, resources and names, or by resources and label selector +* [kubectl describe](kubectl_describe.md) - Show details of a specific resource or group of resources +* [kubectl diff](kubectl_diff.md) - Diff live version against would-be applied version +* [kubectl drain](kubectl_drain.md) - Drain node in preparation for maintenance +* [kubectl edit](kubectl_edit.md) - Edit a resource on the server +* [kubectl exec](kubectl_exec.md) - Execute a command in a container +* [kubectl explain](kubectl_explain.md) - Documentation of resources +* [kubectl expose](kubectl_expose.md) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service +* [kubectl get](kubectl_get.md) - Display one or many resources +* [kubectl kustomize](kubectl_kustomize.md) - Build a kustomization target from a directory or a remote url. +* [kubectl label](kubectl_label.md) - Update the labels on a resource +* [kubectl logs](kubectl_logs.md) - Print the logs for a container in a pod +* [kubectl options](kubectl_options.md) - Print the list of flags inherited by all commands +* [kubectl patch](kubectl_patch.md) - Update field(s) of a resource using strategic merge patch +* [kubectl plugin](kubectl_plugin.md) - Provides utilities for interacting with plugins. +* [kubectl port-forward](kubectl_port-forward.md) - Forward one or more local ports to a pod +* [kubectl proxy](kubectl_proxy.md) - Run a proxy to the Kubernetes API server +* [kubectl replace](kubectl_replace.md) - Replace a resource by filename or stdin +* [kubectl rollout](kubectl_rollout.md) - Manage the rollout of a resource +* [kubectl run](kubectl_run.md) - Run a particular image on the cluster +* [kubectl scale](kubectl_scale.md) - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job +* [kubectl set](kubectl_set.md) - Set specific features on objects +* [kubectl taint](kubectl_taint.md) - Update the taints on one or more nodes +* [kubectl top](kubectl_top.md) - Display Resource (CPU/Memory/Storage) usage. +* [kubectl uncordon](kubectl_uncordon.md) - Mark node as schedulable +* [kubectl version](kubectl_version.md) - Print the client and server version information +* [kubectl wait](kubectl_wait.md) - Experimental: Wait for a specific condition on one or many resources. + +{{% /capture %}} diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md index 3758917b6b..42fc217a24 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md @@ -1,10 +1,9 @@ -kubeadm: easily bootstrap a secure Kubernetes cluster - ### Synopsis + ┌──────────────────────────────────────────────────────────┐ │ KUBEADM │ │ Easily bootstrap a secure Kubernetes cluster │ @@ -28,7 +27,7 @@ Example usage: ┌──────────────────────────────────────────────────────────┐ │ On the second machine: │ ├──────────────────────────────────────────────────────────┤ - │ worker# kubeadm join │ + │ worker# kubeadm join <arguments-returned-from-init> │ └──────────────────────────────────────────────────────────┘ You can then repeat the second step on as many other machines as you like. @@ -37,8 +36,41 @@ Example usage: ### Options -``` - -h, --help help for kubeadm - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` +
--add-dir-header
If true, adds the file directory to the header
--alsologtostderr
--cache-dir string     Default: "/home/tengqm/.kube/http-cache"--cache-dir string     Default: "/home/karen/.kube/http-cache"
Default HTTP cache directory
--containerd string     Default: "unix:///var/run/containerd.sock"--containerd string     Default: "/run/containerd/containerd.sock"
containerd endpoint
--containerd-namespace string     Default: "k8s.io"
containerd namespace
--context string
Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration.
--disable-root-cgroup-stats
Disable collecting root Cgroup stats
--docker string     Default: "unix:///var/run/docker.sock"
If non-empty, use this log file
--log-file-max-size uint     Default: 1800
Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited.
--log-flush-frequency duration     Default: 5s
Require server version to match client version
--mesos-agent string     Default: "127.0.0.1:5051"
Mesos agent address
--mesos-agent-timeout duration     Default: 10s
Mesos agent timeout
-n, --namespace string
If true, avoid header prefixes in the log messages
--skip-log-headers
If true, avoid headers when opening log files
--stderrthreshold severity     Default: 2
+ + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for kubeadm
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha](kubeadm_alpha.md) - Kubeadm experimental sub-commands +* [kubeadm completion](kubeadm_completion.md) - Output shell completion code for the specified shell (bash or zsh) +* [kubeadm config](kubeadm_config.md) - Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster +* [kubeadm init](kubeadm_init.md) - Run this command in order to set up the Kubernetes control plane +* [kubeadm join](kubeadm_join.md) - Run this on any machine you wish to join an existing cluster +* [kubeadm reset](kubeadm_reset.md) - Performs a best effort revert of changes made to this host by 'kubeadm init' or 'kubeadm join' +* [kubeadm token](kubeadm_token.md) - Manage bootstrap tokens +* [kubeadm upgrade](kubeadm_upgrade.md) - Upgrade your cluster smoothly to a newer version with this command +* [kubeadm version](kubeadm_version.md) - Print the version of kubeadm diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md index 4211c0b57e..6126704769 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md @@ -1,19 +1,56 @@ -Kubeadm experimental sub-commands - ### Synopsis + Kubeadm experimental sub-commands ### Options -``` - -h, --help help for alpha -``` + + + + + + + + + + + + + + + +
-h, --help
help for alpha
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm](kubeadm.md) - kubeadm: easily bootstrap a secure Kubernetes cluster +* [kubeadm alpha certs](kubeadm_alpha_certs.md) - Commands related to handling kubernetes certificates +* [kubeadm alpha kubeconfig](kubeadm_alpha_kubeconfig.md) - Kubeconfig file utilities +* [kubeadm alpha kubelet](kubeadm_alpha_kubelet.md) - Commands related to handling the kubelet +* [kubeadm alpha selfhosting](kubeadm_alpha_selfhosting.md) - Make a kubeadm cluster self-hosted diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs.md index 8ddf61d005..f9c8f5b507 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs.md @@ -1,19 +1,55 @@ -Commands related to handling kubernetes certificates - ### Synopsis + Commands related to handling kubernetes certificates ### Options -``` - -h, --help help for certs -``` + + + + + + + + + + + + + + + +
-h, --help
help for certs
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha](kubeadm_alpha.md) - Kubeadm experimental sub-commands +* [kubeadm alpha certs certificate-key](kubeadm_alpha_certs_certificate-key.md) - Generate certificate keys +* [kubeadm alpha certs check-expiration](kubeadm_alpha_certs_check-expiration.md) - Check certificates expiration for a Kubernetes cluster +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_certificate-key.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_certificate-key.md index c42340618f..6aec62b006 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_certificate-key.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_certificate-key.md @@ -1,13 +1,12 @@ -Generate certificate keys - ### Synopsis + This command will print out a secure randomly-generated certificate key that can be used with the "init" command. -You can also use "kubeadm init --experimental-upload-certs" without specifying a certificate key and it will +You can also use "kubeadm init --upload-certs" without specifying a certificate key and it will generate and print one for you. @@ -17,13 +16,47 @@ kubeadm alpha certs certificate-key [flags] ### Options -``` - -h, --help help for certificate-key -``` + + + + + + + + + + + + + + + +
-h, --help
help for certificate-key
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs](kubeadm_alpha_certs.md) - Commands related to handling kubernetes certificates diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_check-expiration.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_check-expiration.md index 3cf14558b0..0e2ae5f44b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_check-expiration.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_check-expiration.md @@ -1,8 +1,7 @@ -Check certificates expiration for a Kubernetes cluster - ### Synopsis + Checks expiration for the certificates in the local PKI managed by kubeadm. ``` @@ -11,15 +10,61 @@ kubeadm alpha certs check-expiration [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for check-expiration -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
-h, --help
help for check-expiration
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs](kubeadm_alpha_certs.md) - Commands related to handling kubernetes certificates diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew.md index 4aba5d9618..a20547786f 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew.md @@ -1,8 +1,7 @@ -Renew certificates for a Kubernetes cluster - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ``` @@ -11,13 +10,58 @@ kubeadm alpha certs renew [flags] ### Options -``` - -h, --help help for renew -``` + + + + + + + + + + + + + + + +
-h, --help
help for renew
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs](kubeadm_alpha_certs.md) - Commands related to handling kubernetes certificates +* [kubeadm alpha certs renew admin.conf](kubeadm_alpha_certs_renew_admin.conf.md) - Renew the certificate embedded in the kubeconfig file for the admin to use and for kubeadm itself +* [kubeadm alpha certs renew all](kubeadm_alpha_certs_renew_all.md) - Renew all available certificates +* [kubeadm alpha certs renew apiserver](kubeadm_alpha_certs_renew_apiserver.md) - Renew the certificate for serving the Kubernetes API +* [kubeadm alpha certs renew apiserver-etcd-client](kubeadm_alpha_certs_renew_apiserver-etcd-client.md) - Renew the certificate the apiserver uses to access etcd +* [kubeadm alpha certs renew apiserver-kubelet-client](kubeadm_alpha_certs_renew_apiserver-kubelet-client.md) - Renew the certificate for the API server to connect to kubelet +* [kubeadm alpha certs renew controller-manager.conf](kubeadm_alpha_certs_renew_controller-manager.conf.md) - Renew the certificate embedded in the kubeconfig file for the controller manager to use +* [kubeadm alpha certs renew etcd-healthcheck-client](kubeadm_alpha_certs_renew_etcd-healthcheck-client.md) - Renew the certificate for liveness probes to healthcheck etcd +* [kubeadm alpha certs renew etcd-peer](kubeadm_alpha_certs_renew_etcd-peer.md) - Renew the certificate for etcd nodes to communicate with each other +* [kubeadm alpha certs renew etcd-server](kubeadm_alpha_certs_renew_etcd-server.md) - Renew the certificate for serving etcd +* [kubeadm alpha certs renew front-proxy-client](kubeadm_alpha_certs_renew_front-proxy-client.md) - Renew the certificate for the front proxy client +* [kubeadm alpha certs renew scheduler.conf](kubeadm_alpha_certs_renew_scheduler.conf.md) - Renew the certificate embedded in the kubeconfig file for the scheduler manager to use diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_admin.conf.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_admin.conf.md index fafd0c7641..56e23ecebe 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_admin.conf.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_admin.conf.md @@ -1,13 +1,12 @@ -Renew the certificate embedded in the kubeconfig file for the admin to use and for kubeadm itself - ### Synopsis -Renew the certificate embedded in the kubeconfig file for the admin to use and for kubeadm itself. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate embedded in the kubeconfig file for the admin to use and for kubeadm itself. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew admin.conf [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for admin.conf - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for admin.conf
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_all.md index ba6e1bb75a..3cf4bbda4a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_all.md @@ -1,8 +1,7 @@ -Renew all available certificates - ### Synopsis + Renew all known certificates necessary to run the control plane. Renewals are run unconditionally, regardless of expiration date. Renewals can also be run individually for more control. ``` @@ -11,19 +10,89 @@ kubeadm alpha certs renew all [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for all - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for all
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-etcd-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-etcd-client.md index e7c791ed1b..15dd9fdbd4 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-etcd-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-etcd-client.md @@ -1,13 +1,12 @@ -Renew the certificate the apiserver uses to access etcd - ### Synopsis -Renew the certificate the apiserver uses to access etcd. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate the apiserver uses to access etcd. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew apiserver-etcd-client [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for apiserver-etcd-client - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver-etcd-client
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md index 064e0c24db..a5a21b2994 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md @@ -1,13 +1,12 @@ -Renew the certificate for the API server to connect to kubelet - ### Synopsis -Renew the certificate for the API server to connect to kubelet. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate for the API server to connect to kubelet. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew apiserver-kubelet-client [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for apiserver-kubelet-client - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver-kubelet-client
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver.md index 92b62d83d0..f7b18e2822 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_apiserver.md @@ -1,13 +1,12 @@ -Renew the certificate for serving the Kubernetes API - ### Synopsis -Renew the certificate for serving the Kubernetes API. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate for serving the Kubernetes API. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew apiserver [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for apiserver - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_controller-manager.conf.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_controller-manager.conf.md index 7339fc04b8..5a091a984b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_controller-manager.conf.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_controller-manager.conf.md @@ -1,13 +1,12 @@ -Renew the certificate embedded in the kubeconfig file for the controller manager to use - ### Synopsis -Renew the certificate embedded in the kubeconfig file for the controller manager to use. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate embedded in the kubeconfig file for the controller manager to use. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew controller-manager.conf [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for controller-manager.conf - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for controller-manager.conf
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md index f1b796a08b..c551253b53 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md @@ -1,13 +1,12 @@ -Renew the certificate for liveness probes to healtcheck etcd - ### Synopsis -Renew the certificate for liveness probes to healtcheck etcd. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate for liveness probes to healthcheck etcd. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew etcd-healthcheck-client [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for etcd-healthcheck-client - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-healthcheck-client
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-peer.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-peer.md index e5c46d5245..c22ad65788 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-peer.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-peer.md @@ -1,13 +1,12 @@ -Renew the certificate for etcd nodes to communicate with each other - ### Synopsis -Renew the certificate for etcd nodes to communicate with each other. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate for etcd nodes to communicate with each other. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew etcd-peer [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for etcd-peer - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-peer
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-server.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-server.md index 997a607bd8..85813ac991 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-server.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_etcd-server.md @@ -1,13 +1,12 @@ -Renew the certificate for serving etcd - ### Synopsis -Renew the certificate for serving etcd. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate for serving etcd. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew etcd-server [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for etcd-server - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-server
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_front-proxy-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_front-proxy-client.md index 2945b45b2f..c909c36f59 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_front-proxy-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_front-proxy-client.md @@ -1,13 +1,12 @@ -Renew the certificate for the front proxy client - ### Synopsis -Renew the certificate for the front proxy client. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate for the front proxy client. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew front-proxy-client [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for front-proxy-client - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for front-proxy-client
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_scheduler.conf.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_scheduler.conf.md index 58dc3900a9..f9eacbb4dc 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_scheduler.conf.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_certs_renew_scheduler.conf.md @@ -1,13 +1,12 @@ -Renew the certificate embedded in the kubeconfig file for the scheduler manager to use - ### Synopsis -Renew the certificate embedded in the kubeconfig file for the scheduler manager to use. -Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. +Renew the certificate embedded in the kubeconfig file for the scheduler manager to use. -Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. +Renewals run unconditionally, regardless of certificate expiration date; extra attributes such as SANs will be based on the existing file/certificates, there is no need to resupply them. + +Renewal by default tries to use the certificate authority in the local PKI managed by kubeadm; as alternative it is possible to use K8s certificate API for certificate renewal, or as a last option, to generate a CSR request. After renewal, in order to make changes effective, is is required to restart control-plane components and eventually re-distribute the renewed certificate in case the file is used elsewhere. @@ -17,19 +16,89 @@ kubeadm alpha certs renew scheduler.conf [flags] ### Options -``` - --cert-dir string The path where to save the certificates (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for scheduler.conf - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --use-api Use the Kubernetes certificate API to renew certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificates
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for scheduler.conf
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--use-api
Use the Kubernetes certificate API to renew certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha certs renew](kubeadm_alpha_certs_renew.md) - Renew certificates for a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig.md index 0481bb1d2a..fe1662c68e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig.md @@ -1,21 +1,55 @@ -Kubeconfig file utilities - ### Synopsis -Kubeconfig file utilities. - Alpha Disclaimer: this command is currently alpha. +Kubeconfig file utilities. + +Alpha Disclaimer: this command is currently alpha. ### Options -``` - -h, --help help for kubeconfig -``` + + + + + + + + + + + + + + + +
-h, --help
help for kubeconfig
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha](kubeadm_alpha.md) - Kubeadm experimental sub-commands +* [kubeadm alpha kubeconfig user](kubeadm_alpha_kubeconfig_user.md) - Output a kubeconfig file for an additional user diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig_user.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig_user.md index 5bcc47139c..c0abaa504e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig_user.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubeconfig_user.md @@ -1,11 +1,10 @@ -Output a kubeconfig file for an additional user - ### Synopsis -Output a kubeconfig file for an additional user. - Alpha Disclaimer: this command is currently alpha. +Output a kubeconfig file for an additional user. + +Alpha Disclaimer: this command is currently alpha. ``` kubeadm alpha kubeconfig user [flags] @@ -20,19 +19,89 @@ kubeadm alpha kubeconfig user [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API server is accessible on - --apiserver-bind-port int32 The port the API server is accessible on (default 6443) - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --client-name string The name of user. It will be used as the CN if client certificates are created - -h, --help help for user - --org strings The orgnizations of the client certificate. It will be used as the O if client certificates are created - --token string The token that should be used as the authentication mechanism for this kubeconfig, instead of client certificates -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--client-name string
The name of user. It will be used as the CN if client certificates are created
-h, --help
help for user
--org stringSlice
The orgnizations of the client certificate. It will be used as the O if client certificates are created
--token string
The token that should be used as the authentication mechanism for this kubeconfig, instead of client certificates
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha kubeconfig](kubeadm_alpha_kubeconfig.md) - Kubeconfig file utilities diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet.md index d975aae963..9b27009955 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet.md @@ -1,19 +1,53 @@ -Commands related to handling the kubelet - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for kubelet -``` + + + + + + + + + + + + + + + +
-h, --help
help for kubelet
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha](kubeadm_alpha.md) - Kubeadm experimental sub-commands +* [kubeadm alpha kubelet config](kubeadm_alpha_kubelet_config.md) - Utilities for kubelet configuration diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config.md index 0040242ff2..53f4736bdb 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config.md @@ -1,19 +1,54 @@ -Utilities for kubelet configuration - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for config -``` + + + + + + + + + + + + + + + +
-h, --help
help for config
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha kubelet](kubeadm_alpha_kubelet.md) - Commands related to handling the kubelet +* [kubeadm alpha kubelet config download](kubeadm_alpha_kubelet_config_download.md) - Download the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet +* [kubeadm alpha kubelet config enable-dynamic](kubeadm_alpha_kubelet_config_enable-dynamic.md) - EXPERIMENTAL: Enable or update dynamic kubelet configuration for a Node diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_download.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_download.md index ca6e808504..18fe29ddb2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_download.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_download.md @@ -1,9 +1,8 @@ -Download the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet - ### Synopsis -Download the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. Either kubeadm autodetects the kubelet version by exec-ing "kubelet --version" or respects the --kubelet-version parameter. + +Download the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. Either kubeadm autodetects the kubelet version by exec-ing "kubelet --version" or respects the --kubelet-version parameter. Alpha Disclaimer: this command is currently alpha. @@ -18,20 +17,66 @@ kubeadm alpha kubelet config download [flags] kubeadm alpha phase kubelet config download # Download the kubelet configuration from the ConfigMap in the cluster. Use a specific desired kubelet version. - kubeadm alpha phase kubelet config download --kubelet-version 1.14.0 + kubeadm alpha phase kubelet config download --kubelet-version 1.16.0 ``` ### Options -``` - -h, --help help for download - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --kubelet-version string The desired version for the kubelet. Defaults to being autodetected from 'kubelet --version'. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for download
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--kubelet-version string
The desired version for the kubelet. Defaults to being autodetected from 'kubelet --version'.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha kubelet config](kubeadm_alpha_kubelet_config.md) - Utilities for kubelet configuration diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_enable-dynamic.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_enable-dynamic.md index 3d772d05b9..8572af878c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_enable-dynamic.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_kubelet_config_enable-dynamic.md @@ -1,11 +1,10 @@ -EXPERIMENTAL: Enable or update dynamic kubelet configuration for a Node - ### Synopsis -Enable or update dynamic kubelet configuration for a Node, against the kubelet-config-1.X ConfigMap in the cluster, where X is the minor version of the desired kubelet version. -WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it may have surprising side-effects at this stage. +Enable or update dynamic kubelet configuration for a Node, against the kubelet-config-1.X ConfigMap in the cluster, where X is the minor version of the desired kubelet version. + +WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it may have surprising side-effects at this stage. Alpha Disclaimer: this command is currently alpha. @@ -17,7 +16,7 @@ kubeadm alpha kubelet config enable-dynamic [flags] ``` # Enable dynamic kubelet configuration for a Node. - kubeadm alpha phase kubelet enable-dynamic-config --node-name node-1 --kubelet-version 1.14.0 + kubeadm alpha phase kubelet enable-dynamic-config --node-name node-1 --kubelet-version 1.16.0 WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it may have surprising side-effects at this stage. @@ -25,16 +24,68 @@ kubeadm alpha kubelet config enable-dynamic [flags] ### Options -``` - -h, --help help for enable-dynamic - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --kubelet-version string The desired version for the kubelet - --node-name string Name of the node that should enable the dynamic kubelet configuration -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for enable-dynamic
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--kubelet-version string
The desired version for the kubelet
--node-name string
Name of the node that should enable the dynamic kubelet configuration
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha kubelet config](kubeadm_alpha_kubelet_config.md) - Utilities for kubelet configuration diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting.md index 95951d4bbe..e1a6440697 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting.md @@ -1,19 +1,53 @@ -Make a kubeadm cluster self-hosted - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ### Options -``` - -h, --help help for selfhosting -``` + + + + + + + + + + + + + + + +
-h, --help
help for selfhosting
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha](kubeadm_alpha.md) - Kubeadm experimental sub-commands +* [kubeadm alpha selfhosting pivot](kubeadm_alpha_selfhosting_pivot.md) - Convert a static Pod-hosted control plane into a self-hosted one diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting_pivot.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting_pivot.md index eaa946f2c1..584acec834 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting_pivot.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_selfhosting_pivot.md @@ -1,11 +1,10 @@ -Convert a static Pod-hosted control plane into a self-hosted one - ### Synopsis -Convert static Pod files for control plane components into self-hosted DaemonSets configured via the Kubernetes API. -See the documentation for self-hosting limitations. +Convert static Pod files for control plane components into self-hosted DaemonSets configured via the Kubernetes API. + +See the documentation for self-hosting limitations. Alpha Disclaimer: this command is currently alpha. @@ -23,18 +22,82 @@ kubeadm alpha selfhosting pivot [flags] ### Options -``` - --cert-dir string The path where certificates are stored (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -f, --force Pivot the cluster without prompting for confirmation - -h, --help help for pivot - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - -s, --store-certs-in-secrets Enable storing certs in secrets -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are stored
--config string
Path to a kubeadm configuration file.
-f, --force
Pivot the cluster without prompting for confirmation
-h, --help
help for pivot
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
-s, --store-certs-in-secrets
Enable storing certs in secrets
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm alpha selfhosting](kubeadm_alpha_selfhosting.md) - Make a kubeadm cluster self-hosted diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md index 4618befd9b..09f47726a6 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md @@ -1,9 +1,8 @@ -Output shell completion code for the specified shell (bash or zsh) - ### Synopsis + Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubeadm commands. This can be done by sourcing it from @@ -20,7 +19,7 @@ following line to the .bash_profile If bash-completion is not installed on Linux, please install the 'bash-completion' package via your distribution's package manager. -Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2 +Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2 ``` kubeadm completion SHELL [flags] @@ -49,13 +48,47 @@ source <(kubeadm completion zsh) ### Options -``` - -h, --help help for completion -``` + + + + + + + + + + + + + + + +
-h, --help
help for completion
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm](kubeadm.md) - kubeadm: easily bootstrap a secure Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md index bc085de08a..e8ff0e3b30 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md @@ -1,9 +1,8 @@ -Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster - ### Synopsis + There is a ConfigMap in the kube-system namespace called "kubeadm-config" that kubeadm uses to store internal configuration about the cluster. kubeadm CLI v1.8.0+ automatically creates this ConfigMap with the config used with 'kubeadm init', but if you initialized your cluster using kubeadm v1.7.x or lower, you must use the 'config upload' command to create this @@ -16,14 +15,58 @@ kubeadm config [flags] ### Options -``` - -h, --help help for config - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for config
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm](kubeadm.md) - kubeadm: easily bootstrap a secure Kubernetes cluster +* [kubeadm config images](kubeadm_config_images.md) - Interact with container images used by kubeadm +* [kubeadm config migrate](kubeadm_config_migrate.md) - Read an older version of the kubeadm configuration API types from a file, and output the similar config object for the newer version +* [kubeadm config print](kubeadm_config_print.md) - Print configuration +* [kubeadm config view](kubeadm_config_view.md) - View the kubeadm configuration stored inside the cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md index 6c9be5ac3c..a4e5318549 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md @@ -1,8 +1,7 @@ -Interact with container images used by kubeadm - ### Synopsis + Interact with container images used by kubeadm ``` @@ -11,14 +10,56 @@ kubeadm config images [flags] ### Options -``` - -h, --help help for images -``` + + + + + + + + + + + + + + + +
-h, --help
help for images
+ + ### Options inherited from parent commands -``` - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm config](kubeadm_config.md) - Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster +* [kubeadm config images list](kubeadm_config_images_list.md) - Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized +* [kubeadm config images pull](kubeadm_config_images_pull.md) - Pull images used by kubeadm diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md index 28a2f0a7dc..a26431a149 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md @@ -1,8 +1,7 @@ -Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized - ### Synopsis + Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized ``` @@ -11,18 +10,82 @@ kubeadm config images list [flags] ### Options -``` - --config string Path to kubeadm config file. - --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. - -h, --help help for list - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
IPv6DualStack=true|false (ALPHA - default=false)
-h, --help
help for list
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm config images](kubeadm_config_images.md) - Interact with container images used by kubeadm diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md index 611524df9c..a2c84aea3c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md @@ -1,8 +1,7 @@ -Pull images used by kubeadm - ### Synopsis + Pull images used by kubeadm ``` @@ -11,19 +10,89 @@ kubeadm config images pull [flags] ### Options -``` - --config string Path to kubeadm config file. - --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. - --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. - -h, --help help for pull - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
--cri-socket string
Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
IPv6DualStack=true|false (ALPHA - default=false)
-h, --help
help for pull
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm config images](kubeadm_config_images.md) - Interact with container images used by kubeadm diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md index ba1361453e..edfc3ac5ed 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md @@ -1,14 +1,11 @@ -Read an older version of the kubeadm configuration API types from a file, and output the similar config object for the newer version - ### Synopsis + This command lets you convert configuration objects of older versions to the latest supported version, locally in the CLI tool without ever touching anything in the cluster. In this version of kubeadm, the following API versions are supported: - -- kubeadm.k8s.io/v1beta1 - kubeadm.k8s.io/v1beta2 Further, kubeadm can only write out config of version "kubeadm.k8s.io/v1beta2", but read both types. @@ -26,16 +23,68 @@ kubeadm config migrate [flags] ### Options -``` - -h, --help help for migrate - --new-config string Path to the resulting equivalent kubeadm config file using the new API version. Optional, if not specified output will be sent to STDOUT. - --old-config string Path to the kubeadm config file that is using an old API version and should be converted. This flag is mandatory. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for migrate
--new-config string
Path to the resulting equivalent kubeadm config file using the new API version. Optional, if not specified output will be sent to STDOUT.
--old-config string
Path to the kubeadm config file that is using an old API version and should be converted. This flag is mandatory.
+ + ### Options inherited from parent commands -``` - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm config](kubeadm_config.md) - Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print.md index 159b87581d..8c50a1a0fc 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print.md @@ -1,9 +1,10 @@ -Print configuration - ### Synopsis + + This command prints configurations for subcommands provided. +For details, see: https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta2 ``` kubeadm config print [flags] @@ -11,14 +12,56 @@ kubeadm config print [flags] ### Options -``` - -h, --help help for print -``` + + + + + + + + + + + + + + + +
-h, --help
help for print
+ + ### Options inherited from parent commands -``` - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm config](kubeadm_config.md) - Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster +* [kubeadm config print init-defaults](kubeadm_config_print_init-defaults.md) - Print default init configuration, that can be used for 'kubeadm init' +* [kubeadm config print join-defaults](kubeadm_config_print_join-defaults.md) - Print default join configuration, that can be used for 'kubeadm join' diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_init-defaults.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_init-defaults.md index 239a969a82..d89c32472f 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_init-defaults.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_init-defaults.md @@ -1,12 +1,11 @@ -Print default init configuration, that can be used for 'kubeadm init' - ### Synopsis + This command prints objects such as the default init configuration that is used for 'kubeadm init'. -Note that sensitive values like the Bootstrap Token fields are replaced with placeholder values like {"abcdef.0123456789abcdef" "" "nil" [] []} in order to pass validation but +Note that sensitive values like the Bootstrap Token fields are replaced with placeholder values like {"abcdef.0123456789abcdef" "" "nil" <nil> [] []} in order to pass validation but not perform the real computation for creating a token. @@ -16,15 +15,61 @@ kubeadm config print init-defaults [flags] ### Options -``` - --component-configs strings A comma-separated list for component config API objects to print the default values for. Available values: [KubeProxyConfiguration KubeletConfiguration]. If this flag is not set, no component configs will be printed. - -h, --help help for init-defaults -``` + + + + + + + + + + + + + + + + + + + + + + +
--component-configs stringSlice
A comma-separated list for component config API objects to print the default values for. Available values: [KubeProxyConfiguration KubeletConfiguration]. If this flag is not set, no component configs will be printed.
-h, --help
help for init-defaults
+ + ### Options inherited from parent commands -``` - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm config print](kubeadm_config_print.md) - Print configuration diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_join-defaults.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_join-defaults.md index 57d5024988..4abdf41736 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_join-defaults.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print_join-defaults.md @@ -1,12 +1,11 @@ -Print default join configuration, that can be used for 'kubeadm join' - ### Synopsis + This command prints objects such as the default join configuration that is used for 'kubeadm join'. -Note that sensitive values like the Bootstrap Token fields are replaced with placeholder values like {"abcdef.0123456789abcdef" "" "nil" [] []} in order to pass validation but +Note that sensitive values like the Bootstrap Token fields are replaced with placeholder values like {"abcdef.0123456789abcdef" "" "nil" <nil> [] []} in order to pass validation but not perform the real computation for creating a token. @@ -16,15 +15,61 @@ kubeadm config print join-defaults [flags] ### Options -``` - --component-configs strings A comma-separated list for component config API objects to print the default values for. Available values: [KubeProxyConfiguration KubeletConfiguration]. If this flag is not set, no component configs will be printed. - -h, --help help for join-defaults -``` + + + + + + + + + + + + + + + + + + + + + + +
--component-configs stringSlice
A comma-separated list for component config API objects to print the default values for. Available values: [KubeProxyConfiguration KubeletConfiguration]. If this flag is not set, no component configs will be printed.
-h, --help
help for join-defaults
+ + ### Options inherited from parent commands -``` - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm config print](kubeadm_config_print.md) - Print configuration diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md index a311347b32..1c02da8484 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md @@ -1,9 +1,8 @@ -View the kubeadm configuration stored inside the cluster - ### Synopsis + Using this command, you can view the ConfigMap in the cluster where the configuration for kubeadm is located. The configuration is located in the "kube-system" namespace in the "kubeadm-config" ConfigMap. @@ -15,14 +14,54 @@ kubeadm config view [flags] ### Options -``` - -h, --help help for view -``` + + + + + + + + + + + + + + + +
-h, --help
help for view
+ + ### Options inherited from parent commands -``` - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm config](kubeadm_config.md) - Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md index c7faf70640..5784042cb8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md @@ -1,8 +1,7 @@ -Run this command in order to set up the Kubernetes control plane - ### Synopsis + Run this command in order to set up the Kubernetes control plane The "init" command executes the following phases: @@ -10,16 +9,16 @@ The "init" command executes the following phases: preflight Run pre-flight checks kubelet-start Write kubelet settings and (re)start the kubelet certs Certificate generation - /etcd-ca Generate the self-signed CA to provision identities for etcd - /apiserver-etcd-client Generate the certificate the apiserver uses to access etcd - /etcd-healthcheck-client Generate the certificate for liveness probes to healtcheck etcd - /etcd-server Generate the certificate for serving etcd - /etcd-peer Generate the certificate for etcd nodes to communicate with each other /ca Generate the self-signed Kubernetes CA to provision identities for other Kubernetes components /apiserver Generate the certificate for serving the Kubernetes API /apiserver-kubelet-client Generate the certificate for the API server to connect to kubelet /front-proxy-ca Generate the self-signed CA to provision identities for front proxy /front-proxy-client Generate the certificate for the front proxy client + /etcd-ca Generate the self-signed CA to provision identities for etcd + /etcd-server Generate the certificate for serving etcd + /etcd-peer Generate the certificate for etcd nodes to communicate with each other + /etcd-healthcheck-client Generate the certificate for liveness probes to healthcheck etcd + /apiserver-etcd-client Generate the certificate the apiserver uses to access etcd /sa Generate a private key for signing service account tokens along with its public key kubeconfig Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file /admin Generate a kubeconfig file for the admin to use and for kubeadm itself @@ -50,35 +49,216 @@ kubeadm init [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --apiserver-cert-extra-sans strings Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names. - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --certificate-key string Key used to encrypt the control-plane certificates in the kubeadm-certs Secret. - --config string Path to a kubeadm configuration file. - --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. - --dry-run Don't apply any changes; just output what would be done. - --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. - -h, --help help for init - --ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") - --node-name string Specify the node name. - --pod-network-cidr string Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node. - --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") - --service-dns-domain string Use alternative domain for services, e.g. "myorg.internal". (default "cluster.local") - --skip-certificate-key-print Don't print the key used to encrypt the control-plane certificates. - --skip-phases strings List of phases to be skipped - --skip-token-print Skip printing of the default bootstrap token generated by 'kubeadm init'. - --token string The token to use for establishing bidirectional trust between nodes and control-plane nodes. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef - --token-ttl duration The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire (default 24h0m0s) - --upload-certs Upload control-plane certificates to the kubeadm-certs Secret. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--apiserver-cert-extra-sans stringSlice
Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--certificate-key string
Key used to encrypt the control-plane certificates in the kubeadm-certs Secret.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
--cri-socket string
Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket.
--dry-run
Don't apply any changes; just output what would be done.
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
IPv6DualStack=true|false (ALPHA - default=false)
-h, --help
help for init
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--node-name string
Specify the node name.
--pod-network-cidr string
Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".
--skip-certificate-key-print
Don't print the key used to encrypt the control-plane certificates.
--skip-phases stringSlice
List of phases to be skipped
--skip-token-print
Skip printing of the default bootstrap token generated by 'kubeadm init'.
--token string
The token to use for establishing bidirectional trust between nodes and control-plane nodes. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef
--token-ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--upload-certs
Upload control-plane certificates to the kubeadm-certs Secret.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm](kubeadm.md) - kubeadm: easily bootstrap a secure Kubernetes cluster +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase.md index c469017dfd..3474bb717f 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase.md @@ -1,19 +1,63 @@ -Use this command to invoke single phase of the init workflow - ### Synopsis + Use this command to invoke single phase of the init workflow ### Options -``` - -h, --help help for phase -``` + + + + + + + + + + + + + + + +
-h, --help
help for phase
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init](kubeadm_init.md) - Run this command in order to set up the Kubernetes control plane +* [kubeadm init phase addon](kubeadm_init_phase_addon.md) - Install required addons for passing Conformance tests +* [kubeadm init phase bootstrap-token](kubeadm_init_phase_bootstrap-token.md) - Generates bootstrap tokens used to join a node to a cluster +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation +* [kubeadm init phase control-plane](kubeadm_init_phase_control-plane.md) - Generate all static Pod manifest files necessary to establish the control plane +* [kubeadm init phase etcd](kubeadm_init_phase_etcd.md) - Generate static Pod manifest file for local etcd +* [kubeadm init phase kubeconfig](kubeadm_init_phase_kubeconfig.md) - Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file +* [kubeadm init phase kubelet-start](kubeadm_init_phase_kubelet-start.md) - Write kubelet settings and (re)start the kubelet +* [kubeadm init phase mark-control-plane](kubeadm_init_phase_mark-control-plane.md) - Mark a node as a control-plane +* [kubeadm init phase preflight](kubeadm_init_phase_preflight.md) - Run pre-flight checks +* [kubeadm init phase upload-certs](kubeadm_init_phase_upload-certs.md) - Upload certificates to kubeadm-certs +* [kubeadm init phase upload-config](kubeadm_init_phase_upload-config.md) - Upload the kubeadm and kubelet configuration to a ConfigMap diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon.md index 53aea81144..cbb8922971 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon.md @@ -1,8 +1,7 @@ -Install required addons for passing Conformance tests - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ``` @@ -11,13 +10,50 @@ kubeadm init phase addon [flags] ### Options -``` - -h, --help help for addon -``` + + + + + + + + + + + + + + + +
-h, --help
help for addon
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow +* [kubeadm init phase addon all](kubeadm_init_phase_addon_all.md) - Install all the addons +* [kubeadm init phase addon coredns](kubeadm_init_phase_addon_coredns.md) - Install the CoreDNS addon to a Kubernetes cluster +* [kubeadm init phase addon kube-proxy](kubeadm_init_phase_addon_kube-proxy.md) - Install the kube-proxy addon to a Kubernetes cluster diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_all.md index f27dd95699..4e7bc09d70 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_all.md @@ -1,8 +1,7 @@ -Install all the addons - ### Synopsis + Install all the addons ``` @@ -11,23 +10,124 @@ kubeadm init phase addon all [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --config string Path to a kubeadm configuration file. - --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. - -h, --help help for all - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") - --pod-network-cidr string Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node. - --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") - --service-dns-domain string Use alternative domain for services, e.g. "myorg.internal". (default "cluster.local") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
IPv6DualStack=true|false (ALPHA - default=false)
-h, --help
help for all
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--pod-network-cidr string
Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase addon](kubeadm_init_phase_addon.md) - Install required addons for passing Conformance tests diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_coredns.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_coredns.md index 1e7c742f97..fbaeabf059 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_coredns.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_coredns.md @@ -1,8 +1,7 @@ -Install the CoreDNS addon to a Kubernetes cluster - ### Synopsis + Install the CoreDNS addon components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. ``` @@ -11,20 +10,96 @@ kubeadm init phase addon coredns [flags] ### Options -``` - --config string Path to a kubeadm configuration file. - --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. - -h, --help help for coredns - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") - --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") - --service-dns-domain string Use alternative domain for services, e.g. "myorg.internal". (default "cluster.local") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
IPv6DualStack=true|false (ALPHA - default=false)
-h, --help
help for coredns
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase addon](kubeadm_init_phase_addon.md) - Install required addons for passing Conformance tests diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_kube-proxy.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_kube-proxy.md index 2af54fcf9d..04e0833902 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_kube-proxy.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_addon_kube-proxy.md @@ -1,8 +1,7 @@ -Install the kube-proxy addon to a Kubernetes cluster - ### Synopsis + Install the kube-proxy addon components via the API server. ``` @@ -11,20 +10,103 @@ kubeadm init phase addon kube-proxy [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --config string Path to a kubeadm configuration file. - -h, --help help for kube-proxy - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") - --pod-network-cidr string Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
-h, --help
help for kube-proxy
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--pod-network-cidr string
Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase addon](kubeadm_init_phase_addon.md) - Install required addons for passing Conformance tests diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_bootstrap-token.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_bootstrap-token.md index da037aa124..a0bfdcff12 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_bootstrap-token.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_bootstrap-token.md @@ -1,9 +1,8 @@ -Generates bootstrap tokens used to join a node to a cluster - ### Synopsis -Bootstrap tokens are used for establishing bidirectional trust between a node joining the cluster and a the control-plane node. + +Bootstrap tokens are used for establishing bidirectional trust between a node joining the cluster and a control-plane node. This command makes all the configurations required to make bootstrap tokens works and then creates an initial token. @@ -21,16 +20,68 @@ kubeadm init phase bootstrap-token [flags] ### Options -``` - --config string Path to a kubeadm configuration file. - -h, --help help for bootstrap-token - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --skip-token-print Skip printing of the default bootstrap token generated by 'kubeadm init'. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
-h, --help
help for bootstrap-token
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--skip-token-print
Skip printing of the default bootstrap token generated by 'kubeadm init'.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs.md index 0c7c04d9ef..790b42e849 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs.md @@ -1,8 +1,7 @@ -Certificate generation - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ``` @@ -11,13 +10,59 @@ kubeadm init phase certs [flags] ### Options -``` - -h, --help help for certs -``` + + + + + + + + + + + + + + + +
-h, --help
help for certs
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow +* [kubeadm init phase certs all](kubeadm_init_phase_certs_all.md) - Generate all certificates +* [kubeadm init phase certs apiserver](kubeadm_init_phase_certs_apiserver.md) - Generate the certificate for serving the Kubernetes API +* [kubeadm init phase certs apiserver-etcd-client](kubeadm_init_phase_certs_apiserver-etcd-client.md) - Generate the certificate the apiserver uses to access etcd +* [kubeadm init phase certs apiserver-kubelet-client](kubeadm_init_phase_certs_apiserver-kubelet-client.md) - Generate the certificate for the API server to connect to kubelet +* [kubeadm init phase certs ca](kubeadm_init_phase_certs_ca.md) - Generate the self-signed Kubernetes CA to provision identities for other Kubernetes components +* [kubeadm init phase certs etcd-ca](kubeadm_init_phase_certs_etcd-ca.md) - Generate the self-signed CA to provision identities for etcd +* [kubeadm init phase certs etcd-healthcheck-client](kubeadm_init_phase_certs_etcd-healthcheck-client.md) - Generate the certificate for liveness probes to healthcheck etcd +* [kubeadm init phase certs etcd-peer](kubeadm_init_phase_certs_etcd-peer.md) - Generate the certificate for etcd nodes to communicate with each other +* [kubeadm init phase certs etcd-server](kubeadm_init_phase_certs_etcd-server.md) - Generate the certificate for serving etcd +* [kubeadm init phase certs front-proxy-ca](kubeadm_init_phase_certs_front-proxy-ca.md) - Generate the self-signed CA to provision identities for front proxy +* [kubeadm init phase certs front-proxy-client](kubeadm_init_phase_certs_front-proxy-client.md) - Generate the certificate for the front proxy client +* [kubeadm init phase certs sa](kubeadm_init_phase_certs_sa.md) - Generate a private key for signing service account tokens along with its public key diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_all.md index 6798a92d1e..79de3b4d76 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_all.md @@ -1,8 +1,7 @@ -Generate all certificates - ### Synopsis + Generate all certificates ``` @@ -11,19 +10,103 @@ kubeadm init phase certs all [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-cert-extra-sans strings Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names. - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for all - --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") - --service-dns-domain string Use alternative domain for services, e.g. "myorg.internal". (default "cluster.local") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-cert-extra-sans stringSlice
Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
-h, --help
help for all
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-etcd-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-etcd-client.md index 03af7712c0..b946c37575 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-etcd-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-etcd-client.md @@ -1,11 +1,10 @@ -Generate the certificate the apiserver uses to access etcd - ### Synopsis -Generate the certificate the apiserver uses to access etcd, and save them into apiserver-etcd-client.cert and apiserver-etcd-client.key files. -If both files already exist, kubeadm skips the generation step and existing files will be used. +Generate the certificate the apiserver uses to access etcd, and save them into apiserver-etcd-client.cert and apiserver-etcd-client.key files. + +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -15,17 +14,82 @@ kubeadm init phase certs apiserver-etcd-client [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for apiserver-etcd-client -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver-etcd-client
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-kubelet-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-kubelet-client.md index 3ef0865521..6a8895bd81 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-kubelet-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver-kubelet-client.md @@ -1,11 +1,10 @@ -Generate the certificate for the API server to connect to kubelet - ### Synopsis -Generate the certificate for the API server to connect to kubelet, and save them into apiserver-kubelet-client.cert and apiserver-kubelet-client.key files. -If both files already exist, kubeadm skips the generation step and existing files will be used. +Generate the certificate for the API server to connect to kubelet, and save them into apiserver-kubelet-client.cert and apiserver-kubelet-client.key files. + +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -15,17 +14,82 @@ kubeadm init phase certs apiserver-kubelet-client [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for apiserver-kubelet-client -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver-kubelet-client
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver.md index 9562ffd8fe..78812603b0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_apiserver.md @@ -1,13 +1,12 @@ -Generate the certificate for serving the Kubernetes API - ### Synopsis + Generate the certificate for serving the Kubernetes API, and save them into apiserver.cert and apiserver.key files. -Default SANs are kubernetes, kubernetes.default, kubernetes.default.svc, kubernetes.default.svc.cluster.local, 10.96.0.1, 127.0.0.1 +Default SANs are kubernetes, kubernetes.default, kubernetes.default.svc, kubernetes.default.svc.cluster.local, 10.96.0.1, 127.0.0.1 -If both files already exist, kubeadm skips the generation step and existing files will be used. +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -17,21 +16,117 @@ kubeadm init phase certs apiserver [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-cert-extra-sans strings Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names. - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for apiserver - --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") - --service-dns-domain string Use alternative domain for services, e.g. "myorg.internal". (default "cluster.local") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-cert-extra-sans stringSlice
Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for apiserver
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_ca.md index cc5d479e7b..a9bf1620ac 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_ca.md @@ -1,11 +1,10 @@ -Generate the self-signed Kubernetes CA to provision identities for other Kubernetes components - ### Synopsis -Generate the self-signed Kubernetes CA to provision identities for other Kubernetes components, and save them into ca.cert and ca.key files. -If both files already exist, kubeadm skips the generation step and existing files will be used. +Generate the self-signed Kubernetes CA to provision identities for other Kubernetes components, and save them into ca.cert and ca.key files. + +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -15,15 +14,68 @@ kubeadm init phase certs ca [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for ca -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
-h, --help
help for ca
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-ca.md index 48345f6b01..8f202cc8b4 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-ca.md @@ -1,11 +1,10 @@ -Generate the self-signed CA to provision identities for etcd - ### Synopsis -Generate the self-signed CA to provision identities for etcd, and save them into etcd/ca.cert and etcd/ca.key files. -If both files already exist, kubeadm skips the generation step and existing files will be used. +Generate the self-signed CA to provision identities for etcd, and save them into etcd/ca.cert and etcd/ca.key files. + +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -15,15 +14,68 @@ kubeadm init phase certs etcd-ca [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for etcd-ca -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
-h, --help
help for etcd-ca
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-healthcheck-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-healthcheck-client.md index c4428459b7..6bd845cf9a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-healthcheck-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-healthcheck-client.md @@ -1,11 +1,10 @@ -Generate the certificate for liveness probes to healtcheck etcd - ### Synopsis -Generate the certificate for liveness probes to healtcheck etcd, and save them into etcd/healthcheck-client.cert and etcd/healthcheck-client.key files. -If both files already exist, kubeadm skips the generation step and existing files will be used. +Generate the certificate for liveness probes to healthcheck etcd, and save them into etcd/healthcheck-client.cert and etcd/healthcheck-client.key files. + +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -15,17 +14,82 @@ kubeadm init phase certs etcd-healthcheck-client [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for etcd-healthcheck-client -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-healthcheck-client
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-peer.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-peer.md index fd9f355a6a..be1603741d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-peer.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-peer.md @@ -1,13 +1,12 @@ -Generate the certificate for etcd nodes to communicate with each other - ### Synopsis + Generate the certificate for etcd nodes to communicate with each other, and save them into etcd/peer.cert and etcd/peer.key files. -Default SANs are localhost, 127.0.0.1, 127.0.0.1, ::1 +Default SANs are localhost, 127.0.0.1, 127.0.0.1, ::1 -If both files already exist, kubeadm skips the generation step and existing files will be used. +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -17,17 +16,82 @@ kubeadm init phase certs etcd-peer [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for etcd-peer -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-peer
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-server.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-server.md index 19489e9f16..49e4e994c7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-server.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_etcd-server.md @@ -1,13 +1,12 @@ -Generate the certificate for serving etcd - ### Synopsis + Generate the certificate for serving etcd, and save them into etcd/server.cert and etcd/server.key files. -Default SANs are localhost, 127.0.0.1, 127.0.0.1, ::1 +Default SANs are localhost, 127.0.0.1, 127.0.0.1, ::1 -If both files already exist, kubeadm skips the generation step and existing files will be used. +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -17,17 +16,82 @@ kubeadm init phase certs etcd-server [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for etcd-server -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for etcd-server
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-ca.md index dcf4e16da2..22d7676778 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-ca.md @@ -1,11 +1,10 @@ -Generate the self-signed CA to provision identities for front proxy - ### Synopsis -Generate the self-signed CA to provision identities for front proxy, and save them into front-proxy-ca.cert and front-proxy-ca.key files. -If both files already exist, kubeadm skips the generation step and existing files will be used. +Generate the self-signed CA to provision identities for front proxy, and save them into front-proxy-ca.cert and front-proxy-ca.key files. + +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -15,15 +14,68 @@ kubeadm init phase certs front-proxy-ca [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for front-proxy-ca -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
-h, --help
help for front-proxy-ca
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-client.md index 8594356941..ce848439ae 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_front-proxy-client.md @@ -1,11 +1,10 @@ -Generate the certificate for the front proxy client - ### Synopsis -Generate the certificate for the front proxy client, and save them into front-proxy-client.cert and front-proxy-client.key files. -If both files already exist, kubeadm skips the generation step and existing files will be used. +Generate the certificate for the front proxy client, and save them into front-proxy-client.cert and front-proxy-client.key files. + +If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -15,17 +14,82 @@ kubeadm init phase certs front-proxy-client [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --csr-dir string The path to output the CSRs and private keys to - --csr-only Create CSRs instead of generating certificates - -h, --help help for front-proxy-client -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--csr-dir string
The path to output the CSRs and private keys to
--csr-only
Create CSRs instead of generating certificates
-h, --help
help for front-proxy-client
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_sa.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_sa.md index d820c1db4a..8abf8178ae 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_sa.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_certs_sa.md @@ -1,9 +1,8 @@ -Generate a private key for signing service account tokens along with its public key - ### Synopsis -Generate the private key for signing service account tokens along with its public key, and save them into sa.key and sa.pub files. If both files already exist, kubeadm skips the generation step and existing files will be used. + +Generate the private key for signing service account tokens along with its public key, and save them into sa.key and sa.pub files. If both files already exist, kubeadm skips the generation step and existing files will be used. Alpha Disclaimer: this command is currently alpha. @@ -13,14 +12,54 @@ kubeadm init phase certs sa [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - -h, --help help for sa -``` + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
-h, --help
help for sa
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase certs](kubeadm_init_phase_certs.md) - Certificate generation diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane.md index e3b47df73f..36cdc5e54c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane.md @@ -1,8 +1,7 @@ -Generate all static Pod manifest files necessary to establish the control plane - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ``` @@ -11,13 +10,51 @@ kubeadm init phase control-plane [flags] ### Options -``` - -h, --help help for control-plane -``` + + + + + + + + + + + + + + + +
-h, --help
help for control-plane
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow +* [kubeadm init phase control-plane all](kubeadm_init_phase_control-plane_all.md) - Generate all static Pod manifest files +* [kubeadm init phase control-plane apiserver](kubeadm_init_phase_control-plane_apiserver.md) - Generates the kube-apiserver static Pod manifest +* [kubeadm init phase control-plane controller-manager](kubeadm_init_phase_control-plane_controller-manager.md) - Generates the kube-controller-manager static Pod manifest +* [kubeadm init phase control-plane scheduler](kubeadm_init_phase_control-plane_scheduler.md) - Generates the kube-scheduler static Pod manifest diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_all.md index d5a229d47e..c22ba703da 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_all.md @@ -1,8 +1,7 @@ -Generate all static Pod manifest files - ### Synopsis + Generate all static Pod manifest files ``` @@ -22,25 +21,145 @@ kubeadm init phase control-plane all [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --apiserver-extra-args mapStringString A set of extra flags to pass to the API Server or override default ones in form of = - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --controller-manager-extra-args mapStringString A set of extra flags to pass to the Controller Manager or override default ones in form of = - --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. - -h, --help help for all - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") - --pod-network-cidr string Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node. - --scheduler-extra-args mapStringString A set of extra flags to pass to the Scheduler or override default ones in form of = - --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--apiserver-extra-args mapStringString
A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
--controller-manager-extra-args mapStringString
A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
IPv6DualStack=true|false (ALPHA - default=false)
-h, --help
help for all
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--pod-network-cidr string
Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.
--scheduler-extra-args mapStringString
A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase control-plane](kubeadm_init_phase_control-plane.md) - Generate all static Pod manifest files necessary to establish the control plane diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_apiserver.md index a73f6979de..8e5519714c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_apiserver.md @@ -1,8 +1,7 @@ -Generates the kube-apiserver static Pod manifest - ### Synopsis + Generates the kube-apiserver static Pod manifest ``` @@ -11,22 +10,124 @@ kubeadm init phase control-plane apiserver [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --apiserver-extra-args mapStringString A set of extra flags to pass to the API Server or override default ones in form of = - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. - -h, --help help for apiserver - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") - --service-cidr string Use alternative range of IP address for service VIPs. (default "10.96.0.0/12") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--apiserver-extra-args mapStringString
A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
IPv6DualStack=true|false (ALPHA - default=false)
-h, --help
help for apiserver
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase control-plane](kubeadm_init_phase_control-plane.md) - Generate all static Pod manifest files necessary to establish the control plane diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_controller-manager.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_controller-manager.md index a12e82f3c9..cda1122263 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_controller-manager.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_controller-manager.md @@ -1,8 +1,7 @@ -Generates the kube-controller-manager static Pod manifest - ### Synopsis + Generates the kube-controller-manager static Pod manifest ``` @@ -11,19 +10,96 @@ kubeadm init phase control-plane controller-manager [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - --controller-manager-extra-args mapStringString A set of extra flags to pass to the Controller Manager or override default ones in form of = - -h, --help help for controller-manager - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") - --pod-network-cidr string Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--controller-manager-extra-args mapStringString
A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
-h, --help
help for controller-manager
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--pod-network-cidr string
Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase control-plane](kubeadm_init_phase_control-plane.md) - Generate all static Pod manifest files necessary to establish the control plane diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_scheduler.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_scheduler.md index 13219cef36..79cb6d409d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_scheduler.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_control-plane_scheduler.md @@ -1,8 +1,7 @@ -Generates the kube-scheduler static Pod manifest - ### Synopsis + Generates the kube-scheduler static Pod manifest ``` @@ -11,18 +10,89 @@ kubeadm init phase control-plane scheduler [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for scheduler - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") - --kubernetes-version string Choose a specific Kubernetes version for the control plane. (default "stable-1") - --scheduler-extra-args mapStringString A set of extra flags to pass to the Scheduler or override default ones in form of = -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
-h, --help
help for scheduler
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--scheduler-extra-args mapStringString
A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase control-plane](kubeadm_init_phase_control-plane.md) - Generate all static Pod manifest files necessary to establish the control plane diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd.md index e6c93bc7e2..9839e5daf0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd.md @@ -1,8 +1,7 @@ -Generate static Pod manifest file for local etcd - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ``` @@ -11,13 +10,48 @@ kubeadm init phase etcd [flags] ### Options -``` - -h, --help help for etcd -``` + + + + + + + + + + + + + + + +
-h, --help
help for etcd
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow +* [kubeadm init phase etcd local](kubeadm_init_phase_etcd_local.md) - Generate the static Pod manifest file for a local, single-node local etcd instance diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd_local.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd_local.md index c07f3d39ca..f379226d7a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd_local.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_etcd_local.md @@ -1,8 +1,7 @@ -Generate the static Pod manifest file for a local, single-node local etcd instance - ### Synopsis + Generate the static Pod manifest file for a local, single-node local etcd instance ``` @@ -23,16 +22,75 @@ kubeadm init phase etcd local [flags] ### Options -``` - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for local - --image-repository string Choose a container registry to pull control plane images from (default "k8s.gcr.io") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
-h, --help
help for local
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase etcd](kubeadm_init_phase_etcd.md) - Generate static Pod manifest file for local etcd diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig.md index e903238a9e..d6f270dd03 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig.md @@ -1,8 +1,7 @@ -Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ``` @@ -11,13 +10,52 @@ kubeadm init phase kubeconfig [flags] ### Options -``` - -h, --help help for kubeconfig -``` + + + + + + + + + + + + + + + +
-h, --help
help for kubeconfig
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow +* [kubeadm init phase kubeconfig admin](kubeadm_init_phase_kubeconfig_admin.md) - Generate a kubeconfig file for the admin to use and for kubeadm itself +* [kubeadm init phase kubeconfig all](kubeadm_init_phase_kubeconfig_all.md) - Generate all kubeconfig files +* [kubeadm init phase kubeconfig controller-manager](kubeadm_init_phase_kubeconfig_controller-manager.md) - Generate a kubeconfig file for the controller manager to use +* [kubeadm init phase kubeconfig kubelet](kubeadm_init_phase_kubeconfig_kubelet.md) - Generate a kubeconfig file for the kubelet to use *only* for cluster bootstrapping purposes +* [kubeadm init phase kubeconfig scheduler](kubeadm_init_phase_kubeconfig_scheduler.md) - Generate a kubeconfig file for the scheduler to use diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_admin.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_admin.md index 4173da018f..04c7c36e79 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_admin.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_admin.md @@ -1,8 +1,7 @@ -Generate a kubeconfig file for the admin to use and for kubeadm itself - ### Synopsis + Generate the kubeconfig file for the admin and for kubeadm itself, and save it to admin.conf file. ``` @@ -11,18 +10,96 @@ kubeadm init phase kubeconfig admin [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for admin - --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
-h, --help
help for admin
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase kubeconfig](kubeadm_init_phase_kubeconfig.md) - Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_all.md index 5182f62548..f99dfd8027 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_all.md @@ -1,8 +1,7 @@ -Generate all kubeconfig files - ### Synopsis + Generate all kubeconfig files ``` @@ -11,19 +10,103 @@ kubeadm init phase kubeconfig all [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for all - --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") - --node-name string Specify the node name. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
-h, --help
help for all
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--node-name string
Specify the node name.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase kubeconfig](kubeadm_init_phase_kubeconfig.md) - Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_controller-manager.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_controller-manager.md index 5e6514887a..d99a78f6f3 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_controller-manager.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_controller-manager.md @@ -1,8 +1,7 @@ -Generate a kubeconfig file for the controller manager to use - ### Synopsis + Generate the kubeconfig file for the controller manager to use and save it to controller-manager.conf file ``` @@ -11,18 +10,96 @@ kubeadm init phase kubeconfig controller-manager [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for controller-manager - --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
-h, --help
help for controller-manager
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase kubeconfig](kubeadm_init_phase_kubeconfig.md) - Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_kubelet.md index 4d08ce4bcf..3affd30133 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_kubelet.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_kubelet.md @@ -1,11 +1,10 @@ -Generate a kubeconfig file for the kubelet to use *only* for cluster bootstrapping purposes - ### Synopsis -Generate the kubeconfig file for the kubelet to use and save it to kubelet.conf file. -Please note that this should only be used for cluster bootstrapping purposes. After your control plane is up, you should request all kubelet credentials from the CSR API. +Generate the kubeconfig file for the kubelet to use and save it to kubelet.conf file. + +Please note that this should *only* be used for cluster bootstrapping purposes. After your control plane is up, you should request all kubelet credentials from the CSR API. ``` kubeadm init phase kubeconfig kubelet [flags] @@ -13,19 +12,103 @@ kubeadm init phase kubeconfig kubelet [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for kubelet - --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") - --node-name string Specify the node name. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
-h, --help
help for kubelet
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
--node-name string
Specify the node name.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase kubeconfig](kubeadm_init_phase_kubeconfig.md) - Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_scheduler.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_scheduler.md index 72784a9508..92d7621345 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_scheduler.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubeconfig_scheduler.md @@ -1,8 +1,7 @@ -Generate a kubeconfig file for the scheduler to use - ### Synopsis + Generate the kubeconfig file for the scheduler to use and save it to scheduler.conf file. ``` @@ -11,18 +10,96 @@ kubeadm init phase kubeconfig scheduler [flags] ### Options -``` - --apiserver-advertise-address string The IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 Port for the API Server to bind to. (default 6443) - --cert-dir string The path where to save and store the certificates. (default "/etc/kubernetes/pki") - --config string Path to a kubeadm configuration file. - -h, --help help for scheduler - --kubeconfig-dir string The path where to save the kubeconfig file. (default "/etc/kubernetes") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.
--config string
Path to a kubeadm configuration file.
--control-plane-endpoint string
Specify a stable IP address or DNS name for the control plane.
-h, --help
help for scheduler
--kubeconfig-dir string     Default: "/etc/kubernetes"
The path where to save the kubeconfig file.
--kubernetes-version string     Default: "stable-1"
Choose a specific Kubernetes version for the control plane.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase kubeconfig](kubeadm_init_phase_kubeconfig.md) - Generate all kubeconfig files necessary to establish the control plane and the admin kubeconfig file diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubelet-start.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubelet-start.md index 4ee94fe1d0..2026acd2cd 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubelet-start.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_kubelet-start.md @@ -1,8 +1,7 @@ -Write kubelet settings and (re)start the kubelet - ### Synopsis + Write a file with KubeletConfiguration and an environment file with node specific kubelet settings, and then (re)start kubelet. ``` @@ -18,16 +17,68 @@ kubeadm init phase kubelet-start [flags] ### Options -``` - --config string Path to a kubeadm configuration file. - --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. - -h, --help help for kubelet-start - --node-name string Specify the node name. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
--cri-socket string
Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket.
-h, --help
help for kubelet-start
--node-name string
Specify the node name.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_mark-control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_mark-control-plane.md index f30046cc55..abf25d7c49 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_mark-control-plane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_mark-control-plane.md @@ -1,8 +1,7 @@ -Mark a node as a control-plane - ### Synopsis + Mark a node as a control-plane ``` @@ -21,15 +20,61 @@ kubeadm init phase mark-control-plane [flags] ### Options -``` - --config string Path to a kubeadm configuration file. - -h, --help help for mark-control-plane - --node-name string Specify the node name. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
-h, --help
help for mark-control-plane
--node-name string
Specify the node name.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_preflight.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_preflight.md index 499c88dfcd..3e5a84cc4e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_preflight.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_preflight.md @@ -1,8 +1,7 @@ -Run pre-flight checks - ### Synopsis + Run pre-flight checks for kubeadm init. ``` @@ -18,15 +17,61 @@ kubeadm init phase preflight [flags] ### Options -``` - --config string Path to a kubeadm configuration file. - -h, --help help for preflight - --ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
-h, --help
help for preflight
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-certs.md index 6db96943a0..ced3e069a2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-certs.md @@ -1,6 +1,4 @@ -Upload certificates to kubeadm-certs - ### Synopsis @@ -12,13 +10,52 @@ kubeadm init phase upload-certs [flags] ### Options -``` - --certificate-key string Key used to encrypt the control-plane certificates in the kubeadm-certs Secret. - --config string Path to a kubeadm configuration file. - -h, --help help for upload-certs - --skip-certificate-key-print Don't print the key used to encrypt the control-plane certificates. - --upload-certs Upload control-plane certificates to the kubeadm-certs Secret. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--certificate-key string
Key used to encrypt the control-plane certificates in the kubeadm-certs Secret.
--config string
Path to a kubeadm configuration file.
-h, --help
help for upload-certs
--skip-certificate-key-print
Don't print the key used to encrypt the control-plane certificates.
--upload-certs
Upload control-plane certificates to the kubeadm-certs Secret.
+ + ### Options inherited from parent commands @@ -41,3 +78,7 @@ kubeadm init phase upload-certs [flags] +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config.md index c44ed60548..f60a6bfb90 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config.md @@ -1,8 +1,7 @@ -Upload the kubeadm and kubelet configuration to a ConfigMap - ### Synopsis + This command is not meant to be run on its own. See list of available subcommands. ``` @@ -11,13 +10,50 @@ kubeadm init phase upload-config [flags] ### Options -``` - -h, --help help for upload-config -``` + + + + + + + + + + + + + + + +
-h, --help
help for upload-config
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase](kubeadm_init_phase.md) - Use this command to invoke single phase of the init workflow +* [kubeadm init phase upload-config all](kubeadm_init_phase_upload-config_all.md) - Upload all configuration to a config map +* [kubeadm init phase upload-config kubeadm](kubeadm_init_phase_upload-config_kubeadm.md) - Upload the kubeadm ClusterConfiguration to a ConfigMap +* [kubeadm init phase upload-config kubelet](kubeadm_init_phase_upload-config_kubelet.md) - Upload the kubelet component config to a ConfigMap diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_all.md index d6ccc063d3..c042611e95 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_all.md @@ -1,8 +1,7 @@ -Upload all configuration to a config map - ### Synopsis + Upload all configuration to a config map ``` @@ -11,15 +10,61 @@ kubeadm init phase upload-config all [flags] ### Options -``` - --config string Path to a kubeadm configuration file. - -h, --help help for all - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
-h, --help
help for all
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase upload-config](kubeadm_init_phase_upload-config.md) - Upload the kubeadm and kubelet configuration to a ConfigMap diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubeadm.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubeadm.md index cec14b629f..895819ce66 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubeadm.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubeadm.md @@ -1,9 +1,8 @@ -Upload the kubeadm ClusterConfiguration to a ConfigMap - ### Synopsis -Upload the kubeadm ClusterConfiguration to a ConfigMap called kubeadm-config in the kube-system namespace. This enables correct configuration of system components and a seamless user experience when upgrading. + +Upload the kubeadm ClusterConfiguration to a ConfigMap called kubeadm-config in the kube-system namespace. This enables correct configuration of system components and a seamless user experience when upgrading. Alternatively, you can use kubeadm config. @@ -20,15 +19,61 @@ kubeadm init phase upload-config kubeadm [flags] ### Options -``` - --config string Path to a kubeadm configuration file. - -h, --help help for kubeadm - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
-h, --help
help for kubeadm
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase upload-config](kubeadm_init_phase_upload-config.md) - Upload the kubeadm and kubelet configuration to a ConfigMap diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubelet.md index 549703c970..797d36ee53 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubelet.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init_phase_upload-config_kubelet.md @@ -1,8 +1,7 @@ -Upload the kubelet component config to a ConfigMap - ### Synopsis + Upload kubelet configuration extracted from the kubeadm InitConfiguration object to a ConfigMap of the form kubelet-config-1.X in the cluster, where X is the minor version of the current (API Server) Kubernetes version. ``` @@ -18,15 +17,61 @@ kubeadm init phase upload-config kubelet [flags] ### Options -``` - --config string Path to a kubeadm configuration file. - -h, --help help for kubelet - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
-h, --help
help for kubelet
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm init phase upload-config](kubeadm_init_phase_upload-config.md) - Upload the kubeadm and kubelet configuration to a ConfigMap diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md index 8e8c47444e..36d81f7ac7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md @@ -1,9 +1,8 @@ -Run this on any machine you wish to join an existing cluster - ### Synopsis + When joining a kubeadm initialized cluster, we need to establish bidirectional trust. This is split into discovery (having the Node trust the Kubernetes Control Plane) and TLS bootstrap (having the @@ -23,7 +22,7 @@ the connection. If you use a shared token for discovery, you should also pass the --discovery-token-ca-cert-hash flag to validate the public key of the root certificate authority (CA) presented by the Kubernetes Control Plane. -The value of this flag is specified as ":", +The value of this flag is specified as "<hash-type>:<hex-encoded-value>", where the supported hash type is "sha256". The hash is calculated over the bytes of the Subject Public Key Info (SPKI) object (as in RFC7469). This value is available in the output of "kubeadm init" or can be @@ -68,29 +67,160 @@ kubeadm join [api-server-endpoint] [flags] ### Options -``` - --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 If the node should host a new control plane instance, the port for the API Server to bind to. (default 6443) - --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. - --discovery-file string For file-based discovery, a file or URL from which to load cluster information. - --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. - --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). - --discovery-token-unsafe-skip-ca-verification For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning. - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for join - --ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. - --node-name string Specify the node name. - --skip-phases strings List of phases to be skipped - --tls-bootstrap-token string Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node. - --token string Use this token for both discovery-token and tls-bootstrap-token when those values are not provided. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
If the node should host a new control plane instance, the port for the API Server to bind to.
--certificate-key string
Use this key to decrypt the certificate secrets uploaded by init.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
--cri-socket string
Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket.
--discovery-file string
For file-based discovery, a file or URL from which to load cluster information.
--discovery-token string
For token-based discovery, the token used to validate cluster information fetched from the API server.
--discovery-token-ca-cert-hash stringSlice
For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").
--discovery-token-unsafe-skip-ca-verification
For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
-h, --help
help for join
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--node-name string
Specify the node name.
--skip-phases stringSlice
List of phases to be skipped
--tls-bootstrap-token string
Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node.
--token string
Use this token for both discovery-token and tls-bootstrap-token when those values are not provided.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm](kubeadm.md) - kubeadm: easily bootstrap a secure Kubernetes cluster +* [kubeadm join phase](kubeadm_join_phase.md) - Use this command to invoke single phase of the join workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase.md index 438f6d8fbb..5ae58be8fd 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase.md @@ -1,8 +1,7 @@ -Use this command to invoke single phase of the join workflow - ### Synopsis + Use this command to invoke single phase of the join workflow ### Options @@ -47,3 +46,11 @@ Use this command to invoke single phase of the join workflow +SEE ALSO + +* [kubeadm join](kubeadm_join.md) - Run this on any machine you wish to join an existing cluster +* [kubeadm join phase control-plane-join](kubeadm_join_phase_control-plane-join.md) - Join a machine as a control plane instance +* [kubeadm join phase control-plane-prepare](kubeadm_join_phase_control-plane-prepare.md) - Prepare the machine for serving a control plane +* [kubeadm join phase kubelet-start](kubeadm_join_phase_kubelet-start.md) - Write kubelet settings, certificates and (re)start the kubelet +* [kubeadm join phase preflight](kubeadm_join_phase_preflight.md) - Run join pre-flight checks + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join.md index 8d14b464ba..5cd22eae71 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join.md @@ -1,8 +1,7 @@ -Join a machine as a control plane instance - ### Synopsis + Join a machine as a control plane instance ``` @@ -58,3 +57,11 @@ kubeadm join phase control-plane-join [flags] +SEE ALSO + +* [kubeadm join phase](kubeadm_join_phase.md) - Use this command to invoke single phase of the join workflow +* [kubeadm join phase control-plane-join all](kubeadm_join_phase_control-plane-join_all.md) - Join a machine as a control plane instance +* [kubeadm join phase control-plane-join etcd](kubeadm_join_phase_control-plane-join_etcd.md) - Add a new local etcd member +* [kubeadm join phase control-plane-join mark-control-plane](kubeadm_join_phase_control-plane-join_mark-control-plane.md) - Mark a node as a control-plane +* [kubeadm join phase control-plane-join update-status](kubeadm_join_phase_control-plane-join_update-status.md) - Register the new control-plane node into the ClusterStatus maintained in the kubeadm-config ConfigMap + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_all.md index c51823d743..12ff88e925 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_all.md @@ -1,8 +1,7 @@ -Join a machine as a control plane instance - ### Synopsis + Join a machine as a control plane instance ``` @@ -11,14 +10,52 @@ kubeadm join phase control-plane-join all [flags] ### Options -``` - --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for all - --node-name string Specify the node name. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
-h, --help
help for all
--node-name string
Specify the node name.
+ + ### Options inherited from parent commands @@ -41,3 +78,7 @@ kubeadm join phase control-plane-join all [flags] +SEE ALSO + +* [kubeadm join phase control-plane-join](kubeadm_join_phase_control-plane-join.md) - Join a machine as a control plane instance + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_etcd.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_etcd.md index efc20a4d07..dddeab59b7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_etcd.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_etcd.md @@ -1,6 +1,4 @@ -Add a new local etcd member - ### Synopsis @@ -12,14 +10,59 @@ kubeadm join phase control-plane-join etcd [flags] ### Options -``` - --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for etcd - --node-name string Specify the node name. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
-h, --help
help for etcd
--node-name string
Specify the node name.
+ + ### Options inherited from parent commands @@ -42,3 +85,7 @@ kubeadm join phase control-plane-join etcd [flags] +SEE ALSO + +* [kubeadm join phase control-plane-join](kubeadm_join_phase_control-plane-join.md) - Join a machine as a control plane instance + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_mark-control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_mark-control-plane.md index e2c6753083..f08ddeea18 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_mark-control-plane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_mark-control-plane.md @@ -1,6 +1,4 @@ -Mark a node as a control-plane - ### Synopsis @@ -12,13 +10,45 @@ kubeadm join phase control-plane-join mark-control-plane [flags] ### Options -``` - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for mark-control-plane - --node-name string Specify the node name. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
-h, --help
help for mark-control-plane
--node-name string
Specify the node name.
+ + ### Options inherited from parent commands @@ -41,3 +71,7 @@ kubeadm join phase control-plane-join mark-control-plane [flags] +SEE ALSO + +* [kubeadm join phase control-plane-join](kubeadm_join_phase_control-plane-join.md) - Join a machine as a control plane instance + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_update-status.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_update-status.md index 34bb0f92b5..b311ac7e3e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_update-status.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-join_update-status.md @@ -1,6 +1,4 @@ -Register the new control-plane node into the ClusterStatus maintained in the kubeadm-config ConfigMap - ### Synopsis @@ -12,14 +10,52 @@ kubeadm join phase control-plane-join update-status [flags] ### Options -``` - --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for update-status - --node-name string Specify the node name. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
-h, --help
help for update-status
--node-name string
Specify the node name.
+ + ### Options inherited from parent commands @@ -42,3 +78,7 @@ kubeadm join phase control-plane-join update-status [flags] +SEE ALSO + +* [kubeadm join phase control-plane-join](kubeadm_join_phase_control-plane-join.md) - Join a machine as a control plane instance + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare.md index 7aecb0c8cc..0dfec00c51 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare.md @@ -1,8 +1,7 @@ -Prepare the machine for serving a control plane - ### Synopsis + Prepare the machine for serving a control plane ``` @@ -58,3 +57,12 @@ kubeadm join phase control-plane-prepare [flags] +SEE ALSO + +* [kubeadm join phase](kubeadm_join_phase.md) - Use this command to invoke single phase of the join workflow +* [kubeadm join phase control-plane-prepare all](kubeadm_join_phase_control-plane-prepare_all.md) - Prepare the machine for serving a control plane +* [kubeadm join phase control-plane-prepare certs](kubeadm_join_phase_control-plane-prepare_certs.md) - Generate the certificates for the new control plane components +* [kubeadm join phase control-plane-prepare control-plane](kubeadm_join_phase_control-plane-prepare_control-plane.md) - Generate the manifests for the new control plane components +* [kubeadm join phase control-plane-prepare download-certs](kubeadm_join_phase_control-plane-prepare_download-certs.md) - [EXPERIMENTAL] Download certificates shared among control-plane nodes from the kubeadm-certs Secret +* [kubeadm join phase control-plane-prepare kubeconfig](kubeadm_join_phase_control-plane-prepare_kubeconfig.md) - Generate the kubeconfig for the new control plane components + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_all.md index 9ef35f347a..b329214b66 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_all.md @@ -1,8 +1,7 @@ -Prepare the machine for serving a control plane - ### Synopsis + Prepare the machine for serving a control plane ``` @@ -11,22 +10,115 @@ kubeadm join phase control-plane-prepare all [api-server-endpoint] [flags] ### Options -``` - --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 If the node should host a new control plane instance, the port for the API Server to bind to. (default 6443) - --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --discovery-file string For file-based discovery, a file or URL from which to load cluster information. - --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. - --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). - --discovery-token-unsafe-skip-ca-verification For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning. - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for all - --node-name string Specify the node name. - --tls-bootstrap-token string Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node. - --token string Use this token for both discovery-token and tls-bootstrap-token when those values are not provided. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
If the node should host a new control plane instance, the port for the API Server to bind to.
--certificate-key string
Use this key to decrypt the certificate secrets uploaded by init.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
--discovery-file string
For file-based discovery, a file or URL from which to load cluster information.
--discovery-token string
For token-based discovery, the token used to validate cluster information fetched from the API server.
--discovery-token-ca-cert-hash stringSlice
For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").
--discovery-token-unsafe-skip-ca-verification
For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
-h, --help
help for all
--node-name string
Specify the node name.
--tls-bootstrap-token string
Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node.
--token string
Use this token for both discovery-token and tls-bootstrap-token when those values are not provided.
+ + ### Options inherited from parent commands @@ -49,3 +141,7 @@ kubeadm join phase control-plane-prepare all [api-server-endpoint] [flags] +SEE ALSO + +* [kubeadm join phase control-plane-prepare](kubeadm_join_phase_control-plane-prepare.md) - Prepare the machine for serving a control plane + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_certs.md index e4199954e5..01a8078903 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_certs.md @@ -1,8 +1,7 @@ -Generate the certificates for the new control plane components - ### Synopsis + Generate the certificates for the new control plane components ``` @@ -11,20 +10,94 @@ kubeadm join phase control-plane-prepare certs [api-server-endpoint] [flags] ### Options -``` - --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --discovery-file string For file-based discovery, a file or URL from which to load cluster information. - --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. - --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). - --discovery-token-unsafe-skip-ca-verification For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning. - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for certs - --node-name string Specify the node name. - --tls-bootstrap-token string Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node. - --token string Use this token for both discovery-token and tls-bootstrap-token when those values are not provided. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
--discovery-file string
For file-based discovery, a file or URL from which to load cluster information.
--discovery-token string
For token-based discovery, the token used to validate cluster information fetched from the API server.
--discovery-token-ca-cert-hash stringSlice
For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").
--discovery-token-unsafe-skip-ca-verification
For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.
-h, --help
help for certs
--node-name string
Specify the node name.
--tls-bootstrap-token string
Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node.
--token string
Use this token for both discovery-token and tls-bootstrap-token when those values are not provided.
+ + ### Options inherited from parent commands @@ -47,3 +120,7 @@ kubeadm join phase control-plane-prepare certs [api-server-endpoint] [flags] +SEE ALSO + +* [kubeadm join phase control-plane-prepare](kubeadm_join_phase_control-plane-prepare.md) - Prepare the machine for serving a control plane + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_control-plane.md index a0d501f530..7a38d22d98 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_control-plane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_control-plane.md @@ -1,8 +1,7 @@ -Generate the manifests for the new control plane components - ### Synopsis + Generate the manifests for the new control plane components ``` @@ -11,14 +10,59 @@ kubeadm join phase control-plane-prepare control-plane [flags] ### Options -``` - --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 If the node should host a new control plane instance, the port for the API Server to bind to. (default 6443) - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for control-plane -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
If the node should host a new control plane instance, the port for the API Server to bind to.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
-h, --help
help for control-plane
+ + ### Options inherited from parent commands @@ -41,3 +85,7 @@ kubeadm join phase control-plane-prepare control-plane [flags] +SEE ALSO + +* [kubeadm join phase control-plane-prepare](kubeadm_join_phase_control-plane-prepare.md) - Prepare the machine for serving a control plane + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_download-certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_download-certs.md index 2ca0ddcb1c..a23beaa755 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_download-certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_download-certs.md @@ -1,8 +1,7 @@ -[EXPERIMENTAL] Download certificates shared among control-plane nodes from the kubeadm-certs Secret - ### Synopsis + [EXPERIMENTAL] Download certificates shared among control-plane nodes from the kubeadm-certs Secret ``` @@ -11,19 +10,87 @@ kubeadm join phase control-plane-prepare download-certs [api-server-endpoint] [f ### Options -``` - --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --discovery-file string For file-based discovery, a file or URL from which to load cluster information. - --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. - --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). - --discovery-token-unsafe-skip-ca-verification For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning. - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for download-certs - --tls-bootstrap-token string Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node. - --token string Use this token for both discovery-token and tls-bootstrap-token when those values are not provided. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--certificate-key string
Use this key to decrypt the certificate secrets uploaded by init.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
--discovery-file string
For file-based discovery, a file or URL from which to load cluster information.
--discovery-token string
For token-based discovery, the token used to validate cluster information fetched from the API server.
--discovery-token-ca-cert-hash stringSlice
For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").
--discovery-token-unsafe-skip-ca-verification
For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.
-h, --help
help for download-certs
--tls-bootstrap-token string
Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node.
--token string
Use this token for both discovery-token and tls-bootstrap-token when those values are not provided.
+ + ### Options inherited from parent commands @@ -46,3 +113,7 @@ kubeadm join phase control-plane-prepare download-certs [api-server-endpoint] [f +SEE ALSO + +* [kubeadm join phase control-plane-prepare](kubeadm_join_phase_control-plane-prepare.md) - Prepare the machine for serving a control plane + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_kubeconfig.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_kubeconfig.md index 535e4eba29..49f9823486 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_kubeconfig.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_control-plane-prepare_kubeconfig.md @@ -1,8 +1,7 @@ -Generate the kubeconfig for the new control plane components - ### Synopsis + Generate the kubeconfig for the new control plane components ``` @@ -11,19 +10,87 @@ kubeadm join phase control-plane-prepare kubeconfig [api-server-endpoint] [flags ### Options -``` - --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --discovery-file string For file-based discovery, a file or URL from which to load cluster information. - --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. - --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). - --discovery-token-unsafe-skip-ca-verification For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning. - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for kubeconfig - --tls-bootstrap-token string Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node. - --token string Use this token for both discovery-token and tls-bootstrap-token when those values are not provided. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--certificate-key string
Use this key to decrypt the certificate secrets uploaded by init.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
--discovery-file string
For file-based discovery, a file or URL from which to load cluster information.
--discovery-token string
For token-based discovery, the token used to validate cluster information fetched from the API server.
--discovery-token-ca-cert-hash stringSlice
For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").
--discovery-token-unsafe-skip-ca-verification
For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.
-h, --help
help for kubeconfig
--tls-bootstrap-token string
Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node.
--token string
Use this token for both discovery-token and tls-bootstrap-token when those values are not provided.
+ + ### Options inherited from parent commands @@ -46,3 +113,7 @@ kubeadm join phase control-plane-prepare kubeconfig [api-server-endpoint] [flags +SEE ALSO + +* [kubeadm join phase control-plane-prepare](kubeadm_join_phase_control-plane-prepare.md) - Prepare the machine for serving a control plane + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_kubelet-start.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_kubelet-start.md index 68278bd329..ac9ea0ac11 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_kubelet-start.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_kubelet-start.md @@ -1,8 +1,7 @@ -Write kubelet settings, certificates and (re)start the kubelet - ### Synopsis + Write a file with KubeletConfiguration and an environment file with node specific kubelet settings, and then (re)start kubelet. ``` @@ -114,3 +113,7 @@ kubeadm join phase kubelet-start [api-server-endpoint] [flags] +SEE ALSO + +* [kubeadm join phase](kubeadm_join_phase.md) - Use this command to invoke single phase of the join workflow + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_preflight.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_preflight.md index 5570c4f07b..2b85853721 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_preflight.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join_phase_preflight.md @@ -1,6 +1,4 @@ -Run join pre-flight checks - ### Synopsis @@ -19,24 +17,122 @@ kubeadm join phase preflight [api-server-endpoint] [flags] ### Options -``` - --apiserver-advertise-address string If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used. - --apiserver-bind-port int32 If the node should host a new control plane instance, the port for the API Server to bind to. (default 6443) - --certificate-key string Use this key to decrypt the certificate secrets uploaded by init. - --config string Path to kubeadm config file. - --control-plane Create a new control plane instance on this node - --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. - --discovery-file string For file-based discovery, a file or URL from which to load cluster information. - --discovery-token string For token-based discovery, the token used to validate cluster information fetched from the API server. - --discovery-token-ca-cert-hash strings For token-based discovery, validate that the root CA public key matches this hash (format: ":"). - --discovery-token-unsafe-skip-ca-verification For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning. - --experimental-control-plane Create a new control plane instance on this node - -h, --help help for preflight - --ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. - --node-name string Specify the node name. - --tls-bootstrap-token string Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node. - --token string Use this token for both discovery-token and tls-bootstrap-token when those values are not provided. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--apiserver-advertise-address string
If the node should host a new control plane instance, the IP address the API Server will advertise it's listening on. If not set the default network interface will be used.
--apiserver-bind-port int32     Default: 6443
If the node should host a new control plane instance, the port for the API Server to bind to.
--certificate-key string
Use this key to decrypt the certificate secrets uploaded by init.
--config string
Path to kubeadm config file.
--control-plane
Create a new control plane instance on this node
--cri-socket string
Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket.
--discovery-file string
For file-based discovery, a file or URL from which to load cluster information.
--discovery-token string
For token-based discovery, the token used to validate cluster information fetched from the API server.
--discovery-token-ca-cert-hash stringSlice
For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").
--discovery-token-unsafe-skip-ca-verification
For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.
-h, --help
help for preflight
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--node-name string
Specify the node name.
--tls-bootstrap-token string
Specify the token used to temporarily authenticate with the Kubernetes Control Plane while joining the node.
--token string
Use this token for both discovery-token and tls-bootstrap-token when those values are not provided.
+ + ### Options inherited from parent commands @@ -59,3 +155,7 @@ kubeadm join phase preflight [api-server-endpoint] [flags] +SEE ALSO + +* [kubeadm join phase](kubeadm_join_phase.md) - Use this command to invoke single phase of the join workflow + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md index 8ce1e6dfba..92e2370849 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md @@ -1,9 +1,8 @@ -Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm join' - ### Synopsis -Run this to revert any changes made to this host by 'kubeadm init' or 'kubeadm join' + +Performs a best effort revert of changes made to this host by 'kubeadm init' or 'kubeadm join' The "reset" command executes the following phases: ``` @@ -20,19 +19,90 @@ kubeadm reset [flags] ### Options -``` - --cert-dir string The path to the directory where the certificates are stored. If specified, clean this directory. (default "/etc/kubernetes/pki") - --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. - -f, --force Reset the node without prompting for confirmation. - -h, --help help for reset - --ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --skip-phases strings List of phases to be skipped -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path to the directory where the certificates are stored. If specified, clean this directory.
--cri-socket string
Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket.
-f, --force
Reset the node without prompting for confirmation.
-h, --help
help for reset
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--skip-phases stringSlice
List of phases to be skipped
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm](kubeadm.md) - kubeadm: easily bootstrap a secure Kubernetes cluster +* [kubeadm reset phase](kubeadm_reset_phase.md) - Use this command to invoke single phase of the reset workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase.md index cec28480c0..971f15fa7e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase.md @@ -1,19 +1,56 @@ -Use this command to invoke single phase of the reset workflow - ### Synopsis + Use this command to invoke single phase of the reset workflow ### Options -``` - -h, --help help for phase -``` + + + + + + + + + + + + + + + +
-h, --help
help for phase
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm reset](kubeadm_reset.md) - Performs a best effort revert of changes made to this host by 'kubeadm init' or 'kubeadm join' +* [kubeadm reset phase cleanup-node](kubeadm_reset_phase_cleanup-node.md) - Run cleanup node. +* [kubeadm reset phase preflight](kubeadm_reset_phase_preflight.md) - Run reset pre-flight checks +* [kubeadm reset phase remove-etcd-member](kubeadm_reset_phase_remove-etcd-member.md) - Remove a local etcd member. +* [kubeadm reset phase update-cluster-status](kubeadm_reset_phase_update-cluster-status.md) - Remove this node from the ClusterStatus object. diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_cleanup-node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_cleanup-node.md index 2d7c4e9926..cbcd2b15a2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_cleanup-node.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_cleanup-node.md @@ -1,8 +1,7 @@ -Run cleanup node. - ### Synopsis + Run cleanup node. ``` @@ -11,15 +10,61 @@ kubeadm reset phase cleanup-node [flags] ### Options -``` - --cert-dir string The path to the directory where the certificates are stored. If specified, clean this directory. (default "/etc/kubernetes/pki") - --cri-socket string Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket. - -h, --help help for cleanup-node -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--cert-dir string     Default: "/etc/kubernetes/pki"
The path to the directory where the certificates are stored. If specified, clean this directory.
--cri-socket string
Path to the CRI socket to connect. If empty kubeadm will try to auto-detect this value; use this option only if you have more than one CRI installed or if you have non-standard CRI socket.
-h, --help
help for cleanup-node
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm reset phase](kubeadm_reset_phase.md) - Use this command to invoke single phase of the reset workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_preflight.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_preflight.md index e40c970712..f172f0e339 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_preflight.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_preflight.md @@ -1,8 +1,7 @@ -Run reset pre-flight checks - ### Synopsis + Run pre-flight checks for kubeadm reset. ``` @@ -11,15 +10,61 @@ kubeadm reset phase preflight [flags] ### Options -``` - -f, --force Reset the node without prompting for confirmation. - -h, --help help for preflight - --ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-f, --force
Reset the node without prompting for confirmation.
-h, --help
help for preflight
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm reset phase](kubeadm_reset_phase.md) - Use this command to invoke single phase of the reset workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_remove-etcd-member.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_remove-etcd-member.md index 7642494a5b..d6e925eff7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_remove-etcd-member.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_remove-etcd-member.md @@ -1,8 +1,7 @@ -Remove a local etcd member. - ### Synopsis + Remove a local etcd member for a control plane node. ``` @@ -11,14 +10,54 @@ kubeadm reset phase remove-etcd-member [flags] ### Options -``` - -h, --help help for remove-etcd-member - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for remove-etcd-member
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm reset phase](kubeadm_reset_phase.md) - Use this command to invoke single phase of the reset workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_update-cluster-status.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_update-cluster-status.md index 08b87e73ae..cde705e46e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_update-cluster-status.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset_phase_update-cluster-status.md @@ -1,8 +1,7 @@ -Remove this node from the ClusterStatus object. - ### Synopsis + Remove this node from the ClusterStatus object if the node is a control plane node. ``` @@ -11,13 +10,47 @@ kubeadm reset phase update-cluster-status [flags] ### Options -``` - -h, --help help for update-cluster-status -``` + + + + + + + + + + + + + + + +
-h, --help
help for update-cluster-status
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm reset phase](kubeadm_reset_phase.md) - Use this command to invoke single phase of the reset workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md index 6899b98296..f131254b2c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md @@ -1,9 +1,8 @@ -Manage bootstrap tokens - ### Synopsis + This command manages bootstrap tokens. It is optional and needed only for advanced use cases. In short, bootstrap tokens are used for establishing bidirectional trust between a client and a server. @@ -28,20 +27,65 @@ kubeadm token [flags] ### Options -``` - --dry-run Whether to enable dry-run mode or not - -h, --help help for token - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") -``` + + + + + + -### Options inherited from parent commands + + + + + + -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
-h, --help
help for token
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
+### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm](kubeadm.md) - kubeadm: easily bootstrap a secure Kubernetes cluster +* [kubeadm token create](kubeadm_token_create.md) - Create bootstrap tokens on the server +* [kubeadm token delete](kubeadm_token_delete.md) - Delete bootstrap tokens on the server +* [kubeadm token generate](kubeadm_token_generate.md) - Generate and print a bootstrap token, but do not create it on the server +* [kubeadm token list](kubeadm_token_list.md) - List bootstrap tokens on the server + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md index 6c35a2166b..08d934a2f6 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md @@ -1,9 +1,8 @@ -Create bootstrap tokens on the server - ### Synopsis + This command will create a bootstrap token for you. You can specify the usages for this token, the "time to live" and an optional human friendly description. @@ -18,21 +17,103 @@ kubeadm token create [token] ### Options -``` - --config string Path to a kubeadm configuration file. - --description string A human friendly description of how this token is used. - --groups strings Extra groups that this token will authenticate as when used for authentication. Must match "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z" (default [system:bootstrappers:kubeadm:default-node-token]) - -h, --help help for create - --print-join-command Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token. - --ttl duration The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire (default 24h0m0s) - --usages strings Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication] (default [signing,authentication]) -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm configuration file.
--description string
A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z"
-h, --help
help for create
--print-join-command
Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token.
--ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--usages stringSlice     Default: [signing,authentication]
Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]
+ + ### Options inherited from parent commands -``` - --dry-run Whether to enable dry-run mode or not - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm token](kubeadm_token.md) - Manage bootstrap tokens diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md index 8dd1908b43..ce46067ea0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md @@ -1,9 +1,8 @@ -Delete bootstrap tokens on the server - ### Synopsis + This command will delete a list of bootstrap tokens for you. The [token-value] is the full Token of the form "[a-z0-9]{6}.[a-z0-9]{16}" or the @@ -16,15 +15,61 @@ kubeadm token delete [token-value] ... ### Options -``` - -h, --help help for delete -``` + + + + + + + + + + + + + + + +
-h, --help
help for delete
+ + ### Options inherited from parent commands -``` - --dry-run Whether to enable dry-run mode or not - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm token](kubeadm_token.md) - Manage bootstrap tokens diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md index a49dfb1858..07fd3d38e1 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md @@ -1,9 +1,8 @@ -Generate and print a bootstrap token, but do not create it on the server - ### Synopsis + This command will print out a randomly-generated bootstrap token that can be used with the "init" and "join" commands. @@ -21,15 +20,61 @@ kubeadm token generate [flags] ### Options -``` - -h, --help help for generate -``` + + + + + + + + + + + + + + + +
-h, --help
help for generate
+ + ### Options inherited from parent commands -``` - --dry-run Whether to enable dry-run mode or not - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm token](kubeadm_token.md) - Manage bootstrap tokens diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md index b4d2699d13..5d81ae59df 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md @@ -1,9 +1,8 @@ -List bootstrap tokens on the server - ### Synopsis + This command will list all bootstrap tokens for you. @@ -13,15 +12,61 @@ kubeadm token list [flags] ### Options -``` - -h, --help help for list -``` + + + + + + + + + + + + + + + +
-h, --help
help for list
+ + ### Options inherited from parent commands -``` - --dry-run Whether to enable dry-run mode or not - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Whether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm token](kubeadm_token.md) - Manage bootstrap tokens diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md index fd29befad9..0562fa18ac 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md @@ -1,8 +1,7 @@ -Upgrade your cluster smoothly to a newer version with this command - ### Synopsis + Upgrade your cluster smoothly to a newer version with this command ``` @@ -11,13 +10,51 @@ kubeadm upgrade [flags] ### Options -``` - -h, --help help for upgrade -``` + + + + + + + + + + + + + + + +
-h, --help
help for upgrade
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm](kubeadm.md) - kubeadm: easily bootstrap a secure Kubernetes cluster +* [kubeadm upgrade apply](kubeadm_upgrade_apply.md) - Upgrade your Kubernetes cluster to the specified version +* [kubeadm upgrade diff](kubeadm_upgrade_diff.md) - Show what differences would be applied to existing static pod manifests. See also: kubeadm upgrade apply --dry-run +* [kubeadm upgrade node](kubeadm_upgrade_node.md) - Upgrade commands for a node in the cluster +* [kubeadm upgrade plan](kubeadm_upgrade_plan.md) - Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md index 7a0ad92572..d947c1b835 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md @@ -1,8 +1,7 @@ -Upgrade your Kubernetes cluster to the specified version - ### Synopsis + Upgrade your Kubernetes cluster to the specified version ``` @@ -11,26 +10,145 @@ kubeadm upgrade apply [version] ### Options -``` - --allow-experimental-upgrades Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes. - --allow-release-candidate-upgrades Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes. - --certificate-renewal Perform the renewal of certificates used by component changed during upgrades. (default true) - --config string Path to a kubeadm configuration file. - --dry-run Do not change any state, just output what actions would be performed. - --etcd-upgrade Perform the upgrade of etcd. (default true) - --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. - -f, --force Force upgrading although some requirements might not be met. This also implies non-interactive mode. - -h, --help help for apply - --ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. - --image-pull-timeout duration The maximum amount of time to wait for the control plane pods to be downloaded. (default 15m0s) - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not. - -y, --yes Perform the upgrade and do not prompt for confirmation (non-interactive mode). -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--certificate-renewal     Default: true
Perform the renewal of certificates used by component changed during upgrades.
--config string
Path to a kubeadm configuration file.
--dry-run
Do not change any state, just output what actions would be performed.
--etcd-upgrade     Default: true
Perform the upgrade of etcd.
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
IPv6DualStack=true|false (ALPHA - default=false)
-f, --force
Force upgrading although some requirements might not be met. This also implies non-interactive mode.
-h, --help
help for apply
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--image-pull-timeout duration     Default: 15m0s
The maximum amount of time to wait for the control plane pods to be downloaded.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
-y, --yes
Perform the upgrade and do not prompt for confirmation (non-interactive mode).
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm upgrade](kubeadm_upgrade.md) - Upgrade your cluster smoothly to a newer version with this command diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md index 950b91d7ea..750ccbeb54 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md @@ -1,8 +1,7 @@ -Show what differences would be applied to existing static pod manifests. See also: kubeadm upgrade apply --dry-run - ### Synopsis + Show what differences would be applied to existing static pod manifests. See also: kubeadm upgrade apply --dry-run ``` @@ -11,18 +10,89 @@ kubeadm upgrade diff [version] [flags] ### Options -``` - --api-server-manifest string path to API server manifest (default "/etc/kubernetes/manifests/kube-apiserver.yaml") - --config string Path to a kubeadm configuration file. - -c, --context-lines int How many lines of context in the diff (default 3) - --controller-manager-manifest string path to controller manifest (default "/etc/kubernetes/manifests/kube-controller-manager.yaml") - -h, --help help for diff - --scheduler-manifest string path to scheduler manifest (default "/etc/kubernetes/manifests/kube-scheduler.yaml") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--api-server-manifest string     Default: "/etc/kubernetes/manifests/kube-apiserver.yaml"
path to API server manifest
--config string
Path to a kubeadm configuration file.
-c, --context-lines int     Default: 3
How many lines of context in the diff
--controller-manager-manifest string     Default: "/etc/kubernetes/manifests/kube-controller-manager.yaml"
path to controller manifest
-h, --help
help for diff
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--scheduler-manifest string     Default: "/etc/kubernetes/manifests/kube-scheduler.yaml"
path to scheduler manifest
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm upgrade](kubeadm_upgrade.md) - Upgrade your cluster smoothly to a newer version with this command diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md index 0c58916493..2914eef555 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md @@ -1,8 +1,7 @@ -Upgrade commands for a node in the cluster - ### Synopsis + Upgrade commands for a node in the cluster The "node" command executes the following phases: @@ -18,17 +17,97 @@ kubeadm upgrade node [flags] ### Options -``` - --dry-run Do not change any state, just output the actions that would be performed. - -h, --help help for node - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --kubelet-version string The *desired* version for the kubelet config after the upgrade. If not specified, the KubernetesVersion from the kubeadm-config ConfigMap will be used - --skip-phases strings List of phases to be skipped -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--certificate-renewal
Perform the renewal of certificates used by component changed during upgrades.
--dry-run
Do not change any state, just output the actions that would be performed.
--etcd-upgrade
Perform the upgrade of etcd.
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
-h, --help
help for node
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--kubelet-version string
The *desired* version for the kubelet config after the upgrade. If not specified, the KubernetesVersion from the kubeadm-config ConfigMap will be used
--skip-phases stringSlice
List of phases to be skipped
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm upgrade](kubeadm_upgrade.md) - Upgrade your cluster smoothly to a newer version with this command +* [kubeadm upgrade node phase](kubeadm_upgrade_node_phase.md) - Use this command to invoke single phase of the node workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase.md index 872e9f593d..28774cf102 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase.md @@ -1,19 +1,54 @@ -Use this command to invoke single phase of the node workflow - ### Synopsis + Use this command to invoke single phase of the node workflow ### Options -``` - -h, --help help for phase -``` + + + + + + + + + + + + + + + +
-h, --help
help for phase
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm upgrade node](kubeadm_upgrade_node.md) - Upgrade commands for a node in the cluster +* [kubeadm upgrade node phase control-plane](kubeadm_upgrade_node_phase_control-plane.md) - Upgrade the control plane instance deployed on this node, if any +* [kubeadm upgrade node phase kubelet-config](kubeadm_upgrade_node_phase_kubelet-config.md) - Upgrade the kubelet configuration for this node diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_control-plane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_control-plane.md index ed0d571997..8adf8fbdc8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_control-plane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_control-plane.md @@ -1,8 +1,7 @@ -Upgrade the control plane instance deployed on this node, if any - ### Synopsis + Upgrade the control plane instance deployed on this node, if any ``` @@ -11,15 +10,82 @@ kubeadm upgrade node phase control-plane [flags] ### Options -``` - --dry-run Do not change any state, just output the actions that would be performed. - -h, --help help for control-plane - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--certificate-renewal
Perform the renewal of certificates used by component changed during upgrades.
--dry-run
Do not change any state, just output the actions that would be performed.
--etcd-upgrade
Perform the upgrade of etcd.
-k, --experimental-kustomize string
The path where kustomize patches for static pod manifests are stored.
-h, --help
help for control-plane
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm upgrade node phase](kubeadm_upgrade_node_phase.md) - Use this command to invoke single phase of the node workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_kubelet-config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_kubelet-config.md index dee8786af7..719f0231e5 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_kubelet-config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_phase_kubelet-config.md @@ -1,9 +1,8 @@ -Upgrade the kubelet configuration for this node - ### Synopsis -Download the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. kubeadm uses the KuberneteVersion field in the kubeadm-config ConfigMap to determine what the desired kubelet version is, but the user can override this by using the --kubelet-version parameter. + +Download the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. kubeadm uses the KuberneteVersion field in the kubeadm-config ConfigMap to determine what the _desired_ kubelet version is, but the user can override this by using the --kubelet-version parameter. ``` kubeadm upgrade node phase kubelet-config [flags] @@ -11,16 +10,68 @@ kubeadm upgrade node phase kubelet-config [flags] ### Options -``` - --dry-run Do not change any state, just output the actions that would be performed. - -h, --help help for kubelet-config - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --kubelet-version string The *desired* version for the kubelet config after the upgrade. If not specified, the KubernetesVersion from the kubeadm-config ConfigMap will be used -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Do not change any state, just output the actions that would be performed.
-h, --help
help for kubelet-config
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--kubelet-version string
The *desired* version for the kubelet config after the upgrade. If not specified, the KubernetesVersion from the kubeadm-config ConfigMap will be used
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm upgrade node phase](kubeadm_upgrade_node_phase.md) - Use this command to invoke single phase of the node workflow diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md index 62d73bd99a..d0b712d4bf 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md @@ -1,8 +1,7 @@ -Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter - ### Synopsis + Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter ``` @@ -11,20 +10,96 @@ kubeadm upgrade plan [version] [flags] ### Options -``` - --allow-experimental-upgrades Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes. - --allow-release-candidate-upgrades Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes. - --config string Path to a kubeadm configuration file. - --feature-gates string A set of key=value pairs that describe feature gates for various features. No feature gates are available in this release. - -h, --help help for plan - --ignore-preflight-errors strings A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks. - --kubeconfig string The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. (default "/etc/kubernetes/admin.conf") - --print-config Specifies whether the configuration file that will be used in the upgrade should be printed or not. -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to a kubeadm configuration file.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
IPv6DualStack=true|false (ALPHA - default=false)
-h, --help
help for plan
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm upgrade](kubeadm_upgrade.md) - Upgrade your cluster smoothly to a newer version with this command diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md index df927d0759..aa2da258a0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md @@ -1,8 +1,7 @@ -Print the version of kubeadm - ### Synopsis + Print the version of kubeadm ``` @@ -11,14 +10,54 @@ kubeadm version [flags] ### Options -``` - -h, --help help for version - -o, --output string Output format; available options are 'yaml', 'json' and 'short' -``` + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for version
-o, --output string
Output format; available options are 'yaml', 'json' and 'short'
+ + ### Options inherited from parent commands -``` - --rootfs string [EXPERIMENTAL] The path to the 'real' host root filesystem. -``` + + + + + + + + + + + + + + + +
--rootfs string
[EXPERIMENTAL] The path to the 'real' host root filesystem.
+ + + +SEE ALSO + +* [kubeadm](kubeadm.md) - kubeadm: easily bootstrap a secure Kubernetes cluster