This the multi-page printable view of this section. Click here to print.
Component tools
- 1: Feature Gates
- 2: kubelet
- 3: kube-apiserver
- 4: kube-controller-manager
- 5: kube-proxy
- 6: kube-scheduler
- 7: Kubelet authentication/authorization
- 8: TLS bootstrapping
1 - Feature Gates
This page contains an overview of the various feature gates an administrator can specify on different Kubernetes components.
See feature stages for an explanation of the stages for a feature.
Overview
Feature gates are a set of key=value pairs that describe Kubernetes features.
You can turn these features on or off using the --feature-gates
command line flag
on each Kubernetes component.
Each Kubernetes component lets you enable or disable a set of feature gates that
are relevant to that component.
Use -h
flag to see a full set of feature gates for all components.
To set feature gates for a component, such as kubelet, use the --feature-gates
flag assigned to a list of feature pairs:
--feature-gates="...,GracefulNodeShutdown=true"
The following tables are a summary of the feature gates that you can set on different Kubernetes components.
- The "Since" column contains the Kubernetes release when a feature is introduced or its release stage is changed.
- The "Until" column, if not empty, contains the last Kubernetes release in which you can still use a feature gate.
- If a feature is in the Alpha or Beta state, you can find the feature listed in the Alpha/Beta feature gate table.
- If a feature is stable you can find all stages for that feature listed in the Graduated/Deprecated feature gate table.
- The Graduated/Deprecated feature gate table also lists deprecated and withdrawn features.
Feature gates for Alpha or Beta features
Feature | Default | Stage | Since | Until |
---|---|---|---|---|
APIListChunking |
false |
Alpha | 1.8 | 1.8 |
APIListChunking |
true |
Beta | 1.9 | |
APIPriorityAndFairness |
false |
Alpha | 1.17 | 1.19 |
APIPriorityAndFairness |
true |
Beta | 1.20 | |
APIResponseCompression |
false |
Alpha | 1.7 | 1.15 |
APIResponseCompression |
true |
Beta | 1.16 | |
APIServerIdentity |
false |
Alpha | 1.20 | |
APIServerTracing |
false |
Alpha | 1.22 | |
AllowInsecureBackendProxy |
true |
Beta | 1.17 | |
AnyVolumeDataSource |
false |
Alpha | 1.18 | |
AppArmor |
true |
Beta | 1.4 | |
ControllerManagerLeaderMigration |
false |
Alpha | 1.21 | |
CPUManager |
false |
Alpha | 1.8 | 1.9 |
CPUManager |
true |
Beta | 1.10 | |
CPUManagerPolicyOptions |
false |
Alpha | 1.22 | |
CSIInlineVolume |
false |
Alpha | 1.15 | 1.15 |
CSIInlineVolume |
true |
Beta | 1.16 | - |
CSIMigration |
false |
Alpha | 1.14 | 1.16 |
CSIMigration |
true |
Beta | 1.17 | |
CSIMigrationAWS |
false |
Alpha | 1.14 | |
CSIMigrationAWS |
false |
Beta | 1.17 | 1.22 |
CSIMigrationAWS |
true |
Beta | 1.23 | |
CSIMigrationAzureDisk |
false |
Alpha | 1.15 | 1.18 |
CSIMigrationAzureDisk |
false |
Beta | 1.19 | 1.22 |
CSIMigrationAzureDisk |
true |
Beta | 1.23 | |
CSIMigrationAzureFile |
false |
Alpha | 1.15 | 1.19 |
CSIMigrationAzureFile |
false |
Beta | 1.21 | |
CSIMigrationGCE |
false |
Alpha | 1.14 | 1.16 |
CSIMigrationGCE |
false |
Beta | 1.17 | 1.22 |
CSIMigrationGCE |
true |
Beta | 1.23 | |
CSIMigrationOpenStack |
false |
Alpha | 1.14 | 1.17 |
CSIMigrationOpenStack |
true |
Beta | 1.18 | |
CSIMigrationvSphere |
false |
Beta | 1.19 | |
CSIMigrationPortworx |
false |
Alpha | 1.23 | |
CSIMigrationRBD |
false |
Alpha | 1.23 | |
CSIStorageCapacity |
false |
Alpha | 1.19 | 1.20 |
CSIStorageCapacity |
true |
Beta | 1.21 | |
CSIVolumeHealth |
false |
Alpha | 1.21 | |
CSRDuration |
true |
Beta | 1.22 | |
ConfigurableFSGroupPolicy |
false |
Alpha | 1.18 | 1.19 |
ConfigurableFSGroupPolicy |
true |
Beta | 1.20 | |
ControllerManagerLeaderMigration |
false |
Alpha | 1.21 | 1.21 |
ControllerManagerLeaderMigration |
true |
Beta | 1.22 | |
CustomCPUCFSQuotaPeriod |
false |
Alpha | 1.12 | |
CustomResourceValidationExpressions |
false |
Alpha | 1.23 | |
DaemonSetUpdateSurge |
false |
Alpha | 1.21 | 1.21 |
DaemonSetUpdateSurge |
true |
Beta | 1.22 | |
DefaultPodTopologySpread |
false |
Alpha | 1.19 | 1.19 |
DefaultPodTopologySpread |
true |
Beta | 1.20 | |
DelegateFSGroupToCSIDriver |
false |
Alpha | 1.22 | |
DevicePlugins |
false |
Alpha | 1.8 | 1.9 |
DevicePlugins |
true |
Beta | 1.10 | |
DisableAcceleratorUsageMetrics |
false |
Alpha | 1.19 | 1.19 |
DisableAcceleratorUsageMetrics |
true |
Beta | 1.20 | |
DisableCloudProviders |
false |
Alpha | 1.22 | |
DownwardAPIHugePages |
false |
Alpha | 1.20 | 1.20 |
DownwardAPIHugePages |
false |
Beta | 1.21 | |
EfficientWatchResumption |
false |
Alpha | 1.20 | 1.20 |
EfficientWatchResumption |
true |
Beta | 1.21 | |
EndpointSliceTerminatingCondition |
false |
Alpha | 1.20 | 1.21 |
EndpointSliceTerminatingCondition |
true |
Beta | 1.22 | |
EphemeralContainers |
false |
Alpha | 1.16 | 1.22 |
EphemeralContainers |
true |
Beta | 1.23 | |
ExpandCSIVolumes |
false |
Alpha | 1.14 | 1.15 |
ExpandCSIVolumes |
true |
Beta | 1.16 | |
ExpandedDNSConfig |
false |
Alpha | 1.22 | |
ExpandInUsePersistentVolumes |
false |
Alpha | 1.11 | 1.14 |
ExpandInUsePersistentVolumes |
true |
Beta | 1.15 | |
ExpandPersistentVolumes |
false |
Alpha | 1.8 | 1.10 |
ExpandPersistentVolumes |
true |
Beta | 1.11 | |
ExperimentalHostUserNamespaceDefaulting |
false |
Beta | 1.5 | |
GracefulNodeShutdown |
false |
Alpha | 1.20 | 1.20 |
GracefulNodeShutdown |
true |
Beta | 1.21 | |
GRPCContainerProbe |
false |
Alpha | 1.23 | |
HPAContainerMetrics |
false |
Alpha | 1.20 | |
HPAScaleToZero |
false |
Alpha | 1.16 | |
IdentifyPodOS |
false |
Alpha | 1.23 | |
IndexedJob |
false |
Alpha | 1.21 | 1.21 |
IndexedJob |
true |
Beta | 1.22 | |
InTreePluginAWSUnregister |
false |
Alpha | 1.21 | |
InTreePluginAzureDiskUnregister |
false |
Alpha | 1.21 | |
InTreePluginAzureFileUnregister |
false |
Alpha | 1.21 | |
InTreePluginGCEUnregister |
false |
Alpha | 1.21 | |
InTreePluginOpenStackUnregister |
false |
Alpha | 1.21 | |
InTreePluginvSphereUnregister |
false |
Alpha | 1.21 | |
JobMutableNodeSchedulingDirectives |
true |
Beta | 1.23 | |
JobReadyPods |
false |
Alpha | 1.23 | |
JobTrackingWithFinalizers |
false |
Alpha | 1.22 | 1.22 |
JobTrackingWithFinalizers |
true |
Beta | 1.23 | |
KubeletCredentialProviders |
false |
Alpha | 1.20 | |
KubeletInUserNamespace |
false |
Alpha | 1.22 | |
KubeletPodResourcesGetAllocatable |
false |
Alpha | 1.21 | |
LocalStorageCapacityIsolation |
false |
Alpha | 1.7 | 1.9 |
LocalStorageCapacityIsolation |
true |
Beta | 1.10 | |
LocalStorageCapacityIsolationFSQuotaMonitoring |
false |
Alpha | 1.15 | |
LogarithmicScaleDown |
false |
Alpha | 1.21 | 1.21 |
LogarithmicScaleDown |
true |
Beta | 1.22 | |
MemoryManager |
false |
Alpha | 1.21 | 1.21 |
MemoryManager |
true |
Beta | 1.22 | |
MemoryQoS |
false |
Alpha | 1.22 | |
MixedProtocolLBService |
false |
Alpha | 1.20 | |
NetworkPolicyEndPort |
false |
Alpha | 1.21 | 1.21 |
NetworkPolicyEndPort |
true |
Beta | 1.22 | |
NodeSwap |
false |
Alpha | 1.22 | |
NonPreemptingPriority |
false |
Alpha | 1.15 | 1.18 |
NonPreemptingPriority |
true |
Beta | 1.19 | |
PodDeletionCost |
false |
Alpha | 1.21 | 1.21 |
PodDeletionCost |
true |
Beta | 1.22 | |
PodAffinityNamespaceSelector |
false |
Alpha | 1.21 | 1.21 |
PodAffinityNamespaceSelector |
true |
Beta | 1.22 | |
PodOverhead |
false |
Alpha | 1.16 | 1.17 |
PodOverhead |
true |
Beta | 1.18 | |
PodSecurity |
false |
Alpha | 1.22 | 1.22 |
PodSecurity |
true |
Beta | 1.23 | |
PreferNominatedNode |
false |
Alpha | 1.21 | 1.21 |
PreferNominatedNode |
true |
Beta | 1.22 | |
ProbeTerminationGracePeriod |
false |
Alpha | 1.21 | 1.21 |
ProbeTerminationGracePeriod |
false |
Beta | 1.22 | |
ProcMountType |
false |
Alpha | 1.12 | |
ProxyTerminatingEndpoints |
false |
Alpha | 1.22 | |
QOSReserved |
false |
Alpha | 1.11 | |
ReadWriteOncePod |
false |
Alpha | 1.22 | |
RecoverVolumeExpansionFailure |
false |
Alpha | 1.23 | |
RemainingItemCount |
false |
Alpha | 1.15 | 1.15 |
RemainingItemCount |
true |
Beta | 1.16 | |
RemoveSelfLink |
false |
Alpha | 1.16 | 1.19 |
RemoveSelfLink |
true |
Beta | 1.20 | |
RotateKubeletServerCertificate |
false |
Alpha | 1.7 | 1.11 |
RotateKubeletServerCertificate |
true |
Beta | 1.12 | |
SeccompDefault |
false |
Alpha | 1.22 | |
ServiceInternalTrafficPolicy |
false |
Alpha | 1.21 | 1.21 |
ServiceInternalTrafficPolicy |
true |
Beta | 1.22 | |
ServiceLBNodePortControl |
false |
Alpha | 1.20 | 1.21 |
ServiceLBNodePortControl |
true |
Beta | 1.22 | |
ServiceLoadBalancerClass |
false |
Alpha | 1.21 | 1.21 |
ServiceLoadBalancerClass |
true |
Beta | 1.22 | |
SizeMemoryBackedVolumes |
false |
Alpha | 1.20 | 1.21 |
SizeMemoryBackedVolumes |
true |
Beta | 1.22 | |
StatefulSetMinReadySeconds |
false |
Alpha | 1.22 | 1.22 |
StatefulSetMinReadySeconds |
true |
Beta | 1.23 | |
StorageVersionAPI |
false |
Alpha | 1.20 | |
StorageVersionHash |
false |
Alpha | 1.14 | 1.14 |
StorageVersionHash |
true |
Beta | 1.15 | |
SuspendJob |
false |
Alpha | 1.21 | 1.21 |
SuspendJob |
true |
Beta | 1.22 | |
TopologyAwareHints |
false |
Alpha | 1.21 | 1.22 |
TopologyAwareHints |
true |
Beta | 1.23 | |
TopologyManager |
false |
Alpha | 1.16 | 1.17 |
TopologyManager |
true |
Beta | 1.18 | |
VolumeCapacityPriority |
false |
Alpha | 1.21 | - |
WinDSR |
false |
Alpha | 1.14 | |
WinOverlay |
false |
Alpha | 1.14 | 1.19 |
WinOverlay |
true |
Beta | 1.20 | |
WindowsHostProcessContainers |
false |
Beta | 1.23 |
Feature gates for graduated or deprecated features
Feature | Default | Stage | Since | Until |
---|---|---|---|---|
Accelerators |
false |
Alpha | 1.6 | 1.10 |
Accelerators |
- | Deprecated | 1.11 | - |
AdvancedAuditing |
false |
Alpha | 1.7 | 1.7 |
AdvancedAuditing |
true |
Beta | 1.8 | 1.11 |
AdvancedAuditing |
true |
GA | 1.12 | - |
AffinityInAnnotations |
false |
Alpha | 1.6 | 1.7 |
AffinityInAnnotations |
- | Deprecated | 1.8 | - |
AllowExtTrafficLocalEndpoints |
false |
Beta | 1.4 | 1.6 |
AllowExtTrafficLocalEndpoints |
true |
GA | 1.7 | - |
AttachVolumeLimit |
false |
Alpha | 1.11 | 1.11 |
AttachVolumeLimit |
true |
Beta | 1.12 | 1.16 |
AttachVolumeLimit |
true |
GA | 1.17 | - |
BalanceAttachedNodeVolumes |
false |
Alpha | 1.11 | 1.21 |
BalanceAttachedNodeVolumes |
false |
Deprecated | 1.22 | |
BlockVolume |
false |
Alpha | 1.9 | 1.12 |
BlockVolume |
true |
Beta | 1.13 | 1.17 |
BlockVolume |
true |
GA | 1.18 | - |
BoundServiceAccountTokenVolume |
false |
Alpha | 1.13 | 1.20 |
BoundServiceAccountTokenVolume |
true |
Beta | 1.21 | 1.21 |
BoundServiceAccountTokenVolume |
true |
GA | 1.22 | - |
ConfigurableFSGroupPolicy |
true |
GA | 1.23 | |
CRIContainerLogRotation |
false |
Alpha | 1.10 | 1.10 |
CRIContainerLogRotation |
true |
Beta | 1.11 | 1.20 |
CRIContainerLogRotation |
true |
GA | 1.21 | - |
CSIBlockVolume |
false |
Alpha | 1.11 | 1.13 |
CSIBlockVolume |
true |
Beta | 1.14 | 1.17 |
CSIBlockVolume |
true |
GA | 1.18 | - |
CSIDriverRegistry |
false |
Alpha | 1.12 | 1.13 |
CSIDriverRegistry |
true |
Beta | 1.14 | 1.17 |
CSIDriverRegistry |
true |
GA | 1.18 | |
CSIMigrationAWSComplete |
false |
Alpha | 1.17 | 1.20 |
CSIMigrationAWSComplete |
- | Deprecated | 1.21 | - |
CSIMigrationAzureDiskComplete |
false |
Alpha | 1.17 | 1.20 |
CSIMigrationAzureDiskComplete |
- | Deprecated | 1.21 | - |
CSIMigrationAzureFileComplete |
false |
Alpha | 1.17 | 1.20 |
CSIMigrationAzureFileComplete |
- | Deprecated | 1.21 | - |
CSIMigrationGCEComplete |
false |
Alpha | 1.17 | 1.20 |
CSIMigrationGCEComplete |
- | Deprecated | 1.21 | - |
CSIMigrationOpenStackComplete |
false |
Alpha | 1.17 | 1.20 |
CSIMigrationOpenStackComplete |
- | Deprecated | 1.21 | - |
CSIMigrationvSphereComplete |
false |
Beta | 1.19 | 1.21 |
CSIMigrationvSphereComplete |
- | Deprecated | 1.22 | - |
CSINodeInfo |
false |
Alpha | 1.12 | 1.13 |
CSINodeInfo |
true |
Beta | 1.14 | 1.16 |
CSINodeInfo |
true |
GA | 1.17 | |
CSIPersistentVolume |
false |
Alpha | 1.9 | 1.9 |
CSIPersistentVolume |
true |
Beta | 1.10 | 1.12 |
CSIPersistentVolume |
true |
GA | 1.13 | - |
CSIServiceAccountToken |
false |
Alpha | 1.20 | 1.20 |
CSIServiceAccountToken |
true |
Beta | 1.21 | 1.21 |
CSIServiceAccountToken |
true |
GA | 1.22 | |
CSIVolumeFSGroupPolicy |
false |
Alpha | 1.19 | 1.19 |
CSIVolumeFSGroupPolicy |
true |
Beta | 1.20 | 1.22 |
CSIVolumeFSGroupPolicy |
true |
GA | 1.23 | |
CronJobControllerV2 |
false |
Alpha | 1.20 | 1.20 |
CronJobControllerV2 |
true |
Beta | 1.21 | 1.21 |
CronJobControllerV2 |
true |
GA | 1.22 | - |
CustomPodDNS |
false |
Alpha | 1.9 | 1.9 |
CustomPodDNS |
true |
Beta | 1.10 | 1.13 |
CustomPodDNS |
true |
GA | 1.14 | - |
CustomResourceDefaulting |
false |
Alpha | 1.15 | 1.15 |
CustomResourceDefaulting |
true |
Beta | 1.16 | 1.16 |
CustomResourceDefaulting |
true |
GA | 1.17 | - |
CustomResourcePublishOpenAPI |
false |
Alpha | 1.14 | 1.14 |
CustomResourcePublishOpenAPI |
true |
Beta | 1.15 | 1.15 |
CustomResourcePublishOpenAPI |
true |
GA | 1.16 | - |
CustomResourceSubresources |
false |
Alpha | 1.10 | 1.10 |
CustomResourceSubresources |
true |
Beta | 1.11 | 1.15 |
CustomResourceSubresources |
true |
GA | 1.16 | - |
CustomResourceValidation |
false |
Alpha | 1.8 | 1.8 |
CustomResourceValidation |
true |
Beta | 1.9 | 1.15 |
CustomResourceValidation |
true |
GA | 1.16 | - |
CustomResourceWebhookConversion |
false |
Alpha | 1.13 | 1.14 |
CustomResourceWebhookConversion |
true |
Beta | 1.15 | 1.15 |
CustomResourceWebhookConversion |
true |
GA | 1.16 | - |
DryRun |
false |
Alpha | 1.12 | 1.12 |
DryRun |
true |
Beta | 1.13 | 1.18 |
DryRun |
true |
GA | 1.19 | - |
DynamicAuditing |
false |
Alpha | 1.13 | 1.18 |
DynamicAuditing |
- | Deprecated | 1.19 | - |
DynamicKubeletConfig |
false |
Alpha | 1.4 | 1.10 |
DynamicKubeletConfig |
true |
Beta | 1.11 | 1.21 |
DynamicKubeletConfig |
false |
Deprecated | 1.22 | - |
DynamicProvisioningScheduling |
false |
Alpha | 1.11 | 1.11 |
DynamicProvisioningScheduling |
- | Deprecated | 1.12 | - |
DynamicVolumeProvisioning |
true |
Alpha | 1.3 | 1.7 |
DynamicVolumeProvisioning |
true |
GA | 1.8 | - |
EnableAggregatedDiscoveryTimeout |
true |
Deprecated | 1.16 | - |
EnableEquivalenceClassCache |
false |
Alpha | 1.8 | 1.14 |
EnableEquivalenceClassCache |
- | Deprecated | 1.15 | - |
EndpointSlice |
false |
Alpha | 1.16 | 1.16 |
EndpointSlice |
false |
Beta | 1.17 | 1.17 |
EndpointSlice |
true |
Beta | 1.18 | 1.20 |
EndpointSlice |
true |
GA | 1.21 | - |
EndpointSliceNodeName |
false |
Alpha | 1.20 | 1.20 |
EndpointSliceNodeName |
true |
GA | 1.21 | - |
EndpointSliceProxying |
false |
Alpha | 1.18 | 1.18 |
EndpointSliceProxying |
true |
Beta | 1.19 | 1.21 |
EndpointSliceProxying |
true |
GA | 1.22 | - |
ExperimentalCriticalPodAnnotation |
false |
Alpha | 1.5 | 1.12 |
ExperimentalCriticalPodAnnotation |
false |
Deprecated | 1.13 | - |
EvenPodsSpread |
false |
Alpha | 1.16 | 1.17 |
EvenPodsSpread |
true |
Beta | 1.18 | 1.18 |
EvenPodsSpread |
true |
GA | 1.19 | - |
ExecProbeTimeout |
true |
GA | 1.20 | - |
ExternalPolicyForExternalIP |
true |
GA | 1.18 | - |
GCERegionalPersistentDisk |
true |
Beta | 1.10 | 1.12 |
GCERegionalPersistentDisk |
true |
GA | 1.13 | - |
GenericEphemeralVolume |
false |
Alpha | 1.19 | 1.20 |
GenericEphemeralVolume |
true |
Beta | 1.21 | 1.22 |
GenericEphemeralVolume |
true |
GA | 1.23 | - |
HugePageStorageMediumSize |
false |
Alpha | 1.18 | 1.18 |
HugePageStorageMediumSize |
true |
Beta | 1.19 | 1.21 |
HugePageStorageMediumSize |
true |
GA | 1.22 | - |
HugePages |
false |
Alpha | 1.8 | 1.9 |
HugePages |
true |
Beta | 1.10 | 1.13 |
HugePages |
true |
GA | 1.14 | - |
HugePageStorageMediumSize |
false |
Alpha | 1.18 | 1.18 |
HugePageStorageMediumSize |
true |
Beta | 1.19 | 1.21 |
HugePageStorageMediumSize |
true |
GA | 1.22 | - |
HyperVContainer |
false |
Alpha | 1.10 | 1.19 |
HyperVContainer |
false |
Deprecated | 1.20 | - |
ImmutableEphemeralVolumes |
false |
Alpha | 1.18 | 1.18 |
ImmutableEphemeralVolumes |
true |
Beta | 1.19 | 1.20 |
ImmutableEphemeralVolumes |
true |
GA | 1.21 | |
IngressClassNamespacedParams |
false |
Alpha | 1.21 | 1.21 |
IngressClassNamespacedParams |
true |
Beta | 1.22 | 1.22 |
IngressClassNamespacedParams |
true |
GA | 1.23 | - |
Initializers |
false |
Alpha | 1.7 | 1.13 |
Initializers |
- | Deprecated | 1.14 | - |
IPv6DualStack |
false |
Alpha | 1.15 | 1.20 |
IPv6DualStack |
true |
Beta | 1.21 | 1.22 |
IPv6DualStack |
true |
GA | 1.23 | - |
KubeletConfigFile |
false |
Alpha | 1.8 | 1.9 |
KubeletConfigFile |
- | Deprecated | 1.10 | - |
KubeletPluginsWatcher |
false |
Alpha | 1.11 | 1.11 |
KubeletPluginsWatcher |
true |
Beta | 1.12 | 1.12 |
KubeletPluginsWatcher |
true |
GA | 1.13 | - |
KubeletPodResources |
false |
Alpha | 1.13 | 1.14 |
KubeletPodResources |
true |
Beta | 1.15 | |
KubeletPodResources |
true |
GA | 1.20 | |
LegacyNodeRoleBehavior |
false |
Alpha | 1.16 | 1.18 |
LegacyNodeRoleBehavior |
true |
Beta | 1.19 | 1.20 |
LegacyNodeRoleBehavior |
false |
GA | 1.21 | - |
MountContainers |
false |
Alpha | 1.9 | 1.16 |
MountContainers |
false |
Deprecated | 1.17 | - |
MountPropagation |
false |
Alpha | 1.8 | 1.9 |
MountPropagation |
true |
Beta | 1.10 | 1.11 |
MountPropagation |
true |
GA | 1.12 | - |
NodeDisruptionExclusion |
false |
Alpha | 1.16 | 1.18 |
NodeDisruptionExclusion |
true |
Beta | 1.19 | 1.20 |
NodeDisruptionExclusion |
true |
GA | 1.21 | - |
NodeLease |
false |
Alpha | 1.12 | 1.13 |
NodeLease |
true |
Beta | 1.14 | 1.16 |
NodeLease |
true |
GA | 1.17 | - |
NamespaceDefaultLabelName |
true |
Beta | 1.21 | 1.21 |
NamespaceDefaultLabelName |
true |
GA | 1.22 | - |
PVCProtection |
false |
Alpha | 1.9 | 1.9 |
PVCProtection |
- | Deprecated | 1.10 | - |
PersistentLocalVolumes |
false |
Alpha | 1.7 | 1.9 |
PersistentLocalVolumes |
true |
Beta | 1.10 | 1.13 |
PersistentLocalVolumes |
true |
GA | 1.14 | - |
PodAndContainerStatsFromCRI |
false |
Alpha | 1.23 | |
PodDisruptionBudget |
false |
Alpha | 1.3 | 1.4 |
PodDisruptionBudget |
true |
Beta | 1.5 | 1.20 |
PodDisruptionBudget |
true |
GA | 1.21 | - |
PodPriority |
false |
Alpha | 1.8 | 1.10 |
PodPriority |
true |
Beta | 1.11 | 1.13 |
PodPriority |
true |
GA | 1.14 | - |
PodReadinessGates |
false |
Alpha | 1.11 | 1.11 |
PodReadinessGates |
true |
Beta | 1.12 | 1.13 |
PodReadinessGates |
true |
GA | 1.14 | - |
PodShareProcessNamespace |
false |
Alpha | 1.10 | 1.11 |
PodShareProcessNamespace |
true |
Beta | 1.12 | 1.16 |
PodShareProcessNamespace |
true |
GA | 1.17 | - |
RequestManagement |
false |
Alpha | 1.15 | 1.16 |
RequestManagement |
- | Derecated | 1.17 | - |
ResourceLimitsPriorityFunction |
false |
Alpha | 1.9 | 1.18 |
ResourceLimitsPriorityFunction |
- | Deprecated | 1.19 | - |
ResourceQuotaScopeSelectors |
false |
Alpha | 1.11 | 1.11 |
ResourceQuotaScopeSelectors |
true |
Beta | 1.12 | 1.16 |
ResourceQuotaScopeSelectors |
true |
GA | 1.17 | - |
RootCAConfigMap |
false |
Alpha | 1.13 | 1.19 |
RootCAConfigMap |
true |
Beta | 1.20 | 1.20 |
RootCAConfigMap |
true |
GA | 1.21 | - |
RotateKubeletClientCertificate |
true |
Beta | 1.8 | 1.18 |
RotateKubeletClientCertificate |
true |
GA | 1.19 | - |
RunAsGroup |
true |
Beta | 1.14 | 1.20 |
RunAsGroup |
true |
GA | 1.21 | - |
RuntimeClass |
false |
Alpha | 1.12 | 1.13 |
RuntimeClass |
true |
Beta | 1.14 | 1.19 |
RuntimeClass |
true |
GA | 1.20 | - |
SCTPSupport |
false |
Alpha | 1.12 | 1.18 |
SCTPSupport |
true |
Beta | 1.19 | 1.19 |
SCTPSupport |
true |
GA | 1.20 | - |
ScheduleDaemonSetPods |
false |
Alpha | 1.11 | 1.11 |
ScheduleDaemonSetPods |
true |
Beta | 1.12 | 1.16 |
ScheduleDaemonSetPods |
true |
GA | 1.17 | - |
SelectorIndex |
false |
Alpha | 1.18 | 1.18 |
SelectorIndex |
true |
Beta | 1.19 | 1.19 |
SelectorIndex |
true |
GA | 1.20 | - |
ServerSideApply |
false |
Alpha | 1.14 | 1.15 |
ServerSideApply |
true |
Beta | 1.16 | 1.21 |
ServerSideApply |
true |
GA | 1.22 | - |
ServiceAccountIssuerDiscovery |
false |
Alpha | 1.18 | 1.19 |
ServiceAccountIssuerDiscovery |
true |
Beta | 1.20 | 1.20 |
ServiceAccountIssuerDiscovery |
true |
GA | 1.21 | - |
ServiceAppProtocol |
false |
Alpha | 1.18 | 1.18 |
ServiceAppProtocol |
true |
Beta | 1.19 | 1.19 |
ServiceAppProtocol |
true |
GA | 1.20 | - |
ServiceLoadBalancerFinalizer |
false |
Alpha | 1.15 | 1.15 |
ServiceLoadBalancerFinalizer |
true |
Beta | 1.16 | 1.16 |
ServiceLoadBalancerFinalizer |
true |
GA | 1.17 | - |
ServiceNodeExclusion |
false |
Alpha | 1.8 | 1.18 |
ServiceNodeExclusion |
true |
Beta | 1.19 | 1.20 |
ServiceNodeExclusion |
true |
GA | 1.21 | - |
ServiceTopology |
false |
Alpha | 1.17 | 1.19 |
ServiceTopology |
false |
Deprecated | 1.20 | - |
SetHostnameAsFQDN |
false |
Alpha | 1.19 | 1.19 |
SetHostnameAsFQDN |
true |
Beta | 1.20 | 1.21 |
SetHostnameAsFQDN |
true |
GA | 1.22 | - |
StartupProbe |
false |
Alpha | 1.16 | 1.17 |
StartupProbe |
true |
Beta | 1.18 | 1.19 |
StartupProbe |
true |
GA | 1.20 | - |
StorageObjectInUseProtection |
true |
Beta | 1.10 | 1.10 |
StorageObjectInUseProtection |
true |
GA | 1.11 | - |
StreamingProxyRedirects |
false |
Beta | 1.5 | 1.5 |
StreamingProxyRedirects |
true |
Beta | 1.6 | 1.17 |
StreamingProxyRedirects |
true |
Deprecated | 1.18 | 1.21 |
StreamingProxyRedirects |
false |
Deprecated | 1.22 | - |
SupportIPVSProxyMode |
false |
Alpha | 1.8 | 1.8 |
SupportIPVSProxyMode |
false |
Beta | 1.9 | 1.9 |
SupportIPVSProxyMode |
true |
Beta | 1.10 | 1.10 |
SupportIPVSProxyMode |
true |
GA | 1.11 | - |
SupportNodePidsLimit |
false |
Alpha | 1.14 | 1.14 |
SupportNodePidsLimit |
true |
Beta | 1.15 | 1.19 |
SupportNodePidsLimit |
true |
GA | 1.20 | - |
SupportPodPidsLimit |
false |
Alpha | 1.10 | 1.13 |
SupportPodPidsLimit |
true |
Beta | 1.14 | 1.19 |
SupportPodPidsLimit |
true |
GA | 1.20 | - |
Sysctls |
true |
Beta | 1.11 | 1.20 |
Sysctls |
true |
GA | 1.21 | |
TTLAfterFinished |
false |
Alpha | 1.12 | 1.20 |
TTLAfterFinished |
true |
Beta | 1.21 | 1.22 |
TTLAfterFinished |
true |
GA | 1.23 | - |
TaintBasedEvictions |
false |
Alpha | 1.6 | 1.12 |
TaintBasedEvictions |
true |
Beta | 1.13 | 1.17 |
TaintBasedEvictions |
true |
GA | 1.18 | - |
TaintNodesByCondition |
false |
Alpha | 1.8 | 1.11 |
TaintNodesByCondition |
true |
Beta | 1.12 | 1.16 |
TaintNodesByCondition |
true |
GA | 1.17 | - |
TokenRequest |
false |
Alpha | 1.10 | 1.11 |
TokenRequest |
true |
Beta | 1.12 | 1.19 |
TokenRequest |
true |
GA | 1.20 | - |
TokenRequestProjection |
false |
Alpha | 1.11 | 1.11 |
TokenRequestProjection |
true |
Beta | 1.12 | 1.19 |
TokenRequestProjection |
true |
GA | 1.20 | - |
ValidateProxyRedirects |
false |
Alpha | 1.12 | 1.13 |
ValidateProxyRedirects |
true |
Beta | 1.14 | 1.21 |
ValidateProxyRedirects |
true |
Deprecated | 1.22 | - |
VolumePVCDataSource |
false |
Alpha | 1.15 | 1.15 |
VolumePVCDataSource |
true |
Beta | 1.16 | 1.17 |
VolumePVCDataSource |
true |
GA | 1.18 | - |
VolumeScheduling |
false |
Alpha | 1.9 | 1.9 |
VolumeScheduling |
true |
Beta | 1.10 | 1.12 |
VolumeScheduling |
true |
GA | 1.13 | - |
VolumeSnapshotDataSource |
false |
Alpha | 1.12 | 1.16 |
VolumeSnapshotDataSource |
true |
Beta | 1.17 | 1.19 |
VolumeSnapshotDataSource |
true |
GA | 1.20 | - |
VolumeSubpath |
true |
GA | 1.10 | - |
VolumeSubpathEnvExpansion |
false |
Alpha | 1.14 | 1.14 |
VolumeSubpathEnvExpansion |
true |
Beta | 1.15 | 1.16 |
VolumeSubpathEnvExpansion |
true |
GA | 1.17 | - |
WarningHeaders |
true |
Beta | 1.19 | 1.21 |
WarningHeaders |
true |
GA | 1.22 | - |
WatchBookmark |
false |
Alpha | 1.15 | 1.15 |
WatchBookmark |
true |
Beta | 1.16 | 1.16 |
WatchBookmark |
true |
GA | 1.17 | - |
WindowsEndpointSliceProxying |
false |
Alpha | 1.19 | 1.20 |
WindowsEndpointSliceProxying |
true |
Beta | 1.21 | 1.21 |
WindowsEndpointSliceProxying |
true |
GA | 1.22 | - |
WindowsGMSA |
false |
Alpha | 1.14 | 1.15 |
WindowsGMSA |
true |
Beta | 1.16 | 1.17 |
WindowsGMSA |
true |
GA | 1.18 | - |
WindowsHostProcessContainers |
false |
Alpha | 1.22 | |
WindowsRunAsUserName |
false |
Alpha | 1.16 | 1.16 |
WindowsRunAsUserName |
true |
Beta | 1.17 | 1.17 |
WindowsRunAsUserName |
true |
GA | 1.18 | - |
Using a feature
Feature stages
A feature can be in Alpha, Beta or GA stage. An Alpha feature means:
- Disabled by default.
- Might be buggy. Enabling the feature may expose bugs.
- Support for feature may be dropped at any time without notice.
- The API may change in incompatible ways in a later software release without notice.
- Recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.
A Beta feature means:
- Enabled by default.
- The feature is well tested. Enabling the feature is considered safe.
- Support for the overall feature will not be dropped, though details may change.
- The schema and/or semantics of objects may change in incompatible ways in a subsequent beta or stable release. When this happens, we will provide instructions for migrating to the next version. This may require deleting, editing, and re-creating API objects. The editing process may require some thought. This may require downtime for applications that rely on the feature.
- Recommended for only non-business-critical uses because of potential for incompatible changes in subsequent releases. If you have multiple clusters that can be upgraded independently, you may be able to relax this restriction.
A General Availability (GA) feature is also referred to as a stable feature. It means:
- The feature is always enabled; you cannot disable it.
- The corresponding feature gate is no longer needed.
- Stable versions of features will appear in released software for many subsequent versions.
List of feature gates
Each feature gate is designed for enabling/disabling a specific feature:
APIListChunking
: Enable the API clients to retrieve (LIST
orGET
) resources from API server in chunks.APIPriorityAndFairness
: Enable managing request concurrency with prioritization and fairness at each server. (Renamed fromRequestManagement
)APIResponseCompression
: Compress the API responses forLIST
orGET
requests.APIServerIdentity
: Assign each API server an ID in a cluster.APIServerTracing
: Add support for distributed tracing in the API server.Accelerators
: Enable Nvidia GPU support when using DockerAdvancedAuditing
: Enable advanced auditingAffinityInAnnotations
: Enable setting Pod affinity or anti-affinity.AllowExtTrafficLocalEndpoints
: Enable a service to route external requests to node local endpoints.AllowInsecureBackendProxy
: Enable the users to skip TLS verification of kubelets on Pod log requests.AnyVolumeDataSource
: Enable use of any custom resource as theDataSource
of a PVC.AppArmor
: Enable AppArmor based mandatory access control on Linux nodes when using Docker. See AppArmor Tutorial for more details.AttachVolumeLimit
: Enable volume plugins to report limits on number of volumes that can be attached to a node. See dynamic volume limits for more details.BalanceAttachedNodeVolumes
: Include volume count on node to be considered for balanced resource allocation while scheduling. A node which has closer CPU, memory utilization, and volume count is favored by the scheduler while making decisions.BlockVolume
: Enable the definition and consumption of raw block devices in Pods. See Raw Block Volume Support for more details.BoundServiceAccountTokenVolume
: Migrate ServiceAccount volumes to use a projected volume consisting of a ServiceAccountTokenVolumeProjection. Cluster admins can use metricserviceaccount_stale_tokens_total
to monitor workloads that are depending on the extended tokens. If there are no such workloads, turn off extended tokens by startingkube-apiserver
with flag--service-account-extend-token-expiration=false
. Check Bound Service Account Tokens for more details.ControllerManagerLeaderMigration
: Enables Leader Migration for kube-controller-manager and cloud-controller-manager which allows a cluster operator to live migrate controllers from the kube-controller-manager into an external controller-manager (e.g. the cloud-controller-manager) in an HA cluster without downtime.CPUManager
: Enable container level CPU affinity support, see CPU Management Policies.CPUManagerPolicyOptions
: Allow fine-tuning of CPUManager policies.CRIContainerLogRotation
: Enable container log rotation for CRI container runtime. The default max size of a log file is 10MB and the default max number of log files allowed for a container is 5. These values can be configured in the kubelet config. See the logging at node level documentation for more details.CSIBlockVolume
: Enable external CSI volume drivers to support block storage. See thecsi
raw block volume support documentation for more details.CSIDriverRegistry
: Enable all logic related to the CSIDriver API object in csi.storage.k8s.io.CSIInlineVolume
: Enable CSI Inline volumes support for pods.CSIMigration
: Enables shims and translation logic to route volume operations from in-tree plugins to corresponding pre-installed CSI pluginsCSIMigrationAWS
: Enables shims and translation logic to route volume operations from the AWS-EBS in-tree plugin to EBS CSI plugin. Supports falling back to in-tree EBS plugin if a node does not have EBS CSI plugin installed and configured. Requires CSIMigration feature flag enabled.CSIMigrationAWSComplete
: Stops registering the EBS in-tree plugin in kubelet and volume controllers and enables shims and translation logic to route volume operations from the AWS-EBS in-tree plugin to EBS CSI plugin. Requires CSIMigration and CSIMigrationAWS feature flags enabled and EBS CSI plugin installed and configured on all nodes in the cluster. This flag has been deprecated in favor of theInTreePluginAWSUnregister
feature flag which prevents the registration of in-tree EBS plugin.CSIMigrationAzureDisk
: Enables shims and translation logic to route volume operations from the Azure-Disk in-tree plugin to AzureDisk CSI plugin. Supports falling back to in-tree AzureDisk plugin if a node does not have AzureDisk CSI plugin installed and configured. Requires CSIMigration feature flag enabled.CSIMigrationAzureDiskComplete
: Stops registering the Azure-Disk in-tree plugin in kubelet and volume controllers and enables shims and translation logic to route volume operations from the Azure-Disk in-tree plugin to AzureDisk CSI plugin. Requires CSIMigration and CSIMigrationAzureDisk feature flags enabled and AzureDisk CSI plugin installed and configured on all nodes in the cluster. This flag has been deprecated in favor of theInTreePluginAzureDiskUnregister
feature flag which prevents the registration of in-tree AzureDisk plugin.CSIMigrationAzureFile
: Enables shims and translation logic to route volume operations from the Azure-File in-tree plugin to AzureFile CSI plugin. Supports falling back to in-tree AzureFile plugin if a node does not have AzureFile CSI plugin installed and configured. Requires CSIMigration feature flag enabled.CSIMigrationAzureFileComplete
: Stops registering the Azure-File in-tree plugin in kubelet and volume controllers and enables shims and translation logic to route volume operations from the Azure-File in-tree plugin to AzureFile CSI plugin. Requires CSIMigration and CSIMigrationAzureFile feature flags enabled and AzureFile CSI plugin installed and configured on all nodes in the cluster. This flag has been deprecated in favor of theInTreePluginAzureFileUnregister
feature flag which prevents the registration of in-tree AzureFile plugin.CSIMigrationGCE
: Enables shims and translation logic to route volume operations from the GCE-PD in-tree plugin to PD CSI plugin. Supports falling back to in-tree GCE plugin if a node does not have PD CSI plugin installed and configured. Requires CSIMigration feature flag enabled.CSIMigrationRBD
: Enables shims and translation logic to route volume operations from the RBD in-tree plugin to Ceph RBD CSI plugin. Requires CSIMigration and CSIMigrationRBD feature flags enabled and Ceph CSI plugin installed and configured in the cluster. This flag has been deprecated in favor of theInTreePluginRBDUnregister
feature flag which prevents the registration of in-tree RBD plugin.CSIMigrationGCEComplete
: Stops registering the GCE-PD in-tree plugin in kubelet and volume controllers and enables shims and translation logic to route volume operations from the GCE-PD in-tree plugin to PD CSI plugin. Requires CSIMigration and CSIMigrationGCE feature flags enabled and PD CSI plugin installed and configured on all nodes in the cluster. This flag has been deprecated in favor of theInTreePluginGCEUnregister
feature flag which prevents the registration of in-tree GCE PD plugin.CSIMigrationOpenStack
: Enables shims and translation logic to route volume operations from the Cinder in-tree plugin to Cinder CSI plugin. Supports falling back to in-tree Cinder plugin if a node does not have Cinder CSI plugin installed and configured. Requires CSIMigration feature flag enabled.CSIMigrationOpenStackComplete
: Stops registering the Cinder in-tree plugin in kubelet and volume controllers and enables shims and translation logic to route volume operations from the Cinder in-tree plugin to Cinder CSI plugin. Requires CSIMigration and CSIMigrationOpenStack feature flags enabled and Cinder CSI plugin installed and configured on all nodes in the cluster. This flag has been deprecated in favor of theInTreePluginOpenStackUnregister
feature flag which prevents the registration of in-tree openstack cinder plugin.CSIMigrationvSphere
: Enables shims and translation logic to route volume operations from the vSphere in-tree plugin to vSphere CSI plugin. Supports falling back to in-tree vSphere plugin if a node does not have vSphere CSI plugin installed and configured. Requires CSIMigration feature flag enabled.CSIMigrationvSphereComplete
: Stops registering the vSphere in-tree plugin in kubelet and volume controllers and enables shims and translation logic to route volume operations from the vSphere in-tree plugin to vSphere CSI plugin. Requires CSIMigration and CSIMigrationvSphere feature flags enabled and vSphere CSI plugin installed and configured on all nodes in the cluster. This flag has been deprecated in favor of theInTreePluginvSphereUnregister
feature flag which prevents the registration of in-tree vsphere plugin.CSIMigrationPortworx
: Enables shims and translation logic to route volume operations from the Portworx in-tree plugin to Portworx CSI plugin. Requires Portworx CSI driver to be installed and configured in the cluster, and feature gate setCSIMigrationPortworx=true
in kube-controller-manager and kubelet configs.CSINodeInfo
: Enable all logic related to the CSINodeInfo API object in csi.storage.k8s.io.CSIPersistentVolume
: Enable discovering and mounting volumes provisioned through a CSI (Container Storage Interface) compatible volume plugin.CSIServiceAccountToken
: Enable CSI drivers to receive the pods' service account token that they mount volumes for. See Token Requests.CSIStorageCapacity
: Enables CSI drivers to publish storage capacity information and the Kubernetes scheduler to use that information when scheduling pods. See Storage Capacity. Check thecsi
volume type documentation for more details.CSIVolumeFSGroupPolicy
: Allows CSIDrivers to use thefsGroupPolicy
field. This field controls whether volumes created by a CSIDriver support volume ownership and permission modifications when these volumes are mounted.CSIVolumeHealth
: Enable support for CSI volume health monitoring on node.CSRDuration
: Allows clients to request a duration for certificates issued via the Kubernetes CSR API.ConfigurableFSGroupPolicy
: Allows user to configure volume permission change policy for fsGroups when mounting a volume in a Pod. See Configure volume permission and ownership change policy for Pods for more details.ControllerManagerLeaderMigration
: Enables leader migration forkube-controller-manager
andcloud-controller-manager
.CronJobControllerV2
: Use an alternative implementation of the CronJob controller. Otherwise, version 1 of the same controller is selected.CustomCPUCFSQuotaPeriod
: Enable nodes to changecpuCFSQuotaPeriod
in kubelet config.CustomResourceValidationExpressions
: Enable expression language validation in CRD which will validate customer resource based on validation rules written inx-kubernetes-validations
extension.CustomPodDNS
: Enable customizing the DNS settings for a Pod using itsdnsConfig
property. Check Pod's DNS Config for more details.CustomResourceDefaulting
: Enable CRD support for default values in OpenAPI v3 validation schemas.CustomResourcePublishOpenAPI
: Enables publishing of CRD OpenAPI specs.CustomResourceSubresources
: Enable/status
and/scale
subresources on resources created from CustomResourceDefinition.CustomResourceValidation
: Enable schema based validation on resources created from CustomResourceDefinition.CustomResourceWebhookConversion
: Enable webhook-based conversion on resources created from CustomResourceDefinition.DaemonSetUpdateSurge
: Enables the DaemonSet workloads to maintain availability during update per node.DefaultPodTopologySpread
: Enables the use ofPodTopologySpread
scheduling plugin to do default spreading.DelegateFSGroupToCSIDriver
: If supported by the CSI driver, delegates the role of applyingfsGroup
from a Pod'ssecurityContext
to the driver by passingfsGroup
through the NodeStageVolume and NodePublishVolume CSI calls.DevicePlugins
: Enable the device-plugins based resource provisioning on nodes.DisableAcceleratorUsageMetrics
: Disable accelerator metrics collected by the kubelet.DisableCloudProviders
: Disables any functionality inkube-apiserver
,kube-controller-manager
andkubelet
related to the--cloud-provider
component flag.DownwardAPIHugePages
: Enables usage of hugepages in downward API.DryRun
: Enable server-side dry run requests so that validation, merging, and mutation can be tested without committing.DynamicAuditing
: Used to enable dynamic auditing before v1.19.DynamicKubeletConfig
: Enable the dynamic configuration of kubelet. See Reconfigure kubelet.DynamicProvisioningScheduling
: Extend the default scheduler to be aware of volume topology and handle PV provisioning. This feature is superseded by theVolumeScheduling
feature completely in v1.12.DynamicVolumeProvisioning
: Enable the dynamic provisioning of persistent volumes to Pods.EfficientWatchResumption
: Allows for storage-originated bookmark (progress notify) events to be delivered to the users. This is only applied to watch operations.EnableAggregatedDiscoveryTimeout
: Enable the five second timeout on aggregated discovery calls.EnableEquivalenceClassCache
: Enable the scheduler to cache equivalence of nodes when scheduling Pods.EndpointSlice
: Enables EndpointSlices for more scalable and extensible network endpoints. See Enabling EndpointSlices.EndpointSliceNodeName
: Enables EndpointSlicenodeName
field.EndpointSliceProxying
: When enabled, kube-proxy running on Linux will use EndpointSlices as the primary data source instead of Endpoints, enabling scalability and performance improvements. See Enabling Endpoint Slices.EndpointSliceTerminatingCondition
: Enables EndpointSliceterminating
andserving
condition fields.EphemeralContainers
: Enable the ability to add ephemeral containers to running pods.EvenPodsSpread
: Enable pods to be scheduled evenly across topology domains. See Pod Topology Spread Constraints.ExecProbeTimeout
: Ensure kubelet respects exec probe timeouts. This feature gate exists in case any of your existing workloads depend on a now-corrected fault where Kubernetes ignored exec probe timeouts. See readiness probes.ExpandCSIVolumes
: Enable the expanding of CSI volumes.ExpandedDNSConfig
: Enable kubelet and kube-apiserver to allow more DNS search paths and longer list of DNS search paths. See Expanded DNS Configuration.ExpandInUsePersistentVolumes
: Enable expanding in-use PVCs. See Resizing an in-use PersistentVolumeClaim.ExpandPersistentVolumes
: Enable the expanding of persistent volumes. See Expanding Persistent Volumes Claims.ExperimentalCriticalPodAnnotation
: Enable annotating specific pods as critical so that their scheduling is guaranteed. This feature is deprecated by Pod Priority and Preemption as of v1.13.ExperimentalHostUserNamespaceDefaulting
: Enabling the defaulting user namespace to host. This is for containers that are using other host namespaces, host mounts, or containers that are privileged or using specific non-namespaced capabilities (e.g.MKNODE
,SYS_MODULE
etc.). This should only be enabled if user namespace remapping is enabled in the Docker daemon.ExternalPolicyForExternalIP
: Fix a bug where ExternalTrafficPolicy is not applied to Service ExternalIPs.GCERegionalPersistentDisk
: Enable the regional PD feature on GCE.GenericEphemeralVolume
: Enables ephemeral, inline volumes that support all features of normal volumes (can be provided by third-party storage vendors, storage capacity tracking, restore from snapshot, etc.). See Ephemeral Volumes.GracefulNodeShutdown
: Enables support for graceful shutdown in kubelet. During a system shutdown, kubelet will attempt to detect the shutdown event and gracefully terminate pods running on the node. See Graceful Node Shutdown for more details.GRPCContainerProbe
: Enables the gRPC probe method for {Liveness,Readiness,Startup}Probe. See Configure Liveness, Readiness and Startup Probes.HPAContainerMetrics
: Enable theHorizontalPodAutoscaler
to scale based on metrics from individual containers in target pods.HPAScaleToZero
: Enables settingminReplicas
to 0 forHorizontalPodAutoscaler
resources when using custom or external metrics.HugePages
: Enable the allocation and consumption of pre-allocated huge pages.HugePageStorageMediumSize
: Enable support for multiple sizes pre-allocated huge pages.HyperVContainer
: Enable Hyper-V isolation for Windows containers.IdentifyPodOS
: Allows the Pod OS field to be specified. This helps in identifying the OS of the pod authoritatively during the API server admission time. In Kubernetes 1.23, the allowed values for thepod.spec.os.name
arewindows
andlinux
.ImmutableEphemeralVolumes
: Allows for marking individual Secrets and ConfigMaps as immutable for better safety and performance.InTreePluginAWSUnregister
: Stops registering the aws-ebs in-tree plugin in kubelet and volume controllers.InTreePluginAzureDiskUnregister
: Stops registering the azuredisk in-tree plugin in kubelet and volume controllers.InTreePluginAzureFileUnregister
: Stops registering the azurefile in-tree plugin in kubelet and volume controllers.InTreePluginGCEUnregister
: Stops registering the gce-pd in-tree plugin in kubelet and volume controllers.InTreePluginOpenStackUnregister
: Stops registering the OpenStack cinder in-tree plugin in kubelet and volume controllers.InTreePluginvSphereUnregister
: Stops registering the vSphere in-tree plugin in kubelet and volume controllers.IndexedJob
: Allows the Job controller to manage Pod completions per completion index.IngressClassNamespacedParams
: Allow namespace-scoped parameters reference inIngressClass
resource. This feature adds two fields -Scope
andNamespace
toIngressClass.spec.parameters
.Initializers
: Allow asynchronous coordination of object creation using the Initializers admission plugin.IPv6DualStack
: Enable dual stack support for IPv6.JobMutableNodeSchedulingDirectives
: Allows updating node scheduling directives in the pod template of Job.JobReadyPods
: Enables tracking the number of Pods that have aReady
condition. The count ofReady
pods is recorded in the status of a Job status.JobTrackingWithFinalizers
: Enables tracking Job completions without relying on Pods remaining in the cluster indefinitely. The Job controller uses Pod finalizers and a field in the Job status to keep track of the finished Pods to count towards completion.KubeletConfigFile
: Enable loading kubelet configuration from a file specified using a config file. See setting kubelet parameters via a config file for more details.KubeletCredentialProviders
: Enable kubelet exec credential providers for image pull credentials.KubeletInUserNamespace
: Enables support for running kubelet in a user namespace. See Running Kubernetes Node Components as a Non-root User.KubeletPluginsWatcher
: Enable probe-based plugin watcher utility to enable kubelet to discover plugins such as CSI volume drivers.KubeletPodResources
: Enable the kubelet's pod resources gRPC endpoint. See Support Device Monitoring for more details.KubeletPodResourcesGetAllocatable
: Enable the kubelet's pod resourcesGetAllocatableResources
functionality. This API augments the resource allocation reporting with informations about the allocatable resources, enabling clients to properly track the free compute resources on a node.LegacyNodeRoleBehavior
: When disabled, legacy behavior in service load balancers and node disruption will ignore thenode-role.kubernetes.io/master
label in favor of the feature-specific labels provided byNodeDisruptionExclusion
andServiceNodeExclusion
.LocalStorageCapacityIsolation
: Enable the consumption of local ephemeral storage and also thesizeLimit
property of an emptyDir volume.LocalStorageCapacityIsolationFSQuotaMonitoring
: WhenLocalStorageCapacityIsolation
is enabled for local ephemeral storage and the backing filesystem for emptyDir volumes supports project quotas and they are enabled, use project quotas to monitor emptyDir volume storage consumption rather than filesystem walk for better performance and accuracy.LogarithmicScaleDown
: Enable semi-random selection of pods to evict on controller scaledown based on logarithmic bucketing of pod timestamps.MemoryManager
: Allows setting memory affinity for a container based on NUMA topology.MemoryQoS
: Enable memory protection and usage throttle on pod / container using cgroup v2 memory controller.MixedProtocolLBService
: Enable using different protocols in the sameLoadBalancer
type Service instance.MountContainers
: Enable using utility containers on host as the volume mounter.MountPropagation
: Enable sharing volume mounted by one container to other containers or pods. For more details, please see mount propagation.NamespaceDefaultLabelName
: Configure the API Server to set an immutable labelkubernetes.io/metadata.name
on all namespaces, containing the namespace name.NetworkPolicyEndPort
: Enable use of the fieldendPort
in NetworkPolicy objects, allowing the selection of a port range instead of a single port.NodeDisruptionExclusion
: Enable use of the Node labelnode.kubernetes.io/exclude-disruption
which prevents nodes from being evacuated during zone failures.NodeLease
: Enable the new Lease API to report node heartbeats, which could be used as a node health signal.NodeSwap
: Enable the kubelet to allocate swap memory for Kubernetes workloads on a node. Must be used withKubeletConfiguration.failSwapOn
set to false. For more details, please see swap memoryNonPreemptingPriority
: EnablepreemptionPolicy
field for PriorityClass and Pod.PVCProtection
: Enable the prevention of a PersistentVolumeClaim (PVC) from being deleted when it is still used by any Pod.PodDeletionCost
: Enable the Pod Deletion Cost feature which allows users to influence ReplicaSet downscaling order.PersistentLocalVolumes
: Enable the usage oflocal
volume type in Pods. Pod affinity has to be specified if requesting alocal
volume.PodAndContainerStatsFromCRI
: Configure the kubelet to gather container and pod stats from the CRI container runtime rather than gathering them from cAdvisor.PodDisruptionBudget
: Enable the PodDisruptionBudget feature.PodAffinityNamespaceSelector
: Enable the Pod Affinity Namespace Selector and CrossNamespacePodAffinity quota scope features.PodOverhead
: Enable the PodOverhead feature to account for pod overheads.PodPriority
: Enable the descheduling and preemption of Pods based on their priorities.PodReadinessGates
: Enable the setting ofPodReadinessGate
field for extending Pod readiness evaluation. See Pod readiness gate for more details.PodSecurity
: Enables thePodSecurity
admission plugin.PodShareProcessNamespace
: Enable the setting ofshareProcessNamespace
in a Pod for sharing a single process namespace between containers running in a pod. More details can be found in Share Process Namespace between Containers in a Pod.PreferNominatedNode
: This flag tells the scheduler whether the nominated nodes will be checked first before looping through all the other nodes in the cluster.ProbeTerminationGracePeriod
: Enable setting probe-levelterminationGracePeriodSeconds
on pods. See the enhancement proposal for more details.ProcMountType
: Enables control over the type proc mounts for containers by setting theprocMount
field of a SecurityContext.ProxyTerminatingEndpoints
: Enable the kube-proxy to handle terminating endpoints whenExternalTrafficPolicy=Local
.QOSReserved
: Allows resource reservations at the QoS level preventing pods at lower QoS levels from bursting into resources requested at higher QoS levels (memory only for now).ReadWriteOncePod
: Enables the usage ofReadWriteOncePod
PersistentVolume access mode.RecoverVolumeExpansionFailure
: Enables users to edit their PVCs to smaller sizes so as they can recover from previously issued volume expansion failures. See Recovering from Failure when Expanding Volumes for more details.RemainingItemCount
: Allow the API servers to show a count of remaining items in the response to a chunking list request.RemoveSelfLink
: Deprecates and removesselfLink
from ObjectMeta and ListMeta.RequestManagement
: Enables managing request concurrency with prioritization and fairness at each API server. Deprecated byAPIPriorityAndFairness
since 1.17.ResourceLimitsPriorityFunction
: Enable a scheduler priority function that assigns a lowest possible score of 1 to a node that satisfies at least one of the input Pod's cpu and memory limits. The intent is to break ties between nodes with same scores.ResourceQuotaScopeSelectors
: Enable resource quota scope selectors.RootCAConfigMap
: Configure thekube-controller-manager
to publish a ConfigMap namedkube-root-ca.crt
to every namespace. This ConfigMap contains a CA bundle used for verifying connections to the kube-apiserver. See Bound Service Account Tokens for more details.RotateKubeletClientCertificate
: Enable the rotation of the client TLS certificate on the kubelet. See kubelet configuration for more details.RotateKubeletServerCertificate
: Enable the rotation of the server TLS certificate on the kubelet. See kubelet configuration for more details.RunAsGroup
: Enable control over the primary group ID set on the init processes of containers.RuntimeClass
: Enable the RuntimeClass feature for selecting container runtime configurations.ScheduleDaemonSetPods
: Enable DaemonSet Pods to be scheduled by the default scheduler instead of the DaemonSet controller.SCTPSupport
: Enables the SCTPprotocol
value in Pod, Service, Endpoints, EndpointSlice, and NetworkPolicy definitions.SeccompDefault
: Enables the use ofRuntimeDefault
as the default seccomp profile for all workloads. The seccomp profile is specified in thesecurityContext
of a Pod and/or a Container.SelectorIndex
: Allows label and field based indexes in API server watch cache to accelerate list operations.ServerSideApply
: Enables the Sever Side Apply (SSA) feature on the API Server.ServiceAccountIssuerDiscovery
: Enable OIDC discovery endpoints (issuer and JWKS URLs) for the service account issuer in the API server. See Configure Service Accounts for Pods for more details.ServiceAppProtocol
: Enables theappProtocol
field on Services and Endpoints.ServiceInternalTrafficPolicy
: Enables theinternalTrafficPolicy
field on ServicesServiceLBNodePortControl
: Enables theallocateLoadBalancerNodePorts
field on Services.ServiceLoadBalancerClass
: Enables theloadBalancerClass
field on Services. See Specifying class of load balancer implementation for more details.ServiceLoadBalancerFinalizer
: Enable finalizer protection for Service load balancers.ServiceNodeExclusion
: Enable the exclusion of nodes from load balancers created by a cloud provider. A node is eligible for exclusion if labelled with "node.kubernetes.io/exclude-from-external-load-balancers
".ServiceTopology
: Enable service to route traffic based upon the Node topology of the cluster. See ServiceTopology for more details.SetHostnameAsFQDN
: Enable the ability of setting Fully Qualified Domain Name(FQDN) as the hostname of a pod. See Pod'ssetHostnameAsFQDN
field.SizeMemoryBackedVolumes
: Enable kubelets to determine the size limit for memory-backed volumes (mainlyemptyDir
volumes).StartupProbe
: Enable the startup probe in the kubelet.StatefulSetMinReadySeconds
: AllowsminReadySeconds
to be respected by the StatefulSet controller.StorageObjectInUseProtection
: Postpone the deletion of PersistentVolume or PersistentVolumeClaim objects if they are still being used.StorageVersionAPI
: Enable the storage version API.StorageVersionHash
: Allow API servers to expose the storage version hash in the discovery.StreamingProxyRedirects
: Instructs the API server to intercept (and follow) redirects from the backend (kubelet) for streaming requests. Examples of streaming requests include theexec
,attach
andport-forward
requests.SupportIPVSProxyMode
: Enable providing in-cluster service load balancing using IPVS. See service proxies for more details.SupportNodePidsLimit
: Enable the support to limiting PIDs on the Node. The parameterpid=<number>
in the--system-reserved
and--kube-reserved
options can be specified to ensure that the specified number of process IDs will be reserved for the system as a whole and for Kubernetes system daemons respectively.SupportPodPidsLimit
: Enable the support to limiting PIDs in Pods.SuspendJob
: Enable support to suspend and resume Jobs. See the Jobs docs for more details.Sysctls
: Enable support for namespaced kernel parameters (sysctls) that can be set for each pod. See sysctls for more details.TTLAfterFinished
: Allow a TTL controller to clean up resources after they finish execution.TaintBasedEvictions
: Enable evicting pods from nodes based on taints on Nodes and tolerations on Pods. See taints and tolerations for more details.TaintNodesByCondition
: Enable automatic tainting nodes based on node conditions.TokenRequest
: Enable theTokenRequest
endpoint on service account resources.TokenRequestProjection
: Enable the injection of service account tokens into a Pod through aprojected
volume.TopologyAwareHints
: Enables topology aware routing based on topology hints in EndpointSlices. See Topology Aware Hints for more details.TopologyManager
: Enable a mechanism to coordinate fine-grained hardware resource assignments for different components in Kubernetes. See Control Topology Management Policies on a node.ValidateProxyRedirects
: This flag controls whether the API server should validate that redirects are only followed to the same host. Only used if theStreamingProxyRedirects
flag is enabled.VolumeCapacityPriority
: Enable support for prioritizing nodes in different topologies based on available PV capacity.VolumePVCDataSource
: Enable support for specifying an existing PVC as a DataSource.VolumeScheduling
: Enable volume topology aware scheduling and make the PersistentVolumeClaim (PVC) binding aware of scheduling decisions. It also enables the usage oflocal
volume type when used together with thePersistentLocalVolumes
feature gate.VolumeSnapshotDataSource
: Enable volume snapshot data source support.VolumeSubpath
: Allow mounting a subpath of a volume in a container.VolumeSubpathEnvExpansion
: EnablesubPathExpr
field for expanding environment variables into asubPath
.WarningHeaders
: Allow sending warning headers in API responses.WatchBookmark
: Enable support for watch bookmark events.WinDSR
: Allows kube-proxy to create DSR loadbalancers for Windows.WinOverlay
: Allows kube-proxy to run in overlay mode for Windows.WindowsEndpointSliceProxying
: When enabled, kube-proxy running on Windows will use EndpointSlices as the primary data source instead of Endpoints, enabling scalability and performance improvements. See Enabling Endpoint Slices.WindowsGMSA
: Enables passing of GMSA credential specs from pods to container runtimes.WindowsHostProcessContainers
: Enables support for Windows HostProcess containers.WindowsRunAsUserName
: Enable support for running applications in Windows containers with as a non-default user. See Configuring RunAsUserName for more details.
What's next
- The deprecation policy for Kubernetes explains the project's approach to removing features and components.
2 - kubelet
Synopsis
The kubelet is the primary "node agent" that runs on each 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.
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.
Other than from a PodSpec from the apiserver, there are three ways that a container manifest can be provided to the Kubelet.
- 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 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
--add-dir-header | |
If true, adds the file directory to the header of the log messages | |
--address string Default: 0.0.0.0 | |
The IP address for the Kubelet to serve on (set to 0.0.0.0 or :: for listening in all interfaces and IP families) (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.) |
|
--alsologtostderr | |
Log to standard error as well as files | |
--anonymous-auth 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 . (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 | |
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 Default: 2m0s |
|
The duration to cache responses from the webhook token authenticator. (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 when --config flag is not provided; Webhook when --config flag presents. (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 Default: 5m0s |
|
The duration to cache 'authorized' responses from the webhook authorizer. (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 Default: 30s |
|
The duration to cache 'unauthorized' responses from the webhook authorizer. (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 containing Azure container registry configuration information. | |
--bootstrap-kubeconfig string | |
Path to a kubeconfig file that will be used to get client certificate for kubelet. If the file specified by --kubeconfig does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On success, a kubeconfig file referencing the generated client certificate and key is written to the path specified by --kubeconfig . The client certificate and key file will be stored in the directory pointed by --cert-dir . |
|
--cert-dir string Default: /var/lib/kubelet/pki |
|
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. |
|
--cgroup-driver string Default: cgroupfs |
|
Driver that the kubelet uses to manipulate cgroups on the host. Possible values: cgroupfs , systemd . (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 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 Default: true |
|
Enable creation of QoS cgroup hierarchy, if true top level QoS and pod cgroups are created. (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.) |
|
--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. (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. Empty string for no configuration file. (DEPRECATED: will be removed in 1.23, in favor of removing cloud providers code from Kubelet.) | |
--cloud-provider string | |
The provider for cloud services. Set to 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). (DEPRECATED: will be removed in 1.23, in favor of removing cloud provider code from Kubelet.) | |
--cluster-dns strings | |
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-domain string | |
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 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 . (DEPRECATED: will be removed along with dockershim.) |
|
--cni-cache-dir string Default: /var/lib/cni/cache |
|
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 . (DEPRECATED: will be removed along with dockershim.) |
|
--cni-conf-dir string Default: /etc/cni/net.d |
|
<Warning: Alpha feature> 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 . (DEPRECATED: will be removed along with dockershim.) |
|
--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-log-max-files int32 Default: 5 | |
<Warning: Beta feature> 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 . (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 Default: 10Mi |
|
<Warning: Beta feature> 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 . (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 Default: docker |
|
The container runtime to use. Possible values: docker , remote . |
|
--container-runtime-endpoint string Default: unix:///var/run/dockershim.sock |
|
[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 . |
|
--contention-profiling | |
Enable 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 Default: true |
|
Enable CPU CFS quota enforcement for containers that specify CPU limits (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 Default: 100ms |
|
Sets CPU CFS quota period value, cpu.cfs_period_us , defaults to Linux Kernel 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.) |
|
--cpu-manager-policy string Default: none |
|
CPU Manager policy to use. Possible values: none , static . (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-options strings | |
Comma-separated list of options to fine-tune the behavior of the selected CPU Manager policy. If not supplied, keep the default behaviour. (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 duration Default: 10s |
|
<Warning: Alpha feature> CPU Manager reconciliation period. Examples: 10s , or 1m . If not supplied, defaults to node status update frequency. (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-endpoint string 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 . |
|
--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. The DynamicKubeletConfig feature gate must be enabled to pass this flag. (DEPRECATED: Feature DynamicKubeletConfig is deprecated in 1.22 and will not move to GA. It is planned to be removed from Kubernetes in the version 1.23. Please use alternative ways to update kubelet configuration.) |
|
--enable-controller-attach-detach Default: true |
|
Enables the Attach/Detach controller to manage attachment/detachment of volumes scheduled to this node, and disables kubelet from executing any attach/detach operations. (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-debugging-handlers Default: true |
|
Enables server endpoints for log collection and local running of containers and commands. (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-server Default: true |
|
Enable the Kubelet's server. (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.) |
|
--enforce-node-allocatable strings 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. (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 Default: 10 | |
Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding --event-qps . The number must be >= 0. If 0 will use default burst (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 Default: 5 | |
QPS to limit event creations. The number must be >= 0. If 0 will use default QPS (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-hard mapStringString Default: imagefs.available<15%,memory.available<100Mi,nodefs.available<10% |
|
A set of eviction thresholds (e.g. memory.available<1Gi ) that if met would trigger a pod eviction. On a Linux node, the default value also includes 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. 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. (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 Default: 5m0s |
|
Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. (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. (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. (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.) |
|
--exit-on-lock-contention | |
Whether kubelet should exit upon lock-file contention. | |
--experimental-allocatable-ignore-eviction Default: false |
|
When 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. (DEPRECATED: will be removed in 1.23) |
|
--experimental-bootstrap-kubeconfig string | |
DEPRECATED: Use --bootstrap-kubeconfig |
|
--experimental-check-node-capabilities-before-mount | |
[Experimental] if set to true , the kubelet will check the underlying node for required components (binaries, etc.) before performing the mount (DEPRECATED: will be removed in 1.23, in favor of using CSI.) |
|
--experimental-kernel-memcg-notification | |
If enabled, the kubelet will integrate with the kernel memcg notification to determine if memory eviction thresholds are crossed rather than polling. This flag will be removed in 1.23. (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-log-sanitization bool | |
[Experimental] When enabled, prevents logging of fields tagged as sensitive (passwords, keys, tokens). Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production. (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-mounter-path string Default: mount |
|
[Experimental] Path of mounter binary. Leave empty to use the default mount . (DEPRECATED: will be removed in 1.23, in favor of using CSI.) |
|
--fail-swap-on Default: true |
|
Makes the Kubelet fail to start if swap is enabled on the node. (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 <A list of 'key=true/false' pairs> | |
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:APIListChunking=true|false (BETA - default=true) APIPriorityAndFairness=true|false (BETA - default=true) APIResponseCompression=true|false (BETA - default=true) APIServerIdentity=true|false (ALPHA - default=false) APIServerTracing=true|false (ALPHA - default=false) AllAlpha=true|false (ALPHA - default=false) AllBeta=true|false (BETA - default=false) AnyVolumeDataSource=true|false (ALPHA - default=false) AppArmor=true|false (BETA - default=true) CPUManager=true|false (BETA - default=true) CPUManagerPolicyOptions=true|false (ALPHA - default=false) CSIInlineVolume=true|false (BETA - default=true) CSIMigration=true|false (BETA - default=true) CSIMigrationAWS=true|false (BETA - default=false) CSIMigrationAzureDisk=true|false (BETA - default=false) CSIMigrationAzureFile=true|false (BETA - default=false) CSIMigrationGCE=true|false (BETA - default=false) CSIMigrationOpenStack=true|false (BETA - default=true) CSIMigrationvSphere=true|false (BETA - default=false) CSIStorageCapacity=true|false (BETA - default=true) CSIVolumeFSGroupPolicy=true|false (BETA - default=true) CSIVolumeHealth=true|false (ALPHA - default=false) CSRDuration=true|false (BETA - default=true) ConfigurableFSGroupPolicy=true|false (BETA - default=true) ControllerManagerLeaderMigration=true|false (BETA - default=true) CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false) DaemonSetUpdateSurge=true|false (BETA - default=true) DefaultPodTopologySpread=true|false (BETA - default=true) DelegateFSGroupToCSIDriver=true|false (ALPHA - default=false) DevicePlugins=true|false (BETA - default=true) DisableAcceleratorUsageMetrics=true|false (BETA - default=true) DisableCloudProviders=true|false (ALPHA - default=false) DownwardAPIHugePages=true|false (BETA - default=false) EfficientWatchResumption=true|false (BETA - default=true) EndpointSliceTerminatingCondition=true|false (BETA - default=true) EphemeralContainers=true|false (ALPHA - default=false) ExpandCSIVolumes=true|false (BETA - default=true) ExpandInUsePersistentVolumes=true|false (BETA - default=true) ExpandPersistentVolumes=true|false (BETA - default=true) ExpandedDNSConfig=true|false (ALPHA - default=false) ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false) GenericEphemeralVolume=true|false (BETA - default=true) GracefulNodeShutdown=true|false (BETA - default=true) HPAContainerMetrics=true|false (ALPHA - default=false) HPAScaleToZero=true|false (ALPHA - default=false) IPv6DualStack=true|false (BETA - default=true) InTreePluginAWSUnregister=true|false (ALPHA - default=false) InTreePluginAzureDiskUnregister=true|false (ALPHA - default=false) InTreePluginAzureFileUnregister=true|false (ALPHA - default=false) InTreePluginGCEUnregister=true|false (ALPHA - default=false) InTreePluginOpenStackUnregister=true|false (ALPHA - default=false) InTreePluginvSphereUnregister=true|false (ALPHA - default=false) IndexedJob=true|false (BETA - default=true) IngressClassNamespacedParams=true|false (BETA - default=true) JobTrackingWithFinalizers=true|false (ALPHA - default=false) KubeletCredentialProviders=true|false (ALPHA - default=false) KubeletInUserNamespace=true|false (ALPHA - default=false) KubeletPodResources=true|false (BETA - default=true) KubeletPodResourcesGetAllocatable=true|false (ALPHA - default=false) LocalStorageCapacityIsolation=true|false (BETA - default=true) LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false) LogarithmicScaleDown=true|false (BETA - default=true) MemoryManager=true|false (BETA - default=true) MemoryQoS=true|false (ALPHA - default=false) MixedProtocolLBService=true|false (ALPHA - default=false) NetworkPolicyEndPort=true|false (BETA - default=true) NodeSwap=true|false (ALPHA - default=false) NonPreemptingPriority=true|false (BETA - default=true) PodAffinityNamespaceSelector=true|false (BETA - default=true) PodDeletionCost=true|false (BETA - default=true) PodOverhead=true|false (BETA - default=true) PodSecurity=true|false (ALPHA - default=false) PreferNominatedNode=true|false (BETA - default=true) ProbeTerminationGracePeriod=true|false (BETA - default=false) ProcMountType=true|false (ALPHA - default=false) ProxyTerminatingEndpoints=true|false (ALPHA - default=false) QOSReserved=true|false (ALPHA - default=false) ReadWriteOncePod=true|false (ALPHA - default=false) RemainingItemCount=true|false (BETA - default=true) RemoveSelfLink=true|false (BETA - default=true) RotateKubeletServerCertificate=true|false (BETA - default=true) SeccompDefault=true|false (ALPHA - default=false) ServiceInternalTrafficPolicy=true|false (BETA - default=true) ServiceLBNodePortControl=true|false (BETA - default=true) ServiceLoadBalancerClass=true|false (BETA - default=true) SizeMemoryBackedVolumes=true|false (BETA - default=true) StatefulSetMinReadySeconds=true|false (ALPHA - default=false) StorageVersionAPI=true|false (ALPHA - default=false) StorageVersionHash=true|false (BETA - default=true) SuspendJob=true|false (BETA - default=true) TTLAfterFinished=true|false (BETA - default=true) TopologyAwareHints=true|false (ALPHA - default=false) TopologyManager=true|false (BETA - default=true) VolumeCapacityPriority=true|false (ALPHA - default=false) WinDSR=true|false (ALPHA - default=false) WinOverlay=true|false (BETA - default=true) WindowsHostProcessContainers=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 Default: 20s |
|
Duration between checking config files for new data. (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.) |
|
--hairpin-mode string Default: promiscuous-bridge |
|
How should the kubelet setup hairpin NAT. This allows endpoints of a Service to load balance back to themselves if they should try to access their own Service. Valid values are promiscuous-bridge , hairpin-veth and 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.) |
|
--healthz-bind-address string Default: 127.0.0.1 |
|
The IP address for the healthz server to serve on (set to 0.0.0.0 or :: for listening in all interfaces and IP families). (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 Default: 10248 | |
The port of the localhost healthz endpoint (set to 0 to disable). (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 | |
--hostname-override string | |
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 Default: 20s |
|
Duration between checking HTTP for new data. (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-credential-provider-bin-dir string | |
The path to the directory where credential provider plugin binaries are located. | |
--image-credential-provider-config string | |
The path to the credential provider plugin config file. | |
--image-gc-high-threshold int32 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. (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 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 . (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 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 . (DEPRECATED: will be removed along with dockershim.) |
|
--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 endpoint is supported on Linux, while npipe and TCP endpoints are supported on Windows. Examples: unix:///var/run/dockershim.sock , npipe:////./pipe/dockershim |
|
--iptables-drop-bit int32 Default: 15 | |
The bit of the fwmark space to mark packets for dropping. Must be within the range [0, 31]. (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 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 . (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) | |
--kernel-memcg-notification | |
If enabled, the kubelet will integrate with the kernel memcg notification to determine if memory eviction thresholds are crossed rather than polling. (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-burst int32 Default: 10 | |
Burst to use while talking with kubernetes API server. The number must be >= 0. If 0 will use default burst (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 Default: application/vnd.kubernetes.protobuf |
|
Content type of requests sent to apiserver. (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 Default: 5 | |
QPS to use while talking with kubernetes API server. The number must be >= 0. If 0 will use default QPS (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 Default: <None> | |
A set of <resource name>=<resource quantity> (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi,pid='100' ) 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. (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 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 . (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.) |
|
--kubeconfig string | |
Path to a kubeconfig file, specifying how to connect to the API server. Providing --kubeconfig enables API server mode, omitting --kubeconfig enables standalone mode. |
|
--kubelet-cgroups string | |
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 | |
<Warning: Alpha feature> The path to file for kubelet to use as a lock file. | |
--log-backtrace-at <A string of format 'file:line'> Default: ":0" |
|
When logging hits line , emit a stack trace. |
|
--log-dir string | |
If non-empty, write log files in this directory | |
--log-file string | |
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 |
|
Maximum number of seconds between log flushes. | |
--logging-format string Default: text |
|
Sets the log format. Permitted formats: text , json .Non-default formats don't honor these flags: --add-dir-header , --alsologtostderr , --log-backtrace-at , --log-dir , --log-file , --log-file-max-size , --logtostderr , --skip_headers , --skip_log_headers , --stderrthreshold , --log-flush-frequency .Non-default choices are currently alpha and subject to change without warning. (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.) |
|
--logtostderr Default: true |
|
log to standard error instead of files. | |
--make-iptables-util-chains Default: true |
|
If true, kubelet will ensure iptables utility rules are present on host. (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 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 string | |
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 Default: default |
|
The namespace from which the kubernetes master services should be injected into pods. (DEPRECATED: This flag will be removed in a future version.) | |
--max-open-files int Default: 1000000 | |
Number of files that can be opened by Kubelet process. (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 Default: 110 | |
Number of Pods that can run on this Kubelet. (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 Default: -1 | |
Maximum number of old instances of containers to retain globally. Each container takes up some disk space. To disable, set to a negative number. (DEPRECATED: Use --eviction-hard or --eviction-soft instead. Will be removed in a future version.) |
|
--maximum-dead-containers-per-container int32 Default: 1 | |
Maximum number of old instances to retain per container. Each container takes up some disk space. (DEPRECATED: Use --eviction-hard or --eviction-soft instead. Will be removed in a future version.) |
|
--memory-manager-policy string Default: None |
|
Memory Manager policy to use. Possible values: 'None' , 'Static' . (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.) |
|
--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 Default: 2m0s |
|
Minimum age for an unused image before it is garbage collected. Examples: '300ms' , '10s' or '2h45m' . (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. This docker-specific flag only works when container-runtime is set to docker . (DEPRECATED: will be removed along with dockershim.) |
|
--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. This docker-specific flag only works when container-runtime is set to docker . (DEPRECATED: will be removed along with dockershim.) |
|
--node-ip string | |
IP address (or comma-separated dual-stack IP addresses) of the node. If unset, kubelet will use the node's default IPv4 address, if any, or its default IPv6 address if it has no IPv4 addresses. You can pass '::' to make it prefer the default IPv6 address rather than the default IPv4 address. |
|
--node-labels mapStringString | |
<Warning: Alpha feature>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' , 'kubernetes.io/arch' , 'kubernetes.io/hostname' , 'kubernetes.io/os' , 'node.kubernetes.io/instance-type' , 'topology.kubernetes.io/region' , 'topology.kubernetes.io/zone' ) |
|
--node-status-max-images int32 Default: 50 | |
The maximum number of images to report in node.status.images . If -1 is specified, no cap will be applied. (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.) |
|
--node-status-update-frequency duration Default: 10s |
|
Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in Node controller. (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 Default: 10.0.0.0/8 |
|
Traffic to IPs outside this range will use IP masquerade. Set to '0.0.0.0/0' to never masquerade. (DEPRECATED: will be removed in a future version) |
|
--one-output | |
If true, only write logs to their native severity level (vs also writing to each lower severity level). | |
--oom-score-adj int32 Default: -999 | |
The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000]. (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. 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 Default: k8s.gcr.io/pause:3.5 |
|
Specified image will not be pruned by the image garbage collector. When container-runtime is set to docker , all containers in each pod will use the network/IPC namespaces from this image. Other CRI implementations have their own configuration to set this image. |
|
--pod-manifest-path string | |
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 Default: -1 | |
Set the maximum number of processes per pod. If -1 , the kubelet defaults to the node allocatable PID capacity. (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. (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 Default: 10250 | |
The port for the kubelet to serve on. (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. (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.) |
|
--provider-id string | |
Unique identifier for identifying the node in a machine database, i.e cloud provider. (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.) |
|
--qos-reserved mapStringString | |
<Warning: Alpha feature> A set of <resource name>=<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 Default: 10255 | |
The read-only port for the kubelet to serve on with no authentication/authorization (set to 0 to disable). (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.) |
|
--really-crash-for-testing | |
If true, when panics occur crash. Intended for testing. (DEPRECATED: will be removed in a future version.) | |
--register-node Default: true |
|
Register the node with the API server. If --kubeconfig is not provided, this flag is irrelevant, as the Kubelet won't have an API server to register with. |
|
--register-schedulable Default: true |
|
Register the node as schedulable. Won't have any effect if --register-node is false . (DEPRECATED: will be removed in a future version) |
|
--register-with-taints mapStringString | |
Register the node with the given list of taints (comma separated <key>=<value>:<effect> ). No-op if --register-node is false . |
|
--registry-burst int32 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 is greater than 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.) |
|
--registry-qps int32 Default: 5 | |
If > 0, limit registry pull QPS to this value. If 0 , unlimited. (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.) |
|
--reserved-cpus string | |
A comma-separated list of CPUs or CPU ranges that are reserved for system and kubernetes usage. This specific list will supersede cpu counts in --system-reserved and --kube-reserved . (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.) |
|
--reserved-memory string | |
A comma-separated list of memory reservations for NUMA nodes. (e.g. --reserved-memory 0:memory=1Gi,hugepages-1M=2Gi --reserved-memory 1:memory=2Gi ). The total sum for each memory type should be equal to the sum of --kube-reserved , --system-reserved and --eviction-threshold . See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#reserved-memory-flag for more details. (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 Default: /etc/resolv.conf |
|
Resolver configuration file used as the basis for the container DNS resolution configuration. (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.) |
|
--root-dir string Default: /var/lib/kubelet |
|
Directory path for managing kubelet files (volume mounts, etc). | |
--rotate-certificates | |
<Warning: Beta feature> 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. (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.) |
|
--runonce | |
If true , exit after spawning pods from local manifests or remote urls. Exclusive with --enable-server (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-cgroups string | |
Optional absolute name of cgroups to create and run the runtime in. | |
--runtime-request-timeout duration 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. (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.) |
|
--seccomp-default RuntimeDefault | |
<Warning: Alpha feature> Enable the use of RuntimeDefault as the default seccomp profile for all workloads. The SeccompDefault feature gate must be enabled to allow this flag, which is disabled by default. |
|
--seccomp-profile-root string Default: /var/lib/kubelet/seccomp |
|
<Warning: Alpha feature> Directory path for seccomp profiles. (DEPRECATED: will be removed in 1.23, in favor of using the directory)
|
|
--serialize-image-pulls 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. (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 |
|
--stderrthreshold int Default: 2 | |
logs at or above this threshold go to stderr. | |
--streaming-connection-idle-timeout duration Default: 4h0m0s |
|
Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: 5m . (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 Default: 1m0s |
|
Max period between synchronizing running containers and config. (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 string | |
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 Default: <none> | |
A set of <resource name>=<resource quantity> (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi,pid='100' ) 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. (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 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 . (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 . (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 strings | |
Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used. Preferred values: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, 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_CHACHA20_POLY1305_SHA256, TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, 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_CHACHA20_POLY1305_SHA256, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384. Insecure values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_RC4_128_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, 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 . (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 Default: 'none' |
|
Topology Manager policy to use. Possible values: 'none' , 'best-effort' , 'restricted' , 'single-numa-node' . (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-scope string Default: container |
|
Scope to which topology hints applied. Topology Manager collects hints from Hint Providers and applies them to defined scope to ensure the pod admission. Possible values: 'container' , 'pod' . (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 | |
Number for the log level verbosity | |
--version version[=true] | |
Print version information and quit | |
--vmodule <A list of 'pattern=N' string> | |
Comma-separated list of pattern=N settings for file-filtered logging |
|
--volume-plugin-dir string Default: /usr/libexec/kubernetes/kubelet-plugins/volume/exec/ |
|
The full path of the directory in which to search for additional third party volume plugins. (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.) |
|
--volume-stats-agg-period duration Default: 1m0s |
|
Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to 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.) |
3 - kube-apiserver
Synopsis
The Kubernetes API server validates and configures data for the api objects which include pods, services, replicationcontrollers, and others. The API Server services REST operations and provides the frontend to the cluster's shared state through which all other components interact.
kube-apiserver [flags]
Options
--add-dir-header | |
If true, adds the file directory to the header of the log messages |
|
--admission-control-config-file string | |
File with admission control configuration. |
|
--advertise-address string | |
The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used. |
|
--allow-metric-labels stringToString Default: [] | |
The map from metric-label to value allow-list of this label. The key's format is <MetricName>,<LabelName>. The value's format is <allowed_value>,<allowed_value>...e.g. metric1,label1='v1,v2,v3', metric1,label2='v1,v2,v3' metric2,label1='v1,v2,v3'. |
|
--allow-privileged | |
If true, allow privileged containers. [default=false] |
|
--alsologtostderr | |
log to standard error as well as files |
|
--anonymous-auth Default: true | |
Enables anonymous requests to the secure port of the API 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. |
|
--api-audiences strings | |
Identifiers of the API. The service account token authenticator will validate that tokens used against the API are bound to at least one of these audiences. If the --service-account-issuer flag is configured and this flag is not, this field defaults to a single element list containing the issuer URL. |
|
--apiserver-count int Default: 1 | |
The number of apiservers running in the cluster, must be a positive number. (In use when --endpoint-reconciler-type=master-count is enabled.) |
|
--audit-log-batch-buffer-size int Default: 10000 | |
The size of the buffer to store events before batching and writing. Only used in batch mode. |
|
--audit-log-batch-max-size int Default: 1 | |
The maximum size of a batch. Only used in batch mode. |
|
--audit-log-batch-max-wait duration | |
The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode. |
|
--audit-log-batch-throttle-burst int | |
Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode. |
|
--audit-log-batch-throttle-enable | |
Whether batching throttling is enabled. Only used in batch mode. |
|
--audit-log-batch-throttle-qps float | |
Maximum average number of batches per second. Only used in batch mode. |
|
--audit-log-compress | |
If set, the rotated log files will be compressed using gzip. |
|
--audit-log-format string Default: "json" | |
Format of saved audits. "legacy" indicates 1-line text format for each event. "json" indicates structured json format. Known formats are legacy,json. |
|
--audit-log-maxage int | |
The maximum number of days to retain old audit log files based on the timestamp encoded in their filename. |
|
--audit-log-maxbackup int | |
The maximum number of old audit log files to retain. |
|
--audit-log-maxsize int | |
The maximum size in megabytes of the audit log file before it gets rotated. |
|
--audit-log-mode string Default: "blocking" | |
Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking,blocking-strict. |
|
--audit-log-path string | |
If set, all requests coming to the apiserver will be logged to this file. '-' means standard out. |
|
--audit-log-truncate-enabled | |
Whether event and batch truncating is enabled. |
|
--audit-log-truncate-max-batch-size int Default: 10485760 | |
Maximum size of the batch sent to the underlying backend. Actual serialized size can be several hundreds of bytes greater. If a batch exceeds this limit, it is split into several batches of smaller size. |
|
--audit-log-truncate-max-event-size int Default: 102400 | |
Maximum size of the audit event sent to the underlying backend. If the size of an event is greater than this number, first request and response are removed, and if this doesn't reduce the size enough, event is discarded. |
|
--audit-log-version string Default: "audit.k8s.io/v1" | |
API group and version used for serializing audit events written to log. |
|
--audit-policy-file string | |
Path to the file that defines the audit policy configuration. |
|
--audit-webhook-batch-buffer-size int Default: 10000 | |
The size of the buffer to store events before batching and writing. Only used in batch mode. |
|
--audit-webhook-batch-max-size int Default: 400 | |
The maximum size of a batch. Only used in batch mode. |
|
--audit-webhook-batch-max-wait duration Default: 30s | |
The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode. |
|
--audit-webhook-batch-throttle-burst int Default: 15 | |
Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode. |
|
--audit-webhook-batch-throttle-enable Default: true | |
Whether batching throttling is enabled. Only used in batch mode. |
|
--audit-webhook-batch-throttle-qps float Default: 10 | |
Maximum average number of batches per second. Only used in batch mode. |
|
--audit-webhook-config-file string | |
Path to a kubeconfig formatted file that defines the audit webhook configuration. |
|
--audit-webhook-initial-backoff duration Default: 10s | |
The amount of time to wait before retrying the first failed request. |
|
--audit-webhook-mode string Default: "batch" | |
Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking,blocking-strict. |
|
--audit-webhook-truncate-enabled | |
Whether event and batch truncating is enabled. |
|
--audit-webhook-truncate-max-batch-size int Default: 10485760 | |
Maximum size of the batch sent to the underlying backend. Actual serialized size can be several hundreds of bytes greater. If a batch exceeds this limit, it is split into several batches of smaller size. |
|
--audit-webhook-truncate-max-event-size int Default: 102400 | |
Maximum size of the audit event sent to the underlying backend. If the size of an event is greater than this number, first request and response are removed, and if this doesn't reduce the size enough, event is discarded. |
|
--audit-webhook-version string Default: "audit.k8s.io/v1" | |
API group and version used for serializing audit events written to webhook. |
|
--authentication-token-webhook-cache-ttl duration Default: 2m0s | |
The duration to cache responses from the webhook token authenticator. |
|
--authentication-token-webhook-config-file string | |
File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens. |
|
--authentication-token-webhook-version string Default: "v1beta1" | |
The API version of the authentication.k8s.io TokenReview to send to and expect from the webhook. |
|
--authorization-mode strings Default: "AlwaysAllow" | |
Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC,Node. |
|
--authorization-policy-file string | |
File with authorization policy in json line by line format, used with --authorization-mode=ABAC, on the secure port. |
|
--authorization-webhook-cache-authorized-ttl duration Default: 5m0s | |
The duration to cache 'authorized' responses from the webhook authorizer. |
|
--authorization-webhook-cache-unauthorized-ttl duration Default: 30s | |
The duration to cache 'unauthorized' responses from the webhook authorizer. |
|
--authorization-webhook-config-file string | |
File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port. |
|
--authorization-webhook-version string Default: "v1beta1" | |
The API version of the authorization.k8s.io SubjectAccessReview to send to and expect from the webhook. |
|
--azure-container-registry-config string | |
Path to the file containing Azure container registry configuration information. |
|
--bind-address string Default: 0.0.0.0 | |
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank or an unspecified address (0.0.0.0 or ::), all interfaces will be used. |
|
--cert-dir string Default: "/var/run/kubernetes" | |
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. |
|
--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. |
|
--cloud-config string | |
The path to the cloud provider configuration file. Empty string for no configuration file. |
|
--cloud-provider string | |
The provider for cloud services. Empty string for no provider. |
|
--cloud-provider-gce-l7lb-src-cidrs cidrs Default: 130.211.0.0/22,35.191.0.0/16 | |
CIDRs opened in GCE firewall for L7 LB traffic proxy & health checks |
|
--contention-profiling | |
Enable lock contention profiling, if profiling is enabled |
|
--cors-allowed-origins strings | |
List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. |
|
--default-not-ready-toleration-seconds int Default: 300 | |
Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration. |
|
--default-unreachable-toleration-seconds int Default: 300 | |
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. |
|
--default-watch-cache-size int Default: 100 | |
Default watch cache size. If zero, watch cache will be disabled for resources that do not have a default watch size set. |
|
--delete-collection-workers int Default: 1 | |
Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. |
|
--disable-admission-plugins strings | |
admission plugins that should be disabled although they are in the default enabled plugins list (NamespaceLifecycle, LimitRanger, ServiceAccount, TaintNodesByCondition, PodSecurity, Priority, DefaultTolerationSeconds, DefaultStorageClass, StorageObjectInUseProtection, PersistentVolumeClaimResize, RuntimeClass, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, DefaultIngressClass, MutatingAdmissionWebhook, ValidatingAdmissionWebhook, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, DefaultIngressClass, DefaultStorageClass, DefaultTolerationSeconds, DenyServiceExternalIPs, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodSecurity, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, RuntimeClass, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter. |
|
--disabled-metrics strings | |
This flag provides an escape hatch for misbehaving metrics. You must provide the fully qualified metric name in order to disable it. Disclaimer: disabling metrics is higher in precedence than showing hidden metrics. |
|
--egress-selector-config-file string | |
File with apiserver egress selector configuration. |
|
--enable-admission-plugins strings | |
admission plugins that should be enabled in addition to default enabled ones (NamespaceLifecycle, LimitRanger, ServiceAccount, TaintNodesByCondition, PodSecurity, Priority, DefaultTolerationSeconds, DefaultStorageClass, StorageObjectInUseProtection, PersistentVolumeClaimResize, RuntimeClass, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, DefaultIngressClass, MutatingAdmissionWebhook, ValidatingAdmissionWebhook, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, DefaultIngressClass, DefaultStorageClass, DefaultTolerationSeconds, DenyServiceExternalIPs, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodSecurity, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, RuntimeClass, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter. |
|
--enable-aggregator-routing | |
Turns on aggregator routing requests to endpoints IP rather than cluster IP. |
|
--enable-bootstrap-token-auth | |
Enable to allow secrets of type 'bootstrap.kubernetes.io/token' in the 'kube-system' namespace to be used for TLS bootstrapping authentication. |
|
--enable-garbage-collector Default: true | |
Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. |
|
--enable-priority-and-fairness Default: true | |
If true and the APIPriorityAndFairness feature gate is enabled, replace the max-in-flight handler with an enhanced one that queues and dispatches with priority and fairness |
|
--encryption-provider-config string | |
The file containing configuration for encryption providers to be used for storing secrets in etcd |
|
--endpoint-reconciler-type string Default: "lease" | |
Use an endpoint reconciler (master-count, lease, none) |
|
--etcd-cafile string | |
SSL Certificate Authority file used to secure etcd communication. |
|
--etcd-certfile string | |
SSL certification file used to secure etcd communication. |
|
--etcd-compaction-interval duration Default: 5m0s | |
The interval of compaction requests. If 0, the compaction request from apiserver is disabled. |
|
--etcd-count-metric-poll-period duration Default: 1m0s | |
Frequency of polling etcd for number of resources per type. 0 disables the metric collection. |
|
--etcd-db-metric-poll-interval duration Default: 30s | |
The interval of requests to poll etcd and update metric. 0 disables the metric collection |
|
--etcd-healthcheck-timeout duration Default: 2s | |
The timeout to use when checking etcd health. |
|
--etcd-keyfile string | |
SSL key file used to secure etcd communication. |
|
--etcd-prefix string Default: "/registry" | |
The prefix to prepend to all resource paths in etcd. |
|
--etcd-servers strings | |
List of etcd servers to connect with (scheme://ip:port), comma separated. |
|
--etcd-servers-overrides strings | |
Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are URLs, semicolon separated. Note that this applies only to resources compiled into this server binary. |
|
--event-ttl duration Default: 1h0m0s | |
Amount of time to retain events. |
|
--experimental-logging-sanitization | |
[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). |
|
--external-hostname string | |
The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs or OpenID Discovery). |
|
--feature-gates <comma-separated 'key=True|False' pairs> | |
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: |
|
--goaway-chance float | |
To prevent HTTP/2 clients from getting stuck on a single apiserver, randomly close a connection (GOAWAY). The client's other in-flight requests won't be affected, and the client will reconnect, likely landing on a different apiserver after going through the load balancer again. This argument sets the fraction of requests that will be sent a GOAWAY. Clusters with single apiservers, or which don't use a load balancer, should NOT enable this. Min is 0 (off), Max is .02 (1/50 requests); .001 (1/1000) is a recommended starting point. |
|
-h, --help | |
help for kube-apiserver |
|
--http2-max-streams-per-connection int | |
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default. |
|
--identity-lease-duration-seconds int Default: 3600 | |
The duration of kube-apiserver lease in seconds, must be a positive number. (In use when the APIServerIdentity feature gate is enabled.) |
|
--identity-lease-renew-interval-seconds int Default: 10 | |
The interval of kube-apiserver renewing its lease in seconds, must be a positive number. (In use when the APIServerIdentity feature gate is enabled.) |
|
--kubelet-certificate-authority string | |
Path to a cert file for the certificate authority. |
|
--kubelet-client-certificate string | |
Path to a client cert file for TLS. |
|
--kubelet-client-key string | |
Path to a client key file for TLS. |
|
--kubelet-preferred-address-types strings Default: "Hostname,InternalDNS,InternalIP,ExternalDNS,ExternalIP" | |
List of the preferred NodeAddressTypes to use for kubelet connections. |
|
--kubelet-timeout duration Default: 5s | |
Timeout for kubelet operations. |
|
--kubernetes-service-node-port int | |
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. |
|
--lease-reuse-duration-seconds int Default: 60 | |
The time in seconds that each lease is reused. A lower value could avoid large number of objects reusing the same lease. Notice that a too small value may cause performance problems at storage layer. |
|
--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 <a string in the form 'file:N'> Default: :0 | |
when logging hits line file:N, emit a stack trace |
|
--log-dir string | |
If non-empty, write log files in this directory |
|
--log-file string | |
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 | |
Maximum number of seconds between log flushes |
|
--logging-format string Default: "text" | |
Sets the log format. Permitted formats: "text". |
|
--logtostderr Default: true | |
log to standard error instead of files |
|
--master-service-namespace string Default: "default" | |
DEPRECATED: the namespace from which the Kubernetes master services should be injected into pods. |
|
--max-connection-bytes-per-sec int | |
If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests. |
|
--max-mutating-requests-inflight int Default: 200 | |
This and --max-requests-inflight are summed to determine the server's total concurrency limit (which must be positive) if --enable-priority-and-fairness is true. Otherwise, this flag limits the maximum number of mutating requests in flight, or a zero value disables the limit completely. |
|
--max-requests-inflight int Default: 400 | |
This and --max-mutating-requests-inflight are summed to determine the server's total concurrency limit (which must be positive) if --enable-priority-and-fairness is true. Otherwise, this flag limits the maximum number of non-mutating requests in flight, or a zero value disables the limit completely. |
|
--min-request-timeout int Default: 1800 | |
An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load. |
|
--oidc-ca-file string | |
If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used. |
|
--oidc-client-id string | |
The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set. |
|
--oidc-groups-claim string | |
If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details. |
|
--oidc-groups-prefix string | |
If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies. |
|
--oidc-issuer-url string | |
The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT). |
|
--oidc-required-claim <comma-separated 'key=value' pairs> | |
A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims. |
|
--oidc-signing-algs strings Default: "RS256" | |
Comma-separated list of allowed JOSE asymmetric signing algorithms. JWTs with a 'alg' header value not in this list will be rejected. Values are defined by RFC 7518 https://tools.ietf.org/html/rfc7518#section-3.1. |
|
--oidc-username-claim string Default: "sub" | |
The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details. |
|
--oidc-username-prefix string | |
If provided, all usernames will be prefixed with this value. If not provided, username claims other than 'email' are prefixed by the issuer URL to avoid clashes. To skip any prefixing, provide the value '-'. |
|
--one-output | |
If true, only write logs to their native severity level (vs also writing to each lower severity level) |
|
--permit-address-sharing | |
If true, SO_REUSEADDR will be used when binding the port. This allows binding to wildcard IPs like 0.0.0.0 and specific IPs in parallel, and it avoids waiting for the kernel to release sockets in TIME_WAIT state. [default=false] |
|
--permit-port-sharing | |
If true, SO_REUSEPORT will be used when binding the port, which allows more than one instance to bind on the same address and port. [default=false] |
|
--profiling Default: true | |
Enable profiling via web interface host:port/debug/pprof/ |
|
--proxy-client-cert-file string | |
Client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins. It is expected that this cert includes a signature from the CA in the --requestheader-client-ca-file flag. That CA is published in the 'extension-apiserver-authentication' configmap in the kube-system namespace. Components receiving calls from kube-aggregator should use that CA to perform their half of the mutual TLS verification. |
|
--proxy-client-key-file string | |
Private key for the client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins. |
|
--request-timeout duration Default: 1m0s | |
An optional field indicating the duration a handler must keep a request open before timing it out. This is the default request timeout for requests but may be overridden by flags such as --min-request-timeout for specific types of requests. |
|
--requestheader-allowed-names strings | |
List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed. |
|
--requestheader-client-ca-file string | |
Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers. WARNING: generally do not depend on authorization being already done for incoming requests. |
|
--requestheader-extra-headers-prefix strings | |
List of request header prefixes to inspect. X-Remote-Extra- is suggested. |
|
--requestheader-group-headers strings | |
List of request headers to inspect for groups. X-Remote-Group is suggested. |
|
--requestheader-username-headers strings | |
List of request headers to inspect for usernames. X-Remote-User is common. |
|
--runtime-config <comma-separated 'key=value' pairs> | |
A set of key=value pairs that enable or disable built-in APIs. Supported options are: |
|
--secure-port int Default: 6443 | |
The port on which to serve HTTPS with authentication and authorization. It cannot be switched off with 0. |
|
--service-account-extend-token-expiration Default: true | |
Turns on projected service account expiration extension during token generation, which helps safe transition from legacy token to bound service account token feature. If this flag is enabled, admission injected tokens would be extended up to 1 year to prevent unexpected failure during transition, ignoring value of service-account-max-token-expiration. |
|
--service-account-issuer strings | |
Identifier of the service account token issuer. The issuer will assert this identifier in "iss" claim of issued tokens. This value is a string or URI. If this option is not a valid URI per the OpenID Discovery 1.0 spec, the ServiceAccountIssuerDiscovery feature will remain disabled, even if the feature gate is set to true. It is highly recommended that this value comply with the OpenID spec: https://openid.net/specs/openid-connect-discovery-1_0.html. In practice, this means that service-account-issuer must be an https URL. It is also highly recommended that this URL be capable of serving OpenID discovery documents at {service-account-issuer}/.well-known/openid-configuration. When this flag is specified multiple times, the first is used to generate tokens and all are used to determine which issuers are accepted. |
|
--service-account-jwks-uri string | |
Overrides the URI for the JSON Web Key Set in the discovery doc served at /.well-known/openid-configuration. This flag is useful if the discovery docand key set are served to relying parties from a URL other than the API server's external (as auto-detected or overridden with external-hostname). Only valid if the ServiceAccountIssuerDiscovery feature gate is enabled. |
|
--service-account-key-file strings | |
File containing PEM-encoded x509 RSA or ECDSA private or public keys, used to verify ServiceAccount tokens. The specified file can contain multiple keys, and the flag can be specified multiple times with different files. If unspecified, --tls-private-key-file is used. Must be specified when --service-account-signing-key is provided |
|
--service-account-lookup Default: true | |
If true, validate ServiceAccount tokens exist in etcd as part of authentication. |
|
--service-account-max-token-expiration duration | |
The maximum validity duration of a token created by the service account token issuer. If an otherwise valid TokenRequest with a validity duration larger than this value is requested, a token will be issued with a validity duration of this value. |
|
--service-account-signing-key-file string | |
Path to the file that contains the current private key of the service account token issuer. The issuer will sign issued ID tokens with this private key. |
|
--service-cluster-ip-range string | |
A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes or pods. Max of two dual-stack CIDRs is allowed. |
|
--service-node-port-range <a string in the form 'N1-N2'> Default: 30000-32767 | |
A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. |
|
--show-hidden-metrics-for-version string | |
The previous version for which you want to show hidden metrics. Only the previous minor version is meaningful, other values will not be allowed. The format is <major>.<minor>, e.g.: '1.16'. The purpose of this format is make sure you have the opportunity to notice if the next release hides additional metrics, rather than being surprised when they are permanently removed in the release after that. |
|
--shutdown-delay-duration duration | |
Time to delay the termination. During that time the server keeps serving requests normally. The endpoints /healthz and /livez will return success, but /readyz 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 int Default: 2 | |
logs at or above this threshold go to stderr |
|
--storage-backend string | |
The storage backend for persistence. Options: 'etcd3' (default). |
|
--storage-media-type string Default: "application/vnd.kubernetes.protobuf" | |
The media type to use to store objects in storage. Some resources or storage backends may only support a specific media type and will ignore this setting. |
|
--strict-transport-security-directives strings | |
List of directives for HSTS, comma separated. If this list is empty, then HSTS directives will not be added. Example: 'max-age=31536000,includeSubDomains,preload' |
|
--tls-cert-file string | |
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --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 specified by --cert-dir. |
|
--tls-cipher-suites strings | |
Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used. |
|
--tls-min-version string | |
Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 |
|
--tls-private-key-file string | |
File containing the default x509 private key matching --tls-cert-file. |
|
--tls-sni-cert-key string | |
A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. The domain patterns also allow IP addresses, but IPs should only be used if the apiserver has visibility to the IP address requested by a client. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com". |
|
--token-auth-file string | |
If set, the file that will be used to secure the secure port of the API server via token authentication. |
|
--tracing-config-file string | |
File with apiserver tracing configuration. |
|
-v, --v int | |
number for the log level verbosity |
|
--version version[=true] | |
Print version information and quit |
|
--vmodule <comma-separated 'pattern=N' settings> | |
comma-separated list of pattern=N settings for file-filtered logging |
|
--watch-cache Default: true | |
Enable watch caching in the apiserver |
|
--watch-cache-sizes strings | |
Watch cache size settings for some resources (pods, nodes, etc.), comma separated. The individual setting format: resource[.group]#size, where resource is lowercase plural (no version), group is omitted for resources of apiVersion v1 (the legacy core API) and included for others, and size is a number. It takes effect when watch-cache is enabled. Some resources (replicationcontrollers, endpoints, nodes, pods, services, apiservices.apiregistration.k8s.io) have system defaults set by heuristics, others default to default-watch-cache-size |
4 - kube-controller-manager
Synopsis
The Kubernetes controller manager is a daemon that embeds the core control loops shipped with Kubernetes. In applications of robotics and automation, a control loop is a non-terminating loop that regulates the state of the system. In Kubernetes, a controller is a control loop that watches the shared state of the cluster through the apiserver and makes changes attempting to move the current state towards the desired state. Examples of controllers that ship with Kubernetes today are the replication controller, endpoints controller, namespace controller, and serviceaccounts controller.
kube-controller-manager [flags]
Options
--add-dir-header | |
If true, adds the file directory to the header of the log messages |
|
--allocate-node-cidrs | |
Should CIDRs for Pods be allocated and set on the cloud provider. |
|
--allow-metric-labels stringToString Default: [] | |
The map from metric-label to value allow-list of this label. The key's format is <MetricName>,<LabelName>. The value's format is <allowed_value>,<allowed_value>...e.g. metric1,label1='v1,v2,v3', metric1,label2='v1,v2,v3' metric2,label1='v1,v2,v3'. |
|
--alsologtostderr | |
log to standard error as well as files |
|
--attach-detach-reconcile-sync-period duration Default: 1m0s | |
The reconciler sync wait time between volume attach detach. This duration must be larger than one second, and increasing this value from the default may allow for volumes to be mismatched with pods. |
|
--authentication-kubeconfig string | |
kubeconfig file pointing at the 'core' kubernetes server with enough rights to create tokenreviews.authentication.k8s.io. This is optional. If empty, all token requests are considered to be anonymous and no client CA is looked up in the cluster. |
|
--authentication-skip-lookup | |
If false, the authentication-kubeconfig will be used to lookup missing authentication configuration from the cluster. |
|
--authentication-token-webhook-cache-ttl duration Default: 10s | |
The duration to cache responses from the webhook token authenticator. |
|
--authentication-tolerate-lookup-failure | |
If true, failures to look up missing authentication configuration from the cluster are not considered fatal. Note that this can result in authentication that treats all requests as anonymous. |
|
--authorization-always-allow-paths strings Default: "/healthz,/readyz,/livez" | |
A list of HTTP paths to skip during authorization, i.e. these are authorized without contacting the 'core' kubernetes server. |
|
--authorization-kubeconfig string | |
kubeconfig file pointing at the 'core' kubernetes server with enough rights to create subjectaccessreviews.authorization.k8s.io. This is optional. If empty, all requests not skipped by authorization are forbidden. |
|
--authorization-webhook-cache-authorized-ttl duration Default: 10s | |
The duration to cache 'authorized' responses from the webhook authorizer. |
|
--authorization-webhook-cache-unauthorized-ttl duration Default: 10s | |
The duration to cache 'unauthorized' responses from the webhook authorizer. |
|
--azure-container-registry-config string | |
Path to the file containing Azure container registry configuration information. |
|
--bind-address string Default: 0.0.0.0 | |
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank or an unspecified address (0.0.0.0 or ::), all interfaces will be used. |
|
--cert-dir string | |
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. |
|
--cidr-allocator-type string Default: "RangeAllocator" | |
Type of CIDR allocator to use |
|
--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. |
|
--cloud-config string | |
The path to the cloud provider configuration file. Empty string for no configuration file. |
|
--cloud-provider string | |
The provider for cloud services. Empty string for no provider. |
|
--cluster-cidr string | |
CIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be true |
|
--cluster-name string Default: "kubernetes" | |
The instance prefix for the cluster. |
|
--cluster-signing-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue cluster-scoped certificates. If specified, no more specific --cluster-signing-* flag may be specified. |
|
--cluster-signing-duration duration Default: 8760h0m0s | |
The max length of duration signed certificates will be given. Individual CSRs may request shorter certs by setting spec.expirationSeconds. |
|
--cluster-signing-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign cluster-scoped certificates. If specified, no more specific --cluster-signing-* flag may be specified. |
|
--cluster-signing-kube-apiserver-client-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue certificates for the kubernetes.io/kube-apiserver-client signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
--cluster-signing-kube-apiserver-client-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign certificates for the kubernetes.io/kube-apiserver-client signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
--cluster-signing-kubelet-client-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue certificates for the kubernetes.io/kube-apiserver-client-kubelet signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
--cluster-signing-kubelet-client-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign certificates for the kubernetes.io/kube-apiserver-client-kubelet signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
--cluster-signing-kubelet-serving-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue certificates for the kubernetes.io/kubelet-serving signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
--cluster-signing-kubelet-serving-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign certificates for the kubernetes.io/kubelet-serving signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
--cluster-signing-legacy-unknown-cert-file string | |
Filename containing a PEM-encoded X509 CA certificate used to issue certificates for the kubernetes.io/legacy-unknown signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
--cluster-signing-legacy-unknown-key-file string | |
Filename containing a PEM-encoded RSA or ECDSA private key used to sign certificates for the kubernetes.io/legacy-unknown signer. If specified, --cluster-signing-{cert,key}-file must not be set. |
|
--concurrent-deployment-syncs int32 Default: 5 | |
The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load |
|
--concurrent-endpoint-syncs int32 Default: 5 | |
The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load |
|
--concurrent-gc-syncs int32 Default: 20 | |
The number of garbage collector workers that are allowed to sync concurrently. |
|
--concurrent-namespace-syncs int32 Default: 10 | |
The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load |
|
--concurrent-rc-syncs int32 Default: 5 | |
The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load |
|
--concurrent-replicaset-syncs int32 Default: 5 | |
The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load |
|
--concurrent-resource-quota-syncs int32 Default: 5 | |
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 services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load |
|
--concurrent-serviceaccount-token-syncs int32 Default: 5 | |
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 | |
The number of TTL-after-finished controller workers that are allowed to sync concurrently. |
|
--configure-cloud-routes Default: true | |
Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider. |
|
--contention-profiling | |
Enable lock contention profiling, if profiling is enabled |
|
--controller-start-interval duration | |
Interval between starting controller managers. |
|
--controllers strings 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'. |
|
--deployment-controller-sync-period duration Default: 30s | |
Period for syncing the deployments. |
|
--disable-attach-detach-reconcile-sync | |
Disable volume attach detach reconciler sync. Disabling this may cause volumes to be mismatched with pods. Use wisely. |
|
--disabled-metrics strings | |
This flag provides an escape hatch for misbehaving metrics. You must provide the fully qualified metric name in order to disable it. Disclaimer: disabling metrics is higher in precedence than showing hidden metrics. |
|
--enable-dynamic-provisioning Default: true | |
Enable dynamic provisioning for environments that support it. |
|
--enable-garbage-collector Default: true | |
Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver. |
|
--enable-hostpath-provisioner | |
Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development. |
|
--enable-leader-migration | |
Whether to enable controller leader migration. |
|
--enable-taint-manager Default: true | |
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 |
|
--endpointslice-updates-batch-period duration | |
The length of endpoint slice 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-logging-sanitization | |
[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). |
|
--external-cloud-volume-plugin string | |
The plugin to use when cloud provider is set to external. Can be empty, should only be set when cloud-provider is external. Currently used to allow node and volume controllers to work for in tree cloud providers. |
|
--feature-gates <comma-separated 'key=True|False' pairs> | |
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: |
|
--flex-volume-plugin-dir string Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/" | |
Full path of the directory in which the flex volume plugin should search for additional third party volume plugins. |
|
-h, --help | |
help for kube-controller-manager |
|
--horizontal-pod-autoscaler-cpu-initialization-period duration Default: 5m0s | |
The period after pod start when CPU samples might be skipped. |
|
--horizontal-pod-autoscaler-downscale-stabilization duration Default: 5m0s | |
The period for which autoscaler will look backwards and not scale down below any recommendation it made during that period. |
|
--horizontal-pod-autoscaler-initial-readiness-delay duration Default: 30s | |
The period after pod start during which readiness changes will be treated as initial readiness. |
|
--horizontal-pod-autoscaler-sync-period duration Default: 15s | |
The period for syncing the number of pods in horizontal pod autoscaler. |
|
--horizontal-pod-autoscaler-tolerance float Default: 0.1 | |
The minimum change (from 1.0) in the desired-to-actual metrics ratio for the horizontal pod autoscaler to consider scaling. |
|
--http2-max-streams-per-connection int | |
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default. |
|
--kube-api-burst int32 Default: 30 | |
Burst to use while talking with kubernetes apiserver. |
|
--kube-api-content-type string Default: "application/vnd.kubernetes.protobuf" | |
Content type of requests sent to apiserver. |
|
--kube-api-qps float Default: 20 | |
QPS to use while talking with kubernetes apiserver. |
|
--kubeconfig string | |
Path to kubeconfig file with authorization and master location information. |
|
--large-cluster-size-threshold int32 Default: 50 | |
Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller. |
|
--leader-elect Default: true | |
Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. |
|
--leader-elect-lease-duration duration Default: 15s | |
The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. |
|
--leader-elect-renew-deadline duration Default: 10s | |
The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. |
|
--leader-elect-resource-lock string Default: "leases" | |
The type of resource object that is used for locking during leader election. Supported options are 'endpoints', 'configmaps', 'leases', 'endpointsleases' and 'configmapsleases'. |
|
--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 | |
The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. |
|
--leader-migration-config string | |
Path to the config file for controller leader migration, or empty to use the value that reflects default configuration of the controller manager. The config file should be of type LeaderMigrationConfiguration, group controllermanager.config.k8s.io, version v1alpha1. |
|
--log-backtrace-at <a string in the form 'file:N'> Default: :0 | |
when logging hits line file:N, emit a stack trace |
|
--log-dir string | |
If non-empty, write log files in this directory |
|
--log-file string | |
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 | |
Maximum number of seconds between log flushes |
|
--logging-format string Default: "text" | |
Sets the log format. Permitted formats: "text". |
|
--logtostderr Default: true | |
log to standard error instead of files |
|
--master string | |
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 | |
The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod. |
|
--mirroring-concurrent-service-endpoint-syncs int32 Default: 5 | |
The number of service endpoint syncing operations that will be done concurrently by the EndpointSliceMirroring controller. Larger number = faster endpoint slice updating, but more CPU (and network) load. Defaults to 5. |
|
--mirroring-endpointslice-updates-batch-period duration | |
The length of EndpointSlice updates batching period for EndpointSliceMirroring controller. Processing of EndpointSlice changes will be delayed by this duration to join them with potential upcoming updates and reduce the overall number of EndpointSlice updates. Larger number = higher endpoint programming latency, but lower number of endpoints revision generated |
|
--mirroring-max-endpoints-per-subset int32 Default: 1000 | |
The maximum number of endpoints that will be added to an EndpointSlice by the EndpointSliceMirroring controller. More endpoints per slice will result in less endpoint slices, but larger resources. Defaults to 100. |
|
--namespace-sync-period duration Default: 5m0s | |
The period for syncing namespace life-cycle updates |
|
--node-cidr-mask-size int32 | |
Mask size for node cidr in cluster. Default is 24 for IPv4 and 64 for IPv6. |
|
--node-cidr-mask-size-ipv4 int32 | |
Mask size for IPv4 node cidr in dual-stack cluster. Default is 24. |
|
--node-cidr-mask-size-ipv6 int32 | |
Mask size for IPv6 node cidr in dual-stack cluster. Default is 64. |
|
--node-eviction-rate float Default: 0.1 | |
Number of nodes per second on which pods are deleted in case of node failure when a zone is healthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. |
|
--node-monitor-grace-period duration Default: 40s | |
Amount of time which we allow running Node to be unresponsive before marking it unhealthy. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status. |
|
--node-monitor-period duration Default: 5s | |
The period for syncing NodeStatus in NodeController. |
|
--node-startup-grace-period duration Default: 1m0s | |
Amount of time which we allow starting Node to be unresponsive before marking it unhealthy. |
|
--one-output | |
If true, only write logs to their native severity level (vs also writing to each lower severity level) |
|
--permit-address-sharing | |
If true, SO_REUSEADDR will be used when binding the port. This allows binding to wildcard IPs like 0.0.0.0 and specific IPs in parallel, and it avoids waiting for the kernel to release sockets in TIME_WAIT state. [default=false] |
|
--permit-port-sharing | |
If true, SO_REUSEPORT will be used when binding the port, which allows more than one instance to bind on the same address and port. [default=false] |
|
--pod-eviction-timeout duration Default: 5m0s | |
The grace period for deleting pods on failed nodes. |
|
--profiling Default: true | |
Enable profiling via web interface host:port/debug/pprof/ |
|
--pv-recycler-increment-timeout-nfs int32 Default: 30 | |
the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod |
|
--pv-recycler-minimum-timeout-hostpath int32 Default: 60 | |
The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster. |
|
--pv-recycler-minimum-timeout-nfs int32 Default: 300 | |
The minimum ActiveDeadlineSeconds to use for an NFS Recycler pod |
|
--pv-recycler-pod-template-filepath-hostpath string | |
The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster. |
|
--pv-recycler-pod-template-filepath-nfs string | |
The file path to a pod definition used as a template for NFS persistent volume recycling |
|
--pv-recycler-timeout-increment-hostpath int32 Default: 30 | |
the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster. |
|
--pvclaimbinder-sync-period duration Default: 15s | |
The period for syncing persistent volumes and persistent volume claims |
|
--requestheader-allowed-names strings | |
List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed. |
|
--requestheader-client-ca-file string | |
Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers. WARNING: generally do not depend on authorization being already done for incoming requests. |
|
--requestheader-extra-headers-prefix strings Default: "x-remote-extra-" | |
List of request header prefixes to inspect. X-Remote-Extra- is suggested. |
|
--requestheader-group-headers strings Default: "x-remote-group" | |
List of request headers to inspect for groups. X-Remote-Group is suggested. |
|
--requestheader-username-headers strings Default: "x-remote-user" | |
List of request headers to inspect for usernames. X-Remote-User is common. |
|
--resource-quota-sync-period duration Default: 5m0s | |
The period for syncing quota usage status in the system |
|
--root-ca-file string | |
If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle. |
|
--route-reconciliation-period duration Default: 10s | |
The period for reconciling routes created for Nodes by cloud provider. |
|
--secondary-node-eviction-rate float Default: 0.01 | |
Number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. This value is implicitly overridden to 0 if the cluster size is smaller than --large-cluster-size-threshold. |
|
--secure-port int Default: 10257 | |
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. |
|
--service-account-private-key-file string | |
Filename containing a PEM-encoded private RSA or ECDSA key used to sign service account tokens. |
|
--service-cluster-ip-range string | |
CIDR Range for Services in cluster. Requires --allocate-node-cidrs to be true |
|
--show-hidden-metrics-for-version string | |
The previous version for which you want to show hidden metrics. Only the previous minor version is meaningful, other values will not be allowed. The format is <major>.<minor>, e.g.: '1.16'. The purpose of this format is make sure you have the opportunity to notice if the next release hides additional metrics, rather than being surprised when they are permanently removed in the release after that. |
|
--skip-headers | |
If true, avoid header prefixes in the log messages |
|
--skip-log-headers | |
If true, avoid headers when opening log files |
|
--stderrthreshold int Default: 2 | |
logs at or above this threshold go to stderr |
|
--terminated-pod-gc-threshold int32 Default: 12500 | |
Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled. |
|
--tls-cert-file string | |
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --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 specified by --cert-dir. |
|
--tls-cipher-suites strings | |
Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used. |
|
--tls-min-version string | |
Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 |
|
--tls-private-key-file string | |
File containing the default x509 private key matching --tls-cert-file. |
|
--tls-sni-cert-key string | |
A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. The domain patterns also allow IP addresses, but IPs should only be used if the apiserver has visibility to the IP address requested by a client. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com". |
|
--unhealthy-zone-threshold float Default: 0.55 | |
Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy. |
|
--use-service-account-credentials | |
If true, use individual service account credentials for each controller. |
|
-v, --v int | |
number for the log level verbosity |
|
--version version[=true] | |
Print version information and quit |
|
--vmodule <comma-separated 'pattern=N' settings> | |
comma-separated list of pattern=N settings for file-filtered logging |
|
--volume-host-allow-local-loopback Default: true | |
If false, deny local loopback IPs in addition to any CIDR ranges in --volume-host-cidr-denylist |
|
--volume-host-cidr-denylist strings | |
A comma-separated list of CIDR ranges to avoid from volume plugins. |
5 - kube-proxy
Synopsis
The Kubernetes network proxy runs on each node. This reflects services as defined in the Kubernetes API on each node and can do simple TCP, UDP, and SCTP stream forwarding or round robin TCP, UDP, and SCTP forwarding across a set of backends. Service cluster IPs and ports are currently found through Docker-links-compatible environment variables specifying ports opened by the service proxy. There is an optional addon that provides cluster DNS for these cluster IPs. The user must create a service with the apiserver API to configure the proxy.
kube-proxy [flags]
Options
--add-dir-header | |
If true, adds the file directory to the header of the log messages |
|
--alsologtostderr | |
log to standard error as well as files |
|
--azure-container-registry-config string | |
Path to the file containing Azure container registry configuration information. |
|
--bind-address string Default: 0.0.0.0 | |
The IP address for the proxy server to serve on (set to '0.0.0.0' for all IPv4 interfaces and '::' for all IPv6 interfaces) |
|
--bind-address-hard-fail | |
If true kube-proxy will treat failure to bind to a port as fatal and exit |
|
--boot-id-file string Default: "/proc/sys/kernel/random/boot_id" | |
Comma-separated list of files to check for boot-id. Use the first one that exists. |
|
--cleanup | |
If true cleanup iptables and ipvs rules and exit. |
|
--cloud-provider-gce-l7lb-src-cidrs cidrs Default: 130.211.0.0/22,35.191.0.0/16 | |
CIDRs opened in GCE firewall for L7 LB traffic proxy & health checks |
|
--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 L4 LB traffic proxy & health checks |
|
--cluster-cidr string | |
The CIDR range of pods in the cluster. When configured, traffic sent to a Service cluster IP from outside this range will be masqueraded and traffic sent from pods to an external LoadBalancer IP will be directed to the respective cluster IP instead |
|
--config string | |
The path to the configuration file. |
|
--config-sync-period duration Default: 15m0s | |
How often configuration from the apiserver is refreshed. Must be greater than 0. |
|
--conntrack-max-per-core int32 Default: 32768 | |
Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min). |
|
--conntrack-min int32 Default: 131072 | |
Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is). |
|
--conntrack-tcp-timeout-close-wait duration Default: 1h0m0s | |
NAT timeout for TCP connections in the CLOSE_WAIT state |
|
--conntrack-tcp-timeout-established duration Default: 24h0m0s | |
Idle timeout for established TCP connections (0 to leave as-is) |
|
--default-not-ready-toleration-seconds int Default: 300 | |
Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration. |
|
--default-unreachable-toleration-seconds int Default: 300 | |
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. |
|
--detect-local-mode LocalMode | |
Mode to use to detect local traffic |
|
--feature-gates <comma-separated 'key=True|False' pairs> | |
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: |
|
--healthz-bind-address ipport Default: 0.0.0.0:10256 | |
The IP address with port for the health check server to serve on (set to '0.0.0.0:10256' for all IPv4 interfaces and '[::]:10256' for all IPv6 interfaces). Set empty to disable. |
|
-h, --help | |
help for kube-proxy |
|
--hostname-override string | |
If non-empty, will use this string as identification instead of the actual hostname. |
|
--iptables-masquerade-bit int32 Default: 14 | |
If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31]. |
|
--iptables-min-sync-period duration Default: 1s | |
The minimum interval of how often the iptables rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m'). |
|
--iptables-sync-period duration Default: 30s | |
The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0. |
|
--ipvs-exclude-cidrs strings | |
A comma-separated list of CIDR's which the ipvs proxier should not touch when cleaning up IPVS rules. |
|
--ipvs-min-sync-period duration | |
The minimum interval of how often the ipvs rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m'). |
|
--ipvs-scheduler string | |
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 | |
The maximum interval of how often ipvs rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0. |
|
--ipvs-tcp-timeout duration | |
The timeout for idle IPVS TCP connections, 0 to leave as-is. (e.g. '5s', '1m', '2h22m'). |
|
--ipvs-tcpfin-timeout duration | |
The timeout for IPVS TCP connections after receiving a FIN packet, 0 to leave as-is. (e.g. '5s', '1m', '2h22m'). |
|
--ipvs-udp-timeout duration | |
The timeout for IPVS UDP packets, 0 to leave as-is. (e.g. '5s', '1m', '2h22m'). |
|
--kube-api-burst int32 Default: 10 | |
Burst to use while talking with kubernetes apiserver |
|
--kube-api-content-type string Default: "application/vnd.kubernetes.protobuf" | |
Content type of requests sent to apiserver. |
|
--kube-api-qps float Default: 5 | |
QPS to use while talking with kubernetes apiserver |
|
--kubeconfig string | |
Path to kubeconfig file with authorization information (the master location can be overridden by the master flag). |
|
--log-backtrace-at <a string in the form 'file:N'> Default: :0 | |
when logging hits line file:N, emit a stack trace |
|
--log-dir string | |
If non-empty, write log files in this directory |
|
--log-file string | |
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 | |
Maximum number of seconds between log flushes |
|
--logtostderr Default: true | |
log to standard error instead of files |
|
--machine-id-file string 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. |
|
--masquerade-all | |
If using the pure iptables proxy, SNAT all traffic sent via Service cluster IPs (this not commonly needed) |
|
--master string | |
The address of the Kubernetes API server (overrides any value in kubeconfig) |
|
--metrics-bind-address ipport Default: 127.0.0.1:10249 | |
The IP address with port for the metrics server to serve on (set to '0.0.0.0:10249' for all IPv4 interfaces and '[::]:10249' for all IPv6 interfaces). Set empty to disable. |
|
--nodeport-addresses strings | |
A string slice of values which specify the addresses to use for NodePorts. Values may be valid IP blocks (e.g. 1.2.3.0/24, 1.2.3.4/32). The default empty string slice ([]) means to use all local addresses. |
|
--one-output | |
If true, only write logs to their native severity level (vs also writing to each lower severity level) |
|
--oom-score-adj int32 Default: -999 | |
The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000] |
|
--profiling | |
If true enables profiling via web interface on /debug/pprof handler. |
|
--proxy-mode ProxyMode | |
Which proxy mode to use: 'userspace' (older) or 'iptables' (faster) or 'ipvs' or 'kernelspace' (windows). 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. |
|
--proxy-port-range port-range | |
Range of host ports (beginPort-endPort, single port or beginPort+offset, inclusive) that may be consumed in order to proxy service traffic. If (unspecified, 0, or 0-0) then ports will be randomly chosen. |
|
--show-hidden-metrics-for-version string | |
The previous version for which you want to show hidden metrics. Only the previous minor version is meaningful, other values will not be allowed. The format is <major>.<minor>, e.g.: '1.16'. The purpose of this format is make sure you have the opportunity to notice if the next release hides additional metrics, rather than being surprised when they are permanently removed in the release after that. |
|
--skip-headers | |
If true, avoid header prefixes in the log messages |
|
--skip-log-headers | |
If true, avoid headers when opening log files |
|
--stderrthreshold int Default: 2 | |
logs at or above this threshold go to stderr |
|
--udp-timeout duration Default: 250ms | |
How long an idle UDP connection will be kept open (e.g. '250ms', '2s'). Must be greater than 0. Only applicable for proxy-mode=userspace |
|
-v, --v int | |
number for the log level verbosity |
|
--version version[=true] | |
Print version information and quit |
|
--vmodule <comma-separated 'pattern=N' settings> | |
comma-separated list of pattern=N settings for file-filtered logging |
|
--write-config-to string | |
If set, write the default configuration values to this file and exit. |
6 - kube-scheduler
Synopsis
The Kubernetes scheduler is a control plane process which assigns Pods to Nodes. The scheduler determines which Nodes are valid placements for each Pod in the scheduling queue according to constraints and available resources. The scheduler then ranks each valid Node and binds the Pod to a suitable Node. Multiple different schedulers may be used within a cluster; kube-scheduler is the reference implementation. See scheduling for more information about scheduling and the kube-scheduler component.
kube-scheduler [flags]
Options
--add-dir-header | |
If true, adds the file directory to the header of the log messages |
|
--address string | |
DEPRECATED: the IP address on which to listen for the --port port (set to 0.0.0.0 or :: for listening in all interfaces and IP families). See --bind-address instead. This parameter is ignored if a config file is specified in --config. |
|
--allow-metric-labels stringToString Default: [] | |
The map from metric-label to value allow-list of this label. The key's format is <MetricName>,<LabelName>. The value's format is <allowed_value>,<allowed_value>...e.g. metric1,label1='v1,v2,v3', metric1,label2='v1,v2,v3' metric2,label1='v1,v2,v3'. |
|
--alsologtostderr | |
log to standard error as well as files |
|
--authentication-kubeconfig string | |
kubeconfig file pointing at the 'core' kubernetes server with enough rights to create tokenreviews.authentication.k8s.io. This is optional. If empty, all token requests are considered to be anonymous and no client CA is looked up in the cluster. |
|
--authentication-skip-lookup | |
If false, the authentication-kubeconfig will be used to lookup missing authentication configuration from the cluster. |
|
--authentication-token-webhook-cache-ttl duration Default: 10s | |
The duration to cache responses from the webhook token authenticator. |
|
--authentication-tolerate-lookup-failure Default: true | |
If true, failures to look up missing authentication configuration from the cluster are not considered fatal. Note that this can result in authentication that treats all requests as anonymous. |
|
--authorization-always-allow-paths strings Default: "/healthz,/readyz,/livez" | |
A list of HTTP paths to skip during authorization, i.e. these are authorized without contacting the 'core' kubernetes server. |
|
--authorization-kubeconfig string | |
kubeconfig file pointing at the 'core' kubernetes server with enough rights to create subjectaccessreviews.authorization.k8s.io. This is optional. If empty, all requests not skipped by authorization are forbidden. |
|
--authorization-webhook-cache-authorized-ttl duration Default: 10s | |
The duration to cache 'authorized' responses from the webhook authorizer. |
|
--authorization-webhook-cache-unauthorized-ttl duration Default: 10s | |
The duration to cache 'unauthorized' responses from the webhook authorizer. |
|
--azure-container-registry-config string | |
Path to the file containing Azure container registry configuration information. |
|
--bind-address string Default: 0.0.0.0 | |
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank or an unspecified address (0.0.0.0 or ::), all interfaces will be used. |
|
--cert-dir string | |
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. |
|
--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. |
|
--config string | |
The path to the configuration file. The following flags can overwrite fields in this file: |
|
--contention-profiling | |
DEPRECATED: enable lock contention profiling, if profiling is enabled. This parameter is ignored if a config file is specified in --config. |
|
--disabled-metrics strings | |
This flag provides an escape hatch for misbehaving metrics. You must provide the fully qualified metric name in order to disable it. Disclaimer: disabling metrics is higher in precedence than showing hidden metrics. |
|
--experimental-logging-sanitization | |
[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). |
|
--feature-gates <comma-separated 'key=True|False' pairs> | |
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: |
|
-h, --help | |
help for kube-scheduler |
|
--http2-max-streams-per-connection int | |
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default. |
|
--kube-api-burst int32 | |
DEPRECATED: burst to use while talking with kubernetes apiserver. This parameter is ignored if a config file is specified in --config. |
|
--kube-api-content-type string | |
DEPRECATED: content type of requests sent to apiserver. This parameter is ignored if a config file is specified in --config. |
|
--kube-api-qps float | |
DEPRECATED: QPS to use while talking with kubernetes apiserver. This parameter is ignored if a config file is specified in --config. |
|
--kubeconfig string | |
DEPRECATED: path to kubeconfig file with authorization and master location information. This parameter is ignored if a config file is specified in --config. |
|
--leader-elect | |
Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. |
|
--leader-elect-lease-duration duration | |
The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. |
|
--leader-elect-renew-deadline duration | |
The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. |
|
--leader-elect-resource-lock string | |
The type of resource object that is used for locking during leader election. Supported options are 'endpoints', 'configmaps', 'leases', 'endpointsleases' and 'configmapsleases'. |
|
--leader-elect-resource-name string | |
The name of resource object that is used for locking during leader election. |
|
--leader-elect-resource-namespace string | |
The namespace of resource object that is used for locking during leader election. |
|
--leader-elect-retry-period duration | |
The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. |
|
--lock-object-name string | |
DEPRECATED: define the name of the lock object. Will be removed in favor of leader-elect-resource-name. This parameter is ignored if a config file is specified in --config. |
|
--lock-object-namespace string | |
DEPRECATED: define the namespace of the lock object. Will be removed in favor of leader-elect-resource-namespace. This parameter is ignored if a config file is specified in --config. |
|
--log-backtrace-at <a string in the form 'file:N'> Default: :0 | |
when logging hits line file:N, emit a stack trace |
|
--log-dir string | |
If non-empty, write log files in this directory |
|
--log-file string | |
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 | |
Maximum number of seconds between log flushes |
|
--logging-format string Default: "text" | |
Sets the log format. Permitted formats: "text". |
|
--logtostderr Default: true | |
log to standard error instead of files |
|
--master string | |
The address of the Kubernetes API server (overrides any value in kubeconfig) |
|
--one-output | |
If true, only write logs to their native severity level (vs also writing to each lower severity level) |
|
--permit-address-sharing | |
If true, SO_REUSEADDR will be used when binding the port. This allows binding to wildcard IPs like 0.0.0.0 and specific IPs in parallel, and it avoids waiting for the kernel to release sockets in TIME_WAIT state. [default=false] |
|
--permit-port-sharing | |
If true, SO_REUSEPORT will be used when binding the port, which allows more than one instance to bind on the same address and port. [default=false] |
|
--policy-config-file string | |
DEPRECATED: file with scheduler policy configuration. This file is used if policy ConfigMap is not provided or --use-legacy-policy-config=true. Note: The predicates/priorities defined in this file will take precedence over any profiles define in ComponentConfig. |
|
--policy-configmap string | |
DEPRECATED: name of the ConfigMap object that contains scheduler's policy configuration. It must exist in the system namespace before scheduler initialization if --use-legacy-policy-config=false. The config must be provided as the value of an element in 'Data' map with the key='policy.cfg'. Note: The predicates/priorities defined in this file will take precedence over any profiles define in ComponentConfig. |
|
--policy-configmap-namespace string Default: "kube-system" | |
DEPRECATED: the namespace where policy ConfigMap is located. The kube-system namespace will be used if this is not provided or is empty. Note: The predicates/priorities defined in this file will take precedence over any profiles define in ComponentConfig. |
|
--port int | |
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. This parameter is ignored if a config file is specified in --config. |
|
--profiling | |
DEPRECATED: enable profiling via web interface host:port/debug/pprof/. This parameter is ignored if a config file is specified in --config. |
|
--requestheader-allowed-names strings | |
List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed. |
|
--requestheader-client-ca-file string | |
Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers. WARNING: generally do not depend on authorization being already done for incoming requests. |
|
--requestheader-extra-headers-prefix strings Default: "x-remote-extra-" | |
List of request header prefixes to inspect. X-Remote-Extra- is suggested. |
|
--requestheader-group-headers strings Default: "x-remote-group" | |
List of request headers to inspect for groups. X-Remote-Group is suggested. |
|
--requestheader-username-headers strings Default: "x-remote-user" | |
List of request headers to inspect for usernames. X-Remote-User is common. |
|
--secure-port int Default: 10259 | |
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. |
|
--show-hidden-metrics-for-version string | |
The previous version for which you want to show hidden metrics. Only the previous minor version is meaningful, other values will not be allowed. The format is <major>.<minor>, e.g.: '1.16'. The purpose of this format is make sure you have the opportunity to notice if the next release hides additional metrics, rather than being surprised when they are permanently removed in the release after that. |
|
--skip-headers | |
If true, avoid header prefixes in the log messages |
|
--skip-log-headers | |
If true, avoid headers when opening log files |
|
--stderrthreshold int Default: 2 | |
logs at or above this threshold go to stderr |
|
--tls-cert-file string | |
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --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 specified by --cert-dir. |
|
--tls-cipher-suites strings | |
Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used. |
|
--tls-min-version string | |
Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13 |
|
--tls-private-key-file string | |
File containing the default x509 private key matching --tls-cert-file. |
|
--tls-sni-cert-key string | |
A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. The domain patterns also allow IP addresses, but IPs should only be used if the apiserver has visibility to the IP address requested by a client. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com". |
|
--use-legacy-policy-config | |
DEPRECATED: when set to true, scheduler will ignore policy ConfigMap and uses policy config file. Note: The scheduler will fail if this is combined with Plugin configs |
|
-v, --v int | |
number for the log level verbosity |
|
--version version[=true] | |
Print version information and quit |
|
--vmodule <comma-separated 'pattern=N' settings> | |
comma-separated list of pattern=N settings for file-filtered logging |
|
--write-config-to string | |
If set, write the configuration values to this file and exit. |
7 - Kubelet authentication/authorization
Overview
A kubelet's HTTPS endpoint exposes APIs which give access to data of varying sensitivity, and allow you to perform operations with varying levels of power on the node and within containers.
This document describes how to authenticate and authorize access to the kubelet's HTTPS endpoint.
Kubelet authentication
By default, requests to the kubelet's HTTPS endpoint that are not rejected by other configured
authentication methods are treated as anonymous requests, and given a username of system:anonymous
and a group of system:unauthenticated
.
To disable anonymous access and send 401 Unauthorized
responses to unauthenticated requests:
- start the kubelet with the
--anonymous-auth=false
flag
To enable X509 client certificate authentication to the kubelet's HTTPS endpoint:
- start the kubelet with the
--client-ca-file
flag, providing a CA bundle to verify client certificates with - start the apiserver with
--kubelet-client-certificate
and--kubelet-client-key
flags - see the apiserver authentication documentation for more details
To enable API bearer tokens (including service account tokens) to be used to authenticate to the kubelet's HTTPS endpoint:
- ensure the
authentication.k8s.io/v1beta1
API group is enabled in the API server - start the kubelet with the
--authentication-token-webhook
and--kubeconfig
flags - the kubelet calls the
TokenReview
API on the configured API server to determine user information from bearer tokens
Kubelet authorization
Any request that is successfully authenticated (including an anonymous request) is then authorized. The default authorization mode is AlwaysAllow
, which allows all requests.
There are many possible reasons to subdivide access to the kubelet API:
- anonymous auth is enabled, but anonymous users' ability to call the kubelet API should be limited
- bearer token auth is enabled, but arbitrary API users' (like service accounts) ability to call the kubelet API should be limited
- client certificate auth is enabled, but only some of the client certificates signed by the configured CA should be allowed to use the kubelet API
To subdivide access to the kubelet API, delegate authorization to the API server:
- ensure the
authorization.k8s.io/v1beta1
API group is enabled in the API server - start the kubelet with the
--authorization-mode=Webhook
and the--kubeconfig
flags - the kubelet calls the
SubjectAccessReview
API on the configured API server to determine whether each request is authorized
The kubelet authorizes API requests using the same request attributes approach as the apiserver.
The verb is determined from the incoming request's HTTP verb:
HTTP verb | request verb |
---|---|
POST | create |
GET, HEAD | get |
PUT | update |
PATCH | patch |
DELETE | delete |
The resource and subresource is determined from the incoming request's path:
Kubelet API | resource | subresource |
---|---|---|
/stats/* | nodes | stats |
/metrics/* | nodes | metrics |
/logs/* | nodes | log |
/spec/* | nodes | spec |
all others | nodes | proxy |
The namespace and API group attributes are always an empty string, and
the resource name is always the name of the kubelet's Node
API object.
When running in this mode, ensure the user identified by the --kubelet-client-certificate
and --kubelet-client-key
flags passed to the apiserver is authorized for the following attributes:
- verb=*, resource=nodes, subresource=proxy
- verb=*, resource=nodes, subresource=stats
- verb=*, resource=nodes, subresource=log
- verb=*, resource=nodes, subresource=spec
- verb=*, resource=nodes, subresource=metrics
8 - TLS bootstrapping
In a Kubernetes cluster, the components on the worker nodes - kubelet and kube-proxy - need to communicate with Kubernetes control plane components, specifically kube-apiserver. In order to ensure that communication is kept private, not interfered with, and ensure that each component of the cluster is talking to another trusted component, we strongly recommend using client TLS certificates on nodes.
The normal process of bootstrapping these components, especially worker nodes that need certificates so they can communicate safely with kube-apiserver, can be a challenging process as it is often outside of the scope of Kubernetes and requires significant additional work. This in turn, can make it challenging to initialize or scale a cluster.
In order to simplify the process, beginning in version 1.4, Kubernetes introduced a certificate request and signing API. The proposal can be found here.
This document describes the process of node initialization, how to set up TLS client certificate bootstrapping for kubelets, and how it works.
Initialization Process
When a worker node starts up, the kubelet does the following:
- Look for its
kubeconfig
file - Retrieve the URL of the API server and credentials, normally a TLS key and signed certificate from the
kubeconfig
file - Attempt to communicate with the API server using the credentials.
Assuming that the kube-apiserver successfully validates the kubelet's credentials, it will treat the kubelet as a valid node, and begin to assign pods to it.
Note that the above process depends upon:
- Existence of a key and certificate on the local host in the
kubeconfig
- The certificate having been signed by a Certificate Authority (CA) trusted by the kube-apiserver
All of the following are responsibilities of whoever sets up and manages the cluster:
- Creating the CA key and certificate
- Distributing the CA certificate to the control plane nodes, where kube-apiserver is running
- Creating a key and certificate for each kubelet; strongly recommended to have a unique one, with a unique CN, for each kubelet
- Signing the kubelet certificate using the CA key
- Distributing the kubelet key and signed certificate to the specific node on which the kubelet is running
The TLS Bootstrapping described in this document is intended to simplify, and partially or even completely automate, steps 3 onwards, as these are the most common when initializing or scaling a cluster.
Bootstrap Initialization
In the bootstrap initialization process, the following occurs:
- kubelet begins
- kubelet sees that it does not have a
kubeconfig
file - kubelet searches for and finds a
bootstrap-kubeconfig
file - kubelet reads its bootstrap file, retrieving the URL of the API server and a limited usage "token"
- kubelet connects to the API server, authenticates using the token
- kubelet now has limited credentials to create and retrieve a certificate signing request (CSR)
- kubelet creates a CSR for itself with the signerName set to
kubernetes.io/kube-apiserver-client-kubelet
- CSR is approved in one of two ways:
- If configured, kube-controller-manager automatically approves the CSR
- If configured, an outside process, possibly a person, approves the CSR using the Kubernetes API or via
kubectl
- Certificate is created for the kubelet
- Certificate is issued to the kubelet
- kubelet retrieves the certificate
- kubelet creates a proper
kubeconfig
with the key and signed certificate - kubelet begins normal operation
- Optional: if configured, kubelet automatically requests renewal of the certificate when it is close to expiry
- The renewed certificate is approved and issued, either automatically or manually, depending on configuration.
The rest of this document describes the necessary steps to configure TLS Bootstrapping, and its limitations.
Configuration
To configure for TLS bootstrapping and optional automatic approval, you must configure options on the following components:
- kube-apiserver
- kube-controller-manager
- kubelet
- in-cluster resources:
ClusterRoleBinding
and potentiallyClusterRole
In addition, you need your Kubernetes Certificate Authority (CA).
Certificate Authority
As without bootstrapping, you will need a Certificate Authority (CA) key and certificate. As without bootstrapping, these will be used to sign the kubelet certificate. As before, it is your responsibility to distribute them to control plane nodes.
For the purposes of this document, we will assume these have been distributed to control plane nodes at /var/lib/kubernetes/ca.pem
(certificate) and /var/lib/kubernetes/ca-key.pem
(key).
We will refer to these as "Kubernetes CA certificate and key".
All Kubernetes components that use these certificates - kubelet, kube-apiserver, kube-controller-manager - assume the key and certificate to be PEM-encoded.
kube-apiserver configuration
The kube-apiserver has several requirements to enable TLS bootstrapping:
- Recognizing CA that signs the client certificate
- Authenticating the bootstrapping kubelet to the
system:bootstrappers
group - Authorize the bootstrapping kubelet to create a certificate signing request (CSR)
Recognizing client certificates
This is normal for all client certificate authentication.
If not already set, add the --client-ca-file=FILENAME
flag to the kube-apiserver command to enable
client certificate authentication, referencing a certificate authority bundle
containing the signing certificate, for example
--client-ca-file=/var/lib/kubernetes/ca.pem
.
Initial bootstrap authentication
In order for the bootstrapping kubelet to connect to kube-apiserver and request a certificate, it must first authenticate to the server. You can use any authenticator that can authenticate the kubelet.
While any authentication strategy can be used for the kubelet's initial bootstrap credentials, the following two authenticators are recommended for ease of provisioning.
Bootstrap tokens are a simpler and more easily managed method to authenticate kubelets, and do not require any additional flags when starting kube-apiserver. Using bootstrap tokens is currently beta as of Kubernetes version 1.12.
Whichever method you choose, the requirement is that the kubelet be able to authenticate as a user with the rights to:
- create and retrieve CSRs
- be automatically approved to request node client certificates, if automatic approval is enabled.
A kubelet authenticating using bootstrap tokens is authenticated as a user in the group system:bootstrappers
, which is the standard method to use.
As this feature matures, you should ensure tokens are bound to a Role Based Access Control (RBAC) policy which limits requests (using the bootstrap token) strictly to client requests related to certificate provisioning. With RBAC in place, scoping the tokens to a group allows for great flexibility. For example, you could disable a particular bootstrap group's access when you are done provisioning the nodes.
Bootstrap tokens
Bootstrap tokens are described in detail here. These are tokens that are stored as secrets in the Kubernetes cluster, and then issued to the individual kubelet. You can use a single token for an entire cluster, or issue one per worker node.
The process is two-fold:
- Create a Kubernetes secret with the token ID, secret and scope(s).
- Issue the token to the kubelet
From the kubelet's perspective, one token is like another and has no special meaning.
From the kube-apiserver's perspective, however, the bootstrap token is special. Due to its type
, namespace
and name
, kube-apiserver recognizes it as a special token,
and grants anyone authenticating with that token special bootstrap rights, notably treating them as a member of the system:bootstrappers
group. This fulfills a basic requirement
for TLS bootstrapping.
The details for creating the secret are available here.
If you want to use bootstrap tokens, you must enable it on kube-apiserver with the flag:
--enable-bootstrap-token-auth=true
Token authentication file
kube-apiserver has the ability to accept tokens as authentication.
These tokens are arbitrary but should represent at least 128 bits of entropy derived
from a secure random number generator (such as /dev/urandom
on most modern Linux
systems). There are multiple ways you can generate a token. For example:
head -c 16 /dev/urandom | od -An -t x | tr -d ' '
will generate tokens that look like 02b50b05283e98dd0fd71db496ef01e8
.
The token file should look like the following example, where the first three values can be anything and the quoted group name should be as depicted:
02b50b05283e98dd0fd71db496ef01e8,kubelet-bootstrap,10001,"system:bootstrappers"
Add the --token-auth-file=FILENAME
flag to the kube-apiserver command (in your
systemd unit file perhaps) to enable the token file. See docs
here for
further details.
Authorize kubelet to create CSR
Now that the bootstrapping node is authenticated as part of the
system:bootstrappers
group, it needs to be authorized to create a
certificate signing request (CSR) as well as retrieve it when done.
Fortunately, Kubernetes ships with a ClusterRole
with precisely these (and
only these) permissions, system:node-bootstrapper
.
To do this, you only need to create a ClusterRoleBinding
that binds the system:bootstrappers
group to the cluster role system:node-bootstrapper
.
# enable bootstrapping nodes to create CSR
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: create-csrs-for-bootstrapping
subjects:
- kind: Group
name: system:bootstrappers
apiGroup: rbac.authorization.k8s.io
roleRef:
kind: ClusterRole
name: system:node-bootstrapper
apiGroup: rbac.authorization.k8s.io
kube-controller-manager configuration
While the apiserver receives the requests for certificates from the kubelet and authenticates those requests, the controller-manager is responsible for issuing actual signed certificates.
The controller-manager performs this function via a certificate-issuing control loop. This takes the form of a cfssl local signer using assets on disk. Currently, all certificates issued have one year validity and a default set of key usages.
In order for the controller-manager to sign certificates, it needs the following:
- access to the "Kubernetes CA key and certificate" that you created and distributed
- enabling CSR signing
Access to key and certificate
As described earlier, you need to create a Kubernetes CA key and certificate, and distribute it to the control plane nodes. These will be used by the controller-manager to sign the kubelet certificates.
Since these signed certificates will, in turn, be used by the kubelet to authenticate as a regular kubelet to kube-apiserver, it is important that the CA
provided to the controller-manager at this stage also be trusted by kube-apiserver for authentication. This is provided to kube-apiserver
with the flag --client-ca-file=FILENAME
(for example, --client-ca-file=/var/lib/kubernetes/ca.pem
), as described in the kube-apiserver configuration section.
To provide the Kubernetes CA key and certificate to kube-controller-manager, use the following flags:
--cluster-signing-cert-file="/etc/path/to/kubernetes/ca/ca.crt" --cluster-signing-key-file="/etc/path/to/kubernetes/ca/ca.key"
for example:
--cluster-signing-cert-file="/var/lib/kubernetes/ca.pem" --cluster-signing-key-file="/var/lib/kubernetes/ca-key.pem"
The validity duration of signed certificates can be configured with flag:
--cluster-signing-duration
Approval
In order to approve CSRs, you need to tell the controller-manager that it is acceptable to approve them. This is done by granting RBAC permissions to the correct group.
There are two distinct sets of permissions:
nodeclient
: If a node is creating a new certificate for a node, then it does not have a certificate yet. It is authenticating using one of the tokens listed above, and thus is part of the groupsystem:bootstrappers
.selfnodeclient
: If a node is renewing its certificate, then it already has a certificate (by definition), which it uses continuously to authenticate as part of the groupsystem:nodes
.
To enable the kubelet to request and receive a new certificate, create a ClusterRoleBinding
that binds the group in which the bootstrapping node is a member system:bootstrappers
to the ClusterRole
that grants it permission, system:certificates.k8s.io:certificatesigningrequests:nodeclient
:
# Approve all CSRs for the group "system:bootstrappers"
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: auto-approve-csrs-for-group
subjects:
- kind: Group
name: system:bootstrappers
apiGroup: rbac.authorization.k8s.io
roleRef:
kind: ClusterRole
name: system:certificates.k8s.io:certificatesigningrequests:nodeclient
apiGroup: rbac.authorization.k8s.io
To enable the kubelet to renew its own client certificate, create a ClusterRoleBinding
that binds the group in which the fully functioning node is a member system:nodes
to the ClusterRole
that
grants it permission, system:certificates.k8s.io:certificatesigningrequests:selfnodeclient
:
# Approve renewal CSRs for the group "system:nodes"
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: auto-approve-renewals-for-nodes
subjects:
- kind: Group
name: system:nodes
apiGroup: rbac.authorization.k8s.io
roleRef:
kind: ClusterRole
name: system:certificates.k8s.io:certificatesigningrequests:selfnodeclient
apiGroup: rbac.authorization.k8s.io
The csrapproving
controller that ships as part of
kube-controller-manager and is enabled
by default. The controller uses the
SubjectAccessReview
API to
determine if a given user is authorized to request a CSR, then approves based on
the authorization outcome. To prevent conflicts with other approvers, the
builtin approver doesn't explicitly deny CSRs. It only ignores unauthorized
requests. The controller also prunes expired certificates as part of garbage
collection.
kubelet configuration
Finally, with the control plane nodes properly set up and all of the necessary authentication and authorization in place, we can configure the kubelet.
The kubelet requires the following configuration to bootstrap:
- A path to store the key and certificate it generates (optional, can use default)
- A path to a
kubeconfig
file that does not yet exist; it will place the bootstrapped config file here - A path to a bootstrap
kubeconfig
file to provide the URL for the server and bootstrap credentials, e.g. a bootstrap token - Optional: instructions to rotate certificates
The bootstrap kubeconfig
should be in a path available to the kubelet, for example /var/lib/kubelet/bootstrap-kubeconfig
.
Its format is identical to a normal kubeconfig
file. A sample file might look as follows:
apiVersion: v1
kind: Config
clusters:
- cluster:
certificate-authority: /var/lib/kubernetes/ca.pem
server: https://my.server.example.com:6443
name: bootstrap
contexts:
- context:
cluster: bootstrap
user: kubelet-bootstrap
name: bootstrap
current-context: bootstrap
preferences: {}
users:
- name: kubelet-bootstrap
user:
token: 07401b.f395accd246ae52d
The important elements to note are:
certificate-authority
: path to a CA file, used to validate the server certificate presented by kube-apiserverserver
: URL to kube-apiservertoken
: the token to use
The format of the token does not matter, as long as it matches what kube-apiserver expects. In the above example, we used a bootstrap token. As stated earlier, any valid authentication method can be used, not only tokens.
Because the bootstrap kubeconfig
is a standard kubeconfig
, you can use kubectl
to generate it. To create the above example file:
kubectl config --kubeconfig=/var/lib/kubelet/bootstrap-kubeconfig set-cluster bootstrap --server='https://my.server.example.com:6443' --certificate-authority=/var/lib/kubernetes/ca.pem
kubectl config --kubeconfig=/var/lib/kubelet/bootstrap-kubeconfig set-credentials kubelet-bootstrap --token=07401b.f395accd246ae52d
kubectl config --kubeconfig=/var/lib/kubelet/bootstrap-kubeconfig set-context bootstrap --user=kubelet-bootstrap --cluster=bootstrap
kubectl config --kubeconfig=/var/lib/kubelet/bootstrap-kubeconfig use-context bootstrap
To indicate to the kubelet to use the bootstrap kubeconfig
, use the following kubelet flag:
--bootstrap-kubeconfig="/var/lib/kubelet/bootstrap-kubeconfig" --kubeconfig="/var/lib/kubelet/kubeconfig"
When starting the kubelet, if the file specified via --kubeconfig
does not
exist, the bootstrap kubeconfig specified via --bootstrap-kubeconfig
is used
to request a client certificate from the API server. On approval of the
certificate request and receipt back by the kubelet, a kubeconfig file
referencing the generated key and obtained certificate is written to the path
specified by --kubeconfig
. The certificate and key file will be placed in the
directory specified by --cert-dir
.
Client and Serving Certificates
All of the above relate to kubelet client certificates, specifically, the certificates a kubelet uses to authenticate to kube-apiserver.
A kubelet also can use serving certificates. The kubelet itself exposes an https endpoint for certain features. To secure these, the kubelet can do one of:
- use provided key and certificate, via the
--tls-private-key-file
and--tls-cert-file
flags - create self-signed key and certificate, if a key and certificate are not provided
- request serving certificates from the cluster server, via the CSR API
The client certificate provided by TLS bootstrapping is signed, by default, for client auth
only, and thus cannot
be used as serving certificates, or server auth
.
However, you can enable its server certificate, at least partially, via certificate rotation.
Certificate Rotation
Kubernetes v1.8 and higher kubelet implements beta features for enabling
rotation of its client and/or serving certificates. These can be enabled through
the respective RotateKubeletClientCertificate
and
RotateKubeletServerCertificate
feature flags on the kubelet and are enabled by
default.
RotateKubeletClientCertificate
causes the kubelet to rotate its client
certificates by creating new CSRs as its existing credentials expire. To enable
this feature pass the following flag to the kubelet:
--rotate-certificates
RotateKubeletServerCertificate
causes the kubelet both to request a serving
certificate after bootstrapping its client credentials and to rotate that
certificate. To enable this feature pass the following flag to the kubelet:
--rotate-server-certificates
The CSR approving controllers implemented in core Kubernetes do not
approve node serving certificates for security
reasons. To use
RotateKubeletServerCertificate
operators need to run a custom approving
controller, or manually approve the serving certificate requests.
A deployment-specific approval process for kubelet serving certificates should typically only approve CSRs which:
- are requested by nodes (ensure the
spec.username
field is of the formsystem:node:<nodeName>
andspec.groups
containssystem:nodes
) - request usages for a serving certificate (ensure
spec.usages
containsserver auth
, optionally containsdigital signature
andkey encipherment
, and contains no other usages) - only have IP and DNS subjectAltNames that belong to the requesting node,
and have no URI and Email subjectAltNames (parse the x509 Certificate Signing Request
in
spec.request
to verifysubjectAltNames
)
Other authenticating components
All of TLS bootstrapping described in this document relates to the kubelet. However, other components may need to communicate directly with kube-apiserver. Notable is kube-proxy, which is part of the Kubernetes control plane and runs on every node, but may also include other components such as monitoring or networking.
Like the kubelet, these other components also require a method of authenticating to kube-apiserver. You have several options for generating these credentials:
- The old way: Create and distribute certificates the same way you did for kubelet before TLS bootstrapping
- DaemonSet: Since the kubelet itself is loaded on each node, and is sufficient to start base services, you can run kube-proxy and other node-specific services not as a standalone process, but rather as a daemonset in the
kube-system
namespace. Since it will be in-cluster, you can give it a proper service account with appropriate permissions to perform its activities. This may be the simplest way to configure such services.
kubectl approval
CSRs can be approved outside of the approval flows builtin to the controller manager.
The signing controller does not immediately sign all certificate requests.
Instead, it waits until they have been flagged with an "Approved" status by an
appropriately-privileged user. This flow is intended to allow for automated
approval handled by an external approval controller or the approval controller
implemented in the core controller-manager. However cluster administrators can
also manually approve certificate requests using kubectl. An administrator can
list CSRs with kubectl get csr
and describe one in detail with kubectl describe csr <name>
. An administrator can approve or deny a CSR with kubectl certificate approve <name>
and kubectl certificate deny <name>
.