questions
stringlengths 4
1.65k
| answers
stringlengths 1.73k
353k
| site
stringclasses 24
values | answers_cleaned
stringlengths 1.73k
353k
|
|---|---|---|---|
kubernetes reference contenttype tool reference Resource Types package apiserver k8s io v1alpha1 title kube apiserver Configuration v1alpha1 autogenerated true p Package v1alpha1 is the v1alpha1 version of the API p | ---
title: kube-apiserver Configuration (v1alpha1)
content_type: tool-reference
package: apiserver.k8s.io/v1alpha1
auto_generated: true
---
<p>Package v1alpha1 is the v1alpha1 version of the API.</p>
## Resource Types
- [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration)
- [AuthenticationConfiguration](#apiserver-k8s-io-v1alpha1-AuthenticationConfiguration)
- [AuthorizationConfiguration](#apiserver-k8s-io-v1alpha1-AuthorizationConfiguration)
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration)
- [TracingConfiguration](#apiserver-k8s-io-v1alpha1-TracingConfiguration)
## `TracingConfiguration` {#TracingConfiguration}
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
- [TracingConfiguration](#apiserver-k8s-io-v1alpha1-TracingConfiguration)
<p>TracingConfiguration provides versioned configuration for OpenTelemetry tracing clients.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>endpoint</code><br/>
<code>string</code>
</td>
<td>
<p>Endpoint of the collector this component will report traces to.
The connection is insecure, and does not currently support TLS.
Recommended is unset, and endpoint is the otlp grpc default, localhost:4317.</p>
</td>
</tr>
<tr><td><code>samplingRatePerMillion</code><br/>
<code>int32</code>
</td>
<td>
<p>SamplingRatePerMillion is the number of samples to collect per million spans.
Recommended is unset. If unset, sampler respects its parent span's sampling
rate, but otherwise never samples.</p>
</td>
</tr>
</tbody>
</table>
## `AdmissionConfiguration` {#apiserver-k8s-io-v1alpha1-AdmissionConfiguration}
<p>AdmissionConfiguration provides versioned configuration for admission controllers.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>AdmissionConfiguration</code></td></tr>
<tr><td><code>plugins</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-AdmissionPluginConfiguration"><code>[]AdmissionPluginConfiguration</code></a>
</td>
<td>
<p>Plugins allows specifying a configuration per admission control plugin.</p>
</td>
</tr>
</tbody>
</table>
## `AuthenticationConfiguration` {#apiserver-k8s-io-v1alpha1-AuthenticationConfiguration}
<p>AuthenticationConfiguration provides versioned configuration for authentication.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>AuthenticationConfiguration</code></td></tr>
<tr><td><code>jwt</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-JWTAuthenticator"><code>[]JWTAuthenticator</code></a>
</td>
<td>
<p>jwt is a list of authenticator to authenticate Kubernetes users using
JWT compliant tokens. The authenticator will attempt to parse a raw ID token,
verify it's been signed by the configured issuer. The public key to verify the
signature is discovered from the issuer's public endpoint using OIDC discovery.
For an incoming token, each JWT authenticator will be attempted in
the order in which it is specified in this list. Note however that
other authenticators may run before or after the JWT authenticators.
The specific position of JWT authenticators in relation to other
authenticators is neither defined nor stable across releases. Since
each JWT authenticator must have a unique issuer URL, at most one
JWT authenticator will attempt to cryptographically validate the token.</p>
<p>The minimum valid JWT payload must contain the following claims:
{
"iss": "https://issuer.example.com",
"aud": ["audience"],
"exp": 1234567890,
"<!-- raw HTML omitted -->": "username"
}</p>
</td>
</tr>
<tr><td><code>anonymous</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-AnonymousAuthConfig"><code>AnonymousAuthConfig</code></a>
</td>
<td>
<p>If present --anonymous-auth must not be set</p>
</td>
</tr>
</tbody>
</table>
## `AuthorizationConfiguration` {#apiserver-k8s-io-v1alpha1-AuthorizationConfiguration}
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>AuthorizationConfiguration</code></td></tr>
<tr><td><code>authorizers</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-AuthorizerConfiguration"><code>[]AuthorizerConfiguration</code></a>
</td>
<td>
<p>Authorizers is an ordered list of authorizers to
authorize requests against.
This is similar to the --authorization-modes kube-apiserver flag
Must be at least one.</p>
</td>
</tr>
</tbody>
</table>
## `EgressSelectorConfiguration` {#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration}
<p>EgressSelectorConfiguration provides versioned configuration for egress selector clients.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>EgressSelectorConfiguration</code></td></tr>
<tr><td><code>egressSelections</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-EgressSelection"><code>[]EgressSelection</code></a>
</td>
<td>
<p>connectionServices contains a list of egress selection client configurations</p>
</td>
</tr>
</tbody>
</table>
## `TracingConfiguration` {#apiserver-k8s-io-v1alpha1-TracingConfiguration}
<p>TracingConfiguration provides versioned configuration for tracing clients.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>TracingConfiguration</code></td></tr>
<tr><td><code>TracingConfiguration</code> <B>[Required]</B><br/>
<a href="#TracingConfiguration"><code>TracingConfiguration</code></a>
</td>
<td>(Members of <code>TracingConfiguration</code> are embedded into this type.)
<p>Embed the component config tracing configuration struct</p>
</td>
</tr>
</tbody>
</table>
## `AdmissionPluginConfiguration` {#apiserver-k8s-io-v1alpha1-AdmissionPluginConfiguration}
**Appears in:**
- [AdmissionConfiguration](#apiserver-k8s-io-v1alpha1-AdmissionConfiguration)
<p>AdmissionPluginConfiguration provides the configuration for a single plug-in.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>name</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Name is the name of the admission controller.
It must match the registered admission plugin name.</p>
</td>
</tr>
<tr><td><code>path</code><br/>
<code>string</code>
</td>
<td>
<p>Path is the path to a configuration file that contains the plugin's
configuration</p>
</td>
</tr>
<tr><td><code>configuration</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#Unknown"><code>k8s.io/apimachinery/pkg/runtime.Unknown</code></a>
</td>
<td>
<p>Configuration is an embedded configuration object to be used as the plugin's
configuration. If present, it will be used instead of the path to the configuration file.</p>
</td>
</tr>
</tbody>
</table>
## `AnonymousAuthCondition` {#apiserver-k8s-io-v1alpha1-AnonymousAuthCondition}
**Appears in:**
- [AnonymousAuthConfig](#apiserver-k8s-io-v1alpha1-AnonymousAuthConfig)
<p>AnonymousAuthCondition describes the condition under which anonymous auth
should be enabled.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>path</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Path for which anonymous auth is enabled.</p>
</td>
</tr>
</tbody>
</table>
## `AnonymousAuthConfig` {#apiserver-k8s-io-v1alpha1-AnonymousAuthConfig}
**Appears in:**
- [AuthenticationConfiguration](#apiserver-k8s-io-v1alpha1-AuthenticationConfiguration)
<p>AnonymousAuthConfig provides the configuration for the anonymous authenticator.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>enabled</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>conditions</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-AnonymousAuthCondition"><code>[]AnonymousAuthCondition</code></a>
</td>
<td>
<p>If set, anonymous auth is only allowed if the request meets one of the
conditions.</p>
</td>
</tr>
</tbody>
</table>
## `AudienceMatchPolicyType` {#apiserver-k8s-io-v1alpha1-AudienceMatchPolicyType}
(Alias of `string`)
**Appears in:**
- [Issuer](#apiserver-k8s-io-v1alpha1-Issuer)
<p>AudienceMatchPolicyType is a set of valid values for issuer.audienceMatchPolicy</p>
## `AuthorizerConfiguration` {#apiserver-k8s-io-v1alpha1-AuthorizerConfiguration}
**Appears in:**
- [AuthorizationConfiguration](#apiserver-k8s-io-v1alpha1-AuthorizationConfiguration)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>type</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Type refers to the type of the authorizer
"Webhook" is supported in the generic API server
Other API servers may support additional authorizer
types like Node, RBAC, ABAC, etc.</p>
</td>
</tr>
<tr><td><code>name</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Name used to describe the webhook
This is explicitly used in monitoring machinery for metrics
Note: Names must be DNS1123 labels like <code>myauthorizername</code> or
subdomains like <code>myauthorizer.example.domain</code>
Required, with no default</p>
</td>
</tr>
<tr><td><code>webhook</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-WebhookConfiguration"><code>WebhookConfiguration</code></a>
</td>
<td>
<p>Webhook defines the configuration for a Webhook authorizer
Must be defined when Type=Webhook
Must not be defined when Type!=Webhook</p>
</td>
</tr>
</tbody>
</table>
## `ClaimMappings` {#apiserver-k8s-io-v1alpha1-ClaimMappings}
**Appears in:**
- [JWTAuthenticator](#apiserver-k8s-io-v1alpha1-JWTAuthenticator)
<p>ClaimMappings provides the configuration for claim mapping</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>username</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-PrefixedClaimOrExpression"><code>PrefixedClaimOrExpression</code></a>
</td>
<td>
<p>username represents an option for the username attribute.
The claim's value must be a singular string.
Same as the --oidc-username-claim and --oidc-username-prefix flags.
If username.expression is set, the expression must produce a string value.
If username.expression uses 'claims.email', then 'claims.email_verified' must be used in
username.expression or extra[<em>].valueExpression or claimValidationRules[</em>].expression.
An example claim validation rule expression that matches the validation automatically
applied when username.claim is set to 'email' is 'claims.?email_verified.orValue(true)'.</p>
<p>In the flag based approach, the --oidc-username-claim and --oidc-username-prefix are optional. If --oidc-username-claim is not set,
the default value is "sub". For the authentication config, there is no defaulting for claim or prefix. The claim and prefix must be set explicitly.
For claim, if --oidc-username-claim was not set with legacy flag approach, configure username.claim="sub" in the authentication config.
For prefix:
(1) --oidc-username-prefix="-", no prefix was added to the username. For the same behavior using authentication config,
set username.prefix=""
(2) --oidc-username-prefix="" and --oidc-username-claim != "email", prefix was "<value of --oidc-issuer-url>#". For the same
behavior using authentication config, set username.prefix="<!-- raw HTML omitted -->#"
(3) --oidc-username-prefix="<!-- raw HTML omitted -->". For the same behavior using authentication config, set username.prefix="<!-- raw HTML omitted -->"</p>
</td>
</tr>
<tr><td><code>groups</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-PrefixedClaimOrExpression"><code>PrefixedClaimOrExpression</code></a>
</td>
<td>
<p>groups represents an option for the groups attribute.
The claim's value must be a string or string array claim.
If groups.claim is set, the prefix must be specified (and can be the empty string).
If groups.expression is set, the expression must produce a string or string array value.
"", [], and null values are treated as the group mapping not being present.</p>
</td>
</tr>
<tr><td><code>uid</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-ClaimOrExpression"><code>ClaimOrExpression</code></a>
</td>
<td>
<p>uid represents an option for the uid attribute.
Claim must be a singular string claim.
If uid.expression is set, the expression must produce a string value.</p>
</td>
</tr>
<tr><td><code>extra</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-ExtraMapping"><code>[]ExtraMapping</code></a>
</td>
<td>
<p>extra represents an option for the extra attribute.
expression must produce a string or string array value.
If the value is empty, the extra mapping will not be present.</p>
<p>hard-coded extra key/value</p>
<ul>
<li>key: "foo"
valueExpression: "'bar'"
This will result in an extra attribute - foo: ["bar"]</li>
</ul>
<p>hard-coded key, value copying claim value</p>
<ul>
<li>key: "foo"
valueExpression: "claims.some_claim"
This will result in an extra attribute - foo: [value of some_claim]</li>
</ul>
<p>hard-coded key, value derived from claim value</p>
<ul>
<li>key: "admin"
valueExpression: '(has(claims.is_admin) && claims.is_admin) ? "true":""'
This will result in:</li>
<li>if is_admin claim is present and true, extra attribute - admin: ["true"]</li>
<li>if is_admin claim is present and false or is_admin claim is not present, no extra attribute will be added</li>
</ul>
</td>
</tr>
</tbody>
</table>
## `ClaimOrExpression` {#apiserver-k8s-io-v1alpha1-ClaimOrExpression}
**Appears in:**
- [ClaimMappings](#apiserver-k8s-io-v1alpha1-ClaimMappings)
<p>ClaimOrExpression provides the configuration for a single claim or expression.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>claim</code><br/>
<code>string</code>
</td>
<td>
<p>claim is the JWT claim to use.
Either claim or expression must be set.
Mutually exclusive with expression.</p>
</td>
</tr>
<tr><td><code>expression</code><br/>
<code>string</code>
</td>
<td>
<p>expression represents the expression which will be evaluated by CEL.</p>
<p>CEL expressions have access to the contents of the token claims, organized into CEL variable:</p>
<ul>
<li>'claims' is a map of claim names to claim values.
For example, a variable named 'sub' can be accessed as 'claims.sub'.
Nested claims can be accessed using dot notation, e.g. 'claims.foo.bar'.</li>
</ul>
<p>Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/</p>
<p>Mutually exclusive with claim.</p>
</td>
</tr>
</tbody>
</table>
## `ClaimValidationRule` {#apiserver-k8s-io-v1alpha1-ClaimValidationRule}
**Appears in:**
- [JWTAuthenticator](#apiserver-k8s-io-v1alpha1-JWTAuthenticator)
<p>ClaimValidationRule provides the configuration for a single claim validation rule.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>claim</code><br/>
<code>string</code>
</td>
<td>
<p>claim is the name of a required claim.
Same as --oidc-required-claim flag.
Only string claim keys are supported.
Mutually exclusive with expression and message.</p>
</td>
</tr>
<tr><td><code>requiredValue</code><br/>
<code>string</code>
</td>
<td>
<p>requiredValue is the value of a required claim.
Same as --oidc-required-claim flag.
Only string claim values are supported.
If claim is set and requiredValue is not set, the claim must be present with a value set to the empty string.
Mutually exclusive with expression and message.</p>
</td>
</tr>
<tr><td><code>expression</code><br/>
<code>string</code>
</td>
<td>
<p>expression represents the expression which will be evaluated by CEL.
Must produce a boolean.</p>
<p>CEL expressions have access to the contents of the token claims, organized into CEL variable:</p>
<ul>
<li>'claims' is a map of claim names to claim values.
For example, a variable named 'sub' can be accessed as 'claims.sub'.
Nested claims can be accessed using dot notation, e.g. 'claims.foo.bar'.
Must return true for the validation to pass.</li>
</ul>
<p>Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/</p>
<p>Mutually exclusive with claim and requiredValue.</p>
</td>
</tr>
<tr><td><code>message</code><br/>
<code>string</code>
</td>
<td>
<p>message customizes the returned error message when expression returns false.
message is a literal string.
Mutually exclusive with claim and requiredValue.</p>
</td>
</tr>
</tbody>
</table>
## `Connection` {#apiserver-k8s-io-v1alpha1-Connection}
**Appears in:**
- [EgressSelection](#apiserver-k8s-io-v1alpha1-EgressSelection)
<p>Connection provides the configuration for a single egress selection client.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>proxyProtocol</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-ProtocolType"><code>ProtocolType</code></a>
</td>
<td>
<p>Protocol is the protocol used to connect from client to the konnectivity server.</p>
</td>
</tr>
<tr><td><code>transport</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-Transport"><code>Transport</code></a>
</td>
<td>
<p>Transport defines the transport configurations we use to dial to the konnectivity server.
This is required if ProxyProtocol is HTTPConnect or GRPC.</p>
</td>
</tr>
</tbody>
</table>
## `EgressSelection` {#apiserver-k8s-io-v1alpha1-EgressSelection}
**Appears in:**
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1alpha1-EgressSelectorConfiguration)
<p>EgressSelection provides the configuration for a single egress selection client.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>name</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>name is the name of the egress selection.
Currently supported values are "controlplane", "master", "etcd" and "cluster"
The "master" egress selector is deprecated in favor of "controlplane"</p>
</td>
</tr>
<tr><td><code>connection</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-Connection"><code>Connection</code></a>
</td>
<td>
<p>connection is the exact information used to configure the egress selection</p>
</td>
</tr>
</tbody>
</table>
## `ExtraMapping` {#apiserver-k8s-io-v1alpha1-ExtraMapping}
**Appears in:**
- [ClaimMappings](#apiserver-k8s-io-v1alpha1-ClaimMappings)
<p>ExtraMapping provides the configuration for a single extra mapping.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>key</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>key is a string to use as the extra attribute key.
key must be a domain-prefix path (e.g. example.org/foo). All characters before the first "/" must be a valid
subdomain as defined by RFC 1123. All characters trailing the first "/" must
be valid HTTP Path characters as defined by RFC 3986.
key must be lowercase.
Required to be unique.</p>
</td>
</tr>
<tr><td><code>valueExpression</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>valueExpression is a CEL expression to extract extra attribute value.
valueExpression must produce a string or string array value.
"", [], and null values are treated as the extra mapping not being present.
Empty string values contained within a string array are filtered out.</p>
<p>CEL expressions have access to the contents of the token claims, organized into CEL variable:</p>
<ul>
<li>'claims' is a map of claim names to claim values.
For example, a variable named 'sub' can be accessed as 'claims.sub'.
Nested claims can be accessed using dot notation, e.g. 'claims.foo.bar'.</li>
</ul>
<p>Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/</p>
</td>
</tr>
</tbody>
</table>
## `Issuer` {#apiserver-k8s-io-v1alpha1-Issuer}
**Appears in:**
- [JWTAuthenticator](#apiserver-k8s-io-v1alpha1-JWTAuthenticator)
<p>Issuer provides the configuration for an external provider's specific settings.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>url</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>url points to the issuer URL in a format https://url or https://url/path.
This must match the "iss" claim in the presented JWT, and the issuer returned from discovery.
Same value as the --oidc-issuer-url flag.
Discovery information is fetched from "{url}/.well-known/openid-configuration" unless overridden by discoveryURL.
Required to be unique across all JWT authenticators.
Note that egress selection configuration is not used for this network connection.</p>
</td>
</tr>
<tr><td><code>discoveryURL</code><br/>
<code>string</code>
</td>
<td>
<p>discoveryURL, if specified, overrides the URL used to fetch discovery
information instead of using "{url}/.well-known/openid-configuration".
The exact value specified is used, so "/.well-known/openid-configuration"
must be included in discoveryURL if needed.</p>
<p>The "issuer" field in the fetched discovery information must match the "issuer.url" field
in the AuthenticationConfiguration and will be used to validate the "iss" claim in the presented JWT.
This is for scenarios where the well-known and jwks endpoints are hosted at a different
location than the issuer (such as locally in the cluster).</p>
<p>Example:
A discovery url that is exposed using kubernetes service 'oidc' in namespace 'oidc-namespace'
and discovery information is available at '/.well-known/openid-configuration'.
discoveryURL: "https://oidc.oidc-namespace/.well-known/openid-configuration"
certificateAuthority is used to verify the TLS connection and the hostname on the leaf certificate
must be set to 'oidc.oidc-namespace'.</p>
<p>curl https://oidc.oidc-namespace/.well-known/openid-configuration (.discoveryURL field)
{
issuer: "https://oidc.example.com" (.url field)
}</p>
<p>discoveryURL must be different from url.
Required to be unique across all JWT authenticators.
Note that egress selection configuration is not used for this network connection.</p>
</td>
</tr>
<tr><td><code>certificateAuthority</code><br/>
<code>string</code>
</td>
<td>
<p>certificateAuthority contains PEM-encoded certificate authority certificates
used to validate the connection when fetching discovery information.
If unset, the system verifier is used.
Same value as the content of the file referenced by the --oidc-ca-file flag.</p>
</td>
</tr>
<tr><td><code>audiences</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>audiences is the set of acceptable audiences the JWT must be issued to.
At least one of the entries must match the "aud" claim in presented JWTs.
Same value as the --oidc-client-id flag (though this field supports an array).
Required to be non-empty.</p>
</td>
</tr>
<tr><td><code>audienceMatchPolicy</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-AudienceMatchPolicyType"><code>AudienceMatchPolicyType</code></a>
</td>
<td>
<p>audienceMatchPolicy defines how the "audiences" field is used to match the "aud" claim in the presented JWT.
Allowed values are:</p>
<ol>
<li>"MatchAny" when multiple audiences are specified and</li>
<li>empty (or unset) or "MatchAny" when a single audience is specified.</li>
</ol>
<ul>
<li>
<p>MatchAny: the "aud" claim in the presented JWT must match at least one of the entries in the "audiences" field.
For example, if "audiences" is ["foo", "bar"], the "aud" claim in the presented JWT must contain either "foo" or "bar" (and may contain both).</p>
</li>
<li>
<p>"": The match policy can be empty (or unset) when a single audience is specified in the "audiences" field. The "aud" claim in the presented JWT must contain the single audience (and may contain others).</p>
</li>
</ul>
<p>For more nuanced audience validation, use claimValidationRules.
example: claimValidationRule[].expression: 'sets.equivalent(claims.aud, ["bar", "foo", "baz"])' to require an exact match.</p>
</td>
</tr>
</tbody>
</table>
## `JWTAuthenticator` {#apiserver-k8s-io-v1alpha1-JWTAuthenticator}
**Appears in:**
- [AuthenticationConfiguration](#apiserver-k8s-io-v1alpha1-AuthenticationConfiguration)
<p>JWTAuthenticator provides the configuration for a single JWT authenticator.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>issuer</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-Issuer"><code>Issuer</code></a>
</td>
<td>
<p>issuer contains the basic OIDC provider connection options.</p>
</td>
</tr>
<tr><td><code>claimValidationRules</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-ClaimValidationRule"><code>[]ClaimValidationRule</code></a>
</td>
<td>
<p>claimValidationRules are rules that are applied to validate token claims to authenticate users.</p>
</td>
</tr>
<tr><td><code>claimMappings</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-ClaimMappings"><code>ClaimMappings</code></a>
</td>
<td>
<p>claimMappings points claims of a token to be treated as user attributes.</p>
</td>
</tr>
<tr><td><code>userValidationRules</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-UserValidationRule"><code>[]UserValidationRule</code></a>
</td>
<td>
<p>userValidationRules are rules that are applied to final user before completing authentication.
These allow invariants to be applied to incoming identities such as preventing the
use of the system: prefix that is commonly used by Kubernetes components.
The validation rules are logically ANDed together and must all return true for the validation to pass.</p>
</td>
</tr>
</tbody>
</table>
## `PrefixedClaimOrExpression` {#apiserver-k8s-io-v1alpha1-PrefixedClaimOrExpression}
**Appears in:**
- [ClaimMappings](#apiserver-k8s-io-v1alpha1-ClaimMappings)
<p>PrefixedClaimOrExpression provides the configuration for a single prefixed claim or expression.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>claim</code><br/>
<code>string</code>
</td>
<td>
<p>claim is the JWT claim to use.
Mutually exclusive with expression.</p>
</td>
</tr>
<tr><td><code>prefix</code><br/>
<code>string</code>
</td>
<td>
<p>prefix is prepended to claim's value to prevent clashes with existing names.
prefix needs to be set if claim is set and can be the empty string.
Mutually exclusive with expression.</p>
</td>
</tr>
<tr><td><code>expression</code><br/>
<code>string</code>
</td>
<td>
<p>expression represents the expression which will be evaluated by CEL.</p>
<p>CEL expressions have access to the contents of the token claims, organized into CEL variable:</p>
<ul>
<li>'claims' is a map of claim names to claim values.
For example, a variable named 'sub' can be accessed as 'claims.sub'.
Nested claims can be accessed using dot notation, e.g. 'claims.foo.bar'.</li>
</ul>
<p>Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/</p>
<p>Mutually exclusive with claim and prefix.</p>
</td>
</tr>
</tbody>
</table>
## `ProtocolType` {#apiserver-k8s-io-v1alpha1-ProtocolType}
(Alias of `string`)
**Appears in:**
- [Connection](#apiserver-k8s-io-v1alpha1-Connection)
<p>ProtocolType is a set of valid values for Connection.ProtocolType</p>
## `TCPTransport` {#apiserver-k8s-io-v1alpha1-TCPTransport}
**Appears in:**
- [Transport](#apiserver-k8s-io-v1alpha1-Transport)
<p>TCPTransport provides the information to connect to konnectivity server via TCP</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>url</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>URL is the location of the konnectivity server to connect to.
As an example it might be "https://127.0.0.1:8131"</p>
</td>
</tr>
<tr><td><code>tlsConfig</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-TLSConfig"><code>TLSConfig</code></a>
</td>
<td>
<p>TLSConfig is the config needed to use TLS when connecting to konnectivity server</p>
</td>
</tr>
</tbody>
</table>
## `TLSConfig` {#apiserver-k8s-io-v1alpha1-TLSConfig}
**Appears in:**
- [TCPTransport](#apiserver-k8s-io-v1alpha1-TCPTransport)
<p>TLSConfig provides the authentication information to connect to konnectivity server
Only used with TCPTransport</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>caBundle</code><br/>
<code>string</code>
</td>
<td>
<p>caBundle is the file location of the CA to be used to determine trust with the konnectivity server.
Must be absent/empty if TCPTransport.URL is prefixed with http://
If absent while TCPTransport.URL is prefixed with https://, default to system trust roots.</p>
</td>
</tr>
<tr><td><code>clientKey</code><br/>
<code>string</code>
</td>
<td>
<p>clientKey is the file location of the client key to be used in mtls handshakes with the konnectivity server.
Must be absent/empty if TCPTransport.URL is prefixed with http://
Must be configured if TCPTransport.URL is prefixed with https://</p>
</td>
</tr>
<tr><td><code>clientCert</code><br/>
<code>string</code>
</td>
<td>
<p>clientCert is the file location of the client certificate to be used in mtls handshakes with the konnectivity server.
Must be absent/empty if TCPTransport.URL is prefixed with http://
Must be configured if TCPTransport.URL is prefixed with https://</p>
</td>
</tr>
</tbody>
</table>
## `Transport` {#apiserver-k8s-io-v1alpha1-Transport}
**Appears in:**
- [Connection](#apiserver-k8s-io-v1alpha1-Connection)
<p>Transport defines the transport configurations we use to dial to the konnectivity server</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>tcp</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-TCPTransport"><code>TCPTransport</code></a>
</td>
<td>
<p>TCP is the TCP configuration for communicating with the konnectivity server via TCP
ProxyProtocol of GRPC is not supported with TCP transport at the moment
Requires at least one of TCP or UDS to be set</p>
</td>
</tr>
<tr><td><code>uds</code><br/>
<a href="#apiserver-k8s-io-v1alpha1-UDSTransport"><code>UDSTransport</code></a>
</td>
<td>
<p>UDS is the UDS configuration for communicating with the konnectivity server via UDS
Requires at least one of TCP or UDS to be set</p>
</td>
</tr>
</tbody>
</table>
## `UDSTransport` {#apiserver-k8s-io-v1alpha1-UDSTransport}
**Appears in:**
- [Transport](#apiserver-k8s-io-v1alpha1-Transport)
<p>UDSTransport provides the information to connect to konnectivity server via UDS</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>udsName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>UDSName is the name of the unix domain socket to connect to konnectivity server
This does not use a unix:// prefix. (Eg: /etc/srv/kubernetes/konnectivity-server/konnectivity-server.socket)</p>
</td>
</tr>
</tbody>
</table>
## `UserValidationRule` {#apiserver-k8s-io-v1alpha1-UserValidationRule}
**Appears in:**
- [JWTAuthenticator](#apiserver-k8s-io-v1alpha1-JWTAuthenticator)
<p>UserValidationRule provides the configuration for a single user info validation rule.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>expression</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>expression represents the expression which will be evaluated by CEL.
Must return true for the validation to pass.</p>
<p>CEL expressions have access to the contents of UserInfo, organized into CEL variable:</p>
<ul>
<li>'user' - authentication.k8s.io/v1, Kind=UserInfo object
Refer to https://github.com/kubernetes/api/blob/release-1.28/authentication/v1/types.go#L105-L122 for the definition.
API documentation: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#userinfo-v1-authentication-k8s-io</li>
</ul>
<p>Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/</p>
</td>
</tr>
<tr><td><code>message</code><br/>
<code>string</code>
</td>
<td>
<p>message customizes the returned error message when rule returns false.
message is a literal string.</p>
</td>
</tr>
</tbody>
</table>
## `WebhookConfiguration` {#apiserver-k8s-io-v1alpha1-WebhookConfiguration}
**Appears in:**
- [AuthorizerConfiguration](#apiserver-k8s-io-v1alpha1-AuthorizerConfiguration)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>authorizedTTL</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p>The duration to cache 'authorized' responses from the webhook
authorizer.
Same as setting <code>--authorization-webhook-cache-authorized-ttl</code> flag
Default: 5m0s</p>
</td>
</tr>
<tr><td><code>unauthorizedTTL</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p>The duration to cache 'unauthorized' responses from the webhook
authorizer.
Same as setting <code>--authorization-webhook-cache-unauthorized-ttl</code> flag
Default: 30s</p>
</td>
</tr>
<tr><td><code>timeout</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p>Timeout for the webhook request
Maximum allowed value is 30s.
Required, no default value.</p>
</td>
</tr>
<tr><td><code>subjectAccessReviewVersion</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>The API version of the authorization.k8s.io SubjectAccessReview to
send to and expect from the webhook.
Same as setting <code>--authorization-webhook-version</code> flag
Valid values: v1beta1, v1
Required, no default value</p>
</td>
</tr>
<tr><td><code>matchConditionSubjectAccessReviewVersion</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>MatchConditionSubjectAccessReviewVersion specifies the SubjectAccessReview
version the CEL expressions are evaluated against
Valid values: v1
Required, no default value</p>
</td>
</tr>
<tr><td><code>failurePolicy</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Controls the authorization decision when a webhook request fails to
complete or returns a malformed response or errors evaluating
matchConditions.
Valid values:</p>
<ul>
<li>NoOpinion: continue to subsequent authorizers to see if one of
them allows the request</li>
<li>Deny: reject the request without consulting subsequent authorizers
Required, with no default.</li>
</ul>
</td>
</tr>
<tr><td><code>connectionInfo</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-WebhookConnectionInfo"><code>WebhookConnectionInfo</code></a>
</td>
<td>
<p>ConnectionInfo defines how we talk to the webhook</p>
</td>
</tr>
<tr><td><code>matchConditions</code> <B>[Required]</B><br/>
<a href="#apiserver-k8s-io-v1alpha1-WebhookMatchCondition"><code>[]WebhookMatchCondition</code></a>
</td>
<td>
<p>matchConditions is a list of conditions that must be met for a request to be sent to this
webhook. An empty list of matchConditions matches all requests.
There are a maximum of 64 match conditions allowed.</p>
<p>The exact matching logic is (in order):</p>
<ol>
<li>If at least one matchCondition evaluates to FALSE, then the webhook is skipped.</li>
<li>If ALL matchConditions evaluate to TRUE, then the webhook is called.</li>
<li>If at least one matchCondition evaluates to an error (but none are FALSE):
<ul>
<li>If failurePolicy=Deny, then the webhook rejects the request</li>
<li>If failurePolicy=NoOpinion, then the error is ignored and the webhook is skipped</li>
</ul>
</li>
</ol>
</td>
</tr>
</tbody>
</table>
## `WebhookConnectionInfo` {#apiserver-k8s-io-v1alpha1-WebhookConnectionInfo}
**Appears in:**
- [WebhookConfiguration](#apiserver-k8s-io-v1alpha1-WebhookConfiguration)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>type</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Controls how the webhook should communicate with the server.
Valid values:</p>
<ul>
<li>KubeConfigFile: use the file specified in kubeConfigFile to locate the
server.</li>
<li>InClusterConfig: use the in-cluster configuration to call the
SubjectAccessReview API hosted by kube-apiserver. This mode is not
allowed for kube-apiserver.</li>
</ul>
</td>
</tr>
<tr><td><code>kubeConfigFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Path to KubeConfigFile for connection info
Required, if connectionInfo.Type is KubeConfig</p>
</td>
</tr>
</tbody>
</table>
## `WebhookMatchCondition` {#apiserver-k8s-io-v1alpha1-WebhookMatchCondition}
**Appears in:**
- [WebhookConfiguration](#apiserver-k8s-io-v1alpha1-WebhookConfiguration)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>expression</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>expression represents the expression which will be evaluated by CEL. Must evaluate to bool.
CEL expressions have access to the contents of the SubjectAccessReview in v1 version.
If version specified by subjectAccessReviewVersion in the request variable is v1beta1,
the contents would be converted to the v1 version before evaluating the CEL expression.</p>
<p>Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title kube apiserver Configuration v1alpha1 content type tool reference package apiserver k8s io v1alpha1 auto generated true p Package v1alpha1 is the v1alpha1 version of the API p Resource Types AdmissionConfiguration apiserver k8s io v1alpha1 AdmissionConfiguration AuthenticationConfiguration apiserver k8s io v1alpha1 AuthenticationConfiguration AuthorizationConfiguration apiserver k8s io v1alpha1 AuthorizationConfiguration EgressSelectorConfiguration apiserver k8s io v1alpha1 EgressSelectorConfiguration TracingConfiguration apiserver k8s io v1alpha1 TracingConfiguration TracingConfiguration TracingConfiguration Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration TracingConfiguration apiserver k8s io v1alpha1 TracingConfiguration p TracingConfiguration provides versioned configuration for OpenTelemetry tracing clients p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code endpoint code br code string code td td p Endpoint of the collector this component will report traces to The connection is insecure and does not currently support TLS Recommended is unset and endpoint is the otlp grpc default localhost 4317 p td tr tr td code samplingRatePerMillion code br code int32 code td td p SamplingRatePerMillion is the number of samples to collect per million spans Recommended is unset If unset sampler respects its parent span s sampling rate but otherwise never samples p td tr tbody table AdmissionConfiguration apiserver k8s io v1alpha1 AdmissionConfiguration p AdmissionConfiguration provides versioned configuration for admission controllers p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code apiserver k8s io v1alpha1 code td tr tr td code kind code br string td td code AdmissionConfiguration code td tr tr td code plugins code br a href apiserver k8s io v1alpha1 AdmissionPluginConfiguration code AdmissionPluginConfiguration code a td td p Plugins allows specifying a configuration per admission control plugin p td tr tbody table AuthenticationConfiguration apiserver k8s io v1alpha1 AuthenticationConfiguration p AuthenticationConfiguration provides versioned configuration for authentication p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code apiserver k8s io v1alpha1 code td tr tr td code kind code br string td td code AuthenticationConfiguration code td tr tr td code jwt code B Required B br a href apiserver k8s io v1alpha1 JWTAuthenticator code JWTAuthenticator code a td td p jwt is a list of authenticator to authenticate Kubernetes users using JWT compliant tokens The authenticator will attempt to parse a raw ID token verify it s been signed by the configured issuer The public key to verify the signature is discovered from the issuer s public endpoint using OIDC discovery For an incoming token each JWT authenticator will be attempted in the order in which it is specified in this list Note however that other authenticators may run before or after the JWT authenticators The specific position of JWT authenticators in relation to other authenticators is neither defined nor stable across releases Since each JWT authenticator must have a unique issuer URL at most one JWT authenticator will attempt to cryptographically validate the token p p The minimum valid JWT payload must contain the following claims quot iss quot quot https issuer example com quot quot aud quot quot audience quot quot exp quot 1234567890 quot raw HTML omitted quot quot username quot p td tr tr td code anonymous code B Required B br a href apiserver k8s io v1alpha1 AnonymousAuthConfig code AnonymousAuthConfig code a td td p If present anonymous auth must not be set p td tr tbody table AuthorizationConfiguration apiserver k8s io v1alpha1 AuthorizationConfiguration table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code apiserver k8s io v1alpha1 code td tr tr td code kind code br string td td code AuthorizationConfiguration code td tr tr td code authorizers code B Required B br a href apiserver k8s io v1alpha1 AuthorizerConfiguration code AuthorizerConfiguration code a td td p Authorizers is an ordered list of authorizers to authorize requests against This is similar to the authorization modes kube apiserver flag Must be at least one p td tr tbody table EgressSelectorConfiguration apiserver k8s io v1alpha1 EgressSelectorConfiguration p EgressSelectorConfiguration provides versioned configuration for egress selector clients p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code apiserver k8s io v1alpha1 code td tr tr td code kind code br string td td code EgressSelectorConfiguration code td tr tr td code egressSelections code B Required B br a href apiserver k8s io v1alpha1 EgressSelection code EgressSelection code a td td p connectionServices contains a list of egress selection client configurations p td tr tbody table TracingConfiguration apiserver k8s io v1alpha1 TracingConfiguration p TracingConfiguration provides versioned configuration for tracing clients p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code apiserver k8s io v1alpha1 code td tr tr td code kind code br string td td code TracingConfiguration code td tr tr td code TracingConfiguration code B Required B br a href TracingConfiguration code TracingConfiguration code a td td Members of code TracingConfiguration code are embedded into this type p Embed the component config tracing configuration struct p td tr tbody table AdmissionPluginConfiguration apiserver k8s io v1alpha1 AdmissionPluginConfiguration Appears in AdmissionConfiguration apiserver k8s io v1alpha1 AdmissionConfiguration p AdmissionPluginConfiguration provides the configuration for a single plug in p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code name code B Required B br code string code td td p Name is the name of the admission controller It must match the registered admission plugin name p td tr tr td code path code br code string code td td p Path is the path to a configuration file that contains the plugin s configuration p td tr tr td code configuration code br a href https pkg go dev k8s io apimachinery pkg runtime Unknown code k8s io apimachinery pkg runtime Unknown code a td td p Configuration is an embedded configuration object to be used as the plugin s configuration If present it will be used instead of the path to the configuration file p td tr tbody table AnonymousAuthCondition apiserver k8s io v1alpha1 AnonymousAuthCondition Appears in AnonymousAuthConfig apiserver k8s io v1alpha1 AnonymousAuthConfig p AnonymousAuthCondition describes the condition under which anonymous auth should be enabled p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code path code B Required B br code string code td td p Path for which anonymous auth is enabled p td tr tbody table AnonymousAuthConfig apiserver k8s io v1alpha1 AnonymousAuthConfig Appears in AuthenticationConfiguration apiserver k8s io v1alpha1 AuthenticationConfiguration p AnonymousAuthConfig provides the configuration for the anonymous authenticator p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code enabled code B Required B br code bool code td td span class text muted No description provided span td tr tr td code conditions code B Required B br a href apiserver k8s io v1alpha1 AnonymousAuthCondition code AnonymousAuthCondition code a td td p If set anonymous auth is only allowed if the request meets one of the conditions p td tr tbody table AudienceMatchPolicyType apiserver k8s io v1alpha1 AudienceMatchPolicyType Alias of string Appears in Issuer apiserver k8s io v1alpha1 Issuer p AudienceMatchPolicyType is a set of valid values for issuer audienceMatchPolicy p AuthorizerConfiguration apiserver k8s io v1alpha1 AuthorizerConfiguration Appears in AuthorizationConfiguration apiserver k8s io v1alpha1 AuthorizationConfiguration table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code type code B Required B br code string code td td p Type refers to the type of the authorizer quot Webhook quot is supported in the generic API server Other API servers may support additional authorizer types like Node RBAC ABAC etc p td tr tr td code name code B Required B br code string code td td p Name used to describe the webhook This is explicitly used in monitoring machinery for metrics Note Names must be DNS1123 labels like code myauthorizername code or subdomains like code myauthorizer example domain code Required with no default p td tr tr td code webhook code B Required B br a href apiserver k8s io v1alpha1 WebhookConfiguration code WebhookConfiguration code a td td p Webhook defines the configuration for a Webhook authorizer Must be defined when Type Webhook Must not be defined when Type Webhook p td tr tbody table ClaimMappings apiserver k8s io v1alpha1 ClaimMappings Appears in JWTAuthenticator apiserver k8s io v1alpha1 JWTAuthenticator p ClaimMappings provides the configuration for claim mapping p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code username code B Required B br a href apiserver k8s io v1alpha1 PrefixedClaimOrExpression code PrefixedClaimOrExpression code a td td p username represents an option for the username attribute The claim s value must be a singular string Same as the oidc username claim and oidc username prefix flags If username expression is set the expression must produce a string value If username expression uses claims email then claims email verified must be used in username expression or extra em valueExpression or claimValidationRules em expression An example claim validation rule expression that matches the validation automatically applied when username claim is set to email is claims email verified orValue true p p In the flag based approach the oidc username claim and oidc username prefix are optional If oidc username claim is not set the default value is quot sub quot For the authentication config there is no defaulting for claim or prefix The claim and prefix must be set explicitly For claim if oidc username claim was not set with legacy flag approach configure username claim quot sub quot in the authentication config For prefix 1 oidc username prefix quot quot no prefix was added to the username For the same behavior using authentication config set username prefix quot quot 2 oidc username prefix quot quot and oidc username claim quot email quot prefix was quot lt value of oidc issuer url gt quot For the same behavior using authentication config set username prefix quot raw HTML omitted quot 3 oidc username prefix quot raw HTML omitted quot For the same behavior using authentication config set username prefix quot raw HTML omitted quot p td tr tr td code groups code br a href apiserver k8s io v1alpha1 PrefixedClaimOrExpression code PrefixedClaimOrExpression code a td td p groups represents an option for the groups attribute The claim s value must be a string or string array claim If groups claim is set the prefix must be specified and can be the empty string If groups expression is set the expression must produce a string or string array value quot quot and null values are treated as the group mapping not being present p td tr tr td code uid code br a href apiserver k8s io v1alpha1 ClaimOrExpression code ClaimOrExpression code a td td p uid represents an option for the uid attribute Claim must be a singular string claim If uid expression is set the expression must produce a string value p td tr tr td code extra code br a href apiserver k8s io v1alpha1 ExtraMapping code ExtraMapping code a td td p extra represents an option for the extra attribute expression must produce a string or string array value If the value is empty the extra mapping will not be present p p hard coded extra key value p ul li key quot foo quot valueExpression quot bar quot This will result in an extra attribute foo quot bar quot li ul p hard coded key value copying claim value p ul li key quot foo quot valueExpression quot claims some claim quot This will result in an extra attribute foo value of some claim li ul p hard coded key value derived from claim value p ul li key quot admin quot valueExpression has claims is admin amp amp claims is admin quot true quot quot quot This will result in li li if is admin claim is present and true extra attribute admin quot true quot li li if is admin claim is present and false or is admin claim is not present no extra attribute will be added li ul td tr tbody table ClaimOrExpression apiserver k8s io v1alpha1 ClaimOrExpression Appears in ClaimMappings apiserver k8s io v1alpha1 ClaimMappings p ClaimOrExpression provides the configuration for a single claim or expression p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code claim code br code string code td td p claim is the JWT claim to use Either claim or expression must be set Mutually exclusive with expression p td tr tr td code expression code br code string code td td p expression represents the expression which will be evaluated by CEL p p CEL expressions have access to the contents of the token claims organized into CEL variable p ul li claims is a map of claim names to claim values For example a variable named sub can be accessed as claims sub Nested claims can be accessed using dot notation e g claims foo bar li ul p Documentation on CEL https kubernetes io docs reference using api cel p p Mutually exclusive with claim p td tr tbody table ClaimValidationRule apiserver k8s io v1alpha1 ClaimValidationRule Appears in JWTAuthenticator apiserver k8s io v1alpha1 JWTAuthenticator p ClaimValidationRule provides the configuration for a single claim validation rule p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code claim code br code string code td td p claim is the name of a required claim Same as oidc required claim flag Only string claim keys are supported Mutually exclusive with expression and message p td tr tr td code requiredValue code br code string code td td p requiredValue is the value of a required claim Same as oidc required claim flag Only string claim values are supported If claim is set and requiredValue is not set the claim must be present with a value set to the empty string Mutually exclusive with expression and message p td tr tr td code expression code br code string code td td p expression represents the expression which will be evaluated by CEL Must produce a boolean p p CEL expressions have access to the contents of the token claims organized into CEL variable p ul li claims is a map of claim names to claim values For example a variable named sub can be accessed as claims sub Nested claims can be accessed using dot notation e g claims foo bar Must return true for the validation to pass li ul p Documentation on CEL https kubernetes io docs reference using api cel p p Mutually exclusive with claim and requiredValue p td tr tr td code message code br code string code td td p message customizes the returned error message when expression returns false message is a literal string Mutually exclusive with claim and requiredValue p td tr tbody table Connection apiserver k8s io v1alpha1 Connection Appears in EgressSelection apiserver k8s io v1alpha1 EgressSelection p Connection provides the configuration for a single egress selection client p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code proxyProtocol code B Required B br a href apiserver k8s io v1alpha1 ProtocolType code ProtocolType code a td td p Protocol is the protocol used to connect from client to the konnectivity server p td tr tr td code transport code br a href apiserver k8s io v1alpha1 Transport code Transport code a td td p Transport defines the transport configurations we use to dial to the konnectivity server This is required if ProxyProtocol is HTTPConnect or GRPC p td tr tbody table EgressSelection apiserver k8s io v1alpha1 EgressSelection Appears in EgressSelectorConfiguration apiserver k8s io v1alpha1 EgressSelectorConfiguration p EgressSelection provides the configuration for a single egress selection client p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code name code B Required B br code string code td td p name is the name of the egress selection Currently supported values are quot controlplane quot quot master quot quot etcd quot and quot cluster quot The quot master quot egress selector is deprecated in favor of quot controlplane quot p td tr tr td code connection code B Required B br a href apiserver k8s io v1alpha1 Connection code Connection code a td td p connection is the exact information used to configure the egress selection p td tr tbody table ExtraMapping apiserver k8s io v1alpha1 ExtraMapping Appears in ClaimMappings apiserver k8s io v1alpha1 ClaimMappings p ExtraMapping provides the configuration for a single extra mapping p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code key code B Required B br code string code td td p key is a string to use as the extra attribute key key must be a domain prefix path e g example org foo All characters before the first quot quot must be a valid subdomain as defined by RFC 1123 All characters trailing the first quot quot must be valid HTTP Path characters as defined by RFC 3986 key must be lowercase Required to be unique p td tr tr td code valueExpression code B Required B br code string code td td p valueExpression is a CEL expression to extract extra attribute value valueExpression must produce a string or string array value quot quot and null values are treated as the extra mapping not being present Empty string values contained within a string array are filtered out p p CEL expressions have access to the contents of the token claims organized into CEL variable p ul li claims is a map of claim names to claim values For example a variable named sub can be accessed as claims sub Nested claims can be accessed using dot notation e g claims foo bar li ul p Documentation on CEL https kubernetes io docs reference using api cel p td tr tbody table Issuer apiserver k8s io v1alpha1 Issuer Appears in JWTAuthenticator apiserver k8s io v1alpha1 JWTAuthenticator p Issuer provides the configuration for an external provider s specific settings p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code url code B Required B br code string code td td p url points to the issuer URL in a format https url or https url path This must match the quot iss quot claim in the presented JWT and the issuer returned from discovery Same value as the oidc issuer url flag Discovery information is fetched from quot url well known openid configuration quot unless overridden by discoveryURL Required to be unique across all JWT authenticators Note that egress selection configuration is not used for this network connection p td tr tr td code discoveryURL code br code string code td td p discoveryURL if specified overrides the URL used to fetch discovery information instead of using quot url well known openid configuration quot The exact value specified is used so quot well known openid configuration quot must be included in discoveryURL if needed p p The quot issuer quot field in the fetched discovery information must match the quot issuer url quot field in the AuthenticationConfiguration and will be used to validate the quot iss quot claim in the presented JWT This is for scenarios where the well known and jwks endpoints are hosted at a different location than the issuer such as locally in the cluster p p Example A discovery url that is exposed using kubernetes service oidc in namespace oidc namespace and discovery information is available at well known openid configuration discoveryURL quot https oidc oidc namespace well known openid configuration quot certificateAuthority is used to verify the TLS connection and the hostname on the leaf certificate must be set to oidc oidc namespace p p curl https oidc oidc namespace well known openid configuration discoveryURL field issuer quot https oidc example com quot url field p p discoveryURL must be different from url Required to be unique across all JWT authenticators Note that egress selection configuration is not used for this network connection p td tr tr td code certificateAuthority code br code string code td td p certificateAuthority contains PEM encoded certificate authority certificates used to validate the connection when fetching discovery information If unset the system verifier is used Same value as the content of the file referenced by the oidc ca file flag p td tr tr td code audiences code B Required B br code string code td td p audiences is the set of acceptable audiences the JWT must be issued to At least one of the entries must match the quot aud quot claim in presented JWTs Same value as the oidc client id flag though this field supports an array Required to be non empty p td tr tr td code audienceMatchPolicy code br a href apiserver k8s io v1alpha1 AudienceMatchPolicyType code AudienceMatchPolicyType code a td td p audienceMatchPolicy defines how the quot audiences quot field is used to match the quot aud quot claim in the presented JWT Allowed values are p ol li quot MatchAny quot when multiple audiences are specified and li li empty or unset or quot MatchAny quot when a single audience is specified li ol ul li p MatchAny the quot aud quot claim in the presented JWT must match at least one of the entries in the quot audiences quot field For example if quot audiences quot is quot foo quot quot bar quot the quot aud quot claim in the presented JWT must contain either quot foo quot or quot bar quot and may contain both p li li p quot quot The match policy can be empty or unset when a single audience is specified in the quot audiences quot field The quot aud quot claim in the presented JWT must contain the single audience and may contain others p li ul p For more nuanced audience validation use claimValidationRules example claimValidationRule expression sets equivalent claims aud quot bar quot quot foo quot quot baz quot to require an exact match p td tr tbody table JWTAuthenticator apiserver k8s io v1alpha1 JWTAuthenticator Appears in AuthenticationConfiguration apiserver k8s io v1alpha1 AuthenticationConfiguration p JWTAuthenticator provides the configuration for a single JWT authenticator p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code issuer code B Required B br a href apiserver k8s io v1alpha1 Issuer code Issuer code a td td p issuer contains the basic OIDC provider connection options p td tr tr td code claimValidationRules code br a href apiserver k8s io v1alpha1 ClaimValidationRule code ClaimValidationRule code a td td p claimValidationRules are rules that are applied to validate token claims to authenticate users p td tr tr td code claimMappings code B Required B br a href apiserver k8s io v1alpha1 ClaimMappings code ClaimMappings code a td td p claimMappings points claims of a token to be treated as user attributes p td tr tr td code userValidationRules code br a href apiserver k8s io v1alpha1 UserValidationRule code UserValidationRule code a td td p userValidationRules are rules that are applied to final user before completing authentication These allow invariants to be applied to incoming identities such as preventing the use of the system prefix that is commonly used by Kubernetes components The validation rules are logically ANDed together and must all return true for the validation to pass p td tr tbody table PrefixedClaimOrExpression apiserver k8s io v1alpha1 PrefixedClaimOrExpression Appears in ClaimMappings apiserver k8s io v1alpha1 ClaimMappings p PrefixedClaimOrExpression provides the configuration for a single prefixed claim or expression p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code claim code br code string code td td p claim is the JWT claim to use Mutually exclusive with expression p td tr tr td code prefix code br code string code td td p prefix is prepended to claim s value to prevent clashes with existing names prefix needs to be set if claim is set and can be the empty string Mutually exclusive with expression p td tr tr td code expression code br code string code td td p expression represents the expression which will be evaluated by CEL p p CEL expressions have access to the contents of the token claims organized into CEL variable p ul li claims is a map of claim names to claim values For example a variable named sub can be accessed as claims sub Nested claims can be accessed using dot notation e g claims foo bar li ul p Documentation on CEL https kubernetes io docs reference using api cel p p Mutually exclusive with claim and prefix p td tr tbody table ProtocolType apiserver k8s io v1alpha1 ProtocolType Alias of string Appears in Connection apiserver k8s io v1alpha1 Connection p ProtocolType is a set of valid values for Connection ProtocolType p TCPTransport apiserver k8s io v1alpha1 TCPTransport Appears in Transport apiserver k8s io v1alpha1 Transport p TCPTransport provides the information to connect to konnectivity server via TCP p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code url code B Required B br code string code td td p URL is the location of the konnectivity server to connect to As an example it might be quot https 127 0 0 1 8131 quot p td tr tr td code tlsConfig code br a href apiserver k8s io v1alpha1 TLSConfig code TLSConfig code a td td p TLSConfig is the config needed to use TLS when connecting to konnectivity server p td tr tbody table TLSConfig apiserver k8s io v1alpha1 TLSConfig Appears in TCPTransport apiserver k8s io v1alpha1 TCPTransport p TLSConfig provides the authentication information to connect to konnectivity server Only used with TCPTransport p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code caBundle code br code string code td td p caBundle is the file location of the CA to be used to determine trust with the konnectivity server Must be absent empty if TCPTransport URL is prefixed with http If absent while TCPTransport URL is prefixed with https default to system trust roots p td tr tr td code clientKey code br code string code td td p clientKey is the file location of the client key to be used in mtls handshakes with the konnectivity server Must be absent empty if TCPTransport URL is prefixed with http Must be configured if TCPTransport URL is prefixed with https p td tr tr td code clientCert code br code string code td td p clientCert is the file location of the client certificate to be used in mtls handshakes with the konnectivity server Must be absent empty if TCPTransport URL is prefixed with http Must be configured if TCPTransport URL is prefixed with https p td tr tbody table Transport apiserver k8s io v1alpha1 Transport Appears in Connection apiserver k8s io v1alpha1 Connection p Transport defines the transport configurations we use to dial to the konnectivity server p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code tcp code br a href apiserver k8s io v1alpha1 TCPTransport code TCPTransport code a td td p TCP is the TCP configuration for communicating with the konnectivity server via TCP ProxyProtocol of GRPC is not supported with TCP transport at the moment Requires at least one of TCP or UDS to be set p td tr tr td code uds code br a href apiserver k8s io v1alpha1 UDSTransport code UDSTransport code a td td p UDS is the UDS configuration for communicating with the konnectivity server via UDS Requires at least one of TCP or UDS to be set p td tr tbody table UDSTransport apiserver k8s io v1alpha1 UDSTransport Appears in Transport apiserver k8s io v1alpha1 Transport p UDSTransport provides the information to connect to konnectivity server via UDS p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code udsName code B Required B br code string code td td p UDSName is the name of the unix domain socket to connect to konnectivity server This does not use a unix prefix Eg etc srv kubernetes konnectivity server konnectivity server socket p td tr tbody table UserValidationRule apiserver k8s io v1alpha1 UserValidationRule Appears in JWTAuthenticator apiserver k8s io v1alpha1 JWTAuthenticator p UserValidationRule provides the configuration for a single user info validation rule p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code expression code B Required B br code string code td td p expression represents the expression which will be evaluated by CEL Must return true for the validation to pass p p CEL expressions have access to the contents of UserInfo organized into CEL variable p ul li user authentication k8s io v1 Kind UserInfo object Refer to https github com kubernetes api blob release 1 28 authentication v1 types go L105 L122 for the definition API documentation https kubernetes io docs reference generated kubernetes api v1 28 userinfo v1 authentication k8s io li ul p Documentation on CEL https kubernetes io docs reference using api cel p td tr tr td code message code br code string code td td p message customizes the returned error message when rule returns false message is a literal string p td tr tbody table WebhookConfiguration apiserver k8s io v1alpha1 WebhookConfiguration Appears in AuthorizerConfiguration apiserver k8s io v1alpha1 AuthorizerConfiguration table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code authorizedTTL code B Required B br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p The duration to cache authorized responses from the webhook authorizer Same as setting code authorization webhook cache authorized ttl code flag Default 5m0s p td tr tr td code unauthorizedTTL code B Required B br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p The duration to cache unauthorized responses from the webhook authorizer Same as setting code authorization webhook cache unauthorized ttl code flag Default 30s p td tr tr td code timeout code B Required B br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p Timeout for the webhook request Maximum allowed value is 30s Required no default value p td tr tr td code subjectAccessReviewVersion code B Required B br code string code td td p The API version of the authorization k8s io SubjectAccessReview to send to and expect from the webhook Same as setting code authorization webhook version code flag Valid values v1beta1 v1 Required no default value p td tr tr td code matchConditionSubjectAccessReviewVersion code B Required B br code string code td td p MatchConditionSubjectAccessReviewVersion specifies the SubjectAccessReview version the CEL expressions are evaluated against Valid values v1 Required no default value p td tr tr td code failurePolicy code B Required B br code string code td td p Controls the authorization decision when a webhook request fails to complete or returns a malformed response or errors evaluating matchConditions Valid values p ul li NoOpinion continue to subsequent authorizers to see if one of them allows the request li li Deny reject the request without consulting subsequent authorizers Required with no default li ul td tr tr td code connectionInfo code B Required B br a href apiserver k8s io v1alpha1 WebhookConnectionInfo code WebhookConnectionInfo code a td td p ConnectionInfo defines how we talk to the webhook p td tr tr td code matchConditions code B Required B br a href apiserver k8s io v1alpha1 WebhookMatchCondition code WebhookMatchCondition code a td td p matchConditions is a list of conditions that must be met for a request to be sent to this webhook An empty list of matchConditions matches all requests There are a maximum of 64 match conditions allowed p p The exact matching logic is in order p ol li If at least one matchCondition evaluates to FALSE then the webhook is skipped li li If ALL matchConditions evaluate to TRUE then the webhook is called li li If at least one matchCondition evaluates to an error but none are FALSE ul li If failurePolicy Deny then the webhook rejects the request li li If failurePolicy NoOpinion then the error is ignored and the webhook is skipped li ul li ol td tr tbody table WebhookConnectionInfo apiserver k8s io v1alpha1 WebhookConnectionInfo Appears in WebhookConfiguration apiserver k8s io v1alpha1 WebhookConfiguration table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code type code B Required B br code string code td td p Controls how the webhook should communicate with the server Valid values p ul li KubeConfigFile use the file specified in kubeConfigFile to locate the server li li InClusterConfig use the in cluster configuration to call the SubjectAccessReview API hosted by kube apiserver This mode is not allowed for kube apiserver li ul td tr tr td code kubeConfigFile code B Required B br code string code td td p Path to KubeConfigFile for connection info Required if connectionInfo Type is KubeConfig p td tr tbody table WebhookMatchCondition apiserver k8s io v1alpha1 WebhookMatchCondition Appears in WebhookConfiguration apiserver k8s io v1alpha1 WebhookConfiguration table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code expression code B Required B br code string code td td p expression represents the expression which will be evaluated by CEL Must evaluate to bool CEL expressions have access to the contents of the SubjectAccessReview in v1 version If version specified by subjectAccessReviewVersion in the request variable is v1beta1 the contents would be converted to the v1 version before evaluating the CEL expression p p Documentation on CEL https kubernetes io docs reference using api cel p td tr tbody table |
kubernetes reference package imagepolicy k8s io v1alpha1 contenttype tool reference Resource Types title Image Policy API v1alpha1 autogenerated true | ---
title: Image Policy API (v1alpha1)
content_type: tool-reference
package: imagepolicy.k8s.io/v1alpha1
auto_generated: true
---
## Resource Types
- [ImageReview](#imagepolicy-k8s-io-v1alpha1-ImageReview)
## `ImageReview` {#imagepolicy-k8s-io-v1alpha1-ImageReview}
<p>ImageReview checks if the set of images in a pod are allowed.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>imagepolicy.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>ImageReview</code></td></tr>
<tr><td><code>metadata</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a>
</td>
<td>
<p>Standard object's metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</p>
Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.</td>
</tr>
<tr><td><code>spec</code> <B>[Required]</B><br/>
<a href="#imagepolicy-k8s-io-v1alpha1-ImageReviewSpec"><code>ImageReviewSpec</code></a>
</td>
<td>
<p>Spec holds information about the pod being evaluated</p>
</td>
</tr>
<tr><td><code>status</code><br/>
<a href="#imagepolicy-k8s-io-v1alpha1-ImageReviewStatus"><code>ImageReviewStatus</code></a>
</td>
<td>
<p>Status is filled in by the backend and indicates whether the pod should be allowed.</p>
</td>
</tr>
</tbody>
</table>
## `ImageReviewContainerSpec` {#imagepolicy-k8s-io-v1alpha1-ImageReviewContainerSpec}
**Appears in:**
- [ImageReviewSpec](#imagepolicy-k8s-io-v1alpha1-ImageReviewSpec)
<p>ImageReviewContainerSpec is a description of a container within the pod creation request.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>image</code><br/>
<code>string</code>
</td>
<td>
<p>This can be in the form image:tag or image@SHA:012345679abcdef.</p>
</td>
</tr>
</tbody>
</table>
## `ImageReviewSpec` {#imagepolicy-k8s-io-v1alpha1-ImageReviewSpec}
**Appears in:**
- [ImageReview](#imagepolicy-k8s-io-v1alpha1-ImageReview)
<p>ImageReviewSpec is a description of the pod creation request.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>containers</code><br/>
<a href="#imagepolicy-k8s-io-v1alpha1-ImageReviewContainerSpec"><code>[]ImageReviewContainerSpec</code></a>
</td>
<td>
<p>Containers is a list of a subset of the information in each container of the Pod being created.</p>
</td>
</tr>
<tr><td><code>annotations</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>Annotations is a list of key-value pairs extracted from the Pod's annotations.
It only includes keys which match the pattern <code>*.image-policy.k8s.io/*</code>.
It is up to each webhook backend to determine how to interpret these annotations, if at all.</p>
</td>
</tr>
<tr><td><code>namespace</code><br/>
<code>string</code>
</td>
<td>
<p>Namespace is the namespace the pod is being created in.</p>
</td>
</tr>
</tbody>
</table>
## `ImageReviewStatus` {#imagepolicy-k8s-io-v1alpha1-ImageReviewStatus}
**Appears in:**
- [ImageReview](#imagepolicy-k8s-io-v1alpha1-ImageReview)
<p>ImageReviewStatus is the result of the review for the pod creation request.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>allowed</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>Allowed indicates that all images were allowed to be run.</p>
</td>
</tr>
<tr><td><code>reason</code><br/>
<code>string</code>
</td>
<td>
<p>Reason should be empty unless Allowed is false in which case it
may contain a short description of what is wrong. Kubernetes
may truncate excessively long errors when displaying to the user.</p>
</td>
</tr>
<tr><td><code>auditAnnotations</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>AuditAnnotations will be added to the attributes object of the
admission controller request using 'AddAnnotation'. The keys should
be prefix-less (i.e., the admission controller will add an
appropriate prefix).</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title Image Policy API v1alpha1 content type tool reference package imagepolicy k8s io v1alpha1 auto generated true Resource Types ImageReview imagepolicy k8s io v1alpha1 ImageReview ImageReview imagepolicy k8s io v1alpha1 ImageReview p ImageReview checks if the set of images in a pod are allowed p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code imagepolicy k8s io v1alpha1 code td tr tr td code kind code br string td td code ImageReview code td tr tr td code metadata code br a href https kubernetes io docs reference generated kubernetes api v1 31 objectmeta v1 meta code meta v1 ObjectMeta code a td td p Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata p Refer to the Kubernetes API documentation for the fields of the code metadata code field td tr tr td code spec code B Required B br a href imagepolicy k8s io v1alpha1 ImageReviewSpec code ImageReviewSpec code a td td p Spec holds information about the pod being evaluated p td tr tr td code status code br a href imagepolicy k8s io v1alpha1 ImageReviewStatus code ImageReviewStatus code a td td p Status is filled in by the backend and indicates whether the pod should be allowed p td tr tbody table ImageReviewContainerSpec imagepolicy k8s io v1alpha1 ImageReviewContainerSpec Appears in ImageReviewSpec imagepolicy k8s io v1alpha1 ImageReviewSpec p ImageReviewContainerSpec is a description of a container within the pod creation request p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code image code br code string code td td p This can be in the form image tag or image SHA 012345679abcdef p td tr tbody table ImageReviewSpec imagepolicy k8s io v1alpha1 ImageReviewSpec Appears in ImageReview imagepolicy k8s io v1alpha1 ImageReview p ImageReviewSpec is a description of the pod creation request p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code containers code br a href imagepolicy k8s io v1alpha1 ImageReviewContainerSpec code ImageReviewContainerSpec code a td td p Containers is a list of a subset of the information in each container of the Pod being created p td tr tr td code annotations code br code map string string code td td p Annotations is a list of key value pairs extracted from the Pod s annotations It only includes keys which match the pattern code image policy k8s io code It is up to each webhook backend to determine how to interpret these annotations if at all p td tr tr td code namespace code br code string code td td p Namespace is the namespace the pod is being created in p td tr tbody table ImageReviewStatus imagepolicy k8s io v1alpha1 ImageReviewStatus Appears in ImageReview imagepolicy k8s io v1alpha1 ImageReview p ImageReviewStatus is the result of the review for the pod creation request p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code allowed code B Required B br code bool code td td p Allowed indicates that all images were allowed to be run p td tr tr td code reason code br code string code td td p Reason should be empty unless Allowed is false in which case it may contain a short description of what is wrong Kubernetes may truncate excessively long errors when displaying to the user p td tr tr td code auditAnnotations code br code map string string code td td p AuditAnnotations will be added to the attributes object of the admission controller request using AddAnnotation The keys should be prefix less i e the admission controller will add an appropriate prefix p td tr tbody table |
kubernetes reference p Package v1 is the v1 version of the API p contenttype tool reference title kube apiserver Configuration v1 Resource Types package apiserver config k8s io v1 autogenerated true | ---
title: kube-apiserver Configuration (v1)
content_type: tool-reference
package: apiserver.config.k8s.io/v1
auto_generated: true
---
<p>Package v1 is the v1 version of the API.</p>
## Resource Types
- [AdmissionConfiguration](#apiserver-config-k8s-io-v1-AdmissionConfiguration)
- [EncryptionConfiguration](#apiserver-config-k8s-io-v1-EncryptionConfiguration)
## `AdmissionConfiguration` {#apiserver-config-k8s-io-v1-AdmissionConfiguration}
<p>AdmissionConfiguration provides versioned configuration for admission controllers.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>AdmissionConfiguration</code></td></tr>
<tr><td><code>plugins</code><br/>
<a href="#apiserver-config-k8s-io-v1-AdmissionPluginConfiguration"><code>[]AdmissionPluginConfiguration</code></a>
</td>
<td>
<p>Plugins allows specifying a configuration per admission control plugin.</p>
</td>
</tr>
</tbody>
</table>
## `EncryptionConfiguration` {#apiserver-config-k8s-io-v1-EncryptionConfiguration}
<p>EncryptionConfiguration stores the complete configuration for encryption providers.
It also allows the use of wildcards to specify the resources that should be encrypted.
Use '*.<group>' to encrypt all resources within a group or '*.*' to encrypt all resources.
'*.' can be used to encrypt all resource in the core group. '*.*' will encrypt all
resources, even custom resources that are added after API server start.
Use of wildcards that overlap within the same resource list or across multiple
entries are not allowed since part of the configuration would be ineffective.
Resource lists are processed in order, with earlier lists taking precedence.</p>
<p>Example:</p>
<pre><code>kind: EncryptionConfiguration
apiVersion: apiserver.config.k8s.io/v1
resources:
- resources:
- events
providers:
- identity: {} # do not encrypt events even though *.* is specified below
- resources:
- secrets
- configmaps
- pandas.awesome.bears.example
providers:
- aescbc:
keys:
- name: key1
secret: c2VjcmV0IGlzIHNlY3VyZQ==
- resources:
- '*.apps'
providers:
- aescbc:
keys:
- name: key2
secret: c2VjcmV0IGlzIHNlY3VyZSwgb3IgaXMgaXQ/Cg==
- resources:
- '*.*'
providers:
- aescbc:
keys:
- name: key3
secret: c2VjcmV0IGlzIHNlY3VyZSwgSSB0aGluaw==</code></pre>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>EncryptionConfiguration</code></td></tr>
<tr><td><code>resources</code> <B>[Required]</B><br/>
<a href="#apiserver-config-k8s-io-v1-ResourceConfiguration"><code>[]ResourceConfiguration</code></a>
</td>
<td>
<p>resources is a list containing resources, and their corresponding encryption providers.</p>
</td>
</tr>
</tbody>
</table>
## `AESConfiguration` {#apiserver-config-k8s-io-v1-AESConfiguration}
**Appears in:**
- [ProviderConfiguration](#apiserver-config-k8s-io-v1-ProviderConfiguration)
<p>AESConfiguration contains the API configuration for an AES transformer.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>keys</code> <B>[Required]</B><br/>
<a href="#apiserver-config-k8s-io-v1-Key"><code>[]Key</code></a>
</td>
<td>
<p>keys is a list of keys to be used for creating the AES transformer.
Each key has to be 32 bytes long for AES-CBC and 16, 24 or 32 bytes for AES-GCM.</p>
</td>
</tr>
</tbody>
</table>
## `AdmissionPluginConfiguration` {#apiserver-config-k8s-io-v1-AdmissionPluginConfiguration}
**Appears in:**
- [AdmissionConfiguration](#apiserver-config-k8s-io-v1-AdmissionConfiguration)
<p>AdmissionPluginConfiguration provides the configuration for a single plug-in.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>name</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Name is the name of the admission controller.
It must match the registered admission plugin name.</p>
</td>
</tr>
<tr><td><code>path</code><br/>
<code>string</code>
</td>
<td>
<p>Path is the path to a configuration file that contains the plugin's
configuration</p>
</td>
</tr>
<tr><td><code>configuration</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#Unknown"><code>k8s.io/apimachinery/pkg/runtime.Unknown</code></a>
</td>
<td>
<p>Configuration is an embedded configuration object to be used as the plugin's
configuration. If present, it will be used instead of the path to the configuration file.</p>
</td>
</tr>
</tbody>
</table>
## `IdentityConfiguration` {#apiserver-config-k8s-io-v1-IdentityConfiguration}
**Appears in:**
- [ProviderConfiguration](#apiserver-config-k8s-io-v1-ProviderConfiguration)
<p>IdentityConfiguration is an empty struct to allow identity transformer in provider configuration.</p>
## `KMSConfiguration` {#apiserver-config-k8s-io-v1-KMSConfiguration}
**Appears in:**
- [ProviderConfiguration](#apiserver-config-k8s-io-v1-ProviderConfiguration)
<p>KMSConfiguration contains the name, cache size and path to configuration file for a KMS based envelope transformer.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>
<code>string</code>
</td>
<td>
<p>apiVersion of KeyManagementService</p>
</td>
</tr>
<tr><td><code>name</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>name is the name of the KMS plugin to be used.</p>
</td>
</tr>
<tr><td><code>cachesize</code><br/>
<code>int32</code>
</td>
<td>
<p>cachesize is the maximum number of secrets which are cached in memory. The default value is 1000.
Set to a negative value to disable caching. This field is only allowed for KMS v1 providers.</p>
</td>
</tr>
<tr><td><code>endpoint</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>endpoint is the gRPC server listening address, for example "unix:///var/run/kms-provider.sock".</p>
</td>
</tr>
<tr><td><code>timeout</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p>timeout for gRPC calls to kms-plugin (ex. 5s). The default is 3 seconds.</p>
</td>
</tr>
</tbody>
</table>
## `Key` {#apiserver-config-k8s-io-v1-Key}
**Appears in:**
- [AESConfiguration](#apiserver-config-k8s-io-v1-AESConfiguration)
- [SecretboxConfiguration](#apiserver-config-k8s-io-v1-SecretboxConfiguration)
<p>Key contains name and secret of the provided key for a transformer.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>name</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>name is the name of the key to be used while storing data to disk.</p>
</td>
</tr>
<tr><td><code>secret</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>secret is the actual key, encoded in base64.</p>
</td>
</tr>
</tbody>
</table>
## `ProviderConfiguration` {#apiserver-config-k8s-io-v1-ProviderConfiguration}
**Appears in:**
- [ResourceConfiguration](#apiserver-config-k8s-io-v1-ResourceConfiguration)
<p>ProviderConfiguration stores the provided configuration for an encryption provider.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>aesgcm</code> <B>[Required]</B><br/>
<a href="#apiserver-config-k8s-io-v1-AESConfiguration"><code>AESConfiguration</code></a>
</td>
<td>
<p>aesgcm is the configuration for the AES-GCM transformer.</p>
</td>
</tr>
<tr><td><code>aescbc</code> <B>[Required]</B><br/>
<a href="#apiserver-config-k8s-io-v1-AESConfiguration"><code>AESConfiguration</code></a>
</td>
<td>
<p>aescbc is the configuration for the AES-CBC transformer.</p>
</td>
</tr>
<tr><td><code>secretbox</code> <B>[Required]</B><br/>
<a href="#apiserver-config-k8s-io-v1-SecretboxConfiguration"><code>SecretboxConfiguration</code></a>
</td>
<td>
<p>secretbox is the configuration for the Secretbox based transformer.</p>
</td>
</tr>
<tr><td><code>identity</code> <B>[Required]</B><br/>
<a href="#apiserver-config-k8s-io-v1-IdentityConfiguration"><code>IdentityConfiguration</code></a>
</td>
<td>
<p>identity is the (empty) configuration for the identity transformer.</p>
</td>
</tr>
<tr><td><code>kms</code> <B>[Required]</B><br/>
<a href="#apiserver-config-k8s-io-v1-KMSConfiguration"><code>KMSConfiguration</code></a>
</td>
<td>
<p>kms contains the name, cache size and path to configuration file for a KMS based envelope transformer.</p>
</td>
</tr>
</tbody>
</table>
## `ResourceConfiguration` {#apiserver-config-k8s-io-v1-ResourceConfiguration}
**Appears in:**
- [EncryptionConfiguration](#apiserver-config-k8s-io-v1-EncryptionConfiguration)
<p>ResourceConfiguration stores per resource configuration.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>resources</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>resources is a list of kubernetes resources which have to be encrypted. The resource names are derived from <code>resource</code> or <code>resource.group</code> of the group/version/resource.
eg: pandas.awesome.bears.example is a custom resource with 'group': awesome.bears.example, 'resource': pandas.
Use '*.*' to encrypt all resources and '*.<group>' to encrypt all resources in a specific group.
eg: '*.awesome.bears.example' will encrypt all resources in the group 'awesome.bears.example'.
eg: '*.' will encrypt all resources in the core group (such as pods, configmaps, etc).</p>
</td>
</tr>
<tr><td><code>providers</code> <B>[Required]</B><br/>
<a href="#apiserver-config-k8s-io-v1-ProviderConfiguration"><code>[]ProviderConfiguration</code></a>
</td>
<td>
<p>providers is a list of transformers to be used for reading and writing the resources to disk.
eg: aesgcm, aescbc, secretbox, identity, kms.</p>
</td>
</tr>
</tbody>
</table>
## `SecretboxConfiguration` {#apiserver-config-k8s-io-v1-SecretboxConfiguration}
**Appears in:**
- [ProviderConfiguration](#apiserver-config-k8s-io-v1-ProviderConfiguration)
<p>SecretboxConfiguration contains the API configuration for an Secretbox transformer.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>keys</code> <B>[Required]</B><br/>
<a href="#apiserver-config-k8s-io-v1-Key"><code>[]Key</code></a>
</td>
<td>
<p>keys is a list of keys to be used for creating the Secretbox transformer.
Each key has to be 32 bytes long.</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title kube apiserver Configuration v1 content type tool reference package apiserver config k8s io v1 auto generated true p Package v1 is the v1 version of the API p Resource Types AdmissionConfiguration apiserver config k8s io v1 AdmissionConfiguration EncryptionConfiguration apiserver config k8s io v1 EncryptionConfiguration AdmissionConfiguration apiserver config k8s io v1 AdmissionConfiguration p AdmissionConfiguration provides versioned configuration for admission controllers p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code apiserver config k8s io v1 code td tr tr td code kind code br string td td code AdmissionConfiguration code td tr tr td code plugins code br a href apiserver config k8s io v1 AdmissionPluginConfiguration code AdmissionPluginConfiguration code a td td p Plugins allows specifying a configuration per admission control plugin p td tr tbody table EncryptionConfiguration apiserver config k8s io v1 EncryptionConfiguration p EncryptionConfiguration stores the complete configuration for encryption providers It also allows the use of wildcards to specify the resources that should be encrypted Use ast lt group gt to encrypt all resources within a group or ast ast to encrypt all resources ast can be used to encrypt all resource in the core group ast ast will encrypt all resources even custom resources that are added after API server start Use of wildcards that overlap within the same resource list or across multiple entries are not allowed since part of the configuration would be ineffective Resource lists are processed in order with earlier lists taking precedence p p Example p pre code kind EncryptionConfiguration apiVersion apiserver config k8s io v1 resources resources events providers identity do not encrypt events even though is specified below resources secrets configmaps pandas awesome bears example providers aescbc keys name key1 secret c2VjcmV0IGlzIHNlY3VyZQ resources apps providers aescbc keys name key2 secret c2VjcmV0IGlzIHNlY3VyZSwgb3IgaXMgaXQ Cg resources providers aescbc keys name key3 secret c2VjcmV0IGlzIHNlY3VyZSwgSSB0aGluaw code pre table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code apiserver config k8s io v1 code td tr tr td code kind code br string td td code EncryptionConfiguration code td tr tr td code resources code B Required B br a href apiserver config k8s io v1 ResourceConfiguration code ResourceConfiguration code a td td p resources is a list containing resources and their corresponding encryption providers p td tr tbody table AESConfiguration apiserver config k8s io v1 AESConfiguration Appears in ProviderConfiguration apiserver config k8s io v1 ProviderConfiguration p AESConfiguration contains the API configuration for an AES transformer p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code keys code B Required B br a href apiserver config k8s io v1 Key code Key code a td td p keys is a list of keys to be used for creating the AES transformer Each key has to be 32 bytes long for AES CBC and 16 24 or 32 bytes for AES GCM p td tr tbody table AdmissionPluginConfiguration apiserver config k8s io v1 AdmissionPluginConfiguration Appears in AdmissionConfiguration apiserver config k8s io v1 AdmissionConfiguration p AdmissionPluginConfiguration provides the configuration for a single plug in p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code name code B Required B br code string code td td p Name is the name of the admission controller It must match the registered admission plugin name p td tr tr td code path code br code string code td td p Path is the path to a configuration file that contains the plugin s configuration p td tr tr td code configuration code br a href https pkg go dev k8s io apimachinery pkg runtime Unknown code k8s io apimachinery pkg runtime Unknown code a td td p Configuration is an embedded configuration object to be used as the plugin s configuration If present it will be used instead of the path to the configuration file p td tr tbody table IdentityConfiguration apiserver config k8s io v1 IdentityConfiguration Appears in ProviderConfiguration apiserver config k8s io v1 ProviderConfiguration p IdentityConfiguration is an empty struct to allow identity transformer in provider configuration p KMSConfiguration apiserver config k8s io v1 KMSConfiguration Appears in ProviderConfiguration apiserver config k8s io v1 ProviderConfiguration p KMSConfiguration contains the name cache size and path to configuration file for a KMS based envelope transformer p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br code string code td td p apiVersion of KeyManagementService p td tr tr td code name code B Required B br code string code td td p name is the name of the KMS plugin to be used p td tr tr td code cachesize code br code int32 code td td p cachesize is the maximum number of secrets which are cached in memory The default value is 1000 Set to a negative value to disable caching This field is only allowed for KMS v1 providers p td tr tr td code endpoint code B Required B br code string code td td p endpoint is the gRPC server listening address for example quot unix var run kms provider sock quot p td tr tr td code timeout code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p timeout for gRPC calls to kms plugin ex 5s The default is 3 seconds p td tr tbody table Key apiserver config k8s io v1 Key Appears in AESConfiguration apiserver config k8s io v1 AESConfiguration SecretboxConfiguration apiserver config k8s io v1 SecretboxConfiguration p Key contains name and secret of the provided key for a transformer p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code name code B Required B br code string code td td p name is the name of the key to be used while storing data to disk p td tr tr td code secret code B Required B br code string code td td p secret is the actual key encoded in base64 p td tr tbody table ProviderConfiguration apiserver config k8s io v1 ProviderConfiguration Appears in ResourceConfiguration apiserver config k8s io v1 ResourceConfiguration p ProviderConfiguration stores the provided configuration for an encryption provider p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code aesgcm code B Required B br a href apiserver config k8s io v1 AESConfiguration code AESConfiguration code a td td p aesgcm is the configuration for the AES GCM transformer p td tr tr td code aescbc code B Required B br a href apiserver config k8s io v1 AESConfiguration code AESConfiguration code a td td p aescbc is the configuration for the AES CBC transformer p td tr tr td code secretbox code B Required B br a href apiserver config k8s io v1 SecretboxConfiguration code SecretboxConfiguration code a td td p secretbox is the configuration for the Secretbox based transformer p td tr tr td code identity code B Required B br a href apiserver config k8s io v1 IdentityConfiguration code IdentityConfiguration code a td td p identity is the empty configuration for the identity transformer p td tr tr td code kms code B Required B br a href apiserver config k8s io v1 KMSConfiguration code KMSConfiguration code a td td p kms contains the name cache size and path to configuration file for a KMS based envelope transformer p td tr tbody table ResourceConfiguration apiserver config k8s io v1 ResourceConfiguration Appears in EncryptionConfiguration apiserver config k8s io v1 EncryptionConfiguration p ResourceConfiguration stores per resource configuration p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code resources code B Required B br code string code td td p resources is a list of kubernetes resources which have to be encrypted The resource names are derived from code resource code or code resource group code of the group version resource eg pandas awesome bears example is a custom resource with group awesome bears example resource pandas Use ast ast to encrypt all resources and ast lt group gt to encrypt all resources in a specific group eg ast awesome bears example will encrypt all resources in the group awesome bears example eg ast will encrypt all resources in the core group such as pods configmaps etc p td tr tr td code providers code B Required B br a href apiserver config k8s io v1 ProviderConfiguration code ProviderConfiguration code a td td p providers is a list of transformers to be used for reading and writing the resources to disk eg aesgcm aescbc secretbox identity kms p td tr tbody table SecretboxConfiguration apiserver config k8s io v1 SecretboxConfiguration Appears in ProviderConfiguration apiserver config k8s io v1 ProviderConfiguration p SecretboxConfiguration contains the API configuration for an Secretbox transformer p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code keys code B Required B br a href apiserver config k8s io v1 Key code Key code a td td p keys is a list of keys to be used for creating the Secretbox transformer Each key has to be 32 bytes long p td tr tbody table |
kubernetes reference title kubeadm Configuration v1beta4 package kubeadm k8s io v1beta4 contenttype tool reference h2 Overview h2 p Package v1beta4 defines the v1beta4 version of the kubeadm configuration file format This version improves on the v1beta3 format by fixing some minor issues and adding a few new fields p p A list of changes since v1beta3 p autogenerated true | ---
title: kubeadm Configuration (v1beta4)
content_type: tool-reference
package: kubeadm.k8s.io/v1beta4
auto_generated: true
---
<h2>Overview</h2>
<p>Package v1beta4 defines the v1beta4 version of the kubeadm configuration file format.
This version improves on the v1beta3 format by fixing some minor issues and adding a few new fields.</p>
<p>A list of changes since v1beta3:</p>
<ul>
<li>TODO https://github.com/kubernetes/kubeadm/issues/2890</li>
<li>Support custom environment variables in control plane components under <code>ClusterConfiguration</code>.
Use <code>apiServer.extraEnvs</code>, <code>controllerManager.extraEnvs</code>, <code>scheduler.extraEnvs</code>,
<code>etcd.local.extraEnvs</code>.</li>
<li>The <code>ResetConfiguration</code> API type is now supported in v1beta4.
Users are able to reset a node by passing a <code>--config</code> file to <code>kubeadm reset</code>.</li>
<li>Dry run mode is now configureable in InitConfiguration and JoinConfiguration.</li>
<li>Replace the existing string/string extra argument maps with structured extra arguments
that support duplicates. The change applies to <code>ClusterConfiguration</code> - <code>apiServer.extraArgs</code>,
<code>controllerManager.extraArgs</code>, <code>scheduler.extraArgs</code>, <code>etcd.local.extraArgs</code>.
Also to <code>nodeRegistration.kubeletExtraArgs</code>.</li>
<li>Add <code>ClusterConfiguration.encryptionAlgorithm</code> that can be used to set the asymmetric
encryption algorithm used for this cluster's keys and certificates. Can be one of
<code>"RSA-2048"</code> (default), <code>"RSA-3072"</code>, <code>"RSA-4096"</code> or <code>"ECDSA-P256"</code>.</li>
<li>Add <code>ClusterConfiguration.dns.disabled</code> and <code>ClusterConfiguration.proxy.disabled</code>
that can be used to disable the CoreDNS and kube-proxy addons during cluster
initialization. Skipping the related addons phases, during cluster creation will
set the same fields to <code>false</code>.</li>
<li>Add the <code>nodeRegistration.imagePullSerial</code> field in <code>InitConfiguration</code> and <code>JoinConfiguration</code>, which
can be used to control if kubeadm pulls images serially or in parallel.</li>
<li>The <code>UpgradeConfiguration</code> kubeadm API is now supported in v1beta4 when passing
<code>--config</code> to <code>kubeadm upgrade</code> subcommands. Usage of component configuration for <code>kubelet</code> and <code>kube-proxy</code>,
<code>InitConfiguration</code> and <code>ClusterConfiguration</code> is deprecated and will be ignored when passing <code>--config</code> to
<code>upgrade</code> subcommands.</li>
<li>Add a <code>Timeouts</code> structure to <code>InitConfiguration</code>, <code>JoinConfiguration</code>, <code>ResetConfiguration</code> and <code>UpgradeConfiguration</code>
that can be used to configure various timeouts.</li>
<li>Add a <code>certificateValidityPeriod</code> and <code>caCertificateValidityPeriod</code> fields to <code>ClusterConfiguration</code>. These fields
can be used to control the validity period of certificates generated by kubeadm during sub-commands such as <code>init</code>,
<code>join</code>, <code>upgrade</code> and <code>certs</code>. Default values continue to be 1 year for non-CA certificates and 10 years for CA
certificates. Only non-CA certificates continue to be renewable by <code>kubeadm certs renew</code>.</li>
</ul>
<h1>Migration from old kubeadm config versions</h1>
<ul>
<li>kubeadm v1.15.x and newer can be used to migrate from v1beta1 to v1beta2.</li>
<li>kubeadm v1.22.x and newer no longer support v1beta1 and older APIs, but can be used to migrate v1beta2 to v1beta3.</li>
<li>kubeadm v1.27.x and newer no longer support v1beta2 and older APIs.</li>
<li>TODO: https://github.com/kubernetes/kubeadm/issues/2890
add version that can be used to convert to v1beta4</li>
</ul>
<h2>Basics</h2>
<p>The preferred way to configure kubeadm is to pass an YAML configuration file with
the <code>--config</code> option. Some of the configuration options defined in the kubeadm
config file are also available as command line flags, but only the most
common/simple use case are supported with this approach.</p>
<p>A kubeadm config file could contain multiple configuration types separated using three dashes (<code>---</code>).</p>
<p>kubeadm supports the following configuration types:</p>
<pre><code>apiVersion: kubeadm.k8s.io/v1beta4
kind: InitConfiguration
apiVersion: kubeadm.k8s.io/v1beta4
kind: ClusterConfiguration
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
apiVersion: kubeproxy.config.k8s.io/v1alpha1
kind: KubeProxyConfiguration
apiVersion: kubeadm.k8s.io/v1beta4
kind: JoinConfiguration
apiVersion: kubeadm.k8s.io/v1beta4
kind: ResetConfiguration
apiVersion: kubeadm.k8s.io/v1beta4
kind: UpgradeConfiguration
</code></pre>
<p>To print the defaults for <code>init</code> and <code>join</code> actions use the following commands:</p>
<pre style="background-color:#fff">kubeadm config print init-defaults
kubeadm config print join-defaults
kubeadm config print reset-defaults
kubeadm config print upgrade-defaults
</pre><p>The list of configuration types that must be included in a configuration file depends by the action you are
performing (<code>init</code> or <code>join</code>) and by the configuration options you are going to use (defaults or advanced customization).</p>
<p>If some configuration types are not provided, or provided only partially, kubeadm will use default values; defaults
provided by kubeadm includes also enforcing consistency of values across components when required (e.g.
<code>--cluster-cidr</code> flag on controller manager and <code>clusterCIDR</code> on kube-proxy).</p>
<p>Users are always allowed to override default values, with the only exception of a small subset of setting with
relevance for security (e.g. enforce authorization-mode Node and RBAC on api server).</p>
<p>If the user provides a configuration types that is not expected for the action you are performing, kubeadm will
ignore those types and print a warning.</p>
<h2>Kubeadm init configuration types</h2>
<p>When executing kubeadm init with the <code>--config</code> option, the following configuration types could be used:
InitConfiguration, ClusterConfiguration, KubeProxyConfiguration, KubeletConfiguration, but only one
between InitConfiguration and ClusterConfiguration is mandatory.</p>
<pre style="background-color:#fff"><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta4<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>InitConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">bootstrapTokens</span>:<span style="color:#bbb">
</span><span style="color:#bbb"></span>...<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">nodeRegistration</span>:<span style="color:#bbb">
</span><span style="color:#bbb"></span>...<span style="color:#bbb">
</span></pre><p>The InitConfiguration type should be used to configure runtime settings, that in case of kubeadm init
are the configuration of the bootstrap token and all the setting which are specific to the node where kubeadm
is executed, including:</p>
<ul>
<li>
<p>NodeRegistration, that holds fields that relate to registering the new node to the cluster;
use it to customize the node name, the CRI socket to use or any other settings that should apply to this
node only (e.g. the node ip).</p>
</li>
<li>
<p>LocalAPIEndpoint, that represents the endpoint of the instance of the API server to be deployed on this node;
use it e.g. to customize the API server advertise address.</p>
</li>
</ul>
<pre style="background-color:#fff"><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta4<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>ClusterConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">networking</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>...<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">etcd</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>...<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">apiServer</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraArgs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>...<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraVolumes</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>...<span style="color:#bbb">
</span><span style="color:#bbb"></span>...<span style="color:#bbb">
</span></pre><p>The ClusterConfiguration type should be used to configure cluster-wide settings,
including settings for:</p>
<ul>
<li>
<p><code>networking</code> that holds configuration for the networking topology of the cluster; use it e.g. to customize
Pod subnet or services subnet.</p>
</li>
<li>
<p><code>etcd</code>: use it e.g. to customize the local etcd or to configure the API server
for using an external etcd cluster.</p>
</li>
<li>
<p>kube-apiserver, kube-scheduler, kube-controller-manager configurations; use it to customize control-plane
components by adding customized setting or overriding kubeadm default settings.</p>
</li>
</ul>
<pre style="background-color:#fff"><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeproxy.config.k8s.io/v1alpha1<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>KubeProxyConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span>...<span style="color:#bbb">
</span></pre><p>The KubeProxyConfiguration type should be used to change the configuration passed to kube-proxy instances deployed
in the cluster. If this object is not provided or provided only partially, kubeadm applies defaults.</p>
<p>See https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ or
https://pkg.go.dev/k8s.io/kube-proxy/config/v1alpha1#KubeProxyConfiguration
for kube-proxy official documentation.</p>
<pre style="background-color:#fff"><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubelet.config.k8s.io/v1beta1<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>KubeletConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span>...<span style="color:#bbb">
</span></pre><p>The KubeletConfiguration type should be used to change the configurations that will be passed to all kubelet instances
deployed in the cluster. If this object is not provided or provided only partially, kubeadm applies defaults.</p>
<p>See https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/ or
https://pkg.go.dev/k8s.io/kubelet/config/v1beta1#KubeletConfiguration
for kubelet official documentation.</p>
<p>Here is a fully populated example of a single YAML file containing multiple
configuration types to be used during a <code>kubeadm init</code> run.</p>
<pre style="background-color:#fff"><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta4<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>InitConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">bootstrapTokens</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">token</span>:<span style="color:#bbb"> </span><span style="color:#d14">"9a08jv.c0izixklcxtmnze7"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">description</span>:<span style="color:#bbb"> </span><span style="color:#d14">"kubeadm bootstrap token"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">ttl</span>:<span style="color:#bbb"> </span><span style="color:#d14">"24h"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">token</span>:<span style="color:#bbb"> </span><span style="color:#d14">"783bde.3f89s0fje9f38fhf"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">description</span>:<span style="color:#bbb"> </span><span style="color:#d14">"another bootstrap token"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">usages</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- authentication<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- signing<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">groups</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- system:bootstrappers:kubeadm:default-node-token<span style="color:#bbb">
</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">nodeRegistration</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span><span style="color:#d14">"ec2-10-100-0-1"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">criSocket</span>:<span style="color:#bbb"> </span><span style="color:#d14">"unix:///var/run/containerd/containerd.sock"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">taints</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">key</span>:<span style="color:#bbb"> </span><span style="color:#d14">"kubeadmNode"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">value</span>:<span style="color:#bbb"> </span><span style="color:#d14">"someValue"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">effect</span>:<span style="color:#bbb"> </span><span style="color:#d14">"NoSchedule"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">kubeletExtraArgs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span>v<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">value</span>:<span style="color:#bbb"> </span><span style="color:#d14">"5"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">ignorePreflightErrors</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- IsPrivilegedUser<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">imagePullPolicy</span>:<span style="color:#bbb"> </span><span style="color:#d14">"IfNotPresent"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">imagePullSerial</span>:<span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">true</span><span style="color:#bbb">
</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">localAPIEndpoint</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">advertiseAddress</span>:<span style="color:#bbb"> </span><span style="color:#d14">"10.100.0.1"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">bindPort</span>:<span style="color:#bbb"> </span><span style="color:#099">6443</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">certificateKey</span>:<span style="color:#bbb"> </span><span style="color:#d14">"e6a2eb8581237ab72a4f494f30285ec12a9694d750b9785706a83bfcbbbd2204"</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">skipPhases</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- preflight<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">timeouts</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">controlPlaneComponentHealthCheck</span>:<span style="color:#bbb"> </span><span style="color:#d14">"60s"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">kubenetesAPICall</span>:<span style="color:#bbb"> </span><span style="color:#d14">"40s"</span><span style="color:#bbb">
</span><span style="color:#bbb"></span>---<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta4<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>ClusterConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">etcd</span>:<span style="color:#bbb">
</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># one of local or external</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">local</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">imageRepository</span>:<span style="color:#bbb"> </span><span style="color:#d14">"registry.k8s.io"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">imageTag</span>:<span style="color:#bbb"> </span><span style="color:#d14">"3.2.24"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">dataDir</span>:<span style="color:#bbb"> </span><span style="color:#d14">"/var/lib/etcd"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraArgs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span>listen-client-urls<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">value</span>:<span style="color:#bbb"> </span>http://<span style="color:#099">10.100.0.1</span>:<span style="color:#099">2379</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraEnvs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span>SOME_VAR<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">value</span>:<span style="color:#bbb"> </span>SOME_VALUE<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">serverCertSANs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#bbb"> </span><span style="color:#d14">"ec2-10-100-0-1.compute-1.amazonaws.com"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">peerCertSANs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#d14">"10.100.0.1"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># external:</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># endpoints:</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># - "10.100.0.1:2379"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># - "10.100.0.2:2379"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># caFile: "/etcd/kubernetes/pki/etcd/etcd-ca.crt"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># certFile: "/etcd/kubernetes/pki/etcd/etcd.crt"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># keyFile: "/etcd/kubernetes/pki/etcd/etcd.key"</span><span style="color:#bbb">
</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">networking</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">serviceSubnet</span>:<span style="color:#bbb"> </span><span style="color:#d14">"10.96.0.0/16"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">podSubnet</span>:<span style="color:#bbb"> </span><span style="color:#d14">"10.244.0.0/24"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">dnsDomain</span>:<span style="color:#bbb"> </span><span style="color:#d14">"cluster.local"</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kubernetesVersion</span>:<span style="color:#bbb"> </span><span style="color:#d14">"v1.21.0"</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">controlPlaneEndpoint</span>:<span style="color:#bbb"> </span><span style="color:#d14">"10.100.0.1:6443"</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">apiServer</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraArgs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span>authorization-mode<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">value</span>:<span style="color:#bbb"> </span><span style="color:#d14">"Node,RBAC"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraEnvs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span>SOME_VAR<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">value</span>:<span style="color:#bbb"> </span>SOME_VALUE<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraVolumes</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span><span style="color:#d14">"some-volume"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">hostPath</span>:<span style="color:#bbb"> </span><span style="color:#d14">"/etc/some-path"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">mountPath</span>:<span style="color:#bbb"> </span><span style="color:#d14">"/etc/some-pod-path"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">readOnly</span>:<span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">false</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">pathType</span>:<span style="color:#bbb"> </span>File<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">certSANs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#d14">"10.100.1.1"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#d14">"ec2-10-100-0-1.compute-1.amazonaws.com"</span><span style="color:#bbb">
</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">controllerManager</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraArgs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span>node-cidr-mask-size<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">value</span>:<span style="color:#bbb"> </span><span style="color:#d14">"20"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraVolumes</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span><span style="color:#d14">"some-volume"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">hostPath</span>:<span style="color:#bbb"> </span><span style="color:#d14">"/etc/some-path"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">mountPath</span>:<span style="color:#bbb"> </span><span style="color:#d14">"/etc/some-pod-path"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">readOnly</span>:<span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">false</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">pathType</span>:<span style="color:#bbb"> </span>File<span style="color:#bbb">
</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">scheduler</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraArgs</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span>address<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">value</span>:<span style="color:#bbb"> </span><span style="color:#d14">"10.100.0.1"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">extraVolumes</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>- <span style="color:#000;font-weight:bold">name</span>:<span style="color:#bbb"> </span><span style="color:#d14">"some-volume"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">hostPath</span>:<span style="color:#bbb"> </span><span style="color:#d14">"/etc/some-path"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">mountPath</span>:<span style="color:#bbb"> </span><span style="color:#d14">"/etc/some-pod-path"</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">readOnly</span>:<span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">false</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">pathType</span>:<span style="color:#bbb"> </span>File<span style="color:#bbb">
</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">certificatesDir</span>:<span style="color:#bbb"> </span><span style="color:#d14">"/etc/kubernetes/pki"</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">imageRepository</span>:<span style="color:#bbb"> </span><span style="color:#d14">"registry.k8s.io"</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">clusterName</span>:<span style="color:#bbb"> </span><span style="color:#d14">"example-cluster"</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">encryptionAlgorithm</span>:<span style="color:#bbb"> </span>ECDSA-P256<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">dns</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">disabled</span>:<span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">true</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># disable CoreDNS</span><span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">proxy</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">disabled</span>:<span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">true</span><span style="color:#bbb"> </span><span style="color:#998;font-style:italic"># disable kube-proxy</span><span style="color:#bbb">
</span><span style="color:#bbb">
</span><span style="color:#bbb"></span>---<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubelet.config.k8s.io/v1beta1<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>KubeletConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#998;font-style:italic"># kubelet specific options here</span><span style="color:#bbb">
</span><span style="color:#bbb"></span>---<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeproxy.config.k8s.io/v1alpha1<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>KubeProxyConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#998;font-style:italic"># kube-proxy specific options here</span><span style="color:#bbb">
</span></pre><h2>Kubeadm join configuration types</h2>
<p>When executing kubeadm join with the --config option, the JoinConfiguration type should be provided.</p>
<pre style="background-color:#fff"><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta4<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>JoinConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">discovery</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">bootstrapToken</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">apiServerEndpoint</span>:<span style="color:#bbb"> </span>some-address:<span style="color:#099">6443</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">token</span>:<span style="color:#bbb"> </span>abcdef.0123456789abcdef<span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">unsafeSkipCAVerification</span>:<span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">true</span><span style="color:#bbb">
</span><span style="color:#bbb"> </span><span style="color:#000;font-weight:bold">tlsBootstrapToken</span>:<span style="color:#bbb"> </span>abcdef.0123456789abcdef<span style="color:#bbb">
</span></pre><p>The JoinConfiguration type should be used to configure runtime settings, that in case of kubeadm join
are the discovery method used for accessing the cluster info and all the setting which are specific
to the node where kubeadm is executed, including:</p>
<ul>
<li>
<p><code>nodeRegistration</code>, that holds fields that relate to registering the new node to the cluster;
use it to customize the node name, the CRI socket to use or any other settings that should apply to this
node only (e.g. the node ip).</p>
</li>
<li>
<p><code>apiEndpoint</code>, that represents the endpoint of the instance of the API server to be eventually deployed on this node.</p>
</li>
</ul>
<h2>Kubeadm reset configuration types</h2>
<p>When executing <code>kubeadm reset</code> with the <code>--config</code> option, the <code>ResetConfiguration</code> type should be provided.</p>
<pre style="background-color:#fff"><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta4<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>ResetConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span>...<span style="color:#bbb">
</span></pre><h2>Kubeadm upgrade configuration types</h2>
<p>When executing <code>kubeadm upgrade</code> with the <code>--config</code> option, the <code>UpgradeConfiguration</code> type should be provided.</p>
<pre style="background-color:#fff"><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta4<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">kind</span>:<span style="color:#bbb"> </span>UpgradeConfiguration<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">apply</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>...<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">diff</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>...<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">node</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>...<span style="color:#bbb">
</span><span style="color:#bbb"></span><span style="color:#000;font-weight:bold">plan</span>:<span style="color:#bbb">
</span><span style="color:#bbb"> </span>...<span style="color:#bbb">
</span></pre><p>The <code>UpgradeConfiguration</code> structure includes a few substructures that only apply to different subcommands of
<code>kubeadm upgrade</code>. For example, the <code>apply</code> substructure will be used with the <code>kubeadm upgrade apply</code> subcommand
and all other substructures will be ignored in such a case.</p>
## Resource Types
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta4-ClusterConfiguration)
- [InitConfiguration](#kubeadm-k8s-io-v1beta4-InitConfiguration)
- [JoinConfiguration](#kubeadm-k8s-io-v1beta4-JoinConfiguration)
- [ResetConfiguration](#kubeadm-k8s-io-v1beta4-ResetConfiguration)
- [UpgradeConfiguration](#kubeadm-k8s-io-v1beta4-UpgradeConfiguration)
## `BootstrapToken` {#BootstrapToken}
**Appears in:**
- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration)
- [InitConfiguration](#kubeadm-k8s-io-v1beta4-InitConfiguration)
<p>BootstrapToken describes one bootstrap token, stored as a Secret in the cluster</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>token</code> <B>[Required]</B><br/>
<a href="#BootstrapTokenString"><code>BootstrapTokenString</code></a>
</td>
<td>
<p><code>token</code> is used for establishing bidirectional trust between nodes and control-planes.
Used for joining nodes in the cluster.</p>
</td>
</tr>
<tr><td><code>description</code><br/>
<code>string</code>
</td>
<td>
<p><code>description</code> sets a human-friendly message why this token exists and what it's used
for, so other administrators can know its purpose.</p>
</td>
</tr>
<tr><td><code>ttl</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>ttl</code> defines the time to live for this token. Defaults to <code>24h</code>.
<code>expires</code> and <code>ttl</code> are mutually exclusive.</p>
</td>
</tr>
<tr><td><code>expires</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#time-v1-meta"><code>meta/v1.Time</code></a>
</td>
<td>
<p><code>expires</code> specifies the timestamp when this token expires. Defaults to being set
dynamically at runtime based on the <code>ttl</code>. <code>expires</code> and <code>ttl</code> are mutually exclusive.</p>
</td>
</tr>
<tr><td><code>usages</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>usages</code> describes the ways in which this token can be used. Can by default be used
for establishing bidirectional trust, but that can be changed here.</p>
</td>
</tr>
<tr><td><code>groups</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>groups</code> specifies the extra groups that this token will authenticate as when/if
used for authentication</p>
</td>
</tr>
</tbody>
</table>
## `BootstrapTokenString` {#BootstrapTokenString}
**Appears in:**
- [BootstrapToken](#BootstrapToken)
<p>BootstrapTokenString is a token of the format <code>abcdef.abcdef0123456789</code> that is used
for both validation of the practically of the API server from a joining node's point
of view and as an authentication method for the node in the bootstrap phase of
"kubeadm join". This token is and should be short-lived.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>-</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>-</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `ClusterConfiguration` {#kubeadm-k8s-io-v1beta4-ClusterConfiguration}
<p>ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>kubeadm.k8s.io/v1beta4</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>ClusterConfiguration</code></td></tr>
<tr><td><code>etcd</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Etcd"><code>Etcd</code></a>
</td>
<td>
<p><code>etcd</code> holds the configuration for etcd.</p>
</td>
</tr>
<tr><td><code>networking</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Networking"><code>Networking</code></a>
</td>
<td>
<p><code>networking</code> holds configuration for the networking topology of the cluster.</p>
</td>
</tr>
<tr><td><code>kubernetesVersion</code><br/>
<code>string</code>
</td>
<td>
<p><code>kubernetesVersion</code> is the target version of the control plane.</p>
</td>
</tr>
<tr><td><code>controlPlaneEndpoint</code><br/>
<code>string</code>
</td>
<td>
<p><code>controlPlaneEndpoint</code> sets a stable IP address or DNS name for the control plane;
It can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port.
In case the <code>controlPlaneEndpoint</code> is not specified, the <code>advertiseAddress</code> + <code>bindPort</code>
are used; in case the <code>controlPlaneEndpoint</code> is specified but without a TCP port,
the <code>bindPort</code> is used.
Possible usages are:</p>
<ul>
<li>In a cluster with more than one control plane instances, this field should be
assigned the address of the external load balancer in front of the
control plane instances.</li>
<li>In environments with enforced node recycling, the <code>controlPlaneEndpoint</code>
could be used for assigning a stable DNS to the control plane.</li>
</ul>
</td>
</tr>
<tr><td><code>apiServer</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-APIServer"><code>APIServer</code></a>
</td>
<td>
<p><code>apiServer</code> contains extra settings for the API server.</p>
</td>
</tr>
<tr><td><code>controllerManager</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-ControlPlaneComponent"><code>ControlPlaneComponent</code></a>
</td>
<td>
<p><code>controllerManager</code> contains extra settings for the controller manager.</p>
</td>
</tr>
<tr><td><code>scheduler</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-ControlPlaneComponent"><code>ControlPlaneComponent</code></a>
</td>
<td>
<p><code>scheduler</code> contains extra settings for the scheduler.</p>
</td>
</tr>
<tr><td><code>dns</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-DNS"><code>DNS</code></a>
</td>
<td>
<p><code>dns</code> defines the options for the DNS add-on installed in the cluster.</p>
</td>
</tr>
<tr><td><code>proxy</code> <B>[Required]</B><br/>
<a href="#kubeadm-k8s-io-v1beta4-Proxy"><code>Proxy</code></a>
</td>
<td>
<p><code>proxy</code> defines the options for the proxy add-on installed in the cluster.</p>
</td>
</tr>
<tr><td><code>certificatesDir</code><br/>
<code>string</code>
</td>
<td>
<p><code>certificatesDir</code> specifies where to store or look for all required certificates.</p>
</td>
</tr>
<tr><td><code>imageRepository</code><br/>
<code>string</code>
</td>
<td>
<p><code>imageRepository</code> sets the container registry to pull images from.
If empty, <code>registry.k8s.io</code> will be used by default.
In case of kubernetes version is a CI build (kubernetes version starts with <code>ci/</code>)
<code>gcr.io/k8s-staging-ci-images</code> will be used as a default for control plane components
and for kube-proxy, while <code>registry.k8s.io</code> will be used for all the other images.</p>
</td>
</tr>
<tr><td><code>featureGates</code><br/>
<code>map[string]bool</code>
</td>
<td>
<p><code>featureGates</code> contains the feature gates enabled by the user.</p>
</td>
</tr>
<tr><td><code>clusterName</code><br/>
<code>string</code>
</td>
<td>
<p>The cluster name.</p>
</td>
</tr>
<tr><td><code>encryptionAlgorithm</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-EncryptionAlgorithmType"><code>EncryptionAlgorithmType</code></a>
</td>
<td>
<p><code>encryptionAlgorithm</code> holds the type of asymmetric encryption algorithm used for keys and
certificates. Can be one of <code>"RSA-2048"</code> (default), <code>"RSA-3072"</code>, <code>"RSA-4096"</code> or <code>"ECDSA-P256"</code>.</p>
</td>
</tr>
<tr><td><code>certificateValidityPeriod</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>certificateValidityPeriod</code> specifies the validity period for a non-CA certificate generated by kubeadm.
Default value: `8760h`` (365 days * 24 hours = 1 year)</p>
</td>
</tr>
<tr><td><code>caCertificateValidityPeriod</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>caCertificateValidityPeriod</code> specifies the validity period for a CA certificate generated by kubeadm.
Default value: <code>87600h</code> (365 days * 24 hours * 10 = 10 years)</p>
</td>
</tr>
</tbody>
</table>
## `InitConfiguration` {#kubeadm-k8s-io-v1beta4-InitConfiguration}
<p>InitConfiguration contains a list of elements that is specific "kubeadm init"-only runtime
information.
<code>kubeadm init</code>-only information. These fields are solely used the first time <code>kubeadm init</code> runs.
After that, the information in the fields IS NOT uploaded to the <code>kubeadm-config</code> ConfigMap
that is used by <code>kubeadm upgrade</code> for instance. These fields must be omitempty.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>kubeadm.k8s.io/v1beta4</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>InitConfiguration</code></td></tr>
<tr><td><code>bootstrapTokens</code><br/>
<a href="#BootstrapToken"><code>[]BootstrapToken</code></a>
</td>
<td>
<p><code>bootstrapTokens</code> is respected at <code>kubeadm init</code> time and describes a set of Bootstrap Tokens to create.
This information IS NOT uploaded to the kubeadm cluster configmap, partly because of its sensitive nature</p>
</td>
</tr>
<tr><td><code>dryRun</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p><code>dryRun</code> tells if the dry run mode is enabled, don't apply any change in dry run mode,
just out put what would be done.</p>
</td>
</tr>
<tr><td><code>nodeRegistration</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-NodeRegistrationOptions"><code>NodeRegistrationOptions</code></a>
</td>
<td>
<p><code>nodeRegistration</code> holds fields that relate to registering the new control-plane node
to the cluster.</p>
</td>
</tr>
<tr><td><code>localAPIEndpoint</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-APIEndpoint"><code>APIEndpoint</code></a>
</td>
<td>
<p><code>localAPIEndpoint</code> represents the endpoint of the API server instance that's deployed on this
control plane node. In HA setups, this differs from <code>ClusterConfiguration.controlPlaneEndpoint</code>
in the sense that <code>controlPlaneEndpoint</code> is the global endpoint for the cluster, which then
loadbalances the requests to each individual API server.
This configuration object lets you customize what IP/DNS name and port the local API server
advertises it's accessible on. By default, kubeadm tries to auto-detect the IP of the default
interface and use that, but in case that process fails you may set the desired value here.</p>
</td>
</tr>
<tr><td><code>certificateKey</code><br/>
<code>string</code>
</td>
<td>
<p><code>certificateKey</code> sets the key with which certificates and keys are encrypted prior to being
uploaded in a Secret in the cluster during the <code>uploadcerts init</code> phase.
The certificate key is a hex encoded string that is an AES key of size 32 bytes.</p>
</td>
</tr>
<tr><td><code>skipPhases</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>skipPhases</code> is a list of phases to skip during command execution.
The list of phases can be obtained with the <code>kubeadm init --help</code> command.
The flag <code>--skip-phases</code> takes precedence over this field.</p>
</td>
</tr>
<tr><td><code>patches</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Patches"><code>Patches</code></a>
</td>
<td>
<p><code>patches</code> contains options related to applying patches to components deployed by kubeadm during
<code>kubeadm init</code>.</p>
</td>
</tr>
<tr><td><code>timeouts</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Timeouts"><code>Timeouts</code></a>
</td>
<td>
<p><code>timeouts</code> holds various timeouts that apply to kubeadm commands.</p>
</td>
</tr>
</tbody>
</table>
## `JoinConfiguration` {#kubeadm-k8s-io-v1beta4-JoinConfiguration}
<p>JoinConfiguration contains elements describing a particular node.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>kubeadm.k8s.io/v1beta4</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>JoinConfiguration</code></td></tr>
<tr><td><code>dryRun</code><br/>
<code>bool</code>
</td>
<td>
<p><code>dryRun</code> tells if the dry run mode is enabled, don't apply any change if it is set,
just output what would be done.</p>
</td>
</tr>
<tr><td><code>nodeRegistration</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-NodeRegistrationOptions"><code>NodeRegistrationOptions</code></a>
</td>
<td>
<p><code>nodeRegistration</code> holds fields that relate to registering the new control-plane
node to the cluster</p>
</td>
</tr>
<tr><td><code>caCertPath</code><br/>
<code>string</code>
</td>
<td>
<p><code>caCertPath</code> is the path to the SSL certificate authority used to secure comunications
between node and control-plane.
Defaults to "/etc/kubernetes/pki/ca.crt".</p>
</td>
</tr>
<tr><td><code>discovery</code> <B>[Required]</B><br/>
<a href="#kubeadm-k8s-io-v1beta4-Discovery"><code>Discovery</code></a>
</td>
<td>
<p><code>discovery</code> specifies the options for the kubelet to use during the TLS bootstrap process.</p>
</td>
</tr>
<tr><td><code>controlPlane</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-JoinControlPlane"><code>JoinControlPlane</code></a>
</td>
<td>
<p><code>controlPlane</code> defines the additional control plane instance to be deployed on the
joining node. If nil, no additional control plane instance will be deployed.</p>
</td>
</tr>
<tr><td><code>skipPhases</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>skipPhases</code> is a list of phases to skip during command execution.
The list of phases can be obtained with the <code>kubeadm join --help</code> command.
The flag <code>--skip-phases</code> takes precedence over this field.</p>
</td>
</tr>
<tr><td><code>patches</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Patches"><code>Patches</code></a>
</td>
<td>
<p><code>patches</code> contains options related to applying patches to components deployed
by kubeadm during <code>kubeadm join</code>.</p>
</td>
</tr>
<tr><td><code>timeouts</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Timeouts"><code>Timeouts</code></a>
</td>
<td>
<p><code>timeouts</code> holds various timeouts that apply to kubeadm commands.</p>
</td>
</tr>
</tbody>
</table>
## `ResetConfiguration` {#kubeadm-k8s-io-v1beta4-ResetConfiguration}
<p>ResetConfiguration contains a list of fields that are specifically <code>kubeadm reset</code>-only
runtime information.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>kubeadm.k8s.io/v1beta4</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>ResetConfiguration</code></td></tr>
<tr><td><code>cleanupTmpDir</code><br/>
<code>bool</code>
</td>
<td>
<p><code>cleanupTmpDir</code> specifies whether the "/etc/kubernetes/tmp" directory should be cleaned
during the reset process.</p>
</td>
</tr>
<tr><td><code>certificatesDir</code><br/>
<code>string</code>
</td>
<td>
<p><code>certificatesDir</code> specifies the directory where the certificates are stored.
If specified, it will be cleaned during the reset process.</p>
</td>
</tr>
<tr><td><code>criSocket</code><br/>
<code>string</code>
</td>
<td>
<p><code>criSocket</code> is used to retrieve container runtime inforomation and used for the
removal of the containers.
If <code>criSocket</code> is not specified by flag or config file, kubeadm will try to detect
one valid CRI socket instead.</p>
</td>
</tr>
<tr><td><code>dryRun</code><br/>
<code>bool</code>
</td>
<td>
<p><code>dryRun</code> tells if the dry run mode is enabled, don't apply any change if it is set
and just output what would be done.</p>
</td>
</tr>
<tr><td><code>force</code><br/>
<code>bool</code>
</td>
<td>
<p>The <code>force</code> flag instructs kubeadm to reset the node without prompting for confirmation.</p>
</td>
</tr>
<tr><td><code>ignorePreflightErrors</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>ignorePreflightErrors</code> provides a list of pre-flight errors to be ignored during
the reset process, e.g. <code>IsPrivilegedUser,Swap</code>.
Value <code>all</code> ignores errors from all checks.</p>
</td>
</tr>
<tr><td><code>skipPhases</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>skipPhases</code> is a list of phases to skip during command execution.
The list of phases can be obtained with the <code>kubeadm reset phase --help</code> command.</p>
</td>
</tr>
<tr><td><code>unmountFlags</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>unmountFlags</code> is a list of <code>unmount2()</code> syscall flags that kubeadm can use when unmounting
directories during "reset". This flag can be one of: <code>"MNT_FORCE"</code>, <code>"MNT_DETACH"</code>,
<code>"MNT_EXPIRE"</code>, <code>"UMOUNT_NOFOLLOW"</code>. By default this list is empty.</p>
</td>
</tr>
<tr><td><code>timeouts</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Timeouts"><code>Timeouts</code></a>
</td>
<td>
<p>Timeouts holds various timeouts that apply to kubeadm commands.</p>
</td>
</tr>
</tbody>
</table>
## `UpgradeConfiguration` {#kubeadm-k8s-io-v1beta4-UpgradeConfiguration}
<p>UpgradeConfiguration contains a list of options that are specific to <code>kubeadm upgrade</code> subcommands.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>kubeadm.k8s.io/v1beta4</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>UpgradeConfiguration</code></td></tr>
<tr><td><code>apply</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-UpgradeApplyConfiguration"><code>UpgradeApplyConfiguration</code></a>
</td>
<td>
<p><code>apply</code> holds a list of options that are specific to the <code>kubeadm upgrade apply</code> command.</p>
</td>
</tr>
<tr><td><code>diff</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-UpgradeDiffConfiguration"><code>UpgradeDiffConfiguration</code></a>
</td>
<td>
<p><code>diff</code> holds a list of options that are specific to the <code>kubeadm upgrade diff</code> command.</p>
</td>
</tr>
<tr><td><code>node</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-UpgradeNodeConfiguration"><code>UpgradeNodeConfiguration</code></a>
</td>
<td>
<p><code>node</code> holds a list of options that are specific to the <code>kubeadm upgrade node</code> command.</p>
</td>
</tr>
<tr><td><code>plan</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-UpgradePlanConfiguration"><code>UpgradePlanConfiguration</code></a>
</td>
<td>
<p><code>plan</code> holds a list of options that are specific to the <code>kubeadm upgrade plan</code> command.</p>
</td>
</tr>
<tr><td><code>timeouts</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Timeouts"><code>Timeouts</code></a>
</td>
<td>
<p><code>timeouts</code> holds various timeouts that apply to kubeadm commands.</p>
</td>
</tr>
</tbody>
</table>
## `APIEndpoint` {#kubeadm-k8s-io-v1beta4-APIEndpoint}
**Appears in:**
- [InitConfiguration](#kubeadm-k8s-io-v1beta4-InitConfiguration)
- [JoinControlPlane](#kubeadm-k8s-io-v1beta4-JoinControlPlane)
<p>APIEndpoint struct contains elements of API server instance deployed on a node.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>advertiseAddress</code><br/>
<code>string</code>
</td>
<td>
<p><code>dvertiseAddress</code> sets the IP address for the API server to advertise.</p>
</td>
</tr>
<tr><td><code>bindPort</code><br/>
<code>int32</code>
</td>
<td>
<p><code>bindPort</code> sets the secure port for the API Server to bind to.
Defaults to 6443.</p>
</td>
</tr>
</tbody>
</table>
## `APIServer` {#kubeadm-k8s-io-v1beta4-APIServer}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta4-ClusterConfiguration)
<p>APIServer holds settings necessary for API server deployments in the cluster</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ControlPlaneComponent</code> <B>[Required]</B><br/>
<a href="#kubeadm-k8s-io-v1beta4-ControlPlaneComponent"><code>ControlPlaneComponent</code></a>
</td>
<td>(Members of <code>ControlPlaneComponent</code> are embedded into this type.)
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>certSANs</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>certSANs</code> sets extra Subject Alternative Names (SANs) for the API Server signing
certificate.</p>
</td>
</tr>
</tbody>
</table>
## `Arg` {#kubeadm-k8s-io-v1beta4-Arg}
**Appears in:**
- [ControlPlaneComponent](#kubeadm-k8s-io-v1beta4-ControlPlaneComponent)
- [LocalEtcd](#kubeadm-k8s-io-v1beta4-LocalEtcd)
- [NodeRegistrationOptions](#kubeadm-k8s-io-v1beta4-NodeRegistrationOptions)
<p>Arg represents an argument with a name and a value.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>name</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>The name of the argument.</p>
</td>
</tr>
<tr><td><code>value</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>The value of the argument.</p>
</td>
</tr>
</tbody>
</table>
## `BootstrapTokenDiscovery` {#kubeadm-k8s-io-v1beta4-BootstrapTokenDiscovery}
**Appears in:**
- [Discovery](#kubeadm-k8s-io-v1beta4-Discovery)
<p>BootstrapTokenDiscovery is used to set the options for bootstrap token based discovery.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>token</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>token</code> is a token used to validate cluster information fetched from the
control-plane.</p>
</td>
</tr>
<tr><td><code>apiServerEndpoint</code><br/>
<code>string</code>
</td>
<td>
<p><code>apiServerEndpoint</code> is an IP or domain name to the API server from which
information will be fetched.</p>
</td>
</tr>
<tr><td><code>caCertHashes</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>caCertHashes</code> specifies a set of public key pins to verify when token-based discovery
is used. The root CA found during discovery must match one of these values.
Specifying an empty set disables root CA pinning, which can be unsafe.
Each hash is specified as <code><type>:<value></code>, where the only currently supported type is
"sha256". This is a hex-encoded SHA-256 hash of the Subject Public Key Info (SPKI)
object in DER-encoded ASN.1. These hashes can be // calculated using, for example, OpenSSL.</p>
</td>
</tr>
<tr><td><code>unsafeSkipCAVerification</code><br/>
<code>bool</code>
</td>
<td>
<p><code>unsafeSkipCAVerification</code> allows token-based discovery without CA verification
via <code>caCertHashes</code>. This can weaken the security of kubeadm since other nodes can
impersonate the control-plane.</p>
</td>
</tr>
</tbody>
</table>
## `ControlPlaneComponent` {#kubeadm-k8s-io-v1beta4-ControlPlaneComponent}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta4-ClusterConfiguration)
- [APIServer](#kubeadm-k8s-io-v1beta4-APIServer)
<p>ControlPlaneComponent holds settings common to control plane component of the cluster</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>extraArgs</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Arg"><code>[]Arg</code></a>
</td>
<td>
<p><code>extraArgs</code> is an extra set of flags to pass to the control plane component.
An argument name in this list is the flag name as it appears on the
command line except without leading dash(es). Extra arguments will override existing
default arguments. Duplicate extra arguments are allowed.</p>
</td>
</tr>
<tr><td><code>extraVolumes</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-HostPathMount"><code>[]HostPathMount</code></a>
</td>
<td>
<p><code>extraVolumes</code> is an extra set of host volumes, mounted to the control plane component.</p>
</td>
</tr>
<tr><td><code>extraEnvs</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-EnvVar"><code>[]EnvVar</code></a>
</td>
<td>
<p><code>extraEnvs</code> is an extra set of environment variables to pass to the control plane component.
Environment variables passed using <code>extraEnvs</code> will override any existing environment variables,
or <code>*_proxy</code> environment variables that kubeadm adds by default.</p>
</td>
</tr>
</tbody>
</table>
## `DNS` {#kubeadm-k8s-io-v1beta4-DNS}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta4-ClusterConfiguration)
<p>DNS defines the DNS addon that should be used in the cluster</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ImageMeta</code> <B>[Required]</B><br/>
<a href="#kubeadm-k8s-io-v1beta4-ImageMeta"><code>ImageMeta</code></a>
</td>
<td>(Members of <code>ImageMeta</code> are embedded into this type.)
<p><code>imageMeta</code> allows to customize the image used for the DNS addon.</p>
</td>
</tr>
<tr><td><code>disabled</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p><code>disabled</code> specifies whether to disable this addon in the cluster.</p>
</td>
</tr>
</tbody>
</table>
## `Discovery` {#kubeadm-k8s-io-v1beta4-Discovery}
**Appears in:**
- [JoinConfiguration](#kubeadm-k8s-io-v1beta4-JoinConfiguration)
<p>Discovery specifies the options for the kubelet to use during the TLS Bootstrap process</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>bootstrapToken</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-BootstrapTokenDiscovery"><code>BootstrapTokenDiscovery</code></a>
</td>
<td>
<p><code>bootstrapToken</code> is used to set the options for bootstrap token based discovery.
<code>bootstrapToken</code> and <code>file</code> are mutually exclusive.</p>
</td>
</tr>
<tr><td><code>file</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-FileDiscovery"><code>FileDiscovery</code></a>
</td>
<td>
<p><code>file</code> is used to specify a file or URL to a kubeconfig file from which to load
cluster information. <code>bootstrapToken</code> and <code>file</code> are mutually exclusive.</p>
</td>
</tr>
<tr><td><code>tlsBootstrapToken</code><br/>
<code>string</code>
</td>
<td>
<p><code>tlsBootstrapToken</code> is a token used for TLS bootstrapping.
If <code>bootstrapToken</code> is set, this field is defaulted to <code>bootstrapToken.token</code>, but
can be overridden. If <code>file</code> is set, this field <strong>must be set</strong> in case the KubeConfigFile
does not contain any other authentication information.</p>
</td>
</tr>
</tbody>
</table>
## `EncryptionAlgorithmType` {#kubeadm-k8s-io-v1beta4-EncryptionAlgorithmType}
(Alias of `string`)
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta4-ClusterConfiguration)
<p>EncryptionAlgorithmType can define an asymmetric encryption algorithm type.</p>
## `EnvVar` {#kubeadm-k8s-io-v1beta4-EnvVar}
**Appears in:**
- [ControlPlaneComponent](#kubeadm-k8s-io-v1beta4-ControlPlaneComponent)
- [LocalEtcd](#kubeadm-k8s-io-v1beta4-LocalEtcd)
<p>EnvVar represents an environment variable present in a Container.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>EnvVar</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#envvar-v1-core"><code>core/v1.EnvVar</code></a>
</td>
<td>(Members of <code>EnvVar</code> are embedded into this type.)
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `Etcd` {#kubeadm-k8s-io-v1beta4-Etcd}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta4-ClusterConfiguration)
<p>Etcd contains elements describing Etcd configuration.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>local</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-LocalEtcd"><code>LocalEtcd</code></a>
</td>
<td>
<p><code>local</code> provides configuration knobs for configuring the local etcd instance.
<code>local</code> and <code>external</code> are mutually exclusive.</p>
</td>
</tr>
<tr><td><code>external</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-ExternalEtcd"><code>ExternalEtcd</code></a>
</td>
<td>
<p><code>external</code> describes how to connect to an external etcd cluster.
<code>local</code> and <code>external</code> are mutually exclusive.</p>
</td>
</tr>
</tbody>
</table>
## `ExternalEtcd` {#kubeadm-k8s-io-v1beta4-ExternalEtcd}
**Appears in:**
- [Etcd](#kubeadm-k8s-io-v1beta4-Etcd)
<p>ExternalEtcd describes an external etcd cluster.
Kubeadm has no knowledge of where certificate files live and they must be supplied.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>endpoints</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p><code>endpoints</code> contains the list of etcd members.</p>
</td>
</tr>
<tr><td><code>caFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>caFile</code> is an SSL Certificate Authority (CA) file used to secure etcd communication.
Required if using a TLS connection.</p>
</td>
</tr>
<tr><td><code>certFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>certFile</code> is an SSL certification file used to secure etcd communication.
Required if using a TLS connection.</p>
</td>
</tr>
<tr><td><code>keyFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>keyFile</code> is an SSL key file used to secure etcd communication.
Required if using a TLS connection.</p>
</td>
</tr>
</tbody>
</table>
## `FileDiscovery` {#kubeadm-k8s-io-v1beta4-FileDiscovery}
**Appears in:**
- [Discovery](#kubeadm-k8s-io-v1beta4-Discovery)
<p>FileDiscovery is used to specify a file or URL to a kubeconfig file from which to load
cluster information.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>kubeConfigPath</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>kubeConfigPath</code> is used to specify the actual file path or URL to the kubeconfig
file from which to load cluster information.</p>
</td>
</tr>
</tbody>
</table>
## `HostPathMount` {#kubeadm-k8s-io-v1beta4-HostPathMount}
**Appears in:**
- [ControlPlaneComponent](#kubeadm-k8s-io-v1beta4-ControlPlaneComponent)
<p>HostPathMount contains elements describing volumes that are mounted from the host.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>name</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>name</code> is the name of the volume inside the Pod template.</p>
</td>
</tr>
<tr><td><code>hostPath</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>hostPath</code> is the path in the host that will be mounted inside the Pod.</p>
</td>
</tr>
<tr><td><code>mountPath</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>mountPath</code> is the path inside the Pod where <code>hostPath</code> will be mounted.</p>
</td>
</tr>
<tr><td><code>readOnly</code><br/>
<code>bool</code>
</td>
<td>
<p><code>readOnly</code> controls write access to the volume.</p>
</td>
</tr>
<tr><td><code>pathType</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#hostpathtype-v1-core"><code>core/v1.HostPathType</code></a>
</td>
<td>
<p><code>pathType</code> is the type of the <code>hostPath</code>.</p>
</td>
</tr>
</tbody>
</table>
## `ImageMeta` {#kubeadm-k8s-io-v1beta4-ImageMeta}
**Appears in:**
- [DNS](#kubeadm-k8s-io-v1beta4-DNS)
- [LocalEtcd](#kubeadm-k8s-io-v1beta4-LocalEtcd)
<p>ImageMeta allows to customize the image used for components that are not
originated from the Kubernetes/Kubernetes release process</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>imageRepository</code><br/>
<code>string</code>
</td>
<td>
<p><code>imageRepository</code> sets the container registry to pull images from.
if not set, the <code>imageRepository</code> defined in ClusterConfiguration will be used instead.</p>
</td>
</tr>
<tr><td><code>imageTag</code><br/>
<code>string</code>
</td>
<td>
<p><code>imageTag</code> allows to specify a tag for the image.
In case this value is set, kubeadm does not change automatically the version of
the above components during upgrades.</p>
</td>
</tr>
</tbody>
</table>
## `JoinControlPlane` {#kubeadm-k8s-io-v1beta4-JoinControlPlane}
**Appears in:**
- [JoinConfiguration](#kubeadm-k8s-io-v1beta4-JoinConfiguration)
<p>JoinControlPlane contains elements describing an additional control plane instance to be deployed on the joining node.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>localAPIEndpoint</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-APIEndpoint"><code>APIEndpoint</code></a>
</td>
<td>
<p><code>localAPIEndpoint</code> represents the endpoint of the API server instance to be
deployed on this node.</p>
</td>
</tr>
<tr><td><code>certificateKey</code><br/>
<code>string</code>
</td>
<td>
<p><code>certificateKey</code> is the key that is used for decryption of certificates after
they are downloaded from the Secret upon joining a new control plane node.
The corresponding encryption key is in the InitConfiguration.
The certificate key is a hex encoded string that is an AES key of size 32 bytes.</p>
</td>
</tr>
</tbody>
</table>
## `LocalEtcd` {#kubeadm-k8s-io-v1beta4-LocalEtcd}
**Appears in:**
- [Etcd](#kubeadm-k8s-io-v1beta4-Etcd)
<p>LocalEtcd describes that kubeadm should run an etcd cluster locally.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ImageMeta</code> <B>[Required]</B><br/>
<a href="#kubeadm-k8s-io-v1beta4-ImageMeta"><code>ImageMeta</code></a>
</td>
<td>(Members of <code>ImageMeta</code> are embedded into this type.)
<p>ImageMeta allows to customize the container used for etcd</p>
</td>
</tr>
<tr><td><code>dataDir</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>dataDir</code> is the directory etcd will place its data.
Defaults to "/var/lib/etcd".</p>
</td>
</tr>
<tr><td><code>extraArgs</code> <B>[Required]</B><br/>
<a href="#kubeadm-k8s-io-v1beta4-Arg"><code>[]Arg</code></a>
</td>
<td>
<p><code>extraArgs</code> are extra arguments provided to the etcd binary when run
inside a static Pod. An argument name in this list is the flag name as
it appears on the command line except without leading dash(es).
Extra arguments will override existing default arguments.
Duplicate extra arguments are allowed.</p>
</td>
</tr>
<tr><td><code>extraEnvs</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-EnvVar"><code>[]EnvVar</code></a>
</td>
<td>
<p><code>extraEnvs</code> is an extra set of environment variables to pass to the
control plane component. Environment variables passed using <code>extraEnvs</code>
will override any existing environment variables, or <code>*_proxy</code> environment
variables that kubeadm adds by default.</p>
</td>
</tr>
<tr><td><code>serverCertSANs</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>serverCertSANs</code> sets extra Subject Alternative Names (SANs) for the etcd
server signing certificate.</p>
</td>
</tr>
<tr><td><code>peerCertSANs</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>peerCertSANs</code> sets extra Subject Alternative Names (SANs) for the etcd peer
signing certificate.</p>
</td>
</tr>
</tbody>
</table>
## `Networking` {#kubeadm-k8s-io-v1beta4-Networking}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta4-ClusterConfiguration)
<p>Networking contains elements describing cluster's networking configuration.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>serviceSubnet</code><br/>
<code>string</code>
</td>
<td>
<p><code>serviceSubnet</code> is the subnet used by Kubernetes Services. Defaults to "10.96.0.0/12".</p>
</td>
</tr>
<tr><td><code>podSubnet</code><br/>
<code>string</code>
</td>
<td>
<p><code>podSubnet</code> is the subnet used by Pods.</p>
</td>
</tr>
<tr><td><code>dnsDomain</code><br/>
<code>string</code>
</td>
<td>
<p><code>dnsDomain</code> is the dns domain used by Kubernetes Services. Defaults to "cluster.local".</p>
</td>
</tr>
</tbody>
</table>
## `NodeRegistrationOptions` {#kubeadm-k8s-io-v1beta4-NodeRegistrationOptions}
**Appears in:**
- [InitConfiguration](#kubeadm-k8s-io-v1beta4-InitConfiguration)
- [JoinConfiguration](#kubeadm-k8s-io-v1beta4-JoinConfiguration)
<p>NodeRegistrationOptions holds fields that relate to registering a new control-plane or
node to the cluster, either via <code>kubeadm init</code> or <code>kubeadm join</code>.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>name</code><br/>
<code>string</code>
</td>
<td>
<p><code>name</code> is the <code>.Metadata.Name</code> field of the Node API object that will be created in this
<code>kubeadm init</code> or <code>kubeadm join</code> operation.
This field is also used in the <code>CommonName</code> field of the kubelet's client certificate to
the API server.
Defaults to the hostname of the node if not provided.</p>
</td>
</tr>
<tr><td><code>criSocket</code><br/>
<code>string</code>
</td>
<td>
<p><code>criSocket</code> is used to retrieve container runtime info.
This information will be annotated to the Node API object, for later re-use.</p>
</td>
</tr>
<tr><td><code>taints</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#taint-v1-core"><code>[]core/v1.Taint</code></a>
</td>
<td>
<p><code>taints</code> specifies the taints the Node API object should be registered with.
If this field is unset, i.e. nil, it will be defaulted with a control-plane taint for control-plane nodes.
If you don't want to taint your control-plane node, set this field to an empty list,
i.e. <code>taints: []</code> in the YAML file. This field is solely used for Node registration.</p>
</td>
</tr>
<tr><td><code>kubeletExtraArgs</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Arg"><code>[]Arg</code></a>
</td>
<td>
<p><code>kubeletExtraArgs</code> passes through extra arguments to the kubelet.
The arguments here are passed to the kubelet command line via the environment file
kubeadm writes at runtime for the kubelet to source.
This overrides the generic base-level configuration in the <code>kubelet-config</code> ConfigMap.
Flags have higher priority when parsing. These values are local and specific to the node
kubeadm is executing on. An argument name in this list is the flag name as it appears on the
command line except without leading dash(es). Extra arguments will override existing
default arguments. Duplicate extra arguments are allowed.</p>
</td>
</tr>
<tr><td><code>ignorePreflightErrors</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>ignorePreflightErrors</code> provides a slice of pre-flight errors to be ignored when
the current node is registered, e.g. 'IsPrivilegedUser,Swap'.
Value 'all' ignores errors from all checks.</p>
</td>
</tr>
<tr><td><code>imagePullPolicy</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#pullpolicy-v1-core"><code>core/v1.PullPolicy</code></a>
</td>
<td>
<p><code>imagePullPolicy</code> specifies the policy for image pulling during kubeadm <code>init</code> and
<code>join</code> operations.
The value of this field must be one of "Always", "IfNotPresent" or "Never".
If this field is unset kubeadm will default it to "IfNotPresent", or pull the required
images if not present on the host.</p>
</td>
</tr>
<tr><td><code>imagePullSerial</code><br/>
<code>bool</code>
</td>
<td>
<p><code>imagePullSerial</code> specifies if image pulling performed by kubeadm must be done serially or in parallel.
Default: true</p>
</td>
</tr>
</tbody>
</table>
## `Patches` {#kubeadm-k8s-io-v1beta4-Patches}
**Appears in:**
- [InitConfiguration](#kubeadm-k8s-io-v1beta4-InitConfiguration)
- [JoinConfiguration](#kubeadm-k8s-io-v1beta4-JoinConfiguration)
- [UpgradeApplyConfiguration](#kubeadm-k8s-io-v1beta4-UpgradeApplyConfiguration)
- [UpgradeNodeConfiguration](#kubeadm-k8s-io-v1beta4-UpgradeNodeConfiguration)
<p>Patches contains options related to applying patches to components deployed by kubeadm.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>directory</code><br/>
<code>string</code>
</td>
<td>
<p><code>directory</code> is a path to a directory that contains files named
"target[suffix][+patchtype].extension".
For example, "kube-apiserver0+merge.yaml" or just "etcd.json". "target" can be one of
"kube-apiserver", "kube-controller-manager", "kube-scheduler", "etcd", "kubeletconfiguration",
"corednsdeployment".
"patchtype" can be one of "strategic", "merge" or "json" and they match the patch formats
supported by kubectl.
The default "patchtype" is "strategic". "extension" must be either "json" or "yaml".
"suffix" is an optional string that can be used to determine which patches are applied
first alpha-numerically.</p>
</td>
</tr>
</tbody>
</table>
## `Proxy` {#kubeadm-k8s-io-v1beta4-Proxy}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta4-ClusterConfiguration)
<p>Proxy defines the proxy addon that should be used in the cluster.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>disabled</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p><code>disabled</code> specifies whether to disable this addon in the cluster.</p>
</td>
</tr>
</tbody>
</table>
## `Timeouts` {#kubeadm-k8s-io-v1beta4-Timeouts}
**Appears in:**
- [InitConfiguration](#kubeadm-k8s-io-v1beta4-InitConfiguration)
- [JoinConfiguration](#kubeadm-k8s-io-v1beta4-JoinConfiguration)
- [ResetConfiguration](#kubeadm-k8s-io-v1beta4-ResetConfiguration)
- [UpgradeConfiguration](#kubeadm-k8s-io-v1beta4-UpgradeConfiguration)
<p>Timeouts holds various timeouts that apply to kubeadm commands.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>controlPlaneComponentHealthCheck</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>controlPlaneComponentHealthCheck</code> is the amount of time to wait for a control plane
component, such as the API server, to be healthy during <code>kubeadm init</code> and <code>kubeadm join</code>.
Default: 4m</p>
</td>
</tr>
<tr><td><code>kubeletHealthCheck</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>kubeletHealthCheck</code> is the amount of time to wait for the kubelet to be healthy
during <code>kubeadm init</code> and <code>kubeadm join</code>.
Default: 4m</p>
</td>
</tr>
<tr><td><code>kubernetesAPICall</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>kubernetesAPICall</code> is the amount of time to wait for the kubeadm client to complete a request to
the API server. This applies to all types of methods (GET, POST, etc).
Default: 1m</p>
</td>
</tr>
<tr><td><code>etcdAPICall</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>etcdAPICall</code> is the amount of time to wait for the kubeadm etcd client to complete a request to
the etcd cluster.
Default: 2m</p>
</td>
</tr>
<tr><td><code>tlsBootstrap</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>tlsBootstrap</code> is the amount of time to wait for the kubelet to complete TLS bootstrap
for a joining node.
Default: 5m</p>
</td>
</tr>
<tr><td><code>discovery</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>discovery</code> is the amount of time to wait for kubeadm to validate the API server identity
for a joining node.
Default: 5m</p>
</td>
</tr>
<tr><td><code>upgradeManifests</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
</td>
<td>
<p><code>upgradeManifests</code> is the timeout for upgrading static Pod manifests
Default: 5m</p>
</td>
</tr>
</tbody>
</table>
## `UpgradeApplyConfiguration` {#kubeadm-k8s-io-v1beta4-UpgradeApplyConfiguration}
**Appears in:**
- [UpgradeConfiguration](#kubeadm-k8s-io-v1beta4-UpgradeConfiguration)
<p>UpgradeApplyConfiguration contains a list of configurable options which are specific to the "kubeadm upgrade apply" command.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>kubernetesVersion</code><br/>
<code>string</code>
</td>
<td>
<p><code>kubernetesVersion</code> is the target version of the control plane.</p>
</td>
</tr>
<tr><td><code>allowExperimentalUpgrades</code><br/>
<code>bool</code>
</td>
<td>
<p><code>allowExperimentalUpgrades</code> instructs kubeadm to show unstable versions of Kubernetes as an upgrade
alternative and allows upgrading to an alpha/beta/release candidate version of Kubernetes.
Default: false</p>
</td>
</tr>
<tr><td><code>allowRCUpgrades</code><br/>
<code>bool</code>
</td>
<td>
<p>Enable <code>allowRCUpgrades</code> will show release candidate versions of Kubernetes as an upgrade alternative and
allows upgrading to a release candidate version of Kubernetes.</p>
</td>
</tr>
<tr><td><code>certificateRenewal</code><br/>
<code>bool</code>
</td>
<td>
<p><code>certificateRenewal</code> instructs kubeadm to execute certificate renewal during upgrades.
Defaults to true.</p>
</td>
</tr>
<tr><td><code>dryRun</code><br/>
<code>bool</code>
</td>
<td>
<p><code>dryRun</code> tells if the dry run mode is enabled, don't apply any change if it is and just output
what would be done.</p>
</td>
</tr>
<tr><td><code>etcdUpgrade</code><br/>
<code>bool</code>
</td>
<td>
<p><code>etcdUpgrade</code> instructs kubeadm to execute etcd upgrade during upgrades.
Defaults to true.</p>
</td>
</tr>
<tr><td><code>forceUpgrade</code><br/>
<code>bool</code>
</td>
<td>
<p><code>forceUpgrade</code> flag instructs kubeadm to upgrade the cluster without prompting for confirmation.</p>
</td>
</tr>
<tr><td><code>ignorePreflightErrors</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>ignorePreflightErrors</code> provides a slice of pre-flight errors to be ignored during the upgrade process,
e.g. <code>IsPrivilegedUser,Swap</code>. Value <code>all</code> ignores errors from all checks.</p>
</td>
</tr>
<tr><td><code>patches</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Patches"><code>Patches</code></a>
</td>
<td>
<p><code>patches</code> contains options related to applying patches to components deployed by kubeadm during <code>kubeadm upgrade</code>.</p>
</td>
</tr>
<tr><td><code>printConfig</code><br/>
<code>bool</code>
</td>
<td>
<p><code>printConfig</code> specifies whether the configuration file that will be used in the upgrade should be printed or not.</p>
</td>
</tr>
<tr><td><code>skipPhases</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p><code>skipPhases</code> is a list of phases to skip during command execution.
NOTE: This field is currently ignored for <code>kubeadm upgrade apply</code>, but in the future it will be supported.</p>
</td>
</tr>
<tr><td><code>imagePullPolicy</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#pullpolicy-v1-core"><code>core/v1.PullPolicy</code></a>
</td>
<td>
<p><code>imagePullPolicy</code> specifies the policy for image pulling during <code>kubeadm upgrade apply</code> operations.
The value of this field must be one of "Always", "IfNotPresent" or "Never".
If this field is unset kubeadm will default it to "IfNotPresent", or pull the required images if not present on the host.</p>
</td>
</tr>
<tr><td><code>imagePullSerial</code><br/>
<code>bool</code>
</td>
<td>
<p><code>imagePullSerial</code> specifies if image pulling performed by kubeadm must be done serially or in parallel.
Default: true</p>
</td>
</tr>
</tbody>
</table>
## `UpgradeDiffConfiguration` {#kubeadm-k8s-io-v1beta4-UpgradeDiffConfiguration}
**Appears in:**
- [UpgradeConfiguration](#kubeadm-k8s-io-v1beta4-UpgradeConfiguration)
<p>UpgradeDiffConfiguration contains a list of configurable options which are specific to the <code>kubeadm upgrade diff</code> command.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>kubernetesVersion</code><br/>
<code>string</code>
</td>
<td>
<p><code>kubernetesVersion</code> is the target version of the control plane.</p>
</td>
</tr>
<tr><td><code>contextLines</code><br/>
<code>int</code>
</td>
<td>
<p><code>diffContextLines</code> is the number of lines of context in the diff.</p>
</td>
</tr>
</tbody>
</table>
## `UpgradeNodeConfiguration` {#kubeadm-k8s-io-v1beta4-UpgradeNodeConfiguration}
**Appears in:**
- [UpgradeConfiguration](#kubeadm-k8s-io-v1beta4-UpgradeConfiguration)
<p>UpgradeNodeConfiguration contains a list of configurable options which are specific to the "kubeadm upgrade node" command.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>certificateRenewal</code><br/>
<code>bool</code>
</td>
<td>
<p><code>certificateRenewal</code> instructs kubeadm to execute certificate renewal during upgrades.
Defaults to true.</p>
</td>
</tr>
<tr><td><code>dryRun</code><br/>
<code>bool</code>
</td>
<td>
<p><code>dryRun</code> tells if the dry run mode is enabled, don't apply any change if it is and just output what would be done.</p>
</td>
</tr>
<tr><td><code>etcdUpgrade</code><br/>
<code>bool</code>
</td>
<td>
<p><code>etcdUpgrade</code> instructs kubeadm to execute etcd upgrade during upgrades.
Defaults to true.</p>
</td>
</tr>
<tr><td><code>ignorePreflightErrors</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>ignorePreflightErrors</code> provides a slice of pre-flight errors to be ignored during the upgrade process,
e.g. 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.</p>
</td>
</tr>
<tr><td><code>skipPhases</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>skipPhases</code> is a list of phases to skip during command execution.
The list of phases can be obtained with the <code>kubeadm upgrade node phase --help</code> command.</p>
</td>
</tr>
<tr><td><code>patches</code><br/>
<a href="#kubeadm-k8s-io-v1beta4-Patches"><code>Patches</code></a>
</td>
<td>
<p><code>patches</code> contains options related to applying patches to components deployed by kubeadm during <code>kubeadm upgrade</code>.</p>
</td>
</tr>
<tr><td><code>imagePullPolicy</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#pullpolicy-v1-core"><code>core/v1.PullPolicy</code></a>
</td>
<td>
<p><code>imagePullPolicy</code> specifies the policy for image pulling during <code>kubeadm upgrade node</code> operations.
The value of this field must be one of "Always", "IfNotPresent" or "Never".
If this field is unset kubeadm will default it to "IfNotPresent", or pull the required images if not present on the host.</p>
</td>
</tr>
<tr><td><code>imagePullSerial</code><br/>
<code>bool</code>
</td>
<td>
<p><code>imagePullSerial</code> specifies if image pulling performed by kubeadm must be done serially or in parallel.
Default: true</p>
</td>
</tr>
</tbody>
</table>
## `UpgradePlanConfiguration` {#kubeadm-k8s-io-v1beta4-UpgradePlanConfiguration}
**Appears in:**
- [UpgradeConfiguration](#kubeadm-k8s-io-v1beta4-UpgradeConfiguration)
<p>UpgradePlanConfiguration contains a list of configurable options which are specific to the "kubeadm upgrade plan" command.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>kubernetesVersion</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p><code>kubernetesVersion</code> is the target version of the control plane.</p>
</td>
</tr>
<tr><td><code>allowExperimentalUpgrades</code><br/>
<code>bool</code>
</td>
<td>
<p><code>allowExperimentalUpgrades</code> instructs kubeadm to show unstable versions of Kubernetes as an upgrade
alternative and allows upgrading to an alpha/beta/release candidate version of Kubernetes.
Default: false</p>
</td>
</tr>
<tr><td><code>allowRCUpgrades</code><br/>
<code>bool</code>
</td>
<td>
<p>Enable <code>allowRCUpgrades</code> will show release candidate versions of Kubernetes as an upgrade alternative and
allows upgrading to a release candidate version of Kubernetes.</p>
</td>
</tr>
<tr><td><code>dryRun</code><br/>
<code>bool</code>
</td>
<td>
<p><code>dryRun</code> tells if the dry run mode is enabled, don't apply any change if it is and just output what would be done.</p>
</td>
</tr>
<tr><td><code>ignorePreflightErrors</code><br/>
<code>[]string</code>
</td>
<td>
<p><code>ignorePreflightErrors</code> provides a slice of pre-flight errors to be ignored during the upgrade process,
e.g. 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.</p>
</td>
</tr>
<tr><td><code>printConfig</code><br/>
<code>bool</code>
</td>
<td>
<p><code>printConfig</code> specifies whether the configuration file that will be used in the upgrade should be printed or not.</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title kubeadm Configuration v1beta4 content type tool reference package kubeadm k8s io v1beta4 auto generated true h2 Overview h2 p Package v1beta4 defines the v1beta4 version of the kubeadm configuration file format This version improves on the v1beta3 format by fixing some minor issues and adding a few new fields p p A list of changes since v1beta3 p ul li TODO https github com kubernetes kubeadm issues 2890 li li Support custom environment variables in control plane components under code ClusterConfiguration code Use code apiServer extraEnvs code code controllerManager extraEnvs code code scheduler extraEnvs code code etcd local extraEnvs code li li The code ResetConfiguration code API type is now supported in v1beta4 Users are able to reset a node by passing a code config code file to code kubeadm reset code li li Dry run mode is now configureable in InitConfiguration and JoinConfiguration li li Replace the existing string string extra argument maps with structured extra arguments that support duplicates The change applies to code ClusterConfiguration code code apiServer extraArgs code code controllerManager extraArgs code code scheduler extraArgs code code etcd local extraArgs code Also to code nodeRegistration kubeletExtraArgs code li li Add code ClusterConfiguration encryptionAlgorithm code that can be used to set the asymmetric encryption algorithm used for this cluster s keys and certificates Can be one of code quot RSA 2048 quot code default code quot RSA 3072 quot code code quot RSA 4096 quot code or code quot ECDSA P256 quot code li li Add code ClusterConfiguration dns disabled code and code ClusterConfiguration proxy disabled code that can be used to disable the CoreDNS and kube proxy addons during cluster initialization Skipping the related addons phases during cluster creation will set the same fields to code false code li li Add the code nodeRegistration imagePullSerial code field in code InitConfiguration code and code JoinConfiguration code which can be used to control if kubeadm pulls images serially or in parallel li li The code UpgradeConfiguration code kubeadm API is now supported in v1beta4 when passing code config code to code kubeadm upgrade code subcommands Usage of component configuration for code kubelet code and code kube proxy code code InitConfiguration code and code ClusterConfiguration code is deprecated and will be ignored when passing code config code to code upgrade code subcommands li li Add a code Timeouts code structure to code InitConfiguration code code JoinConfiguration code code ResetConfiguration code and code UpgradeConfiguration code that can be used to configure various timeouts li li Add a code certificateValidityPeriod code and code caCertificateValidityPeriod code fields to code ClusterConfiguration code These fields can be used to control the validity period of certificates generated by kubeadm during sub commands such as code init code code join code code upgrade code and code certs code Default values continue to be 1 year for non CA certificates and 10 years for CA certificates Only non CA certificates continue to be renewable by code kubeadm certs renew code li ul h1 Migration from old kubeadm config versions h1 ul li kubeadm v1 15 x and newer can be used to migrate from v1beta1 to v1beta2 li li kubeadm v1 22 x and newer no longer support v1beta1 and older APIs but can be used to migrate v1beta2 to v1beta3 li li kubeadm v1 27 x and newer no longer support v1beta2 and older APIs li li TODO https github com kubernetes kubeadm issues 2890 add version that can be used to convert to v1beta4 li ul h2 Basics h2 p The preferred way to configure kubeadm is to pass an YAML configuration file with the code config code option Some of the configuration options defined in the kubeadm config file are also available as command line flags but only the most common simple use case are supported with this approach p p A kubeadm config file could contain multiple configuration types separated using three dashes code code p p kubeadm supports the following configuration types p pre code apiVersion kubeadm k8s io v1beta4 kind InitConfiguration apiVersion kubeadm k8s io v1beta4 kind ClusterConfiguration apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration apiVersion kubeproxy config k8s io v1alpha1 kind KubeProxyConfiguration apiVersion kubeadm k8s io v1beta4 kind JoinConfiguration apiVersion kubeadm k8s io v1beta4 kind ResetConfiguration apiVersion kubeadm k8s io v1beta4 kind UpgradeConfiguration code pre p To print the defaults for code init code and code join code actions use the following commands p pre style background color fff kubeadm config print init defaults kubeadm config print join defaults kubeadm config print reset defaults kubeadm config print upgrade defaults pre p The list of configuration types that must be included in a configuration file depends by the action you are performing code init code or code join code and by the configuration options you are going to use defaults or advanced customization p p If some configuration types are not provided or provided only partially kubeadm will use default values defaults provided by kubeadm includes also enforcing consistency of values across components when required e g code cluster cidr code flag on controller manager and code clusterCIDR code on kube proxy p p Users are always allowed to override default values with the only exception of a small subset of setting with relevance for security e g enforce authorization mode Node and RBAC on api server p p If the user provides a configuration types that is not expected for the action you are performing kubeadm will ignore those types and print a warning p h2 Kubeadm init configuration types h2 p When executing kubeadm init with the code config code option the following configuration types could be used InitConfiguration ClusterConfiguration KubeProxyConfiguration KubeletConfiguration but only one between InitConfiguration and ClusterConfiguration is mandatory p pre style background color fff span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta4 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span InitConfiguration span style color bbb span span style color bbb span span style color 000 font weight bold bootstrapTokens span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold nodeRegistration span span style color bbb span span style color bbb span span style color bbb span pre p The InitConfiguration type should be used to configure runtime settings that in case of kubeadm init are the configuration of the bootstrap token and all the setting which are specific to the node where kubeadm is executed including p ul li p NodeRegistration that holds fields that relate to registering the new node to the cluster use it to customize the node name the CRI socket to use or any other settings that should apply to this node only e g the node ip p li li p LocalAPIEndpoint that represents the endpoint of the instance of the API server to be deployed on this node use it e g to customize the API server advertise address p li ul pre style background color fff span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta4 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span ClusterConfiguration span style color bbb span span style color bbb span span style color 000 font weight bold networking span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold etcd span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold apiServer span span style color bbb span span style color bbb span span style color 000 font weight bold extraArgs span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold extraVolumes span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color bbb span pre p The ClusterConfiguration type should be used to configure cluster wide settings including settings for p ul li p code networking code that holds configuration for the networking topology of the cluster use it e g to customize Pod subnet or services subnet p li li p code etcd code use it e g to customize the local etcd or to configure the API server for using an external etcd cluster p li li p kube apiserver kube scheduler kube controller manager configurations use it to customize control plane components by adding customized setting or overriding kubeadm default settings p li ul pre style background color fff span style color 000 font weight bold apiVersion span span style color bbb span kubeproxy config k8s io v1alpha1 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span KubeProxyConfiguration span style color bbb span span style color bbb span span style color bbb span pre p The KubeProxyConfiguration type should be used to change the configuration passed to kube proxy instances deployed in the cluster If this object is not provided or provided only partially kubeadm applies defaults p p See https kubernetes io docs reference command line tools reference kube proxy or https pkg go dev k8s io kube proxy config v1alpha1 KubeProxyConfiguration for kube proxy official documentation p pre style background color fff span style color 000 font weight bold apiVersion span span style color bbb span kubelet config k8s io v1beta1 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span KubeletConfiguration span style color bbb span span style color bbb span span style color bbb span pre p The KubeletConfiguration type should be used to change the configurations that will be passed to all kubelet instances deployed in the cluster If this object is not provided or provided only partially kubeadm applies defaults p p See https kubernetes io docs reference command line tools reference kubelet or https pkg go dev k8s io kubelet config v1beta1 KubeletConfiguration for kubelet official documentation p p Here is a fully populated example of a single YAML file containing multiple configuration types to be used during a code kubeadm init code run p pre style background color fff span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta4 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span InitConfiguration span style color bbb span span style color bbb span span style color 000 font weight bold bootstrapTokens span span style color bbb span span style color bbb span span style color 000 font weight bold token span span style color bbb span span style color d14 34 9a08jv c0izixklcxtmnze7 34 span span style color bbb span span style color bbb span span style color 000 font weight bold description span span style color bbb span span style color d14 34 kubeadm bootstrap token 34 span span style color bbb span span style color bbb span span style color 000 font weight bold ttl span span style color bbb span span style color d14 34 24h 34 span span style color bbb span span style color bbb span span style color 000 font weight bold token span span style color bbb span span style color d14 34 783bde 3f89s0fje9f38fhf 34 span span style color bbb span span style color bbb span span style color 000 font weight bold description span span style color bbb span span style color d14 34 another bootstrap token 34 span span style color bbb span span style color bbb span span style color 000 font weight bold usages span span style color bbb span span style color bbb span authentication span style color bbb span span style color bbb span signing span style color bbb span span style color bbb span span style color 000 font weight bold groups span span style color bbb span span style color bbb span system bootstrappers kubeadm default node token span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold nodeRegistration span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span span style color d14 34 ec2 10 100 0 1 34 span span style color bbb span span style color bbb span span style color 000 font weight bold criSocket span span style color bbb span span style color d14 34 unix var run containerd containerd sock 34 span span style color bbb span span style color bbb span span style color 000 font weight bold taints span span style color bbb span span style color bbb span span style color 000 font weight bold key span span style color bbb span span style color d14 34 kubeadmNode 34 span span style color bbb span span style color bbb span span style color 000 font weight bold value span span style color bbb span span style color d14 34 someValue 34 span span style color bbb span span style color bbb span span style color 000 font weight bold effect span span style color bbb span span style color d14 34 NoSchedule 34 span span style color bbb span span style color bbb span span style color 000 font weight bold kubeletExtraArgs span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span v span style color bbb span span style color bbb span span style color 000 font weight bold value span span style color bbb span span style color d14 34 5 34 span span style color bbb span span style color bbb span span style color 000 font weight bold ignorePreflightErrors span span style color bbb span span style color bbb span IsPrivilegedUser span style color bbb span span style color bbb span span style color 000 font weight bold imagePullPolicy span span style color bbb span span style color d14 34 IfNotPresent 34 span span style color bbb span span style color bbb span span style color 000 font weight bold imagePullSerial span span style color bbb span span style color 000 font weight bold true span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold localAPIEndpoint span span style color bbb span span style color bbb span span style color 000 font weight bold advertiseAddress span span style color bbb span span style color d14 34 10 100 0 1 34 span span style color bbb span span style color bbb span span style color 000 font weight bold bindPort span span style color bbb span span style color 099 6443 span span style color bbb span span style color bbb span span style color 000 font weight bold certificateKey span span style color bbb span span style color d14 34 e6a2eb8581237ab72a4f494f30285ec12a9694d750b9785706a83bfcbbbd2204 34 span span style color bbb span span style color bbb span span style color 000 font weight bold skipPhases span span style color bbb span span style color bbb span preflight span style color bbb span span style color bbb span span style color 000 font weight bold timeouts span span style color bbb span span style color bbb span span style color 000 font weight bold controlPlaneComponentHealthCheck span span style color bbb span span style color d14 34 60s 34 span span style color bbb span span style color bbb span span style color 000 font weight bold kubenetesAPICall span span style color bbb span span style color d14 34 40s 34 span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta4 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span ClusterConfiguration span style color bbb span span style color bbb span span style color 000 font weight bold etcd span span style color bbb span span style color bbb span span style color bbb span span style color 998 font style italic one of local or external span span style color bbb span span style color bbb span span style color 000 font weight bold local span span style color bbb span span style color bbb span span style color 000 font weight bold imageRepository span span style color bbb span span style color d14 34 registry k8s io 34 span span style color bbb span span style color bbb span span style color 000 font weight bold imageTag span span style color bbb span span style color d14 34 3 2 24 34 span span style color bbb span span style color bbb span span style color 000 font weight bold dataDir span span style color bbb span span style color d14 34 var lib etcd 34 span span style color bbb span span style color bbb span span style color 000 font weight bold extraArgs span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span listen client urls span style color bbb span span style color bbb span span style color 000 font weight bold value span span style color bbb span http span style color 099 10 100 0 1 span span style color 099 2379 span span style color bbb span span style color bbb span span style color 000 font weight bold extraEnvs span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span SOME VAR span style color bbb span span style color bbb span span style color 000 font weight bold value span span style color bbb span SOME VALUE span style color bbb span span style color bbb span span style color 000 font weight bold serverCertSANs span span style color bbb span span style color bbb span span style color bbb span span style color d14 34 ec2 10 100 0 1 compute 1 amazonaws com 34 span span style color bbb span span style color bbb span span style color 000 font weight bold peerCertSANs span span style color bbb span span style color bbb span span style color d14 34 10 100 0 1 34 span span style color bbb span span style color bbb span span style color 998 font style italic external span span style color bbb span span style color bbb span span style color 998 font style italic endpoints span span style color bbb span span style color bbb span span style color 998 font style italic 34 10 100 0 1 2379 34 span span style color bbb span span style color bbb span span style color 998 font style italic 34 10 100 0 2 2379 34 span span style color bbb span span style color bbb span span style color 998 font style italic caFile 34 etcd kubernetes pki etcd etcd ca crt 34 span span style color bbb span span style color bbb span span style color 998 font style italic certFile 34 etcd kubernetes pki etcd etcd crt 34 span span style color bbb span span style color bbb span span style color 998 font style italic keyFile 34 etcd kubernetes pki etcd etcd key 34 span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold networking span span style color bbb span span style color bbb span span style color 000 font weight bold serviceSubnet span span style color bbb span span style color d14 34 10 96 0 0 16 34 span span style color bbb span span style color bbb span span style color 000 font weight bold podSubnet span span style color bbb span span style color d14 34 10 244 0 0 24 34 span span style color bbb span span style color bbb span span style color 000 font weight bold dnsDomain span span style color bbb span span style color d14 34 cluster local 34 span span style color bbb span span style color bbb span span style color 000 font weight bold kubernetesVersion span span style color bbb span span style color d14 34 v1 21 0 34 span span style color bbb span span style color bbb span span style color 000 font weight bold controlPlaneEndpoint span span style color bbb span span style color d14 34 10 100 0 1 6443 34 span span style color bbb span span style color bbb span span style color 000 font weight bold apiServer span span style color bbb span span style color bbb span span style color 000 font weight bold extraArgs span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span authorization mode span style color bbb span span style color bbb span span style color 000 font weight bold value span span style color bbb span span style color d14 34 Node RBAC 34 span span style color bbb span span style color bbb span span style color 000 font weight bold extraEnvs span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span SOME VAR span style color bbb span span style color bbb span span style color 000 font weight bold value span span style color bbb span SOME VALUE span style color bbb span span style color bbb span span style color 000 font weight bold extraVolumes span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span span style color d14 34 some volume 34 span span style color bbb span span style color bbb span span style color 000 font weight bold hostPath span span style color bbb span span style color d14 34 etc some path 34 span span style color bbb span span style color bbb span span style color 000 font weight bold mountPath span span style color bbb span span style color d14 34 etc some pod path 34 span span style color bbb span span style color bbb span span style color 000 font weight bold readOnly span span style color bbb span span style color 000 font weight bold false span span style color bbb span span style color bbb span span style color 000 font weight bold pathType span span style color bbb span File span style color bbb span span style color bbb span span style color 000 font weight bold certSANs span span style color bbb span span style color bbb span span style color d14 34 10 100 1 1 34 span span style color bbb span span style color bbb span span style color d14 34 ec2 10 100 0 1 compute 1 amazonaws com 34 span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold controllerManager span span style color bbb span span style color bbb span span style color 000 font weight bold extraArgs span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span node cidr mask size span style color bbb span span style color bbb span span style color 000 font weight bold value span span style color bbb span span style color d14 34 20 34 span span style color bbb span span style color bbb span span style color 000 font weight bold extraVolumes span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span span style color d14 34 some volume 34 span span style color bbb span span style color bbb span span style color 000 font weight bold hostPath span span style color bbb span span style color d14 34 etc some path 34 span span style color bbb span span style color bbb span span style color 000 font weight bold mountPath span span style color bbb span span style color d14 34 etc some pod path 34 span span style color bbb span span style color bbb span span style color 000 font weight bold readOnly span span style color bbb span span style color 000 font weight bold false span span style color bbb span span style color bbb span span style color 000 font weight bold pathType span span style color bbb span File span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold scheduler span span style color bbb span span style color bbb span span style color 000 font weight bold extraArgs span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span address span style color bbb span span style color bbb span span style color 000 font weight bold value span span style color bbb span span style color d14 34 10 100 0 1 34 span span style color bbb span span style color bbb span span style color 000 font weight bold extraVolumes span span style color bbb span span style color bbb span span style color 000 font weight bold name span span style color bbb span span style color d14 34 some volume 34 span span style color bbb span span style color bbb span span style color 000 font weight bold hostPath span span style color bbb span span style color d14 34 etc some path 34 span span style color bbb span span style color bbb span span style color 000 font weight bold mountPath span span style color bbb span span style color d14 34 etc some pod path 34 span span style color bbb span span style color bbb span span style color 000 font weight bold readOnly span span style color bbb span span style color 000 font weight bold false span span style color bbb span span style color bbb span span style color 000 font weight bold pathType span span style color bbb span File span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold certificatesDir span span style color bbb span span style color d14 34 etc kubernetes pki 34 span span style color bbb span span style color bbb span span style color 000 font weight bold imageRepository span span style color bbb span span style color d14 34 registry k8s io 34 span span style color bbb span span style color bbb span span style color 000 font weight bold clusterName span span style color bbb span span style color d14 34 example cluster 34 span span style color bbb span span style color bbb span span style color 000 font weight bold encryptionAlgorithm span span style color bbb span ECDSA P256 span style color bbb span span style color bbb span span style color 000 font weight bold dns span span style color bbb span span style color bbb span span style color 000 font weight bold disabled span span style color bbb span span style color 000 font weight bold true span span style color bbb span span style color 998 font style italic disable CoreDNS span span style color bbb span span style color bbb span span style color 000 font weight bold proxy span span style color bbb span span style color bbb span span style color 000 font weight bold disabled span span style color bbb span span style color 000 font weight bold true span span style color bbb span span style color 998 font style italic disable kube proxy span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold apiVersion span span style color bbb span kubelet config k8s io v1beta1 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span KubeletConfiguration span style color bbb span span style color bbb span span style color 998 font style italic kubelet specific options here span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold apiVersion span span style color bbb span kubeproxy config k8s io v1alpha1 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span KubeProxyConfiguration span style color bbb span span style color bbb span span style color 998 font style italic kube proxy specific options here span span style color bbb span pre h2 Kubeadm join configuration types h2 p When executing kubeadm join with the config option the JoinConfiguration type should be provided p pre style background color fff span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta4 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span JoinConfiguration span style color bbb span span style color bbb span span style color 000 font weight bold discovery span span style color bbb span span style color bbb span span style color 000 font weight bold bootstrapToken span span style color bbb span span style color bbb span span style color 000 font weight bold apiServerEndpoint span span style color bbb span some address span style color 099 6443 span span style color bbb span span style color bbb span span style color 000 font weight bold token span span style color bbb span abcdef 0123456789abcdef span style color bbb span span style color bbb span span style color 000 font weight bold unsafeSkipCAVerification span span style color bbb span span style color 000 font weight bold true span span style color bbb span span style color bbb span span style color 000 font weight bold tlsBootstrapToken span span style color bbb span abcdef 0123456789abcdef span style color bbb span pre p The JoinConfiguration type should be used to configure runtime settings that in case of kubeadm join are the discovery method used for accessing the cluster info and all the setting which are specific to the node where kubeadm is executed including p ul li p code nodeRegistration code that holds fields that relate to registering the new node to the cluster use it to customize the node name the CRI socket to use or any other settings that should apply to this node only e g the node ip p li li p code apiEndpoint code that represents the endpoint of the instance of the API server to be eventually deployed on this node p li ul h2 Kubeadm reset configuration types h2 p When executing code kubeadm reset code with the code config code option the code ResetConfiguration code type should be provided p pre style background color fff span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta4 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span ResetConfiguration span style color bbb span span style color bbb span span style color bbb span pre h2 Kubeadm upgrade configuration types h2 p When executing code kubeadm upgrade code with the code config code option the code UpgradeConfiguration code type should be provided p pre style background color fff span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta4 span style color bbb span span style color bbb span span style color 000 font weight bold kind span span style color bbb span UpgradeConfiguration span style color bbb span span style color bbb span span style color 000 font weight bold apply span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold diff span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold node span span style color bbb span span style color bbb span span style color bbb span span style color bbb span span style color 000 font weight bold plan span span style color bbb span span style color bbb span span style color bbb span pre p The code UpgradeConfiguration code structure includes a few substructures that only apply to different subcommands of code kubeadm upgrade code For example the code apply code substructure will be used with the code kubeadm upgrade apply code subcommand and all other substructures will be ignored in such a case p Resource Types ClusterConfiguration kubeadm k8s io v1beta4 ClusterConfiguration InitConfiguration kubeadm k8s io v1beta4 InitConfiguration JoinConfiguration kubeadm k8s io v1beta4 JoinConfiguration ResetConfiguration kubeadm k8s io v1beta4 ResetConfiguration UpgradeConfiguration kubeadm k8s io v1beta4 UpgradeConfiguration BootstrapToken BootstrapToken Appears in InitConfiguration kubeadm k8s io v1beta3 InitConfiguration InitConfiguration kubeadm k8s io v1beta4 InitConfiguration p BootstrapToken describes one bootstrap token stored as a Secret in the cluster p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code token code B Required B br a href BootstrapTokenString code BootstrapTokenString code a td td p code token code is used for establishing bidirectional trust between nodes and control planes Used for joining nodes in the cluster p td tr tr td code description code br code string code td td p code description code sets a human friendly message why this token exists and what it s used for so other administrators can know its purpose p td tr tr td code ttl code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code ttl code defines the time to live for this token Defaults to code 24h code code expires code and code ttl code are mutually exclusive p td tr tr td code expires code br a href https kubernetes io docs reference generated kubernetes api v1 31 time v1 meta code meta v1 Time code a td td p code expires code specifies the timestamp when this token expires Defaults to being set dynamically at runtime based on the code ttl code code expires code and code ttl code are mutually exclusive p td tr tr td code usages code br code string code td td p code usages code describes the ways in which this token can be used Can by default be used for establishing bidirectional trust but that can be changed here p td tr tr td code groups code br code string code td td p code groups code specifies the extra groups that this token will authenticate as when if used for authentication p td tr tbody table BootstrapTokenString BootstrapTokenString Appears in BootstrapToken BootstrapToken p BootstrapTokenString is a token of the format code abcdef abcdef0123456789 code that is used for both validation of the practically of the API server from a joining node s point of view and as an authentication method for the node in the bootstrap phase of quot kubeadm join quot This token is and should be short lived p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code code B Required B br code string code td td span class text muted No description provided span td tr tr td code code B Required B br code string code td td span class text muted No description provided span td tr tbody table ClusterConfiguration kubeadm k8s io v1beta4 ClusterConfiguration p ClusterConfiguration contains cluster wide configuration for a kubeadm cluster p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code kubeadm k8s io v1beta4 code td tr tr td code kind code br string td td code ClusterConfiguration code td tr tr td code etcd code br a href kubeadm k8s io v1beta4 Etcd code Etcd code a td td p code etcd code holds the configuration for etcd p td tr tr td code networking code br a href kubeadm k8s io v1beta4 Networking code Networking code a td td p code networking code holds configuration for the networking topology of the cluster p td tr tr td code kubernetesVersion code br code string code td td p code kubernetesVersion code is the target version of the control plane p td tr tr td code controlPlaneEndpoint code br code string code td td p code controlPlaneEndpoint code sets a stable IP address or DNS name for the control plane It can be a valid IP address or a RFC 1123 DNS subdomain both with optional TCP port In case the code controlPlaneEndpoint code is not specified the code advertiseAddress code code bindPort code are used in case the code controlPlaneEndpoint code is specified but without a TCP port the code bindPort code is used Possible usages are p ul li In a cluster with more than one control plane instances this field should be assigned the address of the external load balancer in front of the control plane instances li li In environments with enforced node recycling the code controlPlaneEndpoint code could be used for assigning a stable DNS to the control plane li ul td tr tr td code apiServer code br a href kubeadm k8s io v1beta4 APIServer code APIServer code a td td p code apiServer code contains extra settings for the API server p td tr tr td code controllerManager code br a href kubeadm k8s io v1beta4 ControlPlaneComponent code ControlPlaneComponent code a td td p code controllerManager code contains extra settings for the controller manager p td tr tr td code scheduler code br a href kubeadm k8s io v1beta4 ControlPlaneComponent code ControlPlaneComponent code a td td p code scheduler code contains extra settings for the scheduler p td tr tr td code dns code br a href kubeadm k8s io v1beta4 DNS code DNS code a td td p code dns code defines the options for the DNS add on installed in the cluster p td tr tr td code proxy code B Required B br a href kubeadm k8s io v1beta4 Proxy code Proxy code a td td p code proxy code defines the options for the proxy add on installed in the cluster p td tr tr td code certificatesDir code br code string code td td p code certificatesDir code specifies where to store or look for all required certificates p td tr tr td code imageRepository code br code string code td td p code imageRepository code sets the container registry to pull images from If empty code registry k8s io code will be used by default In case of kubernetes version is a CI build kubernetes version starts with code ci code code gcr io k8s staging ci images code will be used as a default for control plane components and for kube proxy while code registry k8s io code will be used for all the other images p td tr tr td code featureGates code br code map string bool code td td p code featureGates code contains the feature gates enabled by the user p td tr tr td code clusterName code br code string code td td p The cluster name p td tr tr td code encryptionAlgorithm code br a href kubeadm k8s io v1beta4 EncryptionAlgorithmType code EncryptionAlgorithmType code a td td p code encryptionAlgorithm code holds the type of asymmetric encryption algorithm used for keys and certificates Can be one of code quot RSA 2048 quot code default code quot RSA 3072 quot code code quot RSA 4096 quot code or code quot ECDSA P256 quot code p td tr tr td code certificateValidityPeriod code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code certificateValidityPeriod code specifies the validity period for a non CA certificate generated by kubeadm Default value 8760h 365 days 24 hours 1 year p td tr tr td code caCertificateValidityPeriod code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code caCertificateValidityPeriod code specifies the validity period for a CA certificate generated by kubeadm Default value code 87600h code 365 days 24 hours 10 10 years p td tr tbody table InitConfiguration kubeadm k8s io v1beta4 InitConfiguration p InitConfiguration contains a list of elements that is specific quot kubeadm init quot only runtime information code kubeadm init code only information These fields are solely used the first time code kubeadm init code runs After that the information in the fields IS NOT uploaded to the code kubeadm config code ConfigMap that is used by code kubeadm upgrade code for instance These fields must be omitempty p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code kubeadm k8s io v1beta4 code td tr tr td code kind code br string td td code InitConfiguration code td tr tr td code bootstrapTokens code br a href BootstrapToken code BootstrapToken code a td td p code bootstrapTokens code is respected at code kubeadm init code time and describes a set of Bootstrap Tokens to create This information IS NOT uploaded to the kubeadm cluster configmap partly because of its sensitive nature p td tr tr td code dryRun code B Required B br code bool code td td p code dryRun code tells if the dry run mode is enabled don t apply any change in dry run mode just out put what would be done p td tr tr td code nodeRegistration code br a href kubeadm k8s io v1beta4 NodeRegistrationOptions code NodeRegistrationOptions code a td td p code nodeRegistration code holds fields that relate to registering the new control plane node to the cluster p td tr tr td code localAPIEndpoint code br a href kubeadm k8s io v1beta4 APIEndpoint code APIEndpoint code a td td p code localAPIEndpoint code represents the endpoint of the API server instance that s deployed on this control plane node In HA setups this differs from code ClusterConfiguration controlPlaneEndpoint code in the sense that code controlPlaneEndpoint code is the global endpoint for the cluster which then loadbalances the requests to each individual API server This configuration object lets you customize what IP DNS name and port the local API server advertises it s accessible on By default kubeadm tries to auto detect the IP of the default interface and use that but in case that process fails you may set the desired value here p td tr tr td code certificateKey code br code string code td td p code certificateKey code sets the key with which certificates and keys are encrypted prior to being uploaded in a Secret in the cluster during the code uploadcerts init code phase The certificate key is a hex encoded string that is an AES key of size 32 bytes p td tr tr td code skipPhases code br code string code td td p code skipPhases code is a list of phases to skip during command execution The list of phases can be obtained with the code kubeadm init help code command The flag code skip phases code takes precedence over this field p td tr tr td code patches code br a href kubeadm k8s io v1beta4 Patches code Patches code a td td p code patches code contains options related to applying patches to components deployed by kubeadm during code kubeadm init code p td tr tr td code timeouts code br a href kubeadm k8s io v1beta4 Timeouts code Timeouts code a td td p code timeouts code holds various timeouts that apply to kubeadm commands p td tr tbody table JoinConfiguration kubeadm k8s io v1beta4 JoinConfiguration p JoinConfiguration contains elements describing a particular node p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code kubeadm k8s io v1beta4 code td tr tr td code kind code br string td td code JoinConfiguration code td tr tr td code dryRun code br code bool code td td p code dryRun code tells if the dry run mode is enabled don t apply any change if it is set just output what would be done p td tr tr td code nodeRegistration code br a href kubeadm k8s io v1beta4 NodeRegistrationOptions code NodeRegistrationOptions code a td td p code nodeRegistration code holds fields that relate to registering the new control plane node to the cluster p td tr tr td code caCertPath code br code string code td td p code caCertPath code is the path to the SSL certificate authority used to secure comunications between node and control plane Defaults to quot etc kubernetes pki ca crt quot p td tr tr td code discovery code B Required B br a href kubeadm k8s io v1beta4 Discovery code Discovery code a td td p code discovery code specifies the options for the kubelet to use during the TLS bootstrap process p td tr tr td code controlPlane code br a href kubeadm k8s io v1beta4 JoinControlPlane code JoinControlPlane code a td td p code controlPlane code defines the additional control plane instance to be deployed on the joining node If nil no additional control plane instance will be deployed p td tr tr td code skipPhases code br code string code td td p code skipPhases code is a list of phases to skip during command execution The list of phases can be obtained with the code kubeadm join help code command The flag code skip phases code takes precedence over this field p td tr tr td code patches code br a href kubeadm k8s io v1beta4 Patches code Patches code a td td p code patches code contains options related to applying patches to components deployed by kubeadm during code kubeadm join code p td tr tr td code timeouts code br a href kubeadm k8s io v1beta4 Timeouts code Timeouts code a td td p code timeouts code holds various timeouts that apply to kubeadm commands p td tr tbody table ResetConfiguration kubeadm k8s io v1beta4 ResetConfiguration p ResetConfiguration contains a list of fields that are specifically code kubeadm reset code only runtime information p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code kubeadm k8s io v1beta4 code td tr tr td code kind code br string td td code ResetConfiguration code td tr tr td code cleanupTmpDir code br code bool code td td p code cleanupTmpDir code specifies whether the quot etc kubernetes tmp quot directory should be cleaned during the reset process p td tr tr td code certificatesDir code br code string code td td p code certificatesDir code specifies the directory where the certificates are stored If specified it will be cleaned during the reset process p td tr tr td code criSocket code br code string code td td p code criSocket code is used to retrieve container runtime inforomation and used for the removal of the containers If code criSocket code is not specified by flag or config file kubeadm will try to detect one valid CRI socket instead p td tr tr td code dryRun code br code bool code td td p code dryRun code tells if the dry run mode is enabled don t apply any change if it is set and just output what would be done p td tr tr td code force code br code bool code td td p The code force code flag instructs kubeadm to reset the node without prompting for confirmation p td tr tr td code ignorePreflightErrors code br code string code td td p code ignorePreflightErrors code provides a list of pre flight errors to be ignored during the reset process e g code IsPrivilegedUser Swap code Value code all code ignores errors from all checks p td tr tr td code skipPhases code br code string code td td p code skipPhases code is a list of phases to skip during command execution The list of phases can be obtained with the code kubeadm reset phase help code command p td tr tr td code unmountFlags code br code string code td td p code unmountFlags code is a list of code unmount2 code syscall flags that kubeadm can use when unmounting directories during quot reset quot This flag can be one of code quot MNT FORCE quot code code quot MNT DETACH quot code code quot MNT EXPIRE quot code code quot UMOUNT NOFOLLOW quot code By default this list is empty p td tr tr td code timeouts code br a href kubeadm k8s io v1beta4 Timeouts code Timeouts code a td td p Timeouts holds various timeouts that apply to kubeadm commands p td tr tbody table UpgradeConfiguration kubeadm k8s io v1beta4 UpgradeConfiguration p UpgradeConfiguration contains a list of options that are specific to code kubeadm upgrade code subcommands p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code apiVersion code br string td td code kubeadm k8s io v1beta4 code td tr tr td code kind code br string td td code UpgradeConfiguration code td tr tr td code apply code br a href kubeadm k8s io v1beta4 UpgradeApplyConfiguration code UpgradeApplyConfiguration code a td td p code apply code holds a list of options that are specific to the code kubeadm upgrade apply code command p td tr tr td code diff code br a href kubeadm k8s io v1beta4 UpgradeDiffConfiguration code UpgradeDiffConfiguration code a td td p code diff code holds a list of options that are specific to the code kubeadm upgrade diff code command p td tr tr td code node code br a href kubeadm k8s io v1beta4 UpgradeNodeConfiguration code UpgradeNodeConfiguration code a td td p code node code holds a list of options that are specific to the code kubeadm upgrade node code command p td tr tr td code plan code br a href kubeadm k8s io v1beta4 UpgradePlanConfiguration code UpgradePlanConfiguration code a td td p code plan code holds a list of options that are specific to the code kubeadm upgrade plan code command p td tr tr td code timeouts code br a href kubeadm k8s io v1beta4 Timeouts code Timeouts code a td td p code timeouts code holds various timeouts that apply to kubeadm commands p td tr tbody table APIEndpoint kubeadm k8s io v1beta4 APIEndpoint Appears in InitConfiguration kubeadm k8s io v1beta4 InitConfiguration JoinControlPlane kubeadm k8s io v1beta4 JoinControlPlane p APIEndpoint struct contains elements of API server instance deployed on a node p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code advertiseAddress code br code string code td td p code dvertiseAddress code sets the IP address for the API server to advertise p td tr tr td code bindPort code br code int32 code td td p code bindPort code sets the secure port for the API Server to bind to Defaults to 6443 p td tr tbody table APIServer kubeadm k8s io v1beta4 APIServer Appears in ClusterConfiguration kubeadm k8s io v1beta4 ClusterConfiguration p APIServer holds settings necessary for API server deployments in the cluster p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ControlPlaneComponent code B Required B br a href kubeadm k8s io v1beta4 ControlPlaneComponent code ControlPlaneComponent code a td td Members of code ControlPlaneComponent code are embedded into this type span class text muted No description provided span td tr tr td code certSANs code br code string code td td p code certSANs code sets extra Subject Alternative Names SANs for the API Server signing certificate p td tr tbody table Arg kubeadm k8s io v1beta4 Arg Appears in ControlPlaneComponent kubeadm k8s io v1beta4 ControlPlaneComponent LocalEtcd kubeadm k8s io v1beta4 LocalEtcd NodeRegistrationOptions kubeadm k8s io v1beta4 NodeRegistrationOptions p Arg represents an argument with a name and a value p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code name code B Required B br code string code td td p The name of the argument p td tr tr td code value code B Required B br code string code td td p The value of the argument p td tr tbody table BootstrapTokenDiscovery kubeadm k8s io v1beta4 BootstrapTokenDiscovery Appears in Discovery kubeadm k8s io v1beta4 Discovery p BootstrapTokenDiscovery is used to set the options for bootstrap token based discovery p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code token code B Required B br code string code td td p code token code is a token used to validate cluster information fetched from the control plane p td tr tr td code apiServerEndpoint code br code string code td td p code apiServerEndpoint code is an IP or domain name to the API server from which information will be fetched p td tr tr td code caCertHashes code br code string code td td p code caCertHashes code specifies a set of public key pins to verify when token based discovery is used The root CA found during discovery must match one of these values Specifying an empty set disables root CA pinning which can be unsafe Each hash is specified as code lt type gt lt value gt code where the only currently supported type is quot sha256 quot This is a hex encoded SHA 256 hash of the Subject Public Key Info SPKI object in DER encoded ASN 1 These hashes can be calculated using for example OpenSSL p td tr tr td code unsafeSkipCAVerification code br code bool code td td p code unsafeSkipCAVerification code allows token based discovery without CA verification via code caCertHashes code This can weaken the security of kubeadm since other nodes can impersonate the control plane p td tr tbody table ControlPlaneComponent kubeadm k8s io v1beta4 ControlPlaneComponent Appears in ClusterConfiguration kubeadm k8s io v1beta4 ClusterConfiguration APIServer kubeadm k8s io v1beta4 APIServer p ControlPlaneComponent holds settings common to control plane component of the cluster p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code extraArgs code br a href kubeadm k8s io v1beta4 Arg code Arg code a td td p code extraArgs code is an extra set of flags to pass to the control plane component An argument name in this list is the flag name as it appears on the command line except without leading dash es Extra arguments will override existing default arguments Duplicate extra arguments are allowed p td tr tr td code extraVolumes code br a href kubeadm k8s io v1beta4 HostPathMount code HostPathMount code a td td p code extraVolumes code is an extra set of host volumes mounted to the control plane component p td tr tr td code extraEnvs code br a href kubeadm k8s io v1beta4 EnvVar code EnvVar code a td td p code extraEnvs code is an extra set of environment variables to pass to the control plane component Environment variables passed using code extraEnvs code will override any existing environment variables or code proxy code environment variables that kubeadm adds by default p td tr tbody table DNS kubeadm k8s io v1beta4 DNS Appears in ClusterConfiguration kubeadm k8s io v1beta4 ClusterConfiguration p DNS defines the DNS addon that should be used in the cluster p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ImageMeta code B Required B br a href kubeadm k8s io v1beta4 ImageMeta code ImageMeta code a td td Members of code ImageMeta code are embedded into this type p code imageMeta code allows to customize the image used for the DNS addon p td tr tr td code disabled code B Required B br code bool code td td p code disabled code specifies whether to disable this addon in the cluster p td tr tbody table Discovery kubeadm k8s io v1beta4 Discovery Appears in JoinConfiguration kubeadm k8s io v1beta4 JoinConfiguration p Discovery specifies the options for the kubelet to use during the TLS Bootstrap process p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code bootstrapToken code br a href kubeadm k8s io v1beta4 BootstrapTokenDiscovery code BootstrapTokenDiscovery code a td td p code bootstrapToken code is used to set the options for bootstrap token based discovery code bootstrapToken code and code file code are mutually exclusive p td tr tr td code file code br a href kubeadm k8s io v1beta4 FileDiscovery code FileDiscovery code a td td p code file code is used to specify a file or URL to a kubeconfig file from which to load cluster information code bootstrapToken code and code file code are mutually exclusive p td tr tr td code tlsBootstrapToken code br code string code td td p code tlsBootstrapToken code is a token used for TLS bootstrapping If code bootstrapToken code is set this field is defaulted to code bootstrapToken token code but can be overridden If code file code is set this field strong must be set strong in case the KubeConfigFile does not contain any other authentication information p td tr tbody table EncryptionAlgorithmType kubeadm k8s io v1beta4 EncryptionAlgorithmType Alias of string Appears in ClusterConfiguration kubeadm k8s io v1beta4 ClusterConfiguration p EncryptionAlgorithmType can define an asymmetric encryption algorithm type p EnvVar kubeadm k8s io v1beta4 EnvVar Appears in ControlPlaneComponent kubeadm k8s io v1beta4 ControlPlaneComponent LocalEtcd kubeadm k8s io v1beta4 LocalEtcd p EnvVar represents an environment variable present in a Container p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code EnvVar code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 31 envvar v1 core code core v1 EnvVar code a td td Members of code EnvVar code are embedded into this type span class text muted No description provided span td tr tbody table Etcd kubeadm k8s io v1beta4 Etcd Appears in ClusterConfiguration kubeadm k8s io v1beta4 ClusterConfiguration p Etcd contains elements describing Etcd configuration p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code local code br a href kubeadm k8s io v1beta4 LocalEtcd code LocalEtcd code a td td p code local code provides configuration knobs for configuring the local etcd instance code local code and code external code are mutually exclusive p td tr tr td code external code br a href kubeadm k8s io v1beta4 ExternalEtcd code ExternalEtcd code a td td p code external code describes how to connect to an external etcd cluster code local code and code external code are mutually exclusive p td tr tbody table ExternalEtcd kubeadm k8s io v1beta4 ExternalEtcd Appears in Etcd kubeadm k8s io v1beta4 Etcd p ExternalEtcd describes an external etcd cluster Kubeadm has no knowledge of where certificate files live and they must be supplied p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code endpoints code B Required B br code string code td td p code endpoints code contains the list of etcd members p td tr tr td code caFile code B Required B br code string code td td p code caFile code is an SSL Certificate Authority CA file used to secure etcd communication Required if using a TLS connection p td tr tr td code certFile code B Required B br code string code td td p code certFile code is an SSL certification file used to secure etcd communication Required if using a TLS connection p td tr tr td code keyFile code B Required B br code string code td td p code keyFile code is an SSL key file used to secure etcd communication Required if using a TLS connection p td tr tbody table FileDiscovery kubeadm k8s io v1beta4 FileDiscovery Appears in Discovery kubeadm k8s io v1beta4 Discovery p FileDiscovery is used to specify a file or URL to a kubeconfig file from which to load cluster information p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code kubeConfigPath code B Required B br code string code td td p code kubeConfigPath code is used to specify the actual file path or URL to the kubeconfig file from which to load cluster information p td tr tbody table HostPathMount kubeadm k8s io v1beta4 HostPathMount Appears in ControlPlaneComponent kubeadm k8s io v1beta4 ControlPlaneComponent p HostPathMount contains elements describing volumes that are mounted from the host p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code name code B Required B br code string code td td p code name code is the name of the volume inside the Pod template p td tr tr td code hostPath code B Required B br code string code td td p code hostPath code is the path in the host that will be mounted inside the Pod p td tr tr td code mountPath code B Required B br code string code td td p code mountPath code is the path inside the Pod where code hostPath code will be mounted p td tr tr td code readOnly code br code bool code td td p code readOnly code controls write access to the volume p td tr tr td code pathType code br a href https kubernetes io docs reference generated kubernetes api v1 31 hostpathtype v1 core code core v1 HostPathType code a td td p code pathType code is the type of the code hostPath code p td tr tbody table ImageMeta kubeadm k8s io v1beta4 ImageMeta Appears in DNS kubeadm k8s io v1beta4 DNS LocalEtcd kubeadm k8s io v1beta4 LocalEtcd p ImageMeta allows to customize the image used for components that are not originated from the Kubernetes Kubernetes release process p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code imageRepository code br code string code td td p code imageRepository code sets the container registry to pull images from if not set the code imageRepository code defined in ClusterConfiguration will be used instead p td tr tr td code imageTag code br code string code td td p code imageTag code allows to specify a tag for the image In case this value is set kubeadm does not change automatically the version of the above components during upgrades p td tr tbody table JoinControlPlane kubeadm k8s io v1beta4 JoinControlPlane Appears in JoinConfiguration kubeadm k8s io v1beta4 JoinConfiguration p JoinControlPlane contains elements describing an additional control plane instance to be deployed on the joining node p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code localAPIEndpoint code br a href kubeadm k8s io v1beta4 APIEndpoint code APIEndpoint code a td td p code localAPIEndpoint code represents the endpoint of the API server instance to be deployed on this node p td tr tr td code certificateKey code br code string code td td p code certificateKey code is the key that is used for decryption of certificates after they are downloaded from the Secret upon joining a new control plane node The corresponding encryption key is in the InitConfiguration The certificate key is a hex encoded string that is an AES key of size 32 bytes p td tr tbody table LocalEtcd kubeadm k8s io v1beta4 LocalEtcd Appears in Etcd kubeadm k8s io v1beta4 Etcd p LocalEtcd describes that kubeadm should run an etcd cluster locally p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ImageMeta code B Required B br a href kubeadm k8s io v1beta4 ImageMeta code ImageMeta code a td td Members of code ImageMeta code are embedded into this type p ImageMeta allows to customize the container used for etcd p td tr tr td code dataDir code B Required B br code string code td td p code dataDir code is the directory etcd will place its data Defaults to quot var lib etcd quot p td tr tr td code extraArgs code B Required B br a href kubeadm k8s io v1beta4 Arg code Arg code a td td p code extraArgs code are extra arguments provided to the etcd binary when run inside a static Pod An argument name in this list is the flag name as it appears on the command line except without leading dash es Extra arguments will override existing default arguments Duplicate extra arguments are allowed p td tr tr td code extraEnvs code br a href kubeadm k8s io v1beta4 EnvVar code EnvVar code a td td p code extraEnvs code is an extra set of environment variables to pass to the control plane component Environment variables passed using code extraEnvs code will override any existing environment variables or code proxy code environment variables that kubeadm adds by default p td tr tr td code serverCertSANs code br code string code td td p code serverCertSANs code sets extra Subject Alternative Names SANs for the etcd server signing certificate p td tr tr td code peerCertSANs code br code string code td td p code peerCertSANs code sets extra Subject Alternative Names SANs for the etcd peer signing certificate p td tr tbody table Networking kubeadm k8s io v1beta4 Networking Appears in ClusterConfiguration kubeadm k8s io v1beta4 ClusterConfiguration p Networking contains elements describing cluster s networking configuration p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code serviceSubnet code br code string code td td p code serviceSubnet code is the subnet used by Kubernetes Services Defaults to quot 10 96 0 0 12 quot p td tr tr td code podSubnet code br code string code td td p code podSubnet code is the subnet used by Pods p td tr tr td code dnsDomain code br code string code td td p code dnsDomain code is the dns domain used by Kubernetes Services Defaults to quot cluster local quot p td tr tbody table NodeRegistrationOptions kubeadm k8s io v1beta4 NodeRegistrationOptions Appears in InitConfiguration kubeadm k8s io v1beta4 InitConfiguration JoinConfiguration kubeadm k8s io v1beta4 JoinConfiguration p NodeRegistrationOptions holds fields that relate to registering a new control plane or node to the cluster either via code kubeadm init code or code kubeadm join code p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code name code br code string code td td p code name code is the code Metadata Name code field of the Node API object that will be created in this code kubeadm init code or code kubeadm join code operation This field is also used in the code CommonName code field of the kubelet s client certificate to the API server Defaults to the hostname of the node if not provided p td tr tr td code criSocket code br code string code td td p code criSocket code is used to retrieve container runtime info This information will be annotated to the Node API object for later re use p td tr tr td code taints code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 31 taint v1 core code core v1 Taint code a td td p code taints code specifies the taints the Node API object should be registered with If this field is unset i e nil it will be defaulted with a control plane taint for control plane nodes If you don t want to taint your control plane node set this field to an empty list i e code taints code in the YAML file This field is solely used for Node registration p td tr tr td code kubeletExtraArgs code br a href kubeadm k8s io v1beta4 Arg code Arg code a td td p code kubeletExtraArgs code passes through extra arguments to the kubelet The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source This overrides the generic base level configuration in the code kubelet config code ConfigMap Flags have higher priority when parsing These values are local and specific to the node kubeadm is executing on An argument name in this list is the flag name as it appears on the command line except without leading dash es Extra arguments will override existing default arguments Duplicate extra arguments are allowed p td tr tr td code ignorePreflightErrors code br code string code td td p code ignorePreflightErrors code provides a slice of pre flight errors to be ignored when the current node is registered e g IsPrivilegedUser Swap Value all ignores errors from all checks p td tr tr td code imagePullPolicy code br a href https kubernetes io docs reference generated kubernetes api v1 31 pullpolicy v1 core code core v1 PullPolicy code a td td p code imagePullPolicy code specifies the policy for image pulling during kubeadm code init code and code join code operations The value of this field must be one of quot Always quot quot IfNotPresent quot or quot Never quot If this field is unset kubeadm will default it to quot IfNotPresent quot or pull the required images if not present on the host p td tr tr td code imagePullSerial code br code bool code td td p code imagePullSerial code specifies if image pulling performed by kubeadm must be done serially or in parallel Default true p td tr tbody table Patches kubeadm k8s io v1beta4 Patches Appears in InitConfiguration kubeadm k8s io v1beta4 InitConfiguration JoinConfiguration kubeadm k8s io v1beta4 JoinConfiguration UpgradeApplyConfiguration kubeadm k8s io v1beta4 UpgradeApplyConfiguration UpgradeNodeConfiguration kubeadm k8s io v1beta4 UpgradeNodeConfiguration p Patches contains options related to applying patches to components deployed by kubeadm p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code directory code br code string code td td p code directory code is a path to a directory that contains files named quot target suffix patchtype extension quot For example quot kube apiserver0 merge yaml quot or just quot etcd json quot quot target quot can be one of quot kube apiserver quot quot kube controller manager quot quot kube scheduler quot quot etcd quot quot kubeletconfiguration quot quot corednsdeployment quot quot patchtype quot can be one of quot strategic quot quot merge quot or quot json quot and they match the patch formats supported by kubectl The default quot patchtype quot is quot strategic quot quot extension quot must be either quot json quot or quot yaml quot quot suffix quot is an optional string that can be used to determine which patches are applied first alpha numerically p td tr tbody table Proxy kubeadm k8s io v1beta4 Proxy Appears in ClusterConfiguration kubeadm k8s io v1beta4 ClusterConfiguration p Proxy defines the proxy addon that should be used in the cluster p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code disabled code B Required B br code bool code td td p code disabled code specifies whether to disable this addon in the cluster p td tr tbody table Timeouts kubeadm k8s io v1beta4 Timeouts Appears in InitConfiguration kubeadm k8s io v1beta4 InitConfiguration JoinConfiguration kubeadm k8s io v1beta4 JoinConfiguration ResetConfiguration kubeadm k8s io v1beta4 ResetConfiguration UpgradeConfiguration kubeadm k8s io v1beta4 UpgradeConfiguration p Timeouts holds various timeouts that apply to kubeadm commands p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code controlPlaneComponentHealthCheck code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code controlPlaneComponentHealthCheck code is the amount of time to wait for a control plane component such as the API server to be healthy during code kubeadm init code and code kubeadm join code Default 4m p td tr tr td code kubeletHealthCheck code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code kubeletHealthCheck code is the amount of time to wait for the kubelet to be healthy during code kubeadm init code and code kubeadm join code Default 4m p td tr tr td code kubernetesAPICall code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code kubernetesAPICall code is the amount of time to wait for the kubeadm client to complete a request to the API server This applies to all types of methods GET POST etc Default 1m p td tr tr td code etcdAPICall code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code etcdAPICall code is the amount of time to wait for the kubeadm etcd client to complete a request to the etcd cluster Default 2m p td tr tr td code tlsBootstrap code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code tlsBootstrap code is the amount of time to wait for the kubelet to complete TLS bootstrap for a joining node Default 5m p td tr tr td code discovery code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code discovery code is the amount of time to wait for kubeadm to validate the API server identity for a joining node Default 5m p td tr tr td code upgradeManifests code B Required B br a href https pkg go dev k8s io apimachinery pkg apis meta v1 Duration code meta v1 Duration code a td td p code upgradeManifests code is the timeout for upgrading static Pod manifests Default 5m p td tr tbody table UpgradeApplyConfiguration kubeadm k8s io v1beta4 UpgradeApplyConfiguration Appears in UpgradeConfiguration kubeadm k8s io v1beta4 UpgradeConfiguration p UpgradeApplyConfiguration contains a list of configurable options which are specific to the quot kubeadm upgrade apply quot command p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code kubernetesVersion code br code string code td td p code kubernetesVersion code is the target version of the control plane p td tr tr td code allowExperimentalUpgrades code br code bool code td td p code allowExperimentalUpgrades code instructs kubeadm to show unstable versions of Kubernetes as an upgrade alternative and allows upgrading to an alpha beta release candidate version of Kubernetes Default false p td tr tr td code allowRCUpgrades code br code bool code td td p Enable code allowRCUpgrades code will show release candidate versions of Kubernetes as an upgrade alternative and allows upgrading to a release candidate version of Kubernetes p td tr tr td code certificateRenewal code br code bool code td td p code certificateRenewal code instructs kubeadm to execute certificate renewal during upgrades Defaults to true p td tr tr td code dryRun code br code bool code td td p code dryRun code tells if the dry run mode is enabled don t apply any change if it is and just output what would be done p td tr tr td code etcdUpgrade code br code bool code td td p code etcdUpgrade code instructs kubeadm to execute etcd upgrade during upgrades Defaults to true p td tr tr td code forceUpgrade code br code bool code td td p code forceUpgrade code flag instructs kubeadm to upgrade the cluster without prompting for confirmation p td tr tr td code ignorePreflightErrors code br code string code td td p code ignorePreflightErrors code provides a slice of pre flight errors to be ignored during the upgrade process e g code IsPrivilegedUser Swap code Value code all code ignores errors from all checks p td tr tr td code patches code br a href kubeadm k8s io v1beta4 Patches code Patches code a td td p code patches code contains options related to applying patches to components deployed by kubeadm during code kubeadm upgrade code p td tr tr td code printConfig code br code bool code td td p code printConfig code specifies whether the configuration file that will be used in the upgrade should be printed or not p td tr tr td code skipPhases code B Required B br code string code td td p code skipPhases code is a list of phases to skip during command execution NOTE This field is currently ignored for code kubeadm upgrade apply code but in the future it will be supported p td tr tr td code imagePullPolicy code br a href https kubernetes io docs reference generated kubernetes api v1 31 pullpolicy v1 core code core v1 PullPolicy code a td td p code imagePullPolicy code specifies the policy for image pulling during code kubeadm upgrade apply code operations The value of this field must be one of quot Always quot quot IfNotPresent quot or quot Never quot If this field is unset kubeadm will default it to quot IfNotPresent quot or pull the required images if not present on the host p td tr tr td code imagePullSerial code br code bool code td td p code imagePullSerial code specifies if image pulling performed by kubeadm must be done serially or in parallel Default true p td tr tbody table UpgradeDiffConfiguration kubeadm k8s io v1beta4 UpgradeDiffConfiguration Appears in UpgradeConfiguration kubeadm k8s io v1beta4 UpgradeConfiguration p UpgradeDiffConfiguration contains a list of configurable options which are specific to the code kubeadm upgrade diff code command p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code kubernetesVersion code br code string code td td p code kubernetesVersion code is the target version of the control plane p td tr tr td code contextLines code br code int code td td p code diffContextLines code is the number of lines of context in the diff p td tr tbody table UpgradeNodeConfiguration kubeadm k8s io v1beta4 UpgradeNodeConfiguration Appears in UpgradeConfiguration kubeadm k8s io v1beta4 UpgradeConfiguration p UpgradeNodeConfiguration contains a list of configurable options which are specific to the quot kubeadm upgrade node quot command p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code certificateRenewal code br code bool code td td p code certificateRenewal code instructs kubeadm to execute certificate renewal during upgrades Defaults to true p td tr tr td code dryRun code br code bool code td td p code dryRun code tells if the dry run mode is enabled don t apply any change if it is and just output what would be done p td tr tr td code etcdUpgrade code br code bool code td td p code etcdUpgrade code instructs kubeadm to execute etcd upgrade during upgrades Defaults to true p td tr tr td code ignorePreflightErrors code br code string code td td p code ignorePreflightErrors code provides a slice of pre flight errors to be ignored during the upgrade process e g IsPrivilegedUser Swap Value all ignores errors from all checks p td tr tr td code skipPhases code br code string code td td p code skipPhases code is a list of phases to skip during command execution The list of phases can be obtained with the code kubeadm upgrade node phase help code command p td tr tr td code patches code br a href kubeadm k8s io v1beta4 Patches code Patches code a td td p code patches code contains options related to applying patches to components deployed by kubeadm during code kubeadm upgrade code p td tr tr td code imagePullPolicy code br a href https kubernetes io docs reference generated kubernetes api v1 31 pullpolicy v1 core code core v1 PullPolicy code a td td p code imagePullPolicy code specifies the policy for image pulling during code kubeadm upgrade node code operations The value of this field must be one of quot Always quot quot IfNotPresent quot or quot Never quot If this field is unset kubeadm will default it to quot IfNotPresent quot or pull the required images if not present on the host p td tr tr td code imagePullSerial code br code bool code td td p code imagePullSerial code specifies if image pulling performed by kubeadm must be done serially or in parallel Default true p td tr tbody table UpgradePlanConfiguration kubeadm k8s io v1beta4 UpgradePlanConfiguration Appears in UpgradeConfiguration kubeadm k8s io v1beta4 UpgradeConfiguration p UpgradePlanConfiguration contains a list of configurable options which are specific to the quot kubeadm upgrade plan quot command p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code kubernetesVersion code B Required B br code string code td td p code kubernetesVersion code is the target version of the control plane p td tr tr td code allowExperimentalUpgrades code br code bool code td td p code allowExperimentalUpgrades code instructs kubeadm to show unstable versions of Kubernetes as an upgrade alternative and allows upgrading to an alpha beta release candidate version of Kubernetes Default false p td tr tr td code allowRCUpgrades code br code bool code td td p Enable code allowRCUpgrades code will show release candidate versions of Kubernetes as an upgrade alternative and allows upgrading to a release candidate version of Kubernetes p td tr tr td code dryRun code br code bool code td td p code dryRun code tells if the dry run mode is enabled don t apply any change if it is and just output what would be done p td tr tr td code ignorePreflightErrors code br code string code td td p code ignorePreflightErrors code provides a slice of pre flight errors to be ignored during the upgrade process e g IsPrivilegedUser Swap Value all ignores errors from all checks p td tr tr td code printConfig code br code bool code td td p code printConfig code specifies whether the configuration file that will be used in the upgrade should be printed or not p td tr tbody table |
kubernetes reference Metrics v1 31 Details of the metric data that Kubernetes components export contenttype reference title Kubernetes Metrics Reference autogenerated true | ---
title: Kubernetes Metrics Reference
content_type: reference
auto_generated: true
description: >-
Details of the metric data that Kubernetes components export.
---
## Metrics (v1.31)
<!-- (auto-generated 2024 Oct 28) -->
<!-- (auto-generated v1.31) -->
This page details the metrics that different Kubernetes components export. You can query the metrics endpoint for these
components using an HTTP scrape, and fetch the current metrics data in Prometheus format.
### List of Stable Kubernetes Metrics
Stable metrics observe strict API contracts and no labels can be added or removed from stable metrics during their lifetime.
<div class="metrics"><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_admission_controller_admission_duration_seconds</div>
<div class="metric_help">Admission controller latency histogram in seconds, identified by name and broken out for each operation and API resource and type (validate or admit).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">operation</span><span class="metric_label">rejected</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_admission_step_admission_duration_seconds</div>
<div class="metric_help">Admission sub-step latency histogram in seconds, broken out for each operation and API resource and step type (validate or admit).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span><span class="metric_label">rejected</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_admission_webhook_admission_duration_seconds</div>
<div class="metric_help">Admission webhook latency histogram in seconds, identified by name and broken out for each operation and API resource and type (validate or admit).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">operation</span><span class="metric_label">rejected</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_current_inflight_requests</div>
<div class="metric_help">Maximal number of currently used inflight request limit of this apiserver per request kind in last second.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">request_kind</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_longrunning_requests</div>
<div class="metric_help">Gauge of all active long-running apiserver requests broken out by verb, group, version, resource, scope and component. Not all requests are tracked this way.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">component</span><span class="metric_label">group</span><span class="metric_label">resource</span><span class="metric_label">scope</span><span class="metric_label">subresource</span><span class="metric_label">verb</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_request_duration_seconds</div>
<div class="metric_help">Response latency distribution in seconds for each verb, dry run value, group, version, resource, subresource, scope and component.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">component</span><span class="metric_label">dry_run</span><span class="metric_label">group</span><span class="metric_label">resource</span><span class="metric_label">scope</span><span class="metric_label">subresource</span><span class="metric_label">verb</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_request_total</div>
<div class="metric_help">Counter of apiserver requests broken out for each verb, dry run value, group, version, resource, scope, component, and HTTP response code.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span><span class="metric_label">component</span><span class="metric_label">dry_run</span><span class="metric_label">group</span><span class="metric_label">resource</span><span class="metric_label">scope</span><span class="metric_label">subresource</span><span class="metric_label">verb</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_requested_deprecated_apis</div>
<div class="metric_help">Gauge of deprecated APIs that have been requested, broken out by API group, version, resource, subresource, and removed_release.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">group</span><span class="metric_label">removed_release</span><span class="metric_label">resource</span><span class="metric_label">subresource</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_response_sizes</div>
<div class="metric_help">Response size distribution in bytes for each group, version, verb, resource, subresource, scope and component.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">component</span><span class="metric_label">group</span><span class="metric_label">resource</span><span class="metric_label">scope</span><span class="metric_label">subresource</span><span class="metric_label">verb</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_storage_objects</div>
<div class="metric_help">Number of stored objects at the time of last check split by kind. In case of a fetching error, the value will be -1.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">apiserver_storage_size_bytes</div>
<div class="metric_help">Size of the storage database file physically allocated in bytes.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">storage_cluster_id</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">container_cpu_usage_seconds_total</div>
<div class="metric_help">Cumulative cpu time consumed by the container in core-seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">container</span><span class="metric_label">pod</span><span class="metric_label">namespace</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">container_memory_working_set_bytes</div>
<div class="metric_help">Current working set of the container in bytes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">container</span><span class="metric_label">pod</span><span class="metric_label">namespace</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">container_start_time_seconds</div>
<div class="metric_help">Start time of the container since unix epoch in seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">container</span><span class="metric_label">pod</span><span class="metric_label">namespace</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">cronjob_controller_job_creation_skew_duration_seconds</div>
<div class="metric_help">Time between when a cronjob is scheduled to be run, and when the corresponding job is created</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">job_controller_job_pods_finished_total</div>
<div class="metric_help">The number of finished Pods that are fully tracked</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">completion_mode</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">job_controller_job_sync_duration_seconds</div>
<div class="metric_help">The time it took to sync a job</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">action</span><span class="metric_label">completion_mode</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">job_controller_job_syncs_total</div>
<div class="metric_help">The number of job syncs</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">action</span><span class="metric_label">completion_mode</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">job_controller_jobs_finished_total</div>
<div class="metric_help">The number of finished jobs</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">completion_mode</span><span class="metric_label">reason</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">kube_pod_resource_limit</div>
<div class="metric_help">Resources limit for workloads on the cluster, broken down by pod. This shows the resource usage the scheduler and kubelet expect per pod for resources along with the unit for the resource if any.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">pod</span><span class="metric_label">node</span><span class="metric_label">scheduler</span><span class="metric_label">priority</span><span class="metric_label">resource</span><span class="metric_label">unit</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">kube_pod_resource_request</div>
<div class="metric_help">Resources requested by workloads on the cluster, broken down by pod. This shows the resource usage the scheduler and kubelet expect per pod for resources along with the unit for the resource if any.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">pod</span><span class="metric_label">node</span><span class="metric_label">scheduler</span><span class="metric_label">priority</span><span class="metric_label">resource</span><span class="metric_label">unit</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">kubernetes_healthcheck</div>
<div class="metric_help">This metric records the result of a single healthcheck.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">kubernetes_healthchecks_total</div>
<div class="metric_help">This metric records the results of all healthcheck.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">status</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">node_collector_evictions_total</div>
<div class="metric_help">Number of Node evictions that happened since current instance of NodeController started.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">zone</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">node_cpu_usage_seconds_total</div>
<div class="metric_help">Cumulative cpu time consumed by the node in core-seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
</ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">node_memory_working_set_bytes</div>
<div class="metric_help">Current working set of the node in bytes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
</ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">pod_cpu_usage_seconds_total</div>
<div class="metric_help">Cumulative cpu time consumed by the pod in core-seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">pod</span><span class="metric_label">namespace</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">pod_memory_working_set_bytes</div>
<div class="metric_help">Current working set of the pod in bytes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">pod</span><span class="metric_label">namespace</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">resource_scrape_error</div>
<div class="metric_help">1 if there was an error while getting container metrics, 0 otherwise</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
</ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">scheduler_framework_extension_point_duration_seconds</div>
<div class="metric_help">Latency for running all plugins of a specific extension point.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">extension_point</span><span class="metric_label">profile</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">scheduler_pending_pods</div>
<div class="metric_help">Number of pending pods, by the queue type. 'active' means number of pods in activeQ; 'backoff' means number of pods in backoffQ; 'unschedulable' means number of pods in unschedulablePods that the scheduler attempted to schedule and failed; 'gated' is the number of unschedulable pods that the scheduler never attempted to schedule because they are gated.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">queue</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">scheduler_pod_scheduling_attempts</div>
<div class="metric_help">Number of attempts to successfully schedule a pod.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">scheduler_pod_scheduling_duration_seconds</div>
<div class="metric_help">E2e latency for a pod being scheduled which may include multiple scheduling attempts.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">attempts</span></li><li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.29.0</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">scheduler_preemption_attempts_total</div>
<div class="metric_help">Total preemption attempts in the cluster till now</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">scheduler_preemption_victims</div>
<div class="metric_help">Number of selected preemption victims</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">scheduler_queue_incoming_pods_total</div>
<div class="metric_help">Number of pods added to scheduling queues by event and queue type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">event</span><span class="metric_label">queue</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">scheduler_schedule_attempts_total</div>
<div class="metric_help">Number of attempts to schedule pods, by the result. 'unschedulable' means a pod could not be scheduled, while 'error' means an internal scheduler problem.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">profile</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="stable">
<div class="metric_name">scheduler_scheduling_attempt_duration_seconds</div>
<div class="metric_help">Scheduling attempt latency in seconds (scheduling algorithm + binding)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">STABLE</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">profile</span><span class="metric_label">result</span></li></ul>
</div>
</div>
### List of Beta Kubernetes Metrics
Beta metrics observe a looser API contract than its stable counterparts. No labels can be removed from beta metrics during their lifetime, however, labels can be added while the metric is in the beta stage. This offers the assurance that beta metrics will honor existing dashboards and alerts, while allowing for amendments in the future.
<div class="metrics"><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_cel_compilation_duration_seconds</div>
<div class="metric_help">CEL compilation time in seconds.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_cel_evaluation_duration_seconds</div>
<div class="metric_help">CEL evaluation time in seconds.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_flowcontrol_current_executing_requests</div>
<div class="metric_help">Number of requests in initial (for a WATCH) or any (for a non-WATCH) execution stage in the API Priority and Fairness subsystem</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_flowcontrol_current_executing_seats</div>
<div class="metric_help">Concurrency (number of seats) occupied by the currently executing (initial stage for a WATCH, any stage otherwise) requests in the API Priority and Fairness subsystem</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_flowcontrol_current_inqueue_requests</div>
<div class="metric_help">Number of requests currently pending in queues of the API Priority and Fairness subsystem</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_flowcontrol_dispatched_requests_total</div>
<div class="metric_help">Number of requests executed by API Priority and Fairness subsystem</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_flowcontrol_nominal_limit_seats</div>
<div class="metric_help">Nominal number of execution seats configured for each priority level</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_flowcontrol_rejected_requests_total</div>
<div class="metric_help">Number of requests rejected by API Priority and Fairness subsystem</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span><span class="metric_label">reason</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_flowcontrol_request_wait_duration_seconds</div>
<div class="metric_help">Length of time a request spent waiting in its queue</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">execute</span><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_validating_admission_policy_check_duration_seconds</div>
<div class="metric_help">Validation admission latency for individual validation expressions in seconds, labeled by policy and further including binding and enforcement action taken.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">enforcement_action</span><span class="metric_label">error_type</span><span class="metric_label">policy</span><span class="metric_label">policy_binding</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">apiserver_validating_admission_policy_check_total</div>
<div class="metric_help">Validation admission policy check total, labeled by policy and further identified by binding and enforcement action taken.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">enforcement_action</span><span class="metric_label">error_type</span><span class="metric_label">policy</span><span class="metric_label">policy_binding</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">disabled_metrics_total</div>
<div class="metric_help">The count of disabled metrics.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">hidden_metrics_total</div>
<div class="metric_help">The count of hidden metrics.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">kubernetes_feature_enabled</div>
<div class="metric_help">This metric records the data about the stage and enablement of a k8s feature.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">stage</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">registered_metrics_total</div>
<div class="metric_help">The count of registered metrics broken by stability level and deprecation version.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">deprecated_version</span><span class="metric_label">stability_level</span></li></ul>
</div><div class="metric" data-stability="beta">
<div class="metric_name">scheduler_pod_scheduling_sli_duration_seconds</div>
<div class="metric_help">E2e latency for a pod being scheduled, from the time the pod enters the scheduling queue and might involve multiple scheduling attempts.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">BETA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">attempts</span></li></ul>
</div>
</div>
### List of Alpha Kubernetes Metrics
Alpha metrics do not have any API guarantees. These metrics must be used at your own risk, subsequent versions of Kubernetes may remove these metrics altogether, or mutate the API in such a way that breaks existing dashboards and alerts.
<div class="metrics"><div class="metric" data-stability="alpha">
<div class="metric_name">aggregator_discovery_aggregation_count_total</div>
<div class="metric_help">Counter of number of times discovery was aggregated</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">aggregator_openapi_v2_regeneration_count</div>
<div class="metric_help">Counter of OpenAPI v2 spec regeneration count broken down by causing APIService name and reason.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiservice</span><span class="metric_label">reason</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">aggregator_openapi_v2_regeneration_duration</div>
<div class="metric_help">Gauge of OpenAPI v2 spec regeneration duration in seconds.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">reason</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">aggregator_unavailable_apiservice</div>
<div class="metric_help">Gauge of APIServices which are marked as unavailable broken down by APIService name.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">aggregator_unavailable_apiservice_total</div>
<div class="metric_help">Counter of APIServices which are marked as unavailable broken down by APIService name and reason.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">reason</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiextensions_apiserver_validation_ratcheting_seconds</div>
<div class="metric_help">Time for comparison of old to new for the purposes of CRDValidationRatcheting during an UPDATE in seconds.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiextensions_openapi_v2_regeneration_count</div>
<div class="metric_help">Counter of OpenAPI v2 spec regeneration count broken down by causing CRD name and reason.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">crd</span><span class="metric_label">reason</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiextensions_openapi_v3_regeneration_count</div>
<div class="metric_help">Counter of OpenAPI v3 spec regeneration count broken down by group, version, causing CRD and reason.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">crd</span><span class="metric_label">group</span><span class="metric_label">reason</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_admission_match_condition_evaluation_errors_total</div>
<div class="metric_help">Admission match condition evaluation errors count, identified by name of resource containing the match condition and broken out for each kind containing matchConditions (webhook or policy), operation and admission type (validate or admit).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">kind</span><span class="metric_label">name</span><span class="metric_label">operation</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_admission_match_condition_evaluation_seconds</div>
<div class="metric_help">Admission match condition evaluation time in seconds, identified by name and broken out for each kind containing matchConditions (webhook or policy), operation and type (validate or admit).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">kind</span><span class="metric_label">name</span><span class="metric_label">operation</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_admission_match_condition_exclusions_total</div>
<div class="metric_help">Admission match condition evaluation exclusions count, identified by name of resource containing the match condition and broken out for each kind containing matchConditions (webhook or policy), operation and admission type (validate or admit).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">kind</span><span class="metric_label">name</span><span class="metric_label">operation</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_admission_step_admission_duration_seconds_summary</div>
<div class="metric_help">Admission sub-step latency summary in seconds, broken out for each operation and API resource and step type (validate or admit).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="summary"><label class="metric_detail">Type:</label> <span class="metric_type">Summary</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span><span class="metric_label">rejected</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_admission_webhook_fail_open_count</div>
<div class="metric_help">Admission webhook fail open count, identified by name and broken out for each admission type (validating or mutating).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_admission_webhook_rejection_count</div>
<div class="metric_help">Admission webhook rejection count, identified by name and broken out for each admission type (validating or admit) and operation. Additional labels specify an error type (calling_webhook_error or apiserver_internal_error if an error occurred; no_error otherwise) and optionally a non-zero rejection code if the webhook rejects the request with an HTTP status code (honored by the apiserver when the code is greater or equal to 400). Codes greater than 600 are truncated to 600, to keep the metrics cardinality bounded.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">error_type</span><span class="metric_label">name</span><span class="metric_label">operation</span><span class="metric_label">rejection_code</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_admission_webhook_request_total</div>
<div class="metric_help">Admission webhook request total, identified by name and broken out for each admission type (validating or mutating) and operation. Additional labels specify whether the request was rejected or not and an HTTP status code. Codes greater than 600 are truncated to 600, to keep the metrics cardinality bounded.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span><span class="metric_label">name</span><span class="metric_label">operation</span><span class="metric_label">rejected</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_audit_error_total</div>
<div class="metric_help">Counter of audit events that failed to be audited properly. Plugin identifies the plugin affected by the error.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">plugin</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_audit_event_total</div>
<div class="metric_help">Counter of audit events generated and sent to the audit backend.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_audit_level_total</div>
<div class="metric_help">Counter of policy levels for audit events (1 per request).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_audit_requests_rejected_total</div>
<div class="metric_help">Counter of apiserver requests rejected due to an error in audit logging backend.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authentication_config_controller_automatic_reload_last_timestamp_seconds</div>
<div class="metric_help">Timestamp of the last automatic reload of authentication configuration split by status and apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authentication_config_controller_automatic_reloads_total</div>
<div class="metric_help">Total number of automatic reloads of authentication configuration split by status and apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authentication_jwt_authenticator_latency_seconds</div>
<div class="metric_help">Latency of jwt authentication operations in seconds. This is the time spent authenticating a token for cache miss only (i.e. when the token is not found in the cache).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">jwt_issuer_hash</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authorization_config_controller_automatic_reload_last_timestamp_seconds</div>
<div class="metric_help">Timestamp of the last automatic reload of authorization configuration split by status and apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authorization_config_controller_automatic_reloads_total</div>
<div class="metric_help">Total number of automatic reloads of authorization configuration split by status and apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authorization_decisions_total</div>
<div class="metric_help">Total number of terminal decisions made by an authorizer split by authorizer type, name, and decision.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">decision</span><span class="metric_label">name</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authorization_match_condition_evaluation_errors_total</div>
<div class="metric_help">Total number of errors when an authorization webhook encounters a match condition error split by authorizer type and name.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authorization_match_condition_evaluation_seconds</div>
<div class="metric_help">Authorization match condition evaluation time in seconds, split by authorizer type and name.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authorization_match_condition_exclusions_total</div>
<div class="metric_help">Total number of exclusions when an authorization webhook is skipped because match conditions exclude it.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authorization_webhook_duration_seconds</div>
<div class="metric_help">Request latency in seconds.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authorization_webhook_evaluations_fail_open_total</div>
<div class="metric_help">NoOpinion results due to webhook timeout or error.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_authorization_webhook_evaluations_total</div>
<div class="metric_help">Round-trips to authorization webhooks.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_cache_list_fetched_objects_total</div>
<div class="metric_help">Number of objects read from watch cache in the course of serving a LIST request</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">index</span><span class="metric_label">resource_prefix</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_cache_list_returned_objects_total</div>
<div class="metric_help">Number of objects returned for a LIST request from watch cache</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource_prefix</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_cache_list_total</div>
<div class="metric_help">Number of LIST requests served from watch cache</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">index</span><span class="metric_label">resource_prefix</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_certificates_registry_csr_honored_duration_total</div>
<div class="metric_help">Total number of issued CSRs with a requested duration that was honored, sliced by signer (only kubernetes.io signer names are specifically identified)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">signerName</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_certificates_registry_csr_requested_duration_total</div>
<div class="metric_help">Total number of issued CSRs with a requested duration, sliced by signer (only kubernetes.io signer names are specifically identified)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">signerName</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_client_certificate_expiration_seconds</div>
<div class="metric_help">Distribution of the remaining lifetime on the certificate used to authenticate a request.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_clusterip_repair_ip_errors_total</div>
<div class="metric_help">Number of errors detected on clusterips by the repair loop broken down by type of error: leak, repair, full, outOfRange, duplicate, unknown, invalid</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_clusterip_repair_reconcile_errors_total</div>
<div class="metric_help">Number of reconciliation failures on the clusterip repair reconcile loop</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_conversion_webhook_duration_seconds</div>
<div class="metric_help">Conversion webhook request latency</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">failure_type</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_conversion_webhook_request_total</div>
<div class="metric_help">Counter for conversion webhook requests with success/failure and failure error type</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">failure_type</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_crd_conversion_webhook_duration_seconds</div>
<div class="metric_help">CRD webhook conversion duration in seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">crd_name</span><span class="metric_label">from_version</span><span class="metric_label">succeeded</span><span class="metric_label">to_version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_current_inqueue_requests</div>
<div class="metric_help">Maximal number of queued requests in this apiserver per request kind in last second.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">request_kind</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_delegated_authn_request_duration_seconds</div>
<div class="metric_help">Request latency in seconds. Broken down by status code.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_delegated_authn_request_total</div>
<div class="metric_help">Number of HTTP requests partitioned by status code.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_delegated_authz_request_duration_seconds</div>
<div class="metric_help">Request latency in seconds. Broken down by status code.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_delegated_authz_request_total</div>
<div class="metric_help">Number of HTTP requests partitioned by status code.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_egress_dialer_dial_duration_seconds</div>
<div class="metric_help">Dial latency histogram in seconds, labeled by the protocol (http-connect or grpc), transport (tcp or uds)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">protocol</span><span class="metric_label">transport</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_egress_dialer_dial_failure_count</div>
<div class="metric_help">Dial failure count, labeled by the protocol (http-connect or grpc), transport (tcp or uds), and stage (connect or proxy). The stage indicates at which stage the dial failed</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">protocol</span><span class="metric_label">stage</span><span class="metric_label">transport</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_egress_dialer_dial_start_total</div>
<div class="metric_help">Dial starts, labeled by the protocol (http-connect or grpc) and transport (tcp or uds).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">protocol</span><span class="metric_label">transport</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_encryption_config_controller_automatic_reload_failures_total</div>
<div class="metric_help">Total number of failed automatic reloads of encryption configuration split by apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span></li><li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.30.0</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_encryption_config_controller_automatic_reload_last_timestamp_seconds</div>
<div class="metric_help">Timestamp of the last successful or failed automatic reload of encryption configuration split by apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_encryption_config_controller_automatic_reload_success_total</div>
<div class="metric_help">Total number of successful automatic reloads of encryption configuration split by apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span></li><li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.30.0</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_encryption_config_controller_automatic_reloads_total</div>
<div class="metric_help">Total number of reload successes and failures of encryption configuration split by apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_dek_cache_fill_percent</div>
<div class="metric_help">Percent of the cache slots currently occupied by cached DEKs.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_dek_cache_inter_arrival_time_seconds</div>
<div class="metric_help">Time (in seconds) of inter arrival of transformation requests.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">transformation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_dek_source_cache_size</div>
<div class="metric_help">Number of records in data encryption key (DEK) source cache. On a restart, this value is an approximation of the number of decrypt RPC calls the server will make to the KMS plugin.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">provider_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_invalid_key_id_from_status_total</div>
<div class="metric_help">Number of times an invalid keyID is returned by the Status RPC call split by error.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">error</span><span class="metric_label">provider_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_key_id_hash_last_timestamp_seconds</div>
<div class="metric_help">The last time in seconds when a keyID was used.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">key_id_hash</span><span class="metric_label">provider_name</span><span class="metric_label">transformation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_key_id_hash_status_last_timestamp_seconds</div>
<div class="metric_help">The last time in seconds when a keyID was returned by the Status RPC call.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">key_id_hash</span><span class="metric_label">provider_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_key_id_hash_total</div>
<div class="metric_help">Number of times a keyID is used split by transformation type, provider, and apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">key_id_hash</span><span class="metric_label">provider_name</span><span class="metric_label">transformation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_kms_operations_latency_seconds</div>
<div class="metric_help">KMS operation duration with gRPC error code status total.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">grpc_status_code</span><span class="metric_label">method_name</span><span class="metric_label">provider_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_current_inqueue_seats</div>
<div class="metric_help">Number of seats currently pending in queues of the API Priority and Fairness subsystem</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_current_limit_seats</div>
<div class="metric_help">current derived number of execution seats available to each priority level</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_current_r</div>
<div class="metric_help">R(time of last change)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_demand_seats</div>
<div class="metric_help">Observations, at the end of every nanosecond, of (the number of seats each priority level could use) / (nominal number of seats for that level)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="timingratiohistogram"><label class="metric_detail">Type:</label> <span class="metric_type">TimingRatioHistogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_demand_seats_average</div>
<div class="metric_help">Time-weighted average, over last adjustment period, of demand_seats</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_demand_seats_high_watermark</div>
<div class="metric_help">High watermark, over last adjustment period, of demand_seats</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_demand_seats_smoothed</div>
<div class="metric_help">Smoothed seat demands</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_demand_seats_stdev</div>
<div class="metric_help">Time-weighted standard deviation, over last adjustment period, of demand_seats</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_dispatch_r</div>
<div class="metric_help">R(time of last dispatch)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_epoch_advance_total</div>
<div class="metric_help">Number of times the queueset's progress meter jumped backward</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span><span class="metric_label">success</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_latest_s</div>
<div class="metric_help">S(most recently dispatched request)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_lower_limit_seats</div>
<div class="metric_help">Configured lower bound on number of execution seats available to each priority level</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_next_discounted_s_bounds</div>
<div class="metric_help">min and max, over queues, of S(oldest waiting request in queue) - estimated work in progress</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">bound</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_next_s_bounds</div>
<div class="metric_help">min and max, over queues, of S(oldest waiting request in queue)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">bound</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_priority_level_request_utilization</div>
<div class="metric_help">Observations, at the end of every nanosecond, of number of requests (as a fraction of the relevant limit) waiting or in any stage of execution (but only initial stage for WATCHes)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="timingratiohistogram"><label class="metric_detail">Type:</label> <span class="metric_type">TimingRatioHistogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">phase</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_priority_level_seat_utilization</div>
<div class="metric_help">Observations, at the end of every nanosecond, of utilization of seats for any stage of execution (but only initial stage for WATCHes)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="timingratiohistogram"><label class="metric_detail">Type:</label> <span class="metric_type">TimingRatioHistogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li><li class="metric_labels_constant"><label class="metric_detail">Const Labels:</label><span class="metric_label">phase:executing</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_read_vs_write_current_requests</div>
<div class="metric_help">Observations, at the end of every nanosecond, of the number of requests (as a fraction of the relevant limit) waiting or in regular stage of execution</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="timingratiohistogram"><label class="metric_detail">Type:</label> <span class="metric_type">TimingRatioHistogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">phase</span><span class="metric_label">request_kind</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_request_concurrency_in_use</div>
<div class="metric_help">Concurrency (number of seats) occupied by the currently executing (initial stage for a WATCH, any stage otherwise) requests in the API Priority and Fairness subsystem</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li><li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.31.0</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_request_concurrency_limit</div>
<div class="metric_help">Nominal number of execution seats configured for each priority level</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li><li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.30.0</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_request_dispatch_no_accommodation_total</div>
<div class="metric_help">Number of times a dispatch attempt resulted in a non accommodation due to lack of available seats</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_request_execution_seconds</div>
<div class="metric_help">Duration of initial stage (for a WATCH) or any (for a non-WATCH) stage of request execution in the API Priority and Fairness subsystem</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_request_queue_length_after_enqueue</div>
<div class="metric_help">Length of queue in the API Priority and Fairness subsystem, as seen by each request after it is enqueued</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_seat_fair_frac</div>
<div class="metric_help">Fair fraction of server's concurrency to allocate to each priority level that can use it</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_target_seats</div>
<div class="metric_help">Seat allocation targets</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_upper_limit_seats</div>
<div class="metric_help">Configured upper bound on number of execution seats available to each priority level</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_watch_count_samples</div>
<div class="metric_help">count of watchers for mutating requests in API Priority and Fairness</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_flowcontrol_work_estimated_seats</div>
<div class="metric_help">Number of estimated seats (maximum of initial and final seats) associated with requests in API Priority and Fairness</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">flow_schema</span><span class="metric_label">priority_level</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_init_events_total</div>
<div class="metric_help">Counter of init events processed in watch cache broken by resource type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_kube_aggregator_x509_insecure_sha1_total</div>
<div class="metric_help">Counts the number of requests to servers with insecure SHA1 signatures in their serving certificate OR the number of connection failures due to the insecure SHA1 signatures (either/or, based on the runtime environment)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_kube_aggregator_x509_missing_san_total</div>
<div class="metric_help">Counts the number of requests to servers missing SAN extension in their serving certificate OR the number of connection failures due to the lack of x509 certificate SAN extension missing (either/or, based on the runtime environment)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_nodeport_repair_port_errors_total</div>
<div class="metric_help">Number of errors detected on ports by the repair loop broken down by type of error: leak, repair, full, outOfRange, duplicate, unknown</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_nodeport_repair_reconcile_errors_total</div>
<div class="metric_help">Number of reconciliation failures on the nodeport repair reconcile loop</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_request_aborts_total</div>
<div class="metric_help">Number of requests which apiserver aborted possibly due to a timeout, for each group, version, verb, resource, subresource and scope</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">group</span><span class="metric_label">resource</span><span class="metric_label">scope</span><span class="metric_label">subresource</span><span class="metric_label">verb</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_request_body_size_bytes</div>
<div class="metric_help">Apiserver request body size in bytes broken out by resource and verb.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span><span class="metric_label">verb</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_request_filter_duration_seconds</div>
<div class="metric_help">Request filter latency distribution in seconds, for each filter type</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">filter</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_request_post_timeout_total</div>
<div class="metric_help">Tracks the activity of the request handlers after the associated requests have been timed out by the apiserver</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">source</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_request_sli_duration_seconds</div>
<div class="metric_help">Response latency distribution (not counting webhook duration and priority & fairness queue wait times) in seconds for each verb, group, version, resource, subresource, scope and component.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">component</span><span class="metric_label">group</span><span class="metric_label">resource</span><span class="metric_label">scope</span><span class="metric_label">subresource</span><span class="metric_label">verb</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_request_slo_duration_seconds</div>
<div class="metric_help">Response latency distribution (not counting webhook duration and priority & fairness queue wait times) in seconds for each verb, group, version, resource, subresource, scope and component.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">component</span><span class="metric_label">group</span><span class="metric_label">resource</span><span class="metric_label">scope</span><span class="metric_label">subresource</span><span class="metric_label">verb</span><span class="metric_label">version</span></li><li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.27.0</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_request_terminations_total</div>
<div class="metric_help">Number of requests which apiserver terminated in self-defense.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span><span class="metric_label">component</span><span class="metric_label">group</span><span class="metric_label">resource</span><span class="metric_label">scope</span><span class="metric_label">subresource</span><span class="metric_label">verb</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_request_timestamp_comparison_time</div>
<div class="metric_help">Time taken for comparison of old vs new objects in UPDATE or PATCH requests</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code_path</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_rerouted_request_total</div>
<div class="metric_help">Total number of requests that were proxied to a peer kube apiserver because the local apiserver was not capable of serving it</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_selfrequest_total</div>
<div class="metric_help">Counter of apiserver self-requests broken out for each verb, API resource and subresource.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span><span class="metric_label">subresource</span><span class="metric_label">verb</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_data_key_generation_duration_seconds</div>
<div class="metric_help">Latencies in seconds of data encryption key(DEK) generation operations.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_data_key_generation_failures_total</div>
<div class="metric_help">Total number of failed data encryption key(DEK) generation operations.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_db_total_size_in_bytes</div>
<div class="metric_help">Total size of the storage database file physically allocated in bytes.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">endpoint</span></li><li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.28.0</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_decode_errors_total</div>
<div class="metric_help">Number of stored object decode errors split by object type</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_envelope_transformation_cache_misses_total</div>
<div class="metric_help">Total number of cache misses while accessing key decryption key(KEK).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_events_received_total</div>
<div class="metric_help">Number of etcd events received split by kind.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_list_evaluated_objects_total</div>
<div class="metric_help">Number of objects tested in the course of serving a LIST request from storage</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_list_fetched_objects_total</div>
<div class="metric_help">Number of objects read from storage in the course of serving a LIST request</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_list_returned_objects_total</div>
<div class="metric_help">Number of objects returned for a LIST request from storage</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_list_total</div>
<div class="metric_help">Number of LIST requests served from storage</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_transformation_duration_seconds</div>
<div class="metric_help">Latencies in seconds of value transformation operations.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">transformation_type</span><span class="metric_label">transformer_prefix</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_storage_transformation_operations_total</div>
<div class="metric_help">Total number of transformations. Successful transformation will have a status 'OK' and a varied status string when the transformation fails. This status and transformation_type fields may be used for alerting on encryption/decryption failure using transformation_type from_storage for decryption and to_storage for encryption</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">status</span><span class="metric_label">transformation_type</span><span class="metric_label">transformer_prefix</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_stream_translator_requests_total</div>
<div class="metric_help">Total number of requests that were handled by the StreamTranslatorProxy, which processes streaming RemoteCommand/V5</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_stream_tunnel_requests_total</div>
<div class="metric_help">Total number of requests that were handled by the StreamTunnelProxy, which processes streaming PortForward/V2</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_terminated_watchers_total</div>
<div class="metric_help">Counter of watchers closed due to unresponsiveness broken by resource type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_tls_handshake_errors_total</div>
<div class="metric_help">Number of requests dropped with 'TLS handshake error from' error</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_watch_cache_consistent_read_total</div>
<div class="metric_help">Counter for consistent reads from cache.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">fallback</span><span class="metric_label">resource</span><span class="metric_label">success</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_watch_cache_events_dispatched_total</div>
<div class="metric_help">Counter of events dispatched in watch cache broken by resource type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_watch_cache_events_received_total</div>
<div class="metric_help">Counter of events received in watch cache broken by resource type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_watch_cache_initializations_total</div>
<div class="metric_help">Counter of watch cache initializations broken by resource type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_watch_cache_read_wait_seconds</div>
<div class="metric_help">Histogram of time spent waiting for a watch cache to become fresh.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_watch_cache_resource_version</div>
<div class="metric_help">Current resource version of watch cache broken by resource type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_watch_events_sizes</div>
<div class="metric_help">Watch event size distribution in bytes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">group</span><span class="metric_label">kind</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_watch_events_total</div>
<div class="metric_help">Number of events sent in watch clients</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">group</span><span class="metric_label">kind</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_watch_list_duration_seconds</div>
<div class="metric_help">Response latency distribution in seconds for watch list requests broken by group, version, resource and scope.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">group</span><span class="metric_label">resource</span><span class="metric_label">scope</span><span class="metric_label">version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_webhooks_x509_insecure_sha1_total</div>
<div class="metric_help">Counts the number of requests to servers with insecure SHA1 signatures in their serving certificate OR the number of connection failures due to the insecure SHA1 signatures (either/or, based on the runtime environment)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_webhooks_x509_missing_san_total</div>
<div class="metric_help">Counts the number of requests to servers missing SAN extension in their serving certificate OR the number of connection failures due to the lack of x509 certificate SAN extension missing (either/or, based on the runtime environment)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">attach_detach_controller_attachdetach_controller_forced_detaches</div>
<div class="metric_help">Number of times the A/D Controller performed a forced detach</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">reason</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">attachdetach_controller_total_volumes</div>
<div class="metric_help">Number of volumes in A/D Controller</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">plugin_name</span><span class="metric_label">state</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">authenticated_user_requests</div>
<div class="metric_help">Counter of authenticated requests broken out by username.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">username</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">authentication_attempts</div>
<div class="metric_help">Counter of authenticated attempts.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">authentication_duration_seconds</div>
<div class="metric_help">Authentication duration in seconds broken out by result.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">authentication_token_cache_active_fetch_count</div>
<div class="metric_help"></div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">authentication_token_cache_fetch_total</div>
<div class="metric_help"></div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">authentication_token_cache_request_duration_seconds</div>
<div class="metric_help"></div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">authentication_token_cache_request_total</div>
<div class="metric_help"></div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">authorization_attempts_total</div>
<div class="metric_help">Counter of authorization attempts broken down by result. It can be either 'allowed', 'denied', 'no-opinion' or 'error'.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">authorization_duration_seconds</div>
<div class="metric_help">Authorization duration in seconds broken out by result.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">cloud_provider_webhook_request_duration_seconds</div>
<div class="metric_help">Request latency in seconds. Broken down by status code.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span><span class="metric_label">webhook</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">cloud_provider_webhook_request_total</div>
<div class="metric_help">Number of HTTP requests partitioned by status code.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span><span class="metric_label">webhook</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">container_swap_usage_bytes</div>
<div class="metric_help">Current amount of the container swap usage in bytes. Reported only on non-windows systems</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">container</span><span class="metric_label">pod</span><span class="metric_label">namespace</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">csi_operations_seconds</div>
<div class="metric_help">Container Storage Interface operation duration with gRPC error code status total</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">driver_name</span><span class="metric_label">grpc_status_code</span><span class="metric_label">method_name</span><span class="metric_label">migrated</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_controller_changes</div>
<div class="metric_help">Number of EndpointSlice changes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_controller_desired_endpoint_slices</div>
<div class="metric_help">Number of EndpointSlices that would exist with perfect endpoint allocation</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_controller_endpoints_added_per_sync</div>
<div class="metric_help">Number of endpoints added on each Service sync</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_controller_endpoints_desired</div>
<div class="metric_help">Number of endpoints desired</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_controller_endpoints_removed_per_sync</div>
<div class="metric_help">Number of endpoints removed on each Service sync</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_controller_endpointslices_changed_per_sync</div>
<div class="metric_help">Number of EndpointSlices changed on each Service sync</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">topology</span><span class="metric_label">traffic_distribution</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_controller_num_endpoint_slices</div>
<div class="metric_help">Number of EndpointSlices</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_controller_services_count_by_traffic_distribution</div>
<div class="metric_help">Number of Services using some specific trafficDistribution</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">traffic_distribution</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_controller_syncs</div>
<div class="metric_help">Number of EndpointSlice syncs</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_mirroring_controller_addresses_skipped_per_sync</div>
<div class="metric_help">Number of addresses skipped on each Endpoints sync due to being invalid or exceeding MaxEndpointsPerSubset</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_mirroring_controller_changes</div>
<div class="metric_help">Number of EndpointSlice changes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_mirroring_controller_desired_endpoint_slices</div>
<div class="metric_help">Number of EndpointSlices that would exist with perfect endpoint allocation</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_mirroring_controller_endpoints_added_per_sync</div>
<div class="metric_help">Number of endpoints added on each Endpoints sync</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_mirroring_controller_endpoints_desired</div>
<div class="metric_help">Number of endpoints desired</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_mirroring_controller_endpoints_removed_per_sync</div>
<div class="metric_help">Number of endpoints removed on each Endpoints sync</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_mirroring_controller_endpoints_sync_duration</div>
<div class="metric_help">Duration of syncEndpoints() in seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_mirroring_controller_endpoints_updated_per_sync</div>
<div class="metric_help">Number of endpoints updated on each Endpoints sync</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">endpoint_slice_mirroring_controller_num_endpoint_slices</div>
<div class="metric_help">Number of EndpointSlices</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">ephemeral_volume_controller_create_failures_total</div>
<div class="metric_help">Number of PersistenVolumeClaims creation requests</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">ephemeral_volume_controller_create_total</div>
<div class="metric_help">Number of PersistenVolumeClaims creation requests</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">etcd_bookmark_counts</div>
<div class="metric_help">Number of etcd bookmarks (progress notify events) split by kind.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">etcd_lease_object_counts</div>
<div class="metric_help">Number of objects attached to a single etcd lease.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">etcd_request_duration_seconds</div>
<div class="metric_help">Etcd request latency in seconds for each operation and object type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">etcd_request_errors_total</div>
<div class="metric_help">Etcd failed request counts for each operation and object type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">etcd_requests_total</div>
<div class="metric_help">Etcd request counts for each operation and object type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">etcd_version_info</div>
<div class="metric_help">Etcd server's binary version</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">binary_version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">field_validation_request_duration_seconds</div>
<div class="metric_help">Response latency distribution in seconds for each field validation value</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">field_validation</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">force_cleaned_failed_volume_operation_errors_total</div>
<div class="metric_help">The number of volumes that failed force cleanup after their reconstruction failed during kubelet startup.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">force_cleaned_failed_volume_operations_total</div>
<div class="metric_help">The number of volumes that were force cleaned after their reconstruction failed during kubelet startup. This includes both successful and failed cleanups.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">garbagecollector_controller_resources_sync_error_total</div>
<div class="metric_help">Number of garbage collector resources sync errors</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">horizontal_pod_autoscaler_controller_metric_computation_duration_seconds</div>
<div class="metric_help">The time(seconds) that the HPA controller takes to calculate one metric. The label 'action' should be either 'scale_down', 'scale_up', or 'none'. The label 'error' should be either 'spec', 'internal', or 'none'. The label 'metric_type' corresponds to HPA.spec.metrics[*].type</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">action</span><span class="metric_label">error</span><span class="metric_label">metric_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">horizontal_pod_autoscaler_controller_metric_computation_total</div>
<div class="metric_help">Number of metric computations. The label 'action' should be either 'scale_down', 'scale_up', or 'none'. Also, the label 'error' should be either 'spec', 'internal', or 'none'. The label 'metric_type' corresponds to HPA.spec.metrics[*].type</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">action</span><span class="metric_label">error</span><span class="metric_label">metric_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">horizontal_pod_autoscaler_controller_reconciliation_duration_seconds</div>
<div class="metric_help">The time(seconds) that the HPA controller takes to reconcile once. The label 'action' should be either 'scale_down', 'scale_up', or 'none'. Also, the label 'error' should be either 'spec', 'internal', or 'none'. Note that if both spec and internal errors happen during a reconciliation, the first one to occur is reported in `error` label.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">action</span><span class="metric_label">error</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">horizontal_pod_autoscaler_controller_reconciliations_total</div>
<div class="metric_help">Number of reconciliations of HPA controller. The label 'action' should be either 'scale_down', 'scale_up', or 'none'. Also, the label 'error' should be either 'spec', 'internal', or 'none'. Note that if both spec and internal errors happen during a reconciliation, the first one to occur is reported in `error` label.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">action</span><span class="metric_label">error</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">job_controller_job_finished_indexes_total</div>
<div class="metric_help">`The number of finished indexes. Possible values for the, status label are: "succeeded", "failed". Possible values for the, backoffLimit label are: "perIndex" and "global"`</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">backoffLimit</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">job_controller_job_pods_creation_total</div>
<div class="metric_help">`The number of Pods created by the Job controller labelled with a reason for the Pod creation., This metric also distinguishes between Pods created using different PodReplacementPolicy settings., Possible values of the "reason" label are:, "new", "recreate_terminating_or_failed", "recreate_failed"., Possible values of the "status" label are:, "succeeded", "failed".`</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">reason</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">job_controller_jobs_by_external_controller_total</div>
<div class="metric_help">The number of Jobs managed by an external controller</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">controller_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">job_controller_pod_failures_handled_by_failure_policy_total</div>
<div class="metric_help">`The number of failed Pods handled by failure policy with, respect to the failure policy action applied based on the matched, rule. Possible values of the action label correspond to the, possible values for the failure policy rule action, which are:, "FailJob", "Ignore" and "Count".`</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">action</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">job_controller_terminated_pods_tracking_finalizer_total</div>
<div class="metric_help">`The number of terminated pods (phase=Failed|Succeeded), that have the finalizer batch.kubernetes.io/job-tracking, The event label can be "add" or "delete".`</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">event</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_clusterip_allocator_allocated_ips</div>
<div class="metric_help">Gauge measuring the number of allocated IPs for Services</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">cidr</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_clusterip_allocator_allocation_duration_seconds</div>
<div class="metric_help">Duration in seconds to allocate a Cluster IP by ServiceCIDR</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">cidr</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_clusterip_allocator_allocation_errors_total</div>
<div class="metric_help">Number of errors trying to allocate Cluster IPs</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">cidr</span><span class="metric_label">scope</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_clusterip_allocator_allocation_total</div>
<div class="metric_help">Number of Cluster IPs allocations</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">cidr</span><span class="metric_label">scope</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_clusterip_allocator_available_ips</div>
<div class="metric_help">Gauge measuring the number of available IPs for Services</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">cidr</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_nodeport_allocator_allocated_ports</div>
<div class="metric_help">Gauge measuring the number of allocated NodePorts for Services</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_nodeport_allocator_allocation_errors_total</div>
<div class="metric_help">Number of errors trying to allocate NodePort</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">scope</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_nodeport_allocator_allocation_total</div>
<div class="metric_help">Number of NodePort allocations</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">scope</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_nodeport_allocator_available_ports</div>
<div class="metric_help">Gauge measuring the number of available NodePorts for Services</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_pod_logs_backend_tls_failure_total</div>
<div class="metric_help">Total number of requests for pods/logs that failed due to kubelet server TLS verification</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_pod_logs_insecure_backend_total</div>
<div class="metric_help">Total number of requests for pods/logs sliced by usage type: enforce_tls, skip_tls_allowed, skip_tls_denied</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">usage</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_pod_logs_pods_logs_backend_tls_failure_total</div>
<div class="metric_help">Total number of requests for pods/logs that failed due to kubelet server TLS verification</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.27.0</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kube_apiserver_pod_logs_pods_logs_insecure_backend_total</div>
<div class="metric_help">Total number of requests for pods/logs sliced by usage type: enforce_tls, skip_tls_allowed, skip_tls_denied</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">usage</span></li><li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.27.0</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_active_pods</div>
<div class="metric_help">The number of pods the kubelet considers active and which are being considered when admitting new pods. static is true if the pod is not from the apiserver.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">static</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_certificate_manager_client_expiration_renew_errors</div>
<div class="metric_help">Counter of certificate renewal errors.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_certificate_manager_client_ttl_seconds</div>
<div class="metric_help">Gauge of the TTL (time-to-live) of the Kubelet's client certificate. The value is in seconds until certificate expiry (negative if already expired). If client certificate is invalid or unused, the value will be +INF.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_certificate_manager_server_rotation_seconds</div>
<div class="metric_help">Histogram of the number of seconds the previous certificate lived before being rotated.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_certificate_manager_server_ttl_seconds</div>
<div class="metric_help">Gauge of the shortest TTL (time-to-live) of the Kubelet's serving certificate. The value is in seconds until certificate expiry (negative if already expired). If serving certificate is invalid or unused, the value will be +INF.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_cgroup_manager_duration_seconds</div>
<div class="metric_help">Duration in seconds for cgroup manager operations. Broken down by method.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_cgroup_version</div>
<div class="metric_help">cgroup version on the hosts.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_container_log_filesystem_used_bytes</div>
<div class="metric_help">Bytes used by the container's logs on the filesystem.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">uid</span><span class="metric_label">namespace</span><span class="metric_label">pod</span><span class="metric_label">container</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_containers_per_pod_count</div>
<div class="metric_help">The number of containers per pod.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_cpu_manager_pinning_errors_total</div>
<div class="metric_help">The number of cpu core allocations which required pinning failed.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_cpu_manager_pinning_requests_total</div>
<div class="metric_help">The number of cpu core allocations which required pinning.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_credential_provider_plugin_duration</div>
<div class="metric_help">Duration of execution in seconds for credential provider plugin</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">plugin_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_credential_provider_plugin_errors</div>
<div class="metric_help">Number of errors from credential provider plugin</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">plugin_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_desired_pods</div>
<div class="metric_help">The number of pods the kubelet is being instructed to run. static is true if the pod is not from the apiserver.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">static</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_device_plugin_alloc_duration_seconds</div>
<div class="metric_help">Duration in seconds to serve a device plugin Allocation request. Broken down by resource name.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_device_plugin_registration_total</div>
<div class="metric_help">Cumulative number of device plugin registrations. Broken down by resource name.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_evented_pleg_connection_error_count</div>
<div class="metric_help">The number of errors encountered during the establishment of streaming connection with the CRI runtime.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_evented_pleg_connection_latency_seconds</div>
<div class="metric_help">The latency of streaming connection with the CRI runtime, measured in seconds.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_evented_pleg_connection_success_count</div>
<div class="metric_help">The number of times a streaming client was obtained to receive CRI Events.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_eviction_stats_age_seconds</div>
<div class="metric_help">Time between when stats are collected, and when pod is evicted based on those stats by eviction signal</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">eviction_signal</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_evictions</div>
<div class="metric_help">Cumulative number of pod evictions by eviction signal</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">eviction_signal</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_graceful_shutdown_end_time_seconds</div>
<div class="metric_help">Last graceful shutdown start time since unix epoch in seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_graceful_shutdown_start_time_seconds</div>
<div class="metric_help">Last graceful shutdown start time since unix epoch in seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_http_inflight_requests</div>
<div class="metric_help">Number of the inflight http requests</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">long_running</span><span class="metric_label">method</span><span class="metric_label">path</span><span class="metric_label">server_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_http_requests_duration_seconds</div>
<div class="metric_help">Duration in seconds to serve http requests</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">long_running</span><span class="metric_label">method</span><span class="metric_label">path</span><span class="metric_label">server_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_http_requests_total</div>
<div class="metric_help">Number of the http requests received since the server started</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">long_running</span><span class="metric_label">method</span><span class="metric_label">path</span><span class="metric_label">server_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_image_garbage_collected_total</div>
<div class="metric_help">Total number of images garbage collected by the kubelet, whether through disk usage or image age.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">reason</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_image_pull_duration_seconds</div>
<div class="metric_help">Duration in seconds to pull an image.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">image_size_in_bytes</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_lifecycle_handler_http_fallbacks_total</div>
<div class="metric_help">The number of times lifecycle handlers successfully fell back to http from https.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_managed_ephemeral_containers</div>
<div class="metric_help">Current number of ephemeral containers in pods managed by this kubelet.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_memory_manager_pinning_errors_total</div>
<div class="metric_help">The number of memory pages allocations which required pinning that failed.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_memory_manager_pinning_requests_total</div>
<div class="metric_help">The number of memory pages allocations which required pinning.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_mirror_pods</div>
<div class="metric_help">The number of mirror pods the kubelet will try to create (one per admitted static pod)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_node_name</div>
<div class="metric_help">The node's name. The count is always 1.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">node</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_node_startup_duration_seconds</div>
<div class="metric_help">Duration in seconds of node startup in total.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_node_startup_post_registration_duration_seconds</div>
<div class="metric_help">Duration in seconds of node startup after registration.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_node_startup_pre_kubelet_duration_seconds</div>
<div class="metric_help">Duration in seconds of node startup before kubelet starts.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_node_startup_pre_registration_duration_seconds</div>
<div class="metric_help">Duration in seconds of node startup before registration.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_node_startup_registration_duration_seconds</div>
<div class="metric_help">Duration in seconds of node startup during registration.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_orphan_pod_cleaned_volumes</div>
<div class="metric_help">The total number of orphaned Pods whose volumes were cleaned in the last periodic sweep.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_orphan_pod_cleaned_volumes_errors</div>
<div class="metric_help">The number of orphaned Pods whose volumes failed to be cleaned in the last periodic sweep.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_orphaned_runtime_pods_total</div>
<div class="metric_help">Number of pods that have been detected in the container runtime without being already known to the pod worker. This typically indicates the kubelet was restarted while a pod was force deleted in the API or in the local configuration, which is unusual.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pleg_discard_events</div>
<div class="metric_help">The number of discard events in PLEG.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pleg_last_seen_seconds</div>
<div class="metric_help">Timestamp in seconds when PLEG was last seen active.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pleg_relist_duration_seconds</div>
<div class="metric_help">Duration in seconds for relisting pods in PLEG.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pleg_relist_interval_seconds</div>
<div class="metric_help">Interval in seconds between relisting in PLEG.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_resources_endpoint_errors_get</div>
<div class="metric_help">Number of requests to the PodResource Get endpoint which returned error. Broken down by server api version.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">server_api_version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_resources_endpoint_errors_get_allocatable</div>
<div class="metric_help">Number of requests to the PodResource GetAllocatableResources endpoint which returned error. Broken down by server api version.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">server_api_version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_resources_endpoint_errors_list</div>
<div class="metric_help">Number of requests to the PodResource List endpoint which returned error. Broken down by server api version.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">server_api_version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_resources_endpoint_requests_get</div>
<div class="metric_help">Number of requests to the PodResource Get endpoint. Broken down by server api version.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">server_api_version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_resources_endpoint_requests_get_allocatable</div>
<div class="metric_help">Number of requests to the PodResource GetAllocatableResources endpoint. Broken down by server api version.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">server_api_version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_resources_endpoint_requests_list</div>
<div class="metric_help">Number of requests to the PodResource List endpoint. Broken down by server api version.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">server_api_version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_resources_endpoint_requests_total</div>
<div class="metric_help">Cumulative number of requests to the PodResource endpoint. Broken down by server api version.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">server_api_version</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_start_duration_seconds</div>
<div class="metric_help">Duration in seconds from kubelet seeing a pod for the first time to the pod starting to run</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_start_sli_duration_seconds</div>
<div class="metric_help">Duration in seconds to start a pod, excluding time to pull images and run init containers, measured from pod creation timestamp to when all its containers are reported as started and observed via watch</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_start_total_duration_seconds</div>
<div class="metric_help">Duration in seconds to start a pod since creation, including time to pull images and run init containers, measured from pod creation timestamp to when all its containers are reported as started and observed via watch</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_status_sync_duration_seconds</div>
<div class="metric_help">Duration in seconds to sync a pod status update. Measures time from detection of a change to pod status until the API is successfully updated for that pod, even if multiple intevening changes to pod status occur.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_worker_duration_seconds</div>
<div class="metric_help">Duration in seconds to sync a single pod. Broken down by operation type: create, update, or sync</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_pod_worker_start_duration_seconds</div>
<div class="metric_help">Duration in seconds from kubelet seeing a pod to starting a worker.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_preemptions</div>
<div class="metric_help">Cumulative number of pod preemptions by preemption resource</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">preemption_signal</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_restarted_pods_total</div>
<div class="metric_help">Number of pods that have been restarted because they were deleted and recreated with the same UID while the kubelet was watching them (common for static pods, extremely uncommon for API pods)</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">static</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_run_podsandbox_duration_seconds</div>
<div class="metric_help">Duration in seconds of the run_podsandbox operations. Broken down by RuntimeClass.Handler.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">runtime_handler</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_run_podsandbox_errors_total</div>
<div class="metric_help">Cumulative number of the run_podsandbox operation errors by RuntimeClass.Handler.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">runtime_handler</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_running_containers</div>
<div class="metric_help">Number of containers currently running</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">container_state</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_running_pods</div>
<div class="metric_help">Number of pods that have a running pod sandbox</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_runtime_operations_duration_seconds</div>
<div class="metric_help">Duration in seconds of runtime operations. Broken down by operation type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_runtime_operations_errors_total</div>
<div class="metric_help">Cumulative number of runtime operation errors by operation type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_runtime_operations_total</div>
<div class="metric_help">Cumulative number of runtime operations by operation type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_server_expiration_renew_errors</div>
<div class="metric_help">Counter of certificate renewal errors.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_sleep_action_terminated_early_total</div>
<div class="metric_help">The number of times lifecycle sleep handler got terminated before it finishes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_started_containers_errors_total</div>
<div class="metric_help">Cumulative number of errors when starting containers</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span><span class="metric_label">container_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_started_containers_total</div>
<div class="metric_help">Cumulative number of containers started</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">container_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_started_host_process_containers_errors_total</div>
<div class="metric_help">Cumulative number of errors when starting hostprocess containers. This metric will only be collected on Windows.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span><span class="metric_label">container_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_started_host_process_containers_total</div>
<div class="metric_help">Cumulative number of hostprocess containers started. This metric will only be collected on Windows.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">container_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_started_pods_errors_total</div>
<div class="metric_help">Cumulative number of errors when starting pods</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_started_pods_total</div>
<div class="metric_help">Cumulative number of pods started</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_topology_manager_admission_duration_ms</div>
<div class="metric_help">Duration in milliseconds to serve a pod admission request.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_topology_manager_admission_errors_total</div>
<div class="metric_help">The number of admission request failures where resources could not be aligned.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_topology_manager_admission_requests_total</div>
<div class="metric_help">The number of admission requests where resources have to be aligned.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_volume_metric_collection_duration_seconds</div>
<div class="metric_help">Duration in seconds to calculate volume stats</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">metric_source</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_volume_stats_available_bytes</div>
<div class="metric_help">Number of available bytes in the volume</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">persistentvolumeclaim</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_volume_stats_capacity_bytes</div>
<div class="metric_help">Capacity in bytes of the volume</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">persistentvolumeclaim</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_volume_stats_health_status_abnormal</div>
<div class="metric_help">Abnormal volume health status. The count is either 1 or 0. 1 indicates the volume is unhealthy, 0 indicates volume is healthy</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">persistentvolumeclaim</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_volume_stats_inodes</div>
<div class="metric_help">Maximum number of inodes in the volume</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">persistentvolumeclaim</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_volume_stats_inodes_free</div>
<div class="metric_help">Number of free inodes in the volume</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">persistentvolumeclaim</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_volume_stats_inodes_used</div>
<div class="metric_help">Number of used inodes in the volume</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">persistentvolumeclaim</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_volume_stats_used_bytes</div>
<div class="metric_help">Number of used bytes in the volume</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">persistentvolumeclaim</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubelet_working_pods</div>
<div class="metric_help">Number of pods the kubelet is actually running, broken down by lifecycle phase, whether the pod is desired, orphaned, or runtime only (also orphaned), and whether the pod is static. An orphaned pod has been removed from local configuration or force deleted in the API and consumes resources that are not otherwise visible.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">config</span><span class="metric_label">lifecycle</span><span class="metric_label">static</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_iptables_ct_state_invalid_dropped_packets_total</div>
<div class="metric_help">packets dropped by iptables to work around conntrack problems</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_iptables_localhost_nodeports_accepted_packets_total</div>
<div class="metric_help">Number of packets accepted on nodeports of loopback interface</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_network_programming_duration_seconds</div>
<div class="metric_help">In Cluster Network Programming Latency in seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_proxy_healthz_total</div>
<div class="metric_help">Cumulative proxy healthz HTTP status</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_proxy_livez_total</div>
<div class="metric_help">Cumulative proxy livez HTTP status</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_full_proxy_rules_duration_seconds</div>
<div class="metric_help">SyncProxyRules latency in seconds for full resyncs</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_partial_proxy_rules_duration_seconds</div>
<div class="metric_help">SyncProxyRules latency in seconds for partial resyncs</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_duration_seconds</div>
<div class="metric_help">SyncProxyRules latency in seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_endpoint_changes_pending</div>
<div class="metric_help">Pending proxy rules Endpoint changes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_endpoint_changes_total</div>
<div class="metric_help">Cumulative proxy rules Endpoint changes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_iptables_last</div>
<div class="metric_help">Number of iptables rules written by kube-proxy in last sync</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">table</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_iptables_partial_restore_failures_total</div>
<div class="metric_help">Cumulative proxy iptables partial restore failures</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_iptables_restore_failures_total</div>
<div class="metric_help">Cumulative proxy iptables restore failures</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_iptables_total</div>
<div class="metric_help">Total number of iptables rules owned by kube-proxy</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">table</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_last_queued_timestamp_seconds</div>
<div class="metric_help">The last time a sync of proxy rules was queued</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_last_timestamp_seconds</div>
<div class="metric_help">The last time proxy rules were successfully synced</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_nftables_cleanup_failures_total</div>
<div class="metric_help">Cumulative proxy nftables cleanup failures</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_nftables_sync_failures_total</div>
<div class="metric_help">Cumulative proxy nftables sync failures</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_no_local_endpoints_total</div>
<div class="metric_help">Number of services with a Local traffic policy and no endpoints</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">traffic_policy</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_service_changes_pending</div>
<div class="metric_help">Pending proxy rules Service changes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubeproxy_sync_proxy_rules_service_changes_total</div>
<div class="metric_help">Cumulative proxy rules Service changes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">kubernetes_build_info</div>
<div class="metric_help">A metric with a constant '1' value labeled by major, minor, git version, git commit, git tree state, build date, Go version, and compiler from which Kubernetes was built, and platform on which it is running.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">build_date</span><span class="metric_label">compiler</span><span class="metric_label">git_commit</span><span class="metric_label">git_tree_state</span><span class="metric_label">git_version</span><span class="metric_label">go_version</span><span class="metric_label">major</span><span class="metric_label">minor</span><span class="metric_label">platform</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">leader_election_master_status</div>
<div class="metric_help">Gauge of if the reporting system is master of the relevant lease, 0 indicates backup, 1 indicates master. 'name' is the string used to identify the lease. Please make sure to group by name.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">leader_election_slowpath_total</div>
<div class="metric_help">Total number of slow path exercised in renewing leader leases. 'name' is the string used to identify the lease. Please make sure to group by name.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_authorizer_graph_actions_duration_seconds</div>
<div class="metric_help">Histogram of duration of graph actions in node authorizer.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_collector_unhealthy_nodes_in_zone</div>
<div class="metric_help">Gauge measuring number of not Ready Nodes per zones.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">zone</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_collector_update_all_nodes_health_duration_seconds</div>
<div class="metric_help">Duration in seconds for NodeController to update the health of all nodes.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_collector_update_node_health_duration_seconds</div>
<div class="metric_help">Duration in seconds for NodeController to update the health of a single node.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_collector_zone_health</div>
<div class="metric_help">Gauge measuring percentage of healthy nodes per zone.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">zone</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_collector_zone_size</div>
<div class="metric_help">Gauge measuring number of registered Nodes per zones.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">zone</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_controller_cloud_provider_taint_removal_delay_seconds</div>
<div class="metric_help">Number of seconds after node creation when NodeController removed the cloud-provider taint of a single node.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_controller_initial_node_sync_delay_seconds</div>
<div class="metric_help">Number of seconds after node creation when NodeController finished the initial synchronization of a single node.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_ipam_controller_cidrset_allocation_tries_per_request</div>
<div class="metric_help">Number of endpoints added on each Service sync</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">clusterCIDR</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_ipam_controller_cidrset_cidrs_allocations_total</div>
<div class="metric_help">Counter measuring total number of CIDR allocations.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">clusterCIDR</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_ipam_controller_cidrset_cidrs_releases_total</div>
<div class="metric_help">Counter measuring total number of CIDR releases.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">clusterCIDR</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_ipam_controller_cidrset_usage_cidrs</div>
<div class="metric_help">Gauge measuring percentage of allocated CIDRs.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">clusterCIDR</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_ipam_controller_cirdset_max_cidrs</div>
<div class="metric_help">Maximum number of CIDRs that can be allocated.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">clusterCIDR</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">node_swap_usage_bytes</div>
<div class="metric_help">Current swap usage of the node in bytes. Reported only on non-windows systems</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">plugin_manager_total_plugins</div>
<div class="metric_help">Number of plugins in Plugin Manager</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">socket_path</span><span class="metric_label">state</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pod_gc_collector_force_delete_pod_errors_total</div>
<div class="metric_help">Number of errors encountered when forcefully deleting the pods since the Pod GC Controller started.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">reason</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pod_gc_collector_force_delete_pods_total</div>
<div class="metric_help">Number of pods that are being forcefully deleted since the Pod GC Controller started.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">reason</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pod_security_errors_total</div>
<div class="metric_help">Number of errors preventing normal evaluation. Non-fatal errors may result in the latest restricted profile being used for evaluation.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">fatal</span><span class="metric_label">request_operation</span><span class="metric_label">resource</span><span class="metric_label">subresource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pod_security_evaluations_total</div>
<div class="metric_help">Number of policy evaluations that occurred, not counting ignored or exempt requests.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">decision</span><span class="metric_label">mode</span><span class="metric_label">policy_level</span><span class="metric_label">policy_version</span><span class="metric_label">request_operation</span><span class="metric_label">resource</span><span class="metric_label">subresource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pod_security_exemptions_total</div>
<div class="metric_help">Number of exempt requests, not counting ignored or out of scope requests.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">request_operation</span><span class="metric_label">resource</span><span class="metric_label">subresource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pod_swap_usage_bytes</div>
<div class="metric_help">Current amount of the pod swap usage in bytes. Reported only on non-windows systems</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">pod</span><span class="metric_label">namespace</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">prober_probe_duration_seconds</div>
<div class="metric_help">Duration in seconds for a probe response.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">container</span><span class="metric_label">namespace</span><span class="metric_label">pod</span><span class="metric_label">probe_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">prober_probe_total</div>
<div class="metric_help">Cumulative number of a liveness, readiness or startup probe for a container by result.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">container</span><span class="metric_label">namespace</span><span class="metric_label">pod</span><span class="metric_label">pod_uid</span><span class="metric_label">probe_type</span><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pv_collector_bound_pv_count</div>
<div class="metric_help">Gauge measuring number of persistent volume currently bound</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">storage_class</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pv_collector_bound_pvc_count</div>
<div class="metric_help">Gauge measuring number of persistent volume claim currently bound</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">storage_class</span><span class="metric_label">volume_attributes_class</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pv_collector_total_pv_count</div>
<div class="metric_help">Gauge measuring total number of persistent volumes</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">plugin_name</span><span class="metric_label">volume_mode</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pv_collector_unbound_pv_count</div>
<div class="metric_help">Gauge measuring number of persistent volume currently unbound</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">storage_class</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">pv_collector_unbound_pvc_count</div>
<div class="metric_help">Gauge measuring number of persistent volume claim currently unbound</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">namespace</span><span class="metric_label">storage_class</span><span class="metric_label">volume_attributes_class</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">reconstruct_volume_operations_errors_total</div>
<div class="metric_help">The number of volumes that failed reconstruction from the operating system during kubelet startup.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">reconstruct_volume_operations_total</div>
<div class="metric_help">The number of volumes that were attempted to be reconstructed from the operating system during kubelet startup. This includes both successful and failed reconstruction.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">replicaset_controller_sorting_deletion_age_ratio</div>
<div class="metric_help">The ratio of chosen deleted pod's ages to the current youngest pod's age (at the time). Should be <2. The intent of this metric is to measure the rough efficacy of the LogarithmicScaleDown feature gate's effect on the sorting (and deletion) of pods when a replicaset scales down. This only considers Ready pods when calculating and reporting.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">resourceclaim_controller_create_attempts_total</div>
<div class="metric_help">Number of ResourceClaims creation requests</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">resourceclaim_controller_create_failures_total</div>
<div class="metric_help">Number of ResourceClaims creation request failures</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_dns_resolution_duration_seconds</div>
<div class="metric_help">DNS resolver latency in seconds. Broken down by host.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">host</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_exec_plugin_call_total</div>
<div class="metric_help">Number of calls to an exec plugin, partitioned by the type of event encountered (no_error, plugin_execution_error, plugin_not_found_error, client_internal_error) and an optional exit code. The exit code will be set to 0 if and only if the plugin call was successful.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">call_status</span><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_exec_plugin_certificate_rotation_age</div>
<div class="metric_help">Histogram of the number of seconds the last auth exec plugin client certificate lived before being rotated. If auth exec plugin client certificates are unused, histogram will contain no data.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_exec_plugin_ttl_seconds</div>
<div class="metric_help">Gauge of the shortest TTL (time-to-live) of the client certificate(s) managed by the auth exec plugin. The value is in seconds until certificate expiry (negative if already expired). If auth exec plugins are unused or manage no TLS certificates, the value will be +INF.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_rate_limiter_duration_seconds</div>
<div class="metric_help">Client side rate limiter latency in seconds. Broken down by verb, and host.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">host</span><span class="metric_label">verb</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_request_duration_seconds</div>
<div class="metric_help">Request latency in seconds. Broken down by verb, and host.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">host</span><span class="metric_label">verb</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_request_retries_total</div>
<div class="metric_help">Number of request retries, partitioned by status code, verb, and host.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span><span class="metric_label">host</span><span class="metric_label">verb</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_request_size_bytes</div>
<div class="metric_help">Request size in bytes. Broken down by verb and host.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">host</span><span class="metric_label">verb</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_requests_total</div>
<div class="metric_help">Number of HTTP requests, partitioned by status code, method, and host.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span><span class="metric_label">host</span><span class="metric_label">method</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_response_size_bytes</div>
<div class="metric_help">Response size in bytes. Broken down by verb and host.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">host</span><span class="metric_label">verb</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_transport_cache_entries</div>
<div class="metric_help">Number of transport entries in the internal cache.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">rest_client_transport_create_calls_total</div>
<div class="metric_help">Number of calls to get a new transport, partitioned by the result of the operation hit: obtained from the cache, miss: created and added to the cache, uncacheable: created and not cached</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">retroactive_storageclass_errors_total</div>
<div class="metric_help">Total number of failed retroactive StorageClass assignments to persistent volume claim</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">retroactive_storageclass_total</div>
<div class="metric_help">Total number of retroactive StorageClass assignments to persistent volume claim</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">root_ca_cert_publisher_sync_duration_seconds</div>
<div class="metric_help">Number of namespace syncs happened in root ca cert publisher.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">root_ca_cert_publisher_sync_total</div>
<div class="metric_help">Number of namespace syncs happened in root ca cert publisher.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">code</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">running_managed_controllers</div>
<div class="metric_help">Indicates where instances of a controller are currently running</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">manager</span><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_event_handling_duration_seconds</div>
<div class="metric_help">Event handling latency in seconds.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">event</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_goroutines</div>
<div class="metric_help">Number of running goroutines split by the work they do such as binding.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_permit_wait_duration_seconds</div>
<div class="metric_help">Duration of waiting on permit.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">result</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_plugin_evaluation_total</div>
<div class="metric_help">Number of attempts to schedule pods by each plugin and the extension point (available only in PreFilter, Filter, PreScore, and Score).</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">extension_point</span><span class="metric_label">plugin</span><span class="metric_label">profile</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_plugin_execution_duration_seconds</div>
<div class="metric_help">Duration for running a plugin at a specific extension point.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">extension_point</span><span class="metric_label">plugin</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_queueing_hint_execution_duration_seconds</div>
<div class="metric_help">Duration for running a queueing hint function of a plugin.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">event</span><span class="metric_label">hint</span><span class="metric_label">plugin</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_scheduler_cache_size</div>
<div class="metric_help">Number of nodes, pods, and assumed (bound) pods in the scheduler cache.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_scheduling_algorithm_duration_seconds</div>
<div class="metric_help">Scheduling algorithm latency in seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_unschedulable_pods</div>
<div class="metric_help">The number of unschedulable pods broken down by plugin name. A pod will increment the gauge for all plugins that caused it to not schedule and so this metric have meaning only when broken down by plugin.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">plugin</span><span class="metric_label">profile</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_volume_binder_cache_requests_total</div>
<div class="metric_help">Total number for request volume binding cache</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scheduler_volume_scheduling_stage_error_total</div>
<div class="metric_help">Volume scheduling stage error count</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">scrape_error</div>
<div class="metric_help">1 if there was an error while getting container metrics, 0 otherwise</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_deprecated_version"><label class="metric_detail">Deprecated Versions:</label><span>1.29.0</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">service_controller_loadbalancer_sync_total</div>
<div class="metric_help">A metric counting the amount of times any load balancer has been configured, as an effect of service/node changes on the cluster</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">service_controller_nodesync_error_total</div>
<div class="metric_help">A metric counting the amount of times any load balancer has been configured and errored, as an effect of node changes on the cluster</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">service_controller_nodesync_latency_seconds</div>
<div class="metric_help">A metric measuring the latency for nodesync which updates loadbalancer hosts on cluster node updates.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">service_controller_update_loadbalancer_host_latency_seconds</div>
<div class="metric_help">A metric measuring the latency for updating each load balancer hosts.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">serviceaccount_invalid_legacy_auto_token_uses_total</div>
<div class="metric_help">Cumulative invalid auto-generated legacy tokens used</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">serviceaccount_legacy_auto_token_uses_total</div>
<div class="metric_help">Cumulative auto-generated legacy tokens used</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">serviceaccount_legacy_manual_token_uses_total</div>
<div class="metric_help">Cumulative manually created legacy tokens used</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">serviceaccount_legacy_tokens_total</div>
<div class="metric_help">Cumulative legacy service account tokens used</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">serviceaccount_stale_tokens_total</div>
<div class="metric_help">Cumulative stale projected service account tokens used</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">serviceaccount_valid_tokens_total</div>
<div class="metric_help">Cumulative valid projected service account tokens used</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">storage_count_attachable_volumes_in_use</div>
<div class="metric_help">Measure number of volumes in use</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">node</span><span class="metric_label">volume_plugin</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">storage_operation_duration_seconds</div>
<div class="metric_help">Storage operation duration</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">migrated</span><span class="metric_label">operation_name</span><span class="metric_label">status</span><span class="metric_label">volume_plugin</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">taint_eviction_controller_pod_deletion_duration_seconds</div>
<div class="metric_help">Latency, in seconds, between the time when a taint effect has been activated for the Pod and its deletion via TaintEvictionController.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">taint_eviction_controller_pod_deletions_total</div>
<div class="metric_help">Total number of Pods deleted by TaintEvictionController since its start.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">ttl_after_finished_controller_job_deletion_duration_seconds</div>
<div class="metric_help">The time it took to delete the job since it became eligible for deletion</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
</ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_manager_selinux_container_errors_total</div>
<div class="metric_help">Number of errors when kubelet cannot compute SELinux context for a container. Kubelet can't start such a Pod then and it will retry, therefore value of this metric may not represent the actual nr. of containers.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">access_mode</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_manager_selinux_container_warnings_total</div>
<div class="metric_help">Number of errors when kubelet cannot compute SELinux context for a container that are ignored. They will become real errors when SELinuxMountReadWriteOncePod feature is expanded to all volume access modes.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">access_mode</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_manager_selinux_pod_context_mismatch_errors_total</div>
<div class="metric_help">Number of errors when a Pod defines different SELinux contexts for its containers that use the same volume. Kubelet can't start such a Pod then and it will retry, therefore value of this metric may not represent the actual nr. of Pods.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">access_mode</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_manager_selinux_pod_context_mismatch_warnings_total</div>
<div class="metric_help">Number of errors when a Pod defines different SELinux contexts for its containers that use the same volume. They are not errors yet, but they will become real errors when SELinuxMountReadWriteOncePod feature is expanded to all volume access modes.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">access_mode</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_manager_selinux_volume_context_mismatch_errors_total</div>
<div class="metric_help">Number of errors when a Pod uses a volume that is already mounted with a different SELinux context than the Pod needs. Kubelet can't start such a Pod then and it will retry, therefore value of this metric may not represent the actual nr. of Pods.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">access_mode</span><span class="metric_label">volume_plugin</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_manager_selinux_volume_context_mismatch_warnings_total</div>
<div class="metric_help">Number of errors when a Pod uses a volume that is already mounted with a different SELinux context than the Pod needs. They are not errors yet, but they will become real errors when SELinuxMountReadWriteOncePod feature is expanded to all volume access modes.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">access_mode</span><span class="metric_label">volume_plugin</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_manager_selinux_volumes_admitted_total</div>
<div class="metric_help">Number of volumes whose SELinux context was fine and will be mounted with mount -o context option.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">access_mode</span><span class="metric_label">volume_plugin</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_manager_total_volumes</div>
<div class="metric_help">Number of volumes in Volume Manager</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="custom"><label class="metric_detail">Type:</label> <span class="metric_type">Custom</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">plugin_name</span><span class="metric_label">state</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_operation_total_errors</div>
<div class="metric_help">Total volume operation errors</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation_name</span><span class="metric_label">plugin_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">volume_operation_total_seconds</div>
<div class="metric_help">Storage operation end to end duration in seconds</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">operation_name</span><span class="metric_label">plugin_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">watch_cache_capacity</div>
<div class="metric_help">Total capacity of watch cache broken by resource type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">watch_cache_capacity_decrease_total</div>
<div class="metric_help">Total number of watch cache capacity decrease events broken by resource type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">watch_cache_capacity_increase_total</div>
<div class="metric_help">Total number of watch cache capacity increase events broken by resource type.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">resource</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">workqueue_adds_total</div>
<div class="metric_help">Total number of adds handled by workqueue</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">workqueue_depth</div>
<div class="metric_help">Current depth of workqueue</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">workqueue_longest_running_processor_seconds</div>
<div class="metric_help">How many seconds has the longest running processor for workqueue been running.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">workqueue_queue_duration_seconds</div>
<div class="metric_help">How long in seconds an item stays in workqueue before being requested.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">workqueue_retries_total</div>
<div class="metric_help">Total number of retries handled by workqueue</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">workqueue_unfinished_work_seconds</div>
<div class="metric_help">How many seconds of work has done that is in progress and hasn't been observed by work_duration. Large values indicate stuck threads. One can deduce the number of stuck threads by observing the rate at which this increases.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">workqueue_work_duration_seconds</div>
<div class="metric_help">How long in seconds processing an item from workqueue takes.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="histogram"><label class="metric_detail">Type:</label> <span class="metric_type">Histogram</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">name</span></li></ul>
</div>
</div> | kubernetes reference | title Kubernetes Metrics Reference content type reference auto generated true description Details of the metric data that Kubernetes components export Metrics v1 31 auto generated 2024 Oct 28 auto generated v1 31 This page details the metrics that different Kubernetes components export You can query the metrics endpoint for these components using an HTTP scrape and fetch the current metrics data in Prometheus format List of Stable Kubernetes Metrics Stable metrics observe strict API contracts and no labels can be added or removed from stable metrics during their lifetime div class metrics div class metric data stability stable div class metric name apiserver admission controller admission duration seconds div div class metric help Admission controller latency histogram in seconds identified by name and broken out for each operation and API resource and type validate or admit div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label operation span span class metric label rejected span span class metric label type span li ul div div class metric data stability stable div class metric name apiserver admission step admission duration seconds div div class metric help Admission sub step latency histogram in seconds broken out for each operation and API resource and step type validate or admit div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label operation span span class metric label rejected span span class metric label type span li ul div div class metric data stability stable div class metric name apiserver admission webhook admission duration seconds div div class metric help Admission webhook latency histogram in seconds identified by name and broken out for each operation and API resource and type validate or admit div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label operation span span class metric label rejected span span class metric label type span li ul div div class metric data stability stable div class metric name apiserver current inflight requests div div class metric help Maximal number of currently used inflight request limit of this apiserver per request kind in last second div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label request kind span li ul div div class metric data stability stable div class metric name apiserver longrunning requests div div class metric help Gauge of all active long running apiserver requests broken out by verb group version resource scope and component Not all requests are tracked this way div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label component span span class metric label group span span class metric label resource span span class metric label scope span span class metric label subresource span span class metric label verb span span class metric label version span li ul div div class metric data stability stable div class metric name apiserver request duration seconds div div class metric help Response latency distribution in seconds for each verb dry run value group version resource subresource scope and component div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label component span span class metric label dry run span span class metric label group span span class metric label resource span span class metric label scope span span class metric label subresource span span class metric label verb span span class metric label version span li ul div div class metric data stability stable div class metric name apiserver request total div div class metric help Counter of apiserver requests broken out for each verb dry run value group version resource scope component and HTTP response code div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span span class metric label component span span class metric label dry run span span class metric label group span span class metric label resource span span class metric label scope span span class metric label subresource span span class metric label verb span span class metric label version span li ul div div class metric data stability stable div class metric name apiserver requested deprecated apis div div class metric help Gauge of deprecated APIs that have been requested broken out by API group version resource subresource and removed release div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label group span span class metric label removed release span span class metric label resource span span class metric label subresource span span class metric label version span li ul div div class metric data stability stable div class metric name apiserver response sizes div div class metric help Response size distribution in bytes for each group version verb resource subresource scope and component div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label component span span class metric label group span span class metric label resource span span class metric label scope span span class metric label subresource span span class metric label verb span span class metric label version span li ul div div class metric data stability stable div class metric name apiserver storage objects div div class metric help Number of stored objects at the time of last check split by kind In case of a fetching error the value will be 1 div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability stable div class metric name apiserver storage size bytes div div class metric help Size of the storage database file physically allocated in bytes div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label storage cluster id span li ul div div class metric data stability stable div class metric name container cpu usage seconds total div div class metric help Cumulative cpu time consumed by the container in core seconds div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label container span span class metric label pod span span class metric label namespace span li ul div div class metric data stability stable div class metric name container memory working set bytes div div class metric help Current working set of the container in bytes div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label container span span class metric label pod span span class metric label namespace span li ul div div class metric data stability stable div class metric name container start time seconds div div class metric help Start time of the container since unix epoch in seconds div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label container span span class metric label pod span span class metric label namespace span li ul div div class metric data stability stable div class metric name cronjob controller job creation skew duration seconds div div class metric help Time between when a cronjob is scheduled to be run and when the corresponding job is created div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability stable div class metric name job controller job pods finished total div div class metric help The number of finished Pods that are fully tracked div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label completion mode span span class metric label result span li ul div div class metric data stability stable div class metric name job controller job sync duration seconds div div class metric help The time it took to sync a job div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label action span span class metric label completion mode span span class metric label result span li ul div div class metric data stability stable div class metric name job controller job syncs total div div class metric help The number of job syncs div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label action span span class metric label completion mode span span class metric label result span li ul div div class metric data stability stable div class metric name job controller jobs finished total div div class metric help The number of finished jobs div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label completion mode span span class metric label reason span span class metric label result span li ul div div class metric data stability stable div class metric name kube pod resource limit div div class metric help Resources limit for workloads on the cluster broken down by pod This shows the resource usage the scheduler and kubelet expect per pod for resources along with the unit for the resource if any div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label pod span span class metric label node span span class metric label scheduler span span class metric label priority span span class metric label resource span span class metric label unit span li ul div div class metric data stability stable div class metric name kube pod resource request div div class metric help Resources requested by workloads on the cluster broken down by pod This shows the resource usage the scheduler and kubelet expect per pod for resources along with the unit for the resource if any div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label pod span span class metric label node span span class metric label scheduler span span class metric label priority span span class metric label resource span span class metric label unit span li ul div div class metric data stability stable div class metric name kubernetes healthcheck div div class metric help This metric records the result of a single healthcheck div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label type span li ul div div class metric data stability stable div class metric name kubernetes healthchecks total div div class metric help This metric records the results of all healthcheck div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label status span span class metric label type span li ul div div class metric data stability stable div class metric name node collector evictions total div div class metric help Number of Node evictions that happened since current instance of NodeController started div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label zone span li ul div div class metric data stability stable div class metric name node cpu usage seconds total div div class metric help Cumulative cpu time consumed by the node in core seconds div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li ul div div class metric data stability stable div class metric name node memory working set bytes div div class metric help Current working set of the node in bytes div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li ul div div class metric data stability stable div class metric name pod cpu usage seconds total div div class metric help Cumulative cpu time consumed by the pod in core seconds div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label pod span span class metric label namespace span li ul div div class metric data stability stable div class metric name pod memory working set bytes div div class metric help Current working set of the pod in bytes div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label pod span span class metric label namespace span li ul div div class metric data stability stable div class metric name resource scrape error div div class metric help 1 if there was an error while getting container metrics 0 otherwise div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type custom label class metric detail Type label span class metric type Custom span li ul div div class metric data stability stable div class metric name scheduler framework extension point duration seconds div div class metric help Latency for running all plugins of a specific extension point div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label extension point span span class metric label profile span span class metric label status span li ul div div class metric data stability stable div class metric name scheduler pending pods div div class metric help Number of pending pods by the queue type active means number of pods in activeQ backoff means number of pods in backoffQ unschedulable means number of pods in unschedulablePods that the scheduler attempted to schedule and failed gated is the number of unschedulable pods that the scheduler never attempted to schedule because they are gated div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label queue span li ul div div class metric data stability stable div class metric name scheduler pod scheduling attempts div div class metric help Number of attempts to successfully schedule a pod div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability stable div class metric name scheduler pod scheduling duration seconds div div class metric help E2e latency for a pod being scheduled which may include multiple scheduling attempts div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label attempts span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 29 0 span li ul div div class metric data stability stable div class metric name scheduler preemption attempts total div div class metric help Total preemption attempts in the cluster till now div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability stable div class metric name scheduler preemption victims div div class metric help Number of selected preemption victims div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability stable div class metric name scheduler queue incoming pods total div div class metric help Number of pods added to scheduling queues by event and queue type div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label event span span class metric label queue span li ul div div class metric data stability stable div class metric name scheduler schedule attempts total div div class metric help Number of attempts to schedule pods by the result unschedulable means a pod could not be scheduled while error means an internal scheduler problem div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label profile span span class metric label result span li ul div div class metric data stability stable div class metric name scheduler scheduling attempt duration seconds div div class metric help Scheduling attempt latency in seconds scheduling algorithm binding div ul li label class metric detail Stability Level label span class metric stability level STABLE span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label profile span span class metric label result span li ul div div List of Beta Kubernetes Metrics Beta metrics observe a looser API contract than its stable counterparts No labels can be removed from beta metrics during their lifetime however labels can be added while the metric is in the beta stage This offers the assurance that beta metrics will honor existing dashboards and alerts while allowing for amendments in the future div class metrics div class metric data stability beta div class metric name apiserver cel compilation duration seconds div div class metric help CEL compilation time in seconds div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability beta div class metric name apiserver cel evaluation duration seconds div div class metric help CEL evaluation time in seconds div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability beta div class metric name apiserver flowcontrol current executing requests div div class metric help Number of requests in initial for a WATCH or any for a non WATCH execution stage in the API Priority and Fairness subsystem div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability beta div class metric name apiserver flowcontrol current executing seats div div class metric help Concurrency number of seats occupied by the currently executing initial stage for a WATCH any stage otherwise requests in the API Priority and Fairness subsystem div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability beta div class metric name apiserver flowcontrol current inqueue requests div div class metric help Number of requests currently pending in queues of the API Priority and Fairness subsystem div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability beta div class metric name apiserver flowcontrol dispatched requests total div div class metric help Number of requests executed by API Priority and Fairness subsystem div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability beta div class metric name apiserver flowcontrol nominal limit seats div div class metric help Nominal number of execution seats configured for each priority level div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability beta div class metric name apiserver flowcontrol rejected requests total div div class metric help Number of requests rejected by API Priority and Fairness subsystem div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span span class metric label reason span li ul div div class metric data stability beta div class metric name apiserver flowcontrol request wait duration seconds div div class metric help Length of time a request spent waiting in its queue div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label execute span span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability beta div class metric name apiserver validating admission policy check duration seconds div div class metric help Validation admission latency for individual validation expressions in seconds labeled by policy and further including binding and enforcement action taken div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label enforcement action span span class metric label error type span span class metric label policy span span class metric label policy binding span li ul div div class metric data stability beta div class metric name apiserver validating admission policy check total div div class metric help Validation admission policy check total labeled by policy and further identified by binding and enforcement action taken div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label enforcement action span span class metric label error type span span class metric label policy span span class metric label policy binding span li ul div div class metric data stability beta div class metric name disabled metrics total div div class metric help The count of disabled metrics div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability beta div class metric name hidden metrics total div div class metric help The count of hidden metrics div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability beta div class metric name kubernetes feature enabled div div class metric help This metric records the data about the stage and enablement of a k8s feature div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label stage span li ul div div class metric data stability beta div class metric name registered metrics total div div class metric help The count of registered metrics broken by stability level and deprecation version div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label deprecated version span span class metric label stability level span li ul div div class metric data stability beta div class metric name scheduler pod scheduling sli duration seconds div div class metric help E2e latency for a pod being scheduled from the time the pod enters the scheduling queue and might involve multiple scheduling attempts div ul li label class metric detail Stability Level label span class metric stability level BETA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label attempts span li ul div div List of Alpha Kubernetes Metrics Alpha metrics do not have any API guarantees These metrics must be used at your own risk subsequent versions of Kubernetes may remove these metrics altogether or mutate the API in such a way that breaks existing dashboards and alerts div class metrics div class metric data stability alpha div class metric name aggregator discovery aggregation count total div div class metric help Counter of number of times discovery was aggregated div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name aggregator openapi v2 regeneration count div div class metric help Counter of OpenAPI v2 spec regeneration count broken down by causing APIService name and reason div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label apiservice span span class metric label reason span li ul div div class metric data stability alpha div class metric name aggregator openapi v2 regeneration duration div div class metric help Gauge of OpenAPI v2 spec regeneration duration in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label reason span li ul div div class metric data stability alpha div class metric name aggregator unavailable apiservice div div class metric help Gauge of APIServices which are marked as unavailable broken down by APIService name div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div class metric data stability alpha div class metric name aggregator unavailable apiservice total div div class metric help Counter of APIServices which are marked as unavailable broken down by APIService name and reason div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label reason span li ul div div class metric data stability alpha div class metric name apiextensions apiserver validation ratcheting seconds div div class metric help Time for comparison of old to new for the purposes of CRDValidationRatcheting during an UPDATE in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name apiextensions openapi v2 regeneration count div div class metric help Counter of OpenAPI v2 spec regeneration count broken down by causing CRD name and reason div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label crd span span class metric label reason span li ul div div class metric data stability alpha div class metric name apiextensions openapi v3 regeneration count div div class metric help Counter of OpenAPI v3 spec regeneration count broken down by group version causing CRD and reason div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label crd span span class metric label group span span class metric label reason span span class metric label version span li ul div div class metric data stability alpha div class metric name apiserver admission match condition evaluation errors total div div class metric help Admission match condition evaluation errors count identified by name of resource containing the match condition and broken out for each kind containing matchConditions webhook or policy operation and admission type validate or admit div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label kind span span class metric label name span span class metric label operation span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver admission match condition evaluation seconds div div class metric help Admission match condition evaluation time in seconds identified by name and broken out for each kind containing matchConditions webhook or policy operation and type validate or admit div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label kind span span class metric label name span span class metric label operation span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver admission match condition exclusions total div div class metric help Admission match condition evaluation exclusions count identified by name of resource containing the match condition and broken out for each kind containing matchConditions webhook or policy operation and admission type validate or admit div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label kind span span class metric label name span span class metric label operation span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver admission step admission duration seconds summary div div class metric help Admission sub step latency summary in seconds broken out for each operation and API resource and step type validate or admit div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type summary label class metric detail Type label span class metric type Summary span li li class metric labels varying label class metric detail Labels label span class metric label operation span span class metric label rejected span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver admission webhook fail open count div div class metric help Admission webhook fail open count identified by name and broken out for each admission type validating or mutating div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver admission webhook rejection count div div class metric help Admission webhook rejection count identified by name and broken out for each admission type validating or admit and operation Additional labels specify an error type calling webhook error or apiserver internal error if an error occurred no error otherwise and optionally a non zero rejection code if the webhook rejects the request with an HTTP status code honored by the apiserver when the code is greater or equal to 400 Codes greater than 600 are truncated to 600 to keep the metrics cardinality bounded div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label error type span span class metric label name span span class metric label operation span span class metric label rejection code span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver admission webhook request total div div class metric help Admission webhook request total identified by name and broken out for each admission type validating or mutating and operation Additional labels specify whether the request was rejected or not and an HTTP status code Codes greater than 600 are truncated to 600 to keep the metrics cardinality bounded div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span span class metric label name span span class metric label operation span span class metric label rejected span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver audit error total div div class metric help Counter of audit events that failed to be audited properly Plugin identifies the plugin affected by the error div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label plugin span li ul div div class metric data stability alpha div class metric name apiserver audit event total div div class metric help Counter of audit events generated and sent to the audit backend div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver audit level total div div class metric help Counter of policy levels for audit events 1 per request div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label level span li ul div div class metric data stability alpha div class metric name apiserver audit requests rejected total div div class metric help Counter of apiserver requests rejected due to an error in audit logging backend div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver authentication config controller automatic reload last timestamp seconds div div class metric help Timestamp of the last automatic reload of authentication configuration split by status and apiserver identity div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span span class metric label status span li ul div div class metric data stability alpha div class metric name apiserver authentication config controller automatic reloads total div div class metric help Total number of automatic reloads of authentication configuration split by status and apiserver identity div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span span class metric label status span li ul div div class metric data stability alpha div class metric name apiserver authentication jwt authenticator latency seconds div div class metric help Latency of jwt authentication operations in seconds This is the time spent authenticating a token for cache miss only i e when the token is not found in the cache div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label jwt issuer hash span span class metric label result span li ul div div class metric data stability alpha div class metric name apiserver authorization config controller automatic reload last timestamp seconds div div class metric help Timestamp of the last automatic reload of authorization configuration split by status and apiserver identity div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span span class metric label status span li ul div div class metric data stability alpha div class metric name apiserver authorization config controller automatic reloads total div div class metric help Total number of automatic reloads of authorization configuration split by status and apiserver identity div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span span class metric label status span li ul div div class metric data stability alpha div class metric name apiserver authorization decisions total div div class metric help Total number of terminal decisions made by an authorizer split by authorizer type name and decision div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label decision span span class metric label name span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver authorization match condition evaluation errors total div div class metric help Total number of errors when an authorization webhook encounters a match condition error split by authorizer type and name div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver authorization match condition evaluation seconds div div class metric help Authorization match condition evaluation time in seconds split by authorizer type and name div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver authorization match condition exclusions total div div class metric help Total number of exclusions when an authorization webhook is skipped because match conditions exclude it div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver authorization webhook duration seconds div div class metric help Request latency in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label result span li ul div div class metric data stability alpha div class metric name apiserver authorization webhook evaluations fail open total div div class metric help NoOpinion results due to webhook timeout or error div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label result span li ul div div class metric data stability alpha div class metric name apiserver authorization webhook evaluations total div div class metric help Round trips to authorization webhooks div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span span class metric label result span li ul div div class metric data stability alpha div class metric name apiserver cache list fetched objects total div div class metric help Number of objects read from watch cache in the course of serving a LIST request div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label index span span class metric label resource prefix span li ul div div class metric data stability alpha div class metric name apiserver cache list returned objects total div div class metric help Number of objects returned for a LIST request from watch cache div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource prefix span li ul div div class metric data stability alpha div class metric name apiserver cache list total div div class metric help Number of LIST requests served from watch cache div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label index span span class metric label resource prefix span li ul div div class metric data stability alpha div class metric name apiserver certificates registry csr honored duration total div div class metric help Total number of issued CSRs with a requested duration that was honored sliced by signer only kubernetes io signer names are specifically identified div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label signerName span li ul div div class metric data stability alpha div class metric name apiserver certificates registry csr requested duration total div div class metric help Total number of issued CSRs with a requested duration sliced by signer only kubernetes io signer names are specifically identified div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label signerName span li ul div div class metric data stability alpha div class metric name apiserver client certificate expiration seconds div div class metric help Distribution of the remaining lifetime on the certificate used to authenticate a request div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name apiserver clusterip repair ip errors total div div class metric help Number of errors detected on clusterips by the repair loop broken down by type of error leak repair full outOfRange duplicate unknown invalid div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver clusterip repair reconcile errors total div div class metric help Number of reconciliation failures on the clusterip repair reconcile loop div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver conversion webhook duration seconds div div class metric help Conversion webhook request latency div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label failure type span span class metric label result span li ul div div class metric data stability alpha div class metric name apiserver conversion webhook request total div div class metric help Counter for conversion webhook requests with success failure and failure error type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label failure type span span class metric label result span li ul div div class metric data stability alpha div class metric name apiserver crd conversion webhook duration seconds div div class metric help CRD webhook conversion duration in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label crd name span span class metric label from version span span class metric label succeeded span span class metric label to version span li ul div div class metric data stability alpha div class metric name apiserver current inqueue requests div div class metric help Maximal number of queued requests in this apiserver per request kind in last second div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label request kind span li ul div div class metric data stability alpha div class metric name apiserver delegated authn request duration seconds div div class metric help Request latency in seconds Broken down by status code div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name apiserver delegated authn request total div div class metric help Number of HTTP requests partitioned by status code div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name apiserver delegated authz request duration seconds div div class metric help Request latency in seconds Broken down by status code div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name apiserver delegated authz request total div div class metric help Number of HTTP requests partitioned by status code div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name apiserver egress dialer dial duration seconds div div class metric help Dial latency histogram in seconds labeled by the protocol http connect or grpc transport tcp or uds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label protocol span span class metric label transport span li ul div div class metric data stability alpha div class metric name apiserver egress dialer dial failure count div div class metric help Dial failure count labeled by the protocol http connect or grpc transport tcp or uds and stage connect or proxy The stage indicates at which stage the dial failed div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label protocol span span class metric label stage span span class metric label transport span li ul div div class metric data stability alpha div class metric name apiserver egress dialer dial start total div div class metric help Dial starts labeled by the protocol http connect or grpc and transport tcp or uds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label protocol span span class metric label transport span li ul div div class metric data stability alpha div class metric name apiserver encryption config controller automatic reload failures total div div class metric help Total number of failed automatic reloads of encryption configuration split by apiserver identity div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 30 0 span li ul div div class metric data stability alpha div class metric name apiserver encryption config controller automatic reload last timestamp seconds div div class metric help Timestamp of the last successful or failed automatic reload of encryption configuration split by apiserver identity div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span span class metric label status span li ul div div class metric data stability alpha div class metric name apiserver encryption config controller automatic reload success total div div class metric help Total number of successful automatic reloads of encryption configuration split by apiserver identity div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 30 0 span li ul div div class metric data stability alpha div class metric name apiserver encryption config controller automatic reloads total div div class metric help Total number of reload successes and failures of encryption configuration split by apiserver identity div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span span class metric label status span li ul div div class metric data stability alpha div class metric name apiserver envelope encryption dek cache fill percent div div class metric help Percent of the cache slots currently occupied by cached DEKs div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name apiserver envelope encryption dek cache inter arrival time seconds div div class metric help Time in seconds of inter arrival of transformation requests div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label transformation type span li ul div div class metric data stability alpha div class metric name apiserver envelope encryption dek source cache size div div class metric help Number of records in data encryption key DEK source cache On a restart this value is an approximation of the number of decrypt RPC calls the server will make to the KMS plugin div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label provider name span li ul div div class metric data stability alpha div class metric name apiserver envelope encryption invalid key id from status total div div class metric help Number of times an invalid keyID is returned by the Status RPC call split by error div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label error span span class metric label provider name span li ul div div class metric data stability alpha div class metric name apiserver envelope encryption key id hash last timestamp seconds div div class metric help The last time in seconds when a keyID was used div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span span class metric label key id hash span span class metric label provider name span span class metric label transformation type span li ul div div class metric data stability alpha div class metric name apiserver envelope encryption key id hash status last timestamp seconds div div class metric help The last time in seconds when a keyID was returned by the Status RPC call div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span span class metric label key id hash span span class metric label provider name span li ul div div class metric data stability alpha div class metric name apiserver envelope encryption key id hash total div div class metric help Number of times a keyID is used split by transformation type provider and apiserver identity div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label apiserver id hash span span class metric label key id hash span span class metric label provider name span span class metric label transformation type span li ul div div class metric data stability alpha div class metric name apiserver envelope encryption kms operations latency seconds div div class metric help KMS operation duration with gRPC error code status total div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label grpc status code span span class metric label method name span span class metric label provider name span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol current inqueue seats div div class metric help Number of seats currently pending in queues of the API Priority and Fairness subsystem div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol current limit seats div div class metric help current derived number of execution seats available to each priority level div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol current r div div class metric help R time of last change div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol demand seats div div class metric help Observations at the end of every nanosecond of the number of seats each priority level could use nominal number of seats for that level div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type timingratiohistogram label class metric detail Type label span class metric type TimingRatioHistogram span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol demand seats average div div class metric help Time weighted average over last adjustment period of demand seats div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol demand seats high watermark div div class metric help High watermark over last adjustment period of demand seats div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol demand seats smoothed div div class metric help Smoothed seat demands div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol demand seats stdev div div class metric help Time weighted standard deviation over last adjustment period of demand seats div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol dispatch r div div class metric help R time of last dispatch div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol epoch advance total div div class metric help Number of times the queueset s progress meter jumped backward div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label priority level span span class metric label success span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol latest s div div class metric help S most recently dispatched request div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol lower limit seats div div class metric help Configured lower bound on number of execution seats available to each priority level div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol next discounted s bounds div div class metric help min and max over queues of S oldest waiting request in queue estimated work in progress div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label bound span span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol next s bounds div div class metric help min and max over queues of S oldest waiting request in queue div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label bound span span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol priority level request utilization div div class metric help Observations at the end of every nanosecond of number of requests as a fraction of the relevant limit waiting or in any stage of execution but only initial stage for WATCHes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type timingratiohistogram label class metric detail Type label span class metric type TimingRatioHistogram span li li class metric labels varying label class metric detail Labels label span class metric label phase span span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol priority level seat utilization div div class metric help Observations at the end of every nanosecond of utilization of seats for any stage of execution but only initial stage for WATCHes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type timingratiohistogram label class metric detail Type label span class metric type TimingRatioHistogram span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li li class metric labels constant label class metric detail Const Labels label span class metric label phase executing span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol read vs write current requests div div class metric help Observations at the end of every nanosecond of the number of requests as a fraction of the relevant limit waiting or in regular stage of execution div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type timingratiohistogram label class metric detail Type label span class metric type TimingRatioHistogram span li li class metric labels varying label class metric detail Labels label span class metric label phase span span class metric label request kind span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol request concurrency in use div div class metric help Concurrency number of seats occupied by the currently executing initial stage for a WATCH any stage otherwise requests in the API Priority and Fairness subsystem div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 31 0 span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol request concurrency limit div div class metric help Nominal number of execution seats configured for each priority level div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 30 0 span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol request dispatch no accommodation total div div class metric help Number of times a dispatch attempt resulted in a non accommodation due to lack of available seats div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol request execution seconds div div class metric help Duration of initial stage for a WATCH or any for a non WATCH stage of request execution in the API Priority and Fairness subsystem div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol request queue length after enqueue div div class metric help Length of queue in the API Priority and Fairness subsystem as seen by each request after it is enqueued div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol seat fair frac div div class metric help Fair fraction of server s concurrency to allocate to each priority level that can use it div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol target seats div div class metric help Seat allocation targets div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol upper limit seats div div class metric help Configured upper bound on number of execution seats available to each priority level div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol watch count samples div div class metric help count of watchers for mutating requests in API Priority and Fairness div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver flowcontrol work estimated seats div div class metric help Number of estimated seats maximum of initial and final seats associated with requests in API Priority and Fairness div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label flow schema span span class metric label priority level span li ul div div class metric data stability alpha div class metric name apiserver init events total div div class metric help Counter of init events processed in watch cache broken by resource type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver kube aggregator x509 insecure sha1 total div div class metric help Counts the number of requests to servers with insecure SHA1 signatures in their serving certificate OR the number of connection failures due to the insecure SHA1 signatures either or based on the runtime environment div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver kube aggregator x509 missing san total div div class metric help Counts the number of requests to servers missing SAN extension in their serving certificate OR the number of connection failures due to the lack of x509 certificate SAN extension missing either or based on the runtime environment div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver nodeport repair port errors total div div class metric help Number of errors detected on ports by the repair loop broken down by type of error leak repair full outOfRange duplicate unknown div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label type span li ul div div class metric data stability alpha div class metric name apiserver nodeport repair reconcile errors total div div class metric help Number of reconciliation failures on the nodeport repair reconcile loop div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver request aborts total div div class metric help Number of requests which apiserver aborted possibly due to a timeout for each group version verb resource subresource and scope div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label group span span class metric label resource span span class metric label scope span span class metric label subresource span span class metric label verb span span class metric label version span li ul div div class metric data stability alpha div class metric name apiserver request body size bytes div div class metric help Apiserver request body size in bytes broken out by resource and verb div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label resource span span class metric label verb span li ul div div class metric data stability alpha div class metric name apiserver request filter duration seconds div div class metric help Request filter latency distribution in seconds for each filter type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label filter span li ul div div class metric data stability alpha div class metric name apiserver request post timeout total div div class metric help Tracks the activity of the request handlers after the associated requests have been timed out by the apiserver div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label source span span class metric label status span li ul div div class metric data stability alpha div class metric name apiserver request sli duration seconds div div class metric help Response latency distribution not counting webhook duration and priority fairness queue wait times in seconds for each verb group version resource subresource scope and component div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label component span span class metric label group span span class metric label resource span span class metric label scope span span class metric label subresource span span class metric label verb span span class metric label version span li ul div div class metric data stability alpha div class metric name apiserver request slo duration seconds div div class metric help Response latency distribution not counting webhook duration and priority fairness queue wait times in seconds for each verb group version resource subresource scope and component div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label component span span class metric label group span span class metric label resource span span class metric label scope span span class metric label subresource span span class metric label verb span span class metric label version span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 27 0 span li ul div div class metric data stability alpha div class metric name apiserver request terminations total div div class metric help Number of requests which apiserver terminated in self defense div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span span class metric label component span span class metric label group span span class metric label resource span span class metric label scope span span class metric label subresource span span class metric label verb span span class metric label version span li ul div div class metric data stability alpha div class metric name apiserver request timestamp comparison time div div class metric help Time taken for comparison of old vs new objects in UPDATE or PATCH requests div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label code path span li ul div div class metric data stability alpha div class metric name apiserver rerouted request total div div class metric help Total number of requests that were proxied to a peer kube apiserver because the local apiserver was not capable of serving it div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name apiserver selfrequest total div div class metric help Counter of apiserver self requests broken out for each verb API resource and subresource div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span span class metric label subresource span span class metric label verb span li ul div div class metric data stability alpha div class metric name apiserver storage data key generation duration seconds div div class metric help Latencies in seconds of data encryption key DEK generation operations div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name apiserver storage data key generation failures total div div class metric help Total number of failed data encryption key DEK generation operations div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver storage db total size in bytes div div class metric help Total size of the storage database file physically allocated in bytes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label endpoint span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 28 0 span li ul div div class metric data stability alpha div class metric name apiserver storage decode errors total div div class metric help Number of stored object decode errors split by object type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver storage envelope transformation cache misses total div div class metric help Total number of cache misses while accessing key decryption key KEK div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver storage events received total div div class metric help Number of etcd events received split by kind div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver storage list evaluated objects total div div class metric help Number of objects tested in the course of serving a LIST request from storage div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver storage list fetched objects total div div class metric help Number of objects read from storage in the course of serving a LIST request div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver storage list returned objects total div div class metric help Number of objects returned for a LIST request from storage div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver storage list total div div class metric help Number of LIST requests served from storage div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver storage transformation duration seconds div div class metric help Latencies in seconds of value transformation operations div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label transformation type span span class metric label transformer prefix span li ul div div class metric data stability alpha div class metric name apiserver storage transformation operations total div div class metric help Total number of transformations Successful transformation will have a status OK and a varied status string when the transformation fails This status and transformation type fields may be used for alerting on encryption decryption failure using transformation type from storage for decryption and to storage for encryption div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label status span span class metric label transformation type span span class metric label transformer prefix span li ul div div class metric data stability alpha div class metric name apiserver stream translator requests total div div class metric help Total number of requests that were handled by the StreamTranslatorProxy which processes streaming RemoteCommand V5 div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name apiserver stream tunnel requests total div div class metric help Total number of requests that were handled by the StreamTunnelProxy which processes streaming PortForward V2 div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name apiserver terminated watchers total div div class metric help Counter of watchers closed due to unresponsiveness broken by resource type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver tls handshake errors total div div class metric help Number of requests dropped with TLS handshake error from error div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver watch cache consistent read total div div class metric help Counter for consistent reads from cache div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label fallback span span class metric label resource span span class metric label success span li ul div div class metric data stability alpha div class metric name apiserver watch cache events dispatched total div div class metric help Counter of events dispatched in watch cache broken by resource type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver watch cache events received total div div class metric help Counter of events received in watch cache broken by resource type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver watch cache initializations total div div class metric help Counter of watch cache initializations broken by resource type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver watch cache read wait seconds div div class metric help Histogram of time spent waiting for a watch cache to become fresh div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver watch cache resource version div div class metric help Current resource version of watch cache broken by resource type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name apiserver watch events sizes div div class metric help Watch event size distribution in bytes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label group span span class metric label kind span span class metric label version span li ul div div class metric data stability alpha div class metric name apiserver watch events total div div class metric help Number of events sent in watch clients div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label group span span class metric label kind span span class metric label version span li ul div div class metric data stability alpha div class metric name apiserver watch list duration seconds div div class metric help Response latency distribution in seconds for watch list requests broken by group version resource and scope div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label group span span class metric label resource span span class metric label scope span span class metric label version span li ul div div class metric data stability alpha div class metric name apiserver webhooks x509 insecure sha1 total div div class metric help Counts the number of requests to servers with insecure SHA1 signatures in their serving certificate OR the number of connection failures due to the insecure SHA1 signatures either or based on the runtime environment div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name apiserver webhooks x509 missing san total div div class metric help Counts the number of requests to servers missing SAN extension in their serving certificate OR the number of connection failures due to the lack of x509 certificate SAN extension missing either or based on the runtime environment div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name attach detach controller attachdetach controller forced detaches div div class metric help Number of times the A D Controller performed a forced detach div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label reason span li ul div div class metric data stability alpha div class metric name attachdetach controller total volumes div div class metric help Number of volumes in A D Controller div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label plugin name span span class metric label state span li ul div div class metric data stability alpha div class metric name authenticated user requests div div class metric help Counter of authenticated requests broken out by username div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label username span li ul div div class metric data stability alpha div class metric name authentication attempts div div class metric help Counter of authenticated attempts div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label result span li ul div div class metric data stability alpha div class metric name authentication duration seconds div div class metric help Authentication duration in seconds broken out by result div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label result span li ul div div class metric data stability alpha div class metric name authentication token cache active fetch count div div class metric help div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label status span li ul div div class metric data stability alpha div class metric name authentication token cache fetch total div div class metric help div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label status span li ul div div class metric data stability alpha div class metric name authentication token cache request duration seconds div div class metric help div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label status span li ul div div class metric data stability alpha div class metric name authentication token cache request total div div class metric help div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label status span li ul div div class metric data stability alpha div class metric name authorization attempts total div div class metric help Counter of authorization attempts broken down by result It can be either allowed denied no opinion or error div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label result span li ul div div class metric data stability alpha div class metric name authorization duration seconds div div class metric help Authorization duration in seconds broken out by result div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label result span li ul div div class metric data stability alpha div class metric name cloud provider webhook request duration seconds div div class metric help Request latency in seconds Broken down by status code div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label code span span class metric label webhook span li ul div div class metric data stability alpha div class metric name cloud provider webhook request total div div class metric help Number of HTTP requests partitioned by status code div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span span class metric label webhook span li ul div div class metric data stability alpha div class metric name container swap usage bytes div div class metric help Current amount of the container swap usage in bytes Reported only on non windows systems div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label container span span class metric label pod span span class metric label namespace span li ul div div class metric data stability alpha div class metric name csi operations seconds div div class metric help Container Storage Interface operation duration with gRPC error code status total div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label driver name span span class metric label grpc status code span span class metric label method name span span class metric label migrated span li ul div div class metric data stability alpha div class metric name endpoint slice controller changes div div class metric help Number of EndpointSlice changes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label operation span li ul div div class metric data stability alpha div class metric name endpoint slice controller desired endpoint slices div div class metric help Number of EndpointSlices that would exist with perfect endpoint allocation div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name endpoint slice controller endpoints added per sync div div class metric help Number of endpoints added on each Service sync div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name endpoint slice controller endpoints desired div div class metric help Number of endpoints desired div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name endpoint slice controller endpoints removed per sync div div class metric help Number of endpoints removed on each Service sync div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name endpoint slice controller endpointslices changed per sync div div class metric help Number of EndpointSlices changed on each Service sync div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label topology span span class metric label traffic distribution span li ul div div class metric data stability alpha div class metric name endpoint slice controller num endpoint slices div div class metric help Number of EndpointSlices div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name endpoint slice controller services count by traffic distribution div div class metric help Number of Services using some specific trafficDistribution div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label traffic distribution span li ul div div class metric data stability alpha div class metric name endpoint slice controller syncs div div class metric help Number of EndpointSlice syncs div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label result span li ul div div class metric data stability alpha div class metric name endpoint slice mirroring controller addresses skipped per sync div div class metric help Number of addresses skipped on each Endpoints sync due to being invalid or exceeding MaxEndpointsPerSubset div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name endpoint slice mirroring controller changes div div class metric help Number of EndpointSlice changes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label operation span li ul div div class metric data stability alpha div class metric name endpoint slice mirroring controller desired endpoint slices div div class metric help Number of EndpointSlices that would exist with perfect endpoint allocation div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name endpoint slice mirroring controller endpoints added per sync div div class metric help Number of endpoints added on each Endpoints sync div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name endpoint slice mirroring controller endpoints desired div div class metric help Number of endpoints desired div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name endpoint slice mirroring controller endpoints removed per sync div div class metric help Number of endpoints removed on each Endpoints sync div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name endpoint slice mirroring controller endpoints sync duration div div class metric help Duration of syncEndpoints in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name endpoint slice mirroring controller endpoints updated per sync div div class metric help Number of endpoints updated on each Endpoints sync div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name endpoint slice mirroring controller num endpoint slices div div class metric help Number of EndpointSlices div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name ephemeral volume controller create failures total div div class metric help Number of PersistenVolumeClaims creation requests div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name ephemeral volume controller create total div div class metric help Number of PersistenVolumeClaims creation requests div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name etcd bookmark counts div div class metric help Number of etcd bookmarks progress notify events split by kind div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name etcd lease object counts div div class metric help Number of objects attached to a single etcd lease div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name etcd request duration seconds div div class metric help Etcd request latency in seconds for each operation and object type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label operation span span class metric label type span li ul div div class metric data stability alpha div class metric name etcd request errors total div div class metric help Etcd failed request counts for each operation and object type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label operation span span class metric label type span li ul div div class metric data stability alpha div class metric name etcd requests total div div class metric help Etcd request counts for each operation and object type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label operation span span class metric label type span li ul div div class metric data stability alpha div class metric name etcd version info div div class metric help Etcd server s binary version div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label binary version span li ul div div class metric data stability alpha div class metric name field validation request duration seconds div div class metric help Response latency distribution in seconds for each field validation value div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label field validation span li ul div div class metric data stability alpha div class metric name force cleaned failed volume operation errors total div div class metric help The number of volumes that failed force cleanup after their reconstruction failed during kubelet startup div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name force cleaned failed volume operations total div div class metric help The number of volumes that were force cleaned after their reconstruction failed during kubelet startup This includes both successful and failed cleanups div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name garbagecollector controller resources sync error total div div class metric help Number of garbage collector resources sync errors div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name horizontal pod autoscaler controller metric computation duration seconds div div class metric help The time seconds that the HPA controller takes to calculate one metric The label action should be either scale down scale up or none The label error should be either spec internal or none The label metric type corresponds to HPA spec metrics type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label action span span class metric label error span span class metric label metric type span li ul div div class metric data stability alpha div class metric name horizontal pod autoscaler controller metric computation total div div class metric help Number of metric computations The label action should be either scale down scale up or none Also the label error should be either spec internal or none The label metric type corresponds to HPA spec metrics type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label action span span class metric label error span span class metric label metric type span li ul div div class metric data stability alpha div class metric name horizontal pod autoscaler controller reconciliation duration seconds div div class metric help The time seconds that the HPA controller takes to reconcile once The label action should be either scale down scale up or none Also the label error should be either spec internal or none Note that if both spec and internal errors happen during a reconciliation the first one to occur is reported in error label div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label action span span class metric label error span li ul div div class metric data stability alpha div class metric name horizontal pod autoscaler controller reconciliations total div div class metric help Number of reconciliations of HPA controller The label action should be either scale down scale up or none Also the label error should be either spec internal or none Note that if both spec and internal errors happen during a reconciliation the first one to occur is reported in error label div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label action span span class metric label error span li ul div div class metric data stability alpha div class metric name job controller job finished indexes total div div class metric help The number of finished indexes Possible values for the status label are succeeded failed Possible values for the backoffLimit label are perIndex and global div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label backoffLimit span span class metric label status span li ul div div class metric data stability alpha div class metric name job controller job pods creation total div div class metric help The number of Pods created by the Job controller labelled with a reason for the Pod creation This metric also distinguishes between Pods created using different PodReplacementPolicy settings Possible values of the reason label are new recreate terminating or failed recreate failed Possible values of the status label are succeeded failed div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label reason span span class metric label status span li ul div div class metric data stability alpha div class metric name job controller jobs by external controller total div div class metric help The number of Jobs managed by an external controller div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label controller name span li ul div div class metric data stability alpha div class metric name job controller pod failures handled by failure policy total div div class metric help The number of failed Pods handled by failure policy with respect to the failure policy action applied based on the matched rule Possible values of the action label correspond to the possible values for the failure policy rule action which are FailJob Ignore and Count div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label action span li ul div div class metric data stability alpha div class metric name job controller terminated pods tracking finalizer total div div class metric help The number of terminated pods phase Failed Succeeded that have the finalizer batch kubernetes io job tracking The event label can be add or delete div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label event span li ul div div class metric data stability alpha div class metric name kube apiserver clusterip allocator allocated ips div div class metric help Gauge measuring the number of allocated IPs for Services div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label cidr span li ul div div class metric data stability alpha div class metric name kube apiserver clusterip allocator allocation duration seconds div div class metric help Duration in seconds to allocate a Cluster IP by ServiceCIDR div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label cidr span li ul div div class metric data stability alpha div class metric name kube apiserver clusterip allocator allocation errors total div div class metric help Number of errors trying to allocate Cluster IPs div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label cidr span span class metric label scope span li ul div div class metric data stability alpha div class metric name kube apiserver clusterip allocator allocation total div div class metric help Number of Cluster IPs allocations div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label cidr span span class metric label scope span li ul div div class metric data stability alpha div class metric name kube apiserver clusterip allocator available ips div div class metric help Gauge measuring the number of available IPs for Services div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label cidr span li ul div div class metric data stability alpha div class metric name kube apiserver nodeport allocator allocated ports div div class metric help Gauge measuring the number of allocated NodePorts for Services div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kube apiserver nodeport allocator allocation errors total div div class metric help Number of errors trying to allocate NodePort div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label scope span li ul div div class metric data stability alpha div class metric name kube apiserver nodeport allocator allocation total div div class metric help Number of NodePort allocations div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label scope span li ul div div class metric data stability alpha div class metric name kube apiserver nodeport allocator available ports div div class metric help Gauge measuring the number of available NodePorts for Services div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kube apiserver pod logs backend tls failure total div div class metric help Total number of requests for pods logs that failed due to kubelet server TLS verification div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kube apiserver pod logs insecure backend total div div class metric help Total number of requests for pods logs sliced by usage type enforce tls skip tls allowed skip tls denied div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label usage span li ul div div class metric data stability alpha div class metric name kube apiserver pod logs pods logs backend tls failure total div div class metric help Total number of requests for pods logs that failed due to kubelet server TLS verification div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 27 0 span li ul div div class metric data stability alpha div class metric name kube apiserver pod logs pods logs insecure backend total div div class metric help Total number of requests for pods logs sliced by usage type enforce tls skip tls allowed skip tls denied div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label usage span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 27 0 span li ul div div class metric data stability alpha div class metric name kubelet active pods div div class metric help The number of pods the kubelet considers active and which are being considered when admitting new pods static is true if the pod is not from the apiserver div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label static span li ul div div class metric data stability alpha div class metric name kubelet certificate manager client expiration renew errors div div class metric help Counter of certificate renewal errors div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet certificate manager client ttl seconds div div class metric help Gauge of the TTL time to live of the Kubelet s client certificate The value is in seconds until certificate expiry negative if already expired If client certificate is invalid or unused the value will be INF div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet certificate manager server rotation seconds div div class metric help Histogram of the number of seconds the previous certificate lived before being rotated div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet certificate manager server ttl seconds div div class metric help Gauge of the shortest TTL time to live of the Kubelet s serving certificate The value is in seconds until certificate expiry negative if already expired If serving certificate is invalid or unused the value will be INF div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet cgroup manager duration seconds div div class metric help Duration in seconds for cgroup manager operations Broken down by method div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label operation type span li ul div div class metric data stability alpha div class metric name kubelet cgroup version div div class metric help cgroup version on the hosts div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet container log filesystem used bytes div div class metric help Bytes used by the container s logs on the filesystem div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label uid span span class metric label namespace span span class metric label pod span span class metric label container span li ul div div class metric data stability alpha div class metric name kubelet containers per pod count div div class metric help The number of containers per pod div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet cpu manager pinning errors total div div class metric help The number of cpu core allocations which required pinning failed div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet cpu manager pinning requests total div div class metric help The number of cpu core allocations which required pinning div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet credential provider plugin duration div div class metric help Duration of execution in seconds for credential provider plugin div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label plugin name span li ul div div class metric data stability alpha div class metric name kubelet credential provider plugin errors div div class metric help Number of errors from credential provider plugin div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label plugin name span li ul div div class metric data stability alpha div class metric name kubelet desired pods div div class metric help The number of pods the kubelet is being instructed to run static is true if the pod is not from the apiserver div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label static span li ul div div class metric data stability alpha div class metric name kubelet device plugin alloc duration seconds div div class metric help Duration in seconds to serve a device plugin Allocation request Broken down by resource name div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label resource name span li ul div div class metric data stability alpha div class metric name kubelet device plugin registration total div div class metric help Cumulative number of device plugin registrations Broken down by resource name div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource name span li ul div div class metric data stability alpha div class metric name kubelet evented pleg connection error count div div class metric help The number of errors encountered during the establishment of streaming connection with the CRI runtime div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet evented pleg connection latency seconds div div class metric help The latency of streaming connection with the CRI runtime measured in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet evented pleg connection success count div div class metric help The number of times a streaming client was obtained to receive CRI Events div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet eviction stats age seconds div div class metric help Time between when stats are collected and when pod is evicted based on those stats by eviction signal div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label eviction signal span li ul div div class metric data stability alpha div class metric name kubelet evictions div div class metric help Cumulative number of pod evictions by eviction signal div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label eviction signal span li ul div div class metric data stability alpha div class metric name kubelet graceful shutdown end time seconds div div class metric help Last graceful shutdown start time since unix epoch in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet graceful shutdown start time seconds div div class metric help Last graceful shutdown start time since unix epoch in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet http inflight requests div div class metric help Number of the inflight http requests div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label long running span span class metric label method span span class metric label path span span class metric label server type span li ul div div class metric data stability alpha div class metric name kubelet http requests duration seconds div div class metric help Duration in seconds to serve http requests div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label long running span span class metric label method span span class metric label path span span class metric label server type span li ul div div class metric data stability alpha div class metric name kubelet http requests total div div class metric help Number of the http requests received since the server started div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label long running span span class metric label method span span class metric label path span span class metric label server type span li ul div div class metric data stability alpha div class metric name kubelet image garbage collected total div div class metric help Total number of images garbage collected by the kubelet whether through disk usage or image age div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label reason span li ul div div class metric data stability alpha div class metric name kubelet image pull duration seconds div div class metric help Duration in seconds to pull an image div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label image size in bytes span li ul div div class metric data stability alpha div class metric name kubelet lifecycle handler http fallbacks total div div class metric help The number of times lifecycle handlers successfully fell back to http from https div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet managed ephemeral containers div div class metric help Current number of ephemeral containers in pods managed by this kubelet div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet memory manager pinning errors total div div class metric help The number of memory pages allocations which required pinning that failed div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet memory manager pinning requests total div div class metric help The number of memory pages allocations which required pinning div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet mirror pods div div class metric help The number of mirror pods the kubelet will try to create one per admitted static pod div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet node name div div class metric help The node s name The count is always 1 div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label node span li ul div div class metric data stability alpha div class metric name kubelet node startup duration seconds div div class metric help Duration in seconds of node startup in total div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet node startup post registration duration seconds div div class metric help Duration in seconds of node startup after registration div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet node startup pre kubelet duration seconds div div class metric help Duration in seconds of node startup before kubelet starts div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet node startup pre registration duration seconds div div class metric help Duration in seconds of node startup before registration div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet node startup registration duration seconds div div class metric help Duration in seconds of node startup during registration div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet orphan pod cleaned volumes div div class metric help The total number of orphaned Pods whose volumes were cleaned in the last periodic sweep div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet orphan pod cleaned volumes errors div div class metric help The number of orphaned Pods whose volumes failed to be cleaned in the last periodic sweep div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet orphaned runtime pods total div div class metric help Number of pods that have been detected in the container runtime without being already known to the pod worker This typically indicates the kubelet was restarted while a pod was force deleted in the API or in the local configuration which is unusual div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet pleg discard events div div class metric help The number of discard events in PLEG div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet pleg last seen seconds div div class metric help Timestamp in seconds when PLEG was last seen active div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet pleg relist duration seconds div div class metric help Duration in seconds for relisting pods in PLEG div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet pleg relist interval seconds div div class metric help Interval in seconds between relisting in PLEG div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet pod resources endpoint errors get div div class metric help Number of requests to the PodResource Get endpoint which returned error Broken down by server api version div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label server api version span li ul div div class metric data stability alpha div class metric name kubelet pod resources endpoint errors get allocatable div div class metric help Number of requests to the PodResource GetAllocatableResources endpoint which returned error Broken down by server api version div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label server api version span li ul div div class metric data stability alpha div class metric name kubelet pod resources endpoint errors list div div class metric help Number of requests to the PodResource List endpoint which returned error Broken down by server api version div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label server api version span li ul div div class metric data stability alpha div class metric name kubelet pod resources endpoint requests get div div class metric help Number of requests to the PodResource Get endpoint Broken down by server api version div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label server api version span li ul div div class metric data stability alpha div class metric name kubelet pod resources endpoint requests get allocatable div div class metric help Number of requests to the PodResource GetAllocatableResources endpoint Broken down by server api version div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label server api version span li ul div div class metric data stability alpha div class metric name kubelet pod resources endpoint requests list div div class metric help Number of requests to the PodResource List endpoint Broken down by server api version div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label server api version span li ul div div class metric data stability alpha div class metric name kubelet pod resources endpoint requests total div div class metric help Cumulative number of requests to the PodResource endpoint Broken down by server api version div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label server api version span li ul div div class metric data stability alpha div class metric name kubelet pod start duration seconds div div class metric help Duration in seconds from kubelet seeing a pod for the first time to the pod starting to run div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet pod start sli duration seconds div div class metric help Duration in seconds to start a pod excluding time to pull images and run init containers measured from pod creation timestamp to when all its containers are reported as started and observed via watch div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet pod start total duration seconds div div class metric help Duration in seconds to start a pod since creation including time to pull images and run init containers measured from pod creation timestamp to when all its containers are reported as started and observed via watch div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet pod status sync duration seconds div div class metric help Duration in seconds to sync a pod status update Measures time from detection of a change to pod status until the API is successfully updated for that pod even if multiple intevening changes to pod status occur div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet pod worker duration seconds div div class metric help Duration in seconds to sync a single pod Broken down by operation type create update or sync div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label operation type span li ul div div class metric data stability alpha div class metric name kubelet pod worker start duration seconds div div class metric help Duration in seconds from kubelet seeing a pod to starting a worker div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet preemptions div div class metric help Cumulative number of pod preemptions by preemption resource div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label preemption signal span li ul div div class metric data stability alpha div class metric name kubelet restarted pods total div div class metric help Number of pods that have been restarted because they were deleted and recreated with the same UID while the kubelet was watching them common for static pods extremely uncommon for API pods div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label static span li ul div div class metric data stability alpha div class metric name kubelet run podsandbox duration seconds div div class metric help Duration in seconds of the run podsandbox operations Broken down by RuntimeClass Handler div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label runtime handler span li ul div div class metric data stability alpha div class metric name kubelet run podsandbox errors total div div class metric help Cumulative number of the run podsandbox operation errors by RuntimeClass Handler div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label runtime handler span li ul div div class metric data stability alpha div class metric name kubelet running containers div div class metric help Number of containers currently running div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label container state span li ul div div class metric data stability alpha div class metric name kubelet running pods div div class metric help Number of pods that have a running pod sandbox div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubelet runtime operations duration seconds div div class metric help Duration in seconds of runtime operations Broken down by operation type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label operation type span li ul div div class metric data stability alpha div class metric name kubelet runtime operations errors total div div class metric help Cumulative number of runtime operation errors by operation type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label operation type span li ul div div class metric data stability alpha div class metric name kubelet runtime operations total div div class metric help Cumulative number of runtime operations by operation type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label operation type span li ul div div class metric data stability alpha div class metric name kubelet server expiration renew errors div div class metric help Counter of certificate renewal errors div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet sleep action terminated early total div div class metric help The number of times lifecycle sleep handler got terminated before it finishes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet started containers errors total div div class metric help Cumulative number of errors when starting containers div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span span class metric label container type span li ul div div class metric data stability alpha div class metric name kubelet started containers total div div class metric help Cumulative number of containers started div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label container type span li ul div div class metric data stability alpha div class metric name kubelet started host process containers errors total div div class metric help Cumulative number of errors when starting hostprocess containers This metric will only be collected on Windows div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span span class metric label container type span li ul div div class metric data stability alpha div class metric name kubelet started host process containers total div div class metric help Cumulative number of hostprocess containers started This metric will only be collected on Windows div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label container type span li ul div div class metric data stability alpha div class metric name kubelet started pods errors total div div class metric help Cumulative number of errors when starting pods div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet started pods total div div class metric help Cumulative number of pods started div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet topology manager admission duration ms div div class metric help Duration in milliseconds to serve a pod admission request div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubelet topology manager admission errors total div div class metric help The number of admission request failures where resources could not be aligned div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet topology manager admission requests total div div class metric help The number of admission requests where resources have to be aligned div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubelet volume metric collection duration seconds div div class metric help Duration in seconds to calculate volume stats div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label metric source span li ul div div class metric data stability alpha div class metric name kubelet volume stats available bytes div div class metric help Number of available bytes in the volume div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label persistentvolumeclaim span li ul div div class metric data stability alpha div class metric name kubelet volume stats capacity bytes div div class metric help Capacity in bytes of the volume div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label persistentvolumeclaim span li ul div div class metric data stability alpha div class metric name kubelet volume stats health status abnormal div div class metric help Abnormal volume health status The count is either 1 or 0 1 indicates the volume is unhealthy 0 indicates volume is healthy div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label persistentvolumeclaim span li ul div div class metric data stability alpha div class metric name kubelet volume stats inodes div div class metric help Maximum number of inodes in the volume div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label persistentvolumeclaim span li ul div div class metric data stability alpha div class metric name kubelet volume stats inodes free div div class metric help Number of free inodes in the volume div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label persistentvolumeclaim span li ul div div class metric data stability alpha div class metric name kubelet volume stats inodes used div div class metric help Number of used inodes in the volume div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label persistentvolumeclaim span li ul div div class metric data stability alpha div class metric name kubelet volume stats used bytes div div class metric help Number of used bytes in the volume div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label persistentvolumeclaim span li ul div div class metric data stability alpha div class metric name kubelet working pods div div class metric help Number of pods the kubelet is actually running broken down by lifecycle phase whether the pod is desired orphaned or runtime only also orphaned and whether the pod is static An orphaned pod has been removed from local configuration or force deleted in the API and consumes resources that are not otherwise visible div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label config span span class metric label lifecycle span span class metric label static span li ul div div class metric data stability alpha div class metric name kubeproxy iptables ct state invalid dropped packets total div div class metric help packets dropped by iptables to work around conntrack problems div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li ul div div class metric data stability alpha div class metric name kubeproxy iptables localhost nodeports accepted packets total div div class metric help Number of packets accepted on nodeports of loopback interface div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li ul div div class metric data stability alpha div class metric name kubeproxy network programming duration seconds div div class metric help In Cluster Network Programming Latency in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubeproxy proxy healthz total div div class metric help Cumulative proxy healthz HTTP status div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name kubeproxy proxy livez total div div class metric help Cumulative proxy livez HTTP status div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name kubeproxy sync full proxy rules duration seconds div div class metric help SyncProxyRules latency in seconds for full resyncs div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubeproxy sync partial proxy rules duration seconds div div class metric help SyncProxyRules latency in seconds for partial resyncs div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules duration seconds div div class metric help SyncProxyRules latency in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules endpoint changes pending div div class metric help Pending proxy rules Endpoint changes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules endpoint changes total div div class metric help Cumulative proxy rules Endpoint changes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules iptables last div div class metric help Number of iptables rules written by kube proxy in last sync div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label table span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules iptables partial restore failures total div div class metric help Cumulative proxy iptables partial restore failures div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules iptables restore failures total div div class metric help Cumulative proxy iptables restore failures div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules iptables total div div class metric help Total number of iptables rules owned by kube proxy div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label table span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules last queued timestamp seconds div div class metric help The last time a sync of proxy rules was queued div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules last timestamp seconds div div class metric help The last time proxy rules were successfully synced div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules nftables cleanup failures total div div class metric help Cumulative proxy nftables cleanup failures div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules nftables sync failures total div div class metric help Cumulative proxy nftables sync failures div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules no local endpoints total div div class metric help Number of services with a Local traffic policy and no endpoints div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label traffic policy span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules service changes pending div div class metric help Pending proxy rules Service changes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name kubeproxy sync proxy rules service changes total div div class metric help Cumulative proxy rules Service changes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name kubernetes build info div div class metric help A metric with a constant 1 value labeled by major minor git version git commit git tree state build date Go version and compiler from which Kubernetes was built and platform on which it is running div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label build date span span class metric label compiler span span class metric label git commit span span class metric label git tree state span span class metric label git version span span class metric label go version span span class metric label major span span class metric label minor span span class metric label platform span li ul div div class metric data stability alpha div class metric name leader election master status div div class metric help Gauge of if the reporting system is master of the relevant lease 0 indicates backup 1 indicates master name is the string used to identify the lease Please make sure to group by name div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div class metric data stability alpha div class metric name leader election slowpath total div div class metric help Total number of slow path exercised in renewing leader leases name is the string used to identify the lease Please make sure to group by name div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div class metric data stability alpha div class metric name node authorizer graph actions duration seconds div div class metric help Histogram of duration of graph actions in node authorizer div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label operation span li ul div div class metric data stability alpha div class metric name node collector unhealthy nodes in zone div div class metric help Gauge measuring number of not Ready Nodes per zones div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label zone span li ul div div class metric data stability alpha div class metric name node collector update all nodes health duration seconds div div class metric help Duration in seconds for NodeController to update the health of all nodes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name node collector update node health duration seconds div div class metric help Duration in seconds for NodeController to update the health of a single node div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name node collector zone health div div class metric help Gauge measuring percentage of healthy nodes per zone div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label zone span li ul div div class metric data stability alpha div class metric name node collector zone size div div class metric help Gauge measuring number of registered Nodes per zones div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label zone span li ul div div class metric data stability alpha div class metric name node controller cloud provider taint removal delay seconds div div class metric help Number of seconds after node creation when NodeController removed the cloud provider taint of a single node div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name node controller initial node sync delay seconds div div class metric help Number of seconds after node creation when NodeController finished the initial synchronization of a single node div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name node ipam controller cidrset allocation tries per request div div class metric help Number of endpoints added on each Service sync div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label clusterCIDR span li ul div div class metric data stability alpha div class metric name node ipam controller cidrset cidrs allocations total div div class metric help Counter measuring total number of CIDR allocations div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label clusterCIDR span li ul div div class metric data stability alpha div class metric name node ipam controller cidrset cidrs releases total div div class metric help Counter measuring total number of CIDR releases div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label clusterCIDR span li ul div div class metric data stability alpha div class metric name node ipam controller cidrset usage cidrs div div class metric help Gauge measuring percentage of allocated CIDRs div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label clusterCIDR span li ul div div class metric data stability alpha div class metric name node ipam controller cirdset max cidrs div div class metric help Maximum number of CIDRs that can be allocated div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label clusterCIDR span li ul div div class metric data stability alpha div class metric name node swap usage bytes div div class metric help Current swap usage of the node in bytes Reported only on non windows systems div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li ul div div class metric data stability alpha div class metric name plugin manager total plugins div div class metric help Number of plugins in Plugin Manager div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label socket path span span class metric label state span li ul div div class metric data stability alpha div class metric name pod gc collector force delete pod errors total div div class metric help Number of errors encountered when forcefully deleting the pods since the Pod GC Controller started div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label reason span li ul div div class metric data stability alpha div class metric name pod gc collector force delete pods total div div class metric help Number of pods that are being forcefully deleted since the Pod GC Controller started div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label reason span li ul div div class metric data stability alpha div class metric name pod security errors total div div class metric help Number of errors preventing normal evaluation Non fatal errors may result in the latest restricted profile being used for evaluation div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label fatal span span class metric label request operation span span class metric label resource span span class metric label subresource span li ul div div class metric data stability alpha div class metric name pod security evaluations total div div class metric help Number of policy evaluations that occurred not counting ignored or exempt requests div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label decision span span class metric label mode span span class metric label policy level span span class metric label policy version span span class metric label request operation span span class metric label resource span span class metric label subresource span li ul div div class metric data stability alpha div class metric name pod security exemptions total div div class metric help Number of exempt requests not counting ignored or out of scope requests div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label request operation span span class metric label resource span span class metric label subresource span li ul div div class metric data stability alpha div class metric name pod swap usage bytes div div class metric help Current amount of the pod swap usage in bytes Reported only on non windows systems div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label pod span span class metric label namespace span li ul div div class metric data stability alpha div class metric name prober probe duration seconds div div class metric help Duration in seconds for a probe response div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label container span span class metric label namespace span span class metric label pod span span class metric label probe type span li ul div div class metric data stability alpha div class metric name prober probe total div div class metric help Cumulative number of a liveness readiness or startup probe for a container by result div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label container span span class metric label namespace span span class metric label pod span span class metric label pod uid span span class metric label probe type span span class metric label result span li ul div div class metric data stability alpha div class metric name pv collector bound pv count div div class metric help Gauge measuring number of persistent volume currently bound div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label storage class span li ul div div class metric data stability alpha div class metric name pv collector bound pvc count div div class metric help Gauge measuring number of persistent volume claim currently bound div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label storage class span span class metric label volume attributes class span li ul div div class metric data stability alpha div class metric name pv collector total pv count div div class metric help Gauge measuring total number of persistent volumes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label plugin name span span class metric label volume mode span li ul div div class metric data stability alpha div class metric name pv collector unbound pv count div div class metric help Gauge measuring number of persistent volume currently unbound div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label storage class span li ul div div class metric data stability alpha div class metric name pv collector unbound pvc count div div class metric help Gauge measuring number of persistent volume claim currently unbound div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label namespace span span class metric label storage class span span class metric label volume attributes class span li ul div div class metric data stability alpha div class metric name reconstruct volume operations errors total div div class metric help The number of volumes that failed reconstruction from the operating system during kubelet startup div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name reconstruct volume operations total div div class metric help The number of volumes that were attempted to be reconstructed from the operating system during kubelet startup This includes both successful and failed reconstruction div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name replicaset controller sorting deletion age ratio div div class metric help The ratio of chosen deleted pod s ages to the current youngest pod s age at the time Should be 2 The intent of this metric is to measure the rough efficacy of the LogarithmicScaleDown feature gate s effect on the sorting and deletion of pods when a replicaset scales down This only considers Ready pods when calculating and reporting div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name resourceclaim controller create attempts total div div class metric help Number of ResourceClaims creation requests div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name resourceclaim controller create failures total div div class metric help Number of ResourceClaims creation request failures div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name rest client dns resolution duration seconds div div class metric help DNS resolver latency in seconds Broken down by host div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label host span li ul div div class metric data stability alpha div class metric name rest client exec plugin call total div div class metric help Number of calls to an exec plugin partitioned by the type of event encountered no error plugin execution error plugin not found error client internal error and an optional exit code The exit code will be set to 0 if and only if the plugin call was successful div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label call status span span class metric label code span li ul div div class metric data stability alpha div class metric name rest client exec plugin certificate rotation age div div class metric help Histogram of the number of seconds the last auth exec plugin client certificate lived before being rotated If auth exec plugin client certificates are unused histogram will contain no data div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name rest client exec plugin ttl seconds div div class metric help Gauge of the shortest TTL time to live of the client certificate s managed by the auth exec plugin The value is in seconds until certificate expiry negative if already expired If auth exec plugins are unused or manage no TLS certificates the value will be INF div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name rest client rate limiter duration seconds div div class metric help Client side rate limiter latency in seconds Broken down by verb and host div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label host span span class metric label verb span li ul div div class metric data stability alpha div class metric name rest client request duration seconds div div class metric help Request latency in seconds Broken down by verb and host div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label host span span class metric label verb span li ul div div class metric data stability alpha div class metric name rest client request retries total div div class metric help Number of request retries partitioned by status code verb and host div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span span class metric label host span span class metric label verb span li ul div div class metric data stability alpha div class metric name rest client request size bytes div div class metric help Request size in bytes Broken down by verb and host div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label host span span class metric label verb span li ul div div class metric data stability alpha div class metric name rest client requests total div div class metric help Number of HTTP requests partitioned by status code method and host div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span span class metric label host span span class metric label method span li ul div div class metric data stability alpha div class metric name rest client response size bytes div div class metric help Response size in bytes Broken down by verb and host div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label host span span class metric label verb span li ul div div class metric data stability alpha div class metric name rest client transport cache entries div div class metric help Number of transport entries in the internal cache div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li ul div div class metric data stability alpha div class metric name rest client transport create calls total div div class metric help Number of calls to get a new transport partitioned by the result of the operation hit obtained from the cache miss created and added to the cache uncacheable created and not cached div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label result span li ul div div class metric data stability alpha div class metric name retroactive storageclass errors total div div class metric help Total number of failed retroactive StorageClass assignments to persistent volume claim div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name retroactive storageclass total div div class metric help Total number of retroactive StorageClass assignments to persistent volume claim div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name root ca cert publisher sync duration seconds div div class metric help Number of namespace syncs happened in root ca cert publisher div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name root ca cert publisher sync total div div class metric help Number of namespace syncs happened in root ca cert publisher div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label code span li ul div div class metric data stability alpha div class metric name running managed controllers div div class metric help Indicates where instances of a controller are currently running div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label manager span span class metric label name span li ul div div class metric data stability alpha div class metric name scheduler event handling duration seconds div div class metric help Event handling latency in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label event span li ul div div class metric data stability alpha div class metric name scheduler goroutines div div class metric help Number of running goroutines split by the work they do such as binding div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label operation span li ul div div class metric data stability alpha div class metric name scheduler permit wait duration seconds div div class metric help Duration of waiting on permit div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label result span li ul div div class metric data stability alpha div class metric name scheduler plugin evaluation total div div class metric help Number of attempts to schedule pods by each plugin and the extension point available only in PreFilter Filter PreScore and Score div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label extension point span span class metric label plugin span span class metric label profile span li ul div div class metric data stability alpha div class metric name scheduler plugin execution duration seconds div div class metric help Duration for running a plugin at a specific extension point div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label extension point span span class metric label plugin span span class metric label status span li ul div div class metric data stability alpha div class metric name scheduler queueing hint execution duration seconds div div class metric help Duration for running a queueing hint function of a plugin div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label event span span class metric label hint span span class metric label plugin span li ul div div class metric data stability alpha div class metric name scheduler scheduler cache size div div class metric help Number of nodes pods and assumed bound pods in the scheduler cache div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label type span li ul div div class metric data stability alpha div class metric name scheduler scheduling algorithm duration seconds div div class metric help Scheduling algorithm latency in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name scheduler unschedulable pods div div class metric help The number of unschedulable pods broken down by plugin name A pod will increment the gauge for all plugins that caused it to not schedule and so this metric have meaning only when broken down by plugin div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label plugin span span class metric label profile span li ul div div class metric data stability alpha div class metric name scheduler volume binder cache requests total div div class metric help Total number for request volume binding cache div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label operation span li ul div div class metric data stability alpha div class metric name scheduler volume scheduling stage error total div div class metric help Volume scheduling stage error count div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label operation span li ul div div class metric data stability alpha div class metric name scrape error div div class metric help 1 if there was an error while getting container metrics 0 otherwise div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric deprecated version label class metric detail Deprecated Versions label span 1 29 0 span li ul div div class metric data stability alpha div class metric name service controller loadbalancer sync total div div class metric help A metric counting the amount of times any load balancer has been configured as an effect of service node changes on the cluster div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name service controller nodesync error total div div class metric help A metric counting the amount of times any load balancer has been configured and errored as an effect of node changes on the cluster div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name service controller nodesync latency seconds div div class metric help A metric measuring the latency for nodesync which updates loadbalancer hosts on cluster node updates div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name service controller update loadbalancer host latency seconds div div class metric help A metric measuring the latency for updating each load balancer hosts div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name serviceaccount invalid legacy auto token uses total div div class metric help Cumulative invalid auto generated legacy tokens used div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name serviceaccount legacy auto token uses total div div class metric help Cumulative auto generated legacy tokens used div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name serviceaccount legacy manual token uses total div div class metric help Cumulative manually created legacy tokens used div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name serviceaccount legacy tokens total div div class metric help Cumulative legacy service account tokens used div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name serviceaccount stale tokens total div div class metric help Cumulative stale projected service account tokens used div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name serviceaccount valid tokens total div div class metric help Cumulative valid projected service account tokens used div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name storage count attachable volumes in use div div class metric help Measure number of volumes in use div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label node span span class metric label volume plugin span li ul div div class metric data stability alpha div class metric name storage operation duration seconds div div class metric help Storage operation duration div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label migrated span span class metric label operation name span span class metric label status span span class metric label volume plugin span li ul div div class metric data stability alpha div class metric name taint eviction controller pod deletion duration seconds div div class metric help Latency in seconds between the time when a taint effect has been activated for the Pod and its deletion via TaintEvictionController div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name taint eviction controller pod deletions total div div class metric help Total number of Pods deleted by TaintEvictionController since its start div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li ul div div class metric data stability alpha div class metric name ttl after finished controller job deletion duration seconds div div class metric help The time it took to delete the job since it became eligible for deletion div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li ul div div class metric data stability alpha div class metric name volume manager selinux container errors total div div class metric help Number of errors when kubelet cannot compute SELinux context for a container Kubelet can t start such a Pod then and it will retry therefore value of this metric may not represent the actual nr of containers div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label access mode span li ul div div class metric data stability alpha div class metric name volume manager selinux container warnings total div div class metric help Number of errors when kubelet cannot compute SELinux context for a container that are ignored They will become real errors when SELinuxMountReadWriteOncePod feature is expanded to all volume access modes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label access mode span li ul div div class metric data stability alpha div class metric name volume manager selinux pod context mismatch errors total div div class metric help Number of errors when a Pod defines different SELinux contexts for its containers that use the same volume Kubelet can t start such a Pod then and it will retry therefore value of this metric may not represent the actual nr of Pods div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label access mode span li ul div div class metric data stability alpha div class metric name volume manager selinux pod context mismatch warnings total div div class metric help Number of errors when a Pod defines different SELinux contexts for its containers that use the same volume They are not errors yet but they will become real errors when SELinuxMountReadWriteOncePod feature is expanded to all volume access modes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label access mode span li ul div div class metric data stability alpha div class metric name volume manager selinux volume context mismatch errors total div div class metric help Number of errors when a Pod uses a volume that is already mounted with a different SELinux context than the Pod needs Kubelet can t start such a Pod then and it will retry therefore value of this metric may not represent the actual nr of Pods div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label access mode span span class metric label volume plugin span li ul div div class metric data stability alpha div class metric name volume manager selinux volume context mismatch warnings total div div class metric help Number of errors when a Pod uses a volume that is already mounted with a different SELinux context than the Pod needs They are not errors yet but they will become real errors when SELinuxMountReadWriteOncePod feature is expanded to all volume access modes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label access mode span span class metric label volume plugin span li ul div div class metric data stability alpha div class metric name volume manager selinux volumes admitted total div div class metric help Number of volumes whose SELinux context was fine and will be mounted with mount o context option div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label access mode span span class metric label volume plugin span li ul div div class metric data stability alpha div class metric name volume manager total volumes div div class metric help Number of volumes in Volume Manager div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type custom label class metric detail Type label span class metric type Custom span li li class metric labels varying label class metric detail Labels label span class metric label plugin name span span class metric label state span li ul div div class metric data stability alpha div class metric name volume operation total errors div div class metric help Total volume operation errors div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label operation name span span class metric label plugin name span li ul div div class metric data stability alpha div class metric name volume operation total seconds div div class metric help Storage operation end to end duration in seconds div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label operation name span span class metric label plugin name span li ul div div class metric data stability alpha div class metric name watch cache capacity div div class metric help Total capacity of watch cache broken by resource type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name watch cache capacity decrease total div div class metric help Total number of watch cache capacity decrease events broken by resource type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name watch cache capacity increase total div div class metric help Total number of watch cache capacity increase events broken by resource type div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label resource span li ul div div class metric data stability alpha div class metric name workqueue adds total div div class metric help Total number of adds handled by workqueue div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div class metric data stability alpha div class metric name workqueue depth div div class metric help Current depth of workqueue div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div class metric data stability alpha div class metric name workqueue longest running processor seconds div div class metric help How many seconds has the longest running processor for workqueue been running div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div class metric data stability alpha div class metric name workqueue queue duration seconds div div class metric help How long in seconds an item stays in workqueue before being requested div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div class metric data stability alpha div class metric name workqueue retries total div div class metric help Total number of retries handled by workqueue div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type counter label class metric detail Type label span class metric type Counter span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div class metric data stability alpha div class metric name workqueue unfinished work seconds div div class metric help How many seconds of work has done that is in progress and hasn t been observed by work duration Large values indicate stuck threads One can deduce the number of stuck threads by observing the rate at which this increases div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type gauge label class metric detail Type label span class metric type Gauge span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div class metric data stability alpha div class metric name workqueue work duration seconds div div class metric help How long in seconds processing an item from workqueue takes div ul li label class metric detail Stability Level label span class metric stability level ALPHA span li li data type histogram label class metric detail Type label span class metric type Histogram span li li class metric labels varying label class metric detail Labels label span class metric label name span li ul div div |
kubernetes reference weight 20 title kubeadm init contenttype concept This command initializes a Kubernetes control plane node overview | ---
title: kubeadm init
content_type: concept
weight: 20
---
<!-- overview -->
This command initializes a Kubernetes control-plane node.
<!-- body -->
### Init workflow {#init-workflow}
`kubeadm init` bootstraps a Kubernetes control-plane node by executing the
following steps:
1. Runs a series of pre-flight checks to validate the system state
before making changes. Some checks only trigger warnings, others are
considered errors and will exit kubeadm until the problem is corrected or the
user specifies `--ignore-preflight-errors=<list-of-errors>`.
1. Generates a self-signed CA to set up identities for each component in the cluster. The user can provide their
own CA cert and/or key by dropping it in the cert directory configured via `--cert-dir`
(`/etc/kubernetes/pki` by default).
The APIServer certs will have additional SAN entries for any `--apiserver-cert-extra-sans`
arguments, lowercased if necessary.
1. Writes kubeconfig files in `/etc/kubernetes/` for the kubelet, the controller-manager and the
scheduler to use to connect to the API server, each with its own identity. Also
additional kubeconfig files are written, for kubeadm as administrative entity (`admin.conf`)
and for a super admin user that can bypass RBAC (`super-admin.conf`).
1. Generates static Pod manifests for the API server,
controller-manager and scheduler. In case an external etcd is not provided,
an additional static Pod manifest is generated for etcd.
Static Pod manifests are written to `/etc/kubernetes/manifests`; the kubelet
watches this directory for Pods to create on startup.
Once control plane Pods are up and running, the `kubeadm init` sequence can continue.
1. Apply labels and taints to the control-plane node so that no additional workloads will
run there.
1. Generates the token that additional nodes can use to register
themselves with a control-plane in the future. Optionally, the user can provide a
token via `--token`, as described in the
[kubeadm token](/docs/reference/setup-tools/kubeadm/kubeadm-token/) docs.
1. Makes all the necessary configurations for allowing node joining with the
[Bootstrap Tokens](/docs/reference/access-authn-authz/bootstrap-tokens/) and
[TLS Bootstrap](/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/)
mechanism:
- Write a ConfigMap for making available all the information required
for joining, and set up related RBAC access rules.
- Let Bootstrap Tokens access the CSR signing API.
- Configure auto-approval for new CSR requests.
See [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) for additional info.
1. Installs a DNS server (CoreDNS) and the kube-proxy addon components via the API server.
In Kubernetes version 1.11 and later CoreDNS is the default DNS server.
Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed.
kube-dns usage with kubeadm is deprecated as of v1.18 and is removed in v1.21.
### Using init phases with kubeadm {#init-phases}
Kubeadm allows you to create a control-plane node in phases using the `kubeadm init phase` command.
To view the ordered list of phases and sub-phases you can call `kubeadm init --help`. The list
will be located at the top of the help screen and each phase will have a description next to it.
Note that by calling `kubeadm init` all of the phases and sub-phases will be executed in this exact order.
Some phases have unique flags, so if you want to have a look at the list of available options add
`--help`, for example:
```shell
sudo kubeadm init phase control-plane controller-manager --help
```
You can also use `--help` to see the list of sub-phases for a certain parent phase:
```shell
sudo kubeadm init phase control-plane --help
```
`kubeadm init` also exposes a flag called `--skip-phases` that can be used to skip certain phases.
The flag accepts a list of phase names and the names can be taken from the above ordered list.
An example:
```shell
sudo kubeadm init phase control-plane all --config=configfile.yaml
sudo kubeadm init phase etcd local --config=configfile.yaml
# you can now modify the control plane and etcd manifest files
sudo kubeadm init --skip-phases=control-plane,etcd --config=configfile.yaml
```
What this example would do is write the manifest files for the control plane and etcd in
`/etc/kubernetes/manifests` based on the configuration in `configfile.yaml`. This allows you to
modify the files and then skip these phases using `--skip-phases`. By calling the last command you
will create a control plane node with the custom manifest files.
Alternatively, you can use the `skipPhases` field under `InitConfiguration`.
### Using kubeadm init with a configuration file {#config-file}
The config file is still considered beta and may change in future versions.
It's possible to configure `kubeadm init` with a configuration file instead of command
line flags, and some more advanced features may only be available as
configuration file options. This file is passed using the `--config` flag and it must
contain a `ClusterConfiguration` structure and optionally more structures separated by `---\n`
Mixing `--config` with others flags may not be allowed in some cases.
The default configuration can be printed out using the
[kubeadm config print](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command.
If your configuration is not using the latest version it is **recommended** that you migrate using
the [kubeadm config migrate](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command.
For more information on the fields and usage of the configuration you can navigate to our
[API reference page](/docs/reference/config-api/kubeadm-config.v1beta4/).
### Using kubeadm init with feature gates {#feature-gates}
Kubeadm supports a set of feature gates that are unique to kubeadm and can only be applied
during cluster creation with `kubeadm init`. These features can control the behavior
of the cluster. Feature gates are removed after a feature graduates to GA.
To pass a feature gate you can either use the `--feature-gates` flag for
`kubeadm init`, or you can add items into the `featureGates` field when you pass
a [configuration file](/docs/reference/config-api/kubeadm-config.v1beta4/#kubeadm-k8s-io-v1beta4-ClusterConfiguration)
using `--config`.
Passing [feature gates for core Kubernetes components](/docs/reference/command-line-tools-reference/feature-gates)
directly to kubeadm is not supported. Instead, it is possible to pass them by
[Customizing components with the kubeadm API](/docs/setup/production-environment/tools/kubeadm/control-plane-flags/).
List of feature gates:
Feature | Default | Alpha | Beta | GA
:-------|:--------|:------|:-----|:----
`ControlPlaneKubeletLocalMode` | `false` | 1.31 | - | -
`EtcdLearnerMode` | `true` | 1.27 | 1.29 | -
`PublicKeysECDSA` | `false` | 1.19 | - | -
`WaitForAllControlPlaneComponents` | `false` | 1.30 | - | -
Once a feature gate goes GA its value becomes locked to `true` by default.
Feature gate descriptions:
`ControlPlaneKubeletLocalMode`
: With this feature gate enabled, when joining a new control plane node, kubeadm will configure the kubelet
to connect to the local kube-apiserver. This ensures that there will not be a violation of the version skew
policy during rolling upgrades.
`EtcdLearnerMode`
: With this feature gate enabled, when joining a new control plane node, a new etcd member will be created
as a learner and promoted to a voting member only after the etcd data are fully aligned.
`PublicKeysECDSA`
: Can be used to create a cluster that uses ECDSA certificates instead of the default RSA algorithm.
Renewal of existing ECDSA certificates is also supported using `kubeadm certs renew`, but you cannot
switch between the RSA and ECDSA algorithms on the fly or during upgrades. Kubernetes
has a bug where keys in generated kubeconfig files are set use RSA
despite the feature gate being enabled. Kubernetes versions before v1.31 had a bug where keys in generated kubeconfig files
were set use RSA, even when you had enabled the `PublicKeysECDSA` feature gate.
`WaitForAllControlPlaneComponents`
: With this feature gate enabled kubeadm will wait for all control plane components (kube-apiserver,
kube-controller-manager, kube-scheduler) on a control plane node to report status 200 on their `/healthz`
endpoints. These checks are performed on `https://127.0.0.1:PORT/healthz`, where `PORT` is taken from
`--secure-port` of a component. If you specify custom `--secure-port` values in the kubeadm configuration
they will be respected. Without the feature gate enabled, kubeadm will only wait for the kube-apiserver
on a control plane node to become ready. The wait process starts right after the kubelet on the host
is started by kubeadm. You are advised to enable this feature gate in case you wish to observe a ready
state from all control plane components during the `kubeadm init` or `kubeadm join` command execution.
List of deprecated feature gates:
Feature | Default | Alpha | Beta | GA | Deprecated
:-------|:--------|:------|:-----|:---|:----------
`RootlessControlPlane` | `false` | 1.22 | - | - | 1.31
Feature gate descriptions:
`RootlessControlPlane`
: Setting this flag configures the kubeadm deployed control plane component static Pod containers
for `kube-apiserver`, `kube-controller-manager`, `kube-scheduler` and `etcd` to run as non-root users.
If the flag is not set, those components run as root. You can change the value of this feature gate before
you upgrade to a newer version of Kubernetes.
List of removed feature gates:
Feature | Alpha | Beta | GA | Removed
:-------|:------|:-----|:---|:-------
`IPv6DualStack` | 1.16 | 1.21 | 1.23 | 1.24
`UnversionedKubeletConfigMap` | 1.22 | 1.23 | 1.25 | 1.26
`UpgradeAddonsBeforeControlPlane` | 1.28 | - | - | 1.31
Feature gate descriptions:
`IPv6DualStack`
: This flag helps to configure components dual stack when the feature is in progress. For more details on Kubernetes
dual-stack support see [Dual-stack support with kubeadm](/docs/setup/production-environment/tools/kubeadm/dual-stack-support/).
`UnversionedKubeletConfigMap`
: This flag controls the name of the where kubeadm stores
kubelet configuration data. With this flag not specified or set to `true`, the ConfigMap is named `kubelet-config`.
If you set this flag to `false`, the name of the ConfigMap includes the major and minor version for Kubernetes
(for example: `kubelet-config-`). Kubeadm ensures that RBAC rules for reading and writing
that ConfigMap are appropriate for the value you set. When kubeadm writes this ConfigMap (during `kubeadm init`
or `kubeadm upgrade apply`), kubeadm respects the value of `UnversionedKubeletConfigMap`. When reading that ConfigMap
(during `kubeadm join`, `kubeadm reset`, `kubeadm upgrade ...`), kubeadm attempts to use unversioned ConfigMap name first;
if that does not succeed, kubeadm falls back to using the legacy (versioned) name for that ConfigMap.
`UpgradeAddonsBeforeControlPlane`
: This feature gate has been removed. It was introduced in v1.28 as a deprecated feature and then removed in v1.31. For documentation on older versions, please switch to the corresponding website version.
### Adding kube-proxy parameters {#kube-proxy}
For information about kube-proxy parameters in the kubeadm configuration see:
- [kube-proxy reference](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
For information about enabling IPVS mode with kubeadm see:
- [IPVS](https://github.com/kubernetes/kubernetes/blob/master/pkg/proxy/ipvs/README.md)
### Passing custom flags to control plane components {#control-plane-flags}
For information about passing flags to control plane components see:
- [control-plane-flags](/docs/setup/production-environment/tools/kubeadm/control-plane-flags/)
### Running kubeadm without an Internet connection {#without-internet-connection}
For running kubeadm without an Internet connection you have to pre-pull the required control-plane images.
You can list and pull the images using the `kubeadm config images` sub-command:
```shell
kubeadm config images list
kubeadm config images pull
```
You can pass `--config` to the above commands with a [kubeadm configuration file](#config-file)
to control the `kubernetesVersion` and `imageRepository` fields.
All default `registry.k8s.io` images that kubeadm requires support multiple architectures.
### Using custom images {#custom-images}
By default, kubeadm pulls images from `registry.k8s.io`. If the
requested Kubernetes version is a CI label (such as `ci/latest`)
`gcr.io/k8s-staging-ci-images` is used.
You can override this behavior by using [kubeadm with a configuration file](#config-file).
Allowed customization are:
* To provide `kubernetesVersion` which affects the version of the images.
* To provide an alternative `imageRepository` to be used instead of
`registry.k8s.io`.
* To provide a specific `imageRepository` and `imageTag` for etcd or CoreDNS.
Image paths between the default `registry.k8s.io` and a custom repository specified using
`imageRepository` may differ for backwards compatibility reasons. For example,
one image might have a subpath at `registry.k8s.io/subpath/image`, but be defaulted
to `my.customrepository.io/image` when using a custom repository.
To ensure you push the images to your custom repository in paths that kubeadm
can consume, you must:
* Pull images from the defaults paths at `registry.k8s.io` using `kubeadm config images {list|pull}`.
* Push images to the paths from `kubeadm config images list --config=config.yaml`,
where `config.yaml` contains the custom `imageRepository`, and/or `imageTag`
for etcd and CoreDNS.
* Pass the same `config.yaml` to `kubeadm init`.
#### Custom sandbox (pause) images {#custom-pause-image}
To set a custom image for these you need to configure this in your
to use the image.
Consult the documentation for your container runtime to find out how to change this setting;
for selected container runtimes, you can also find advice within the
[Container Runtimes](/docs/setup/production-environment/container-runtimes/) topic.
### Uploading control-plane certificates to the cluster
By adding the flag `--upload-certs` to `kubeadm init` you can temporary upload
the control-plane certificates to a Secret in the cluster. Please note that this Secret
will expire automatically after 2 hours. The certificates are encrypted using
a 32byte key that can be specified using `--certificate-key`. The same key can be used
to download the certificates when additional control-plane nodes are joining, by passing
`--control-plane` and `--certificate-key` to `kubeadm join`.
The following phase command can be used to re-upload the certificates after expiration:
```shell
kubeadm init phase upload-certs --upload-certs --config=SOME_YAML_FILE
```
A predefined `certificateKey` can be provided in `InitConfiguration` when passing the
[configuration file](/docs/reference/config-api/kubeadm-config.v1beta4/) with `--config`.
If a predefined certificate key is not passed to `kubeadm init` and
`kubeadm init phase upload-certs` a new key will be generated automatically.
The following command can be used to generate a new key on demand:
```shell
kubeadm certs certificate-key
```
### Certificate management with kubeadm
For detailed information on certificate management with kubeadm see
[Certificate Management with kubeadm](/docs/tasks/administer-cluster/kubeadm/kubeadm-certs/).
The document includes information about using external CA, custom certificates
and certificate renewal.
### Managing the kubeadm drop-in file for the kubelet {#kubelet-drop-in}
The `kubeadm` package ships with a configuration file for running the `kubelet` by `systemd`.
Note that the kubeadm CLI never touches this drop-in file. This drop-in file is part of the kubeadm
DEB/RPM package.
For further information, see
[Managing the kubeadm drop-in file for systemd](/docs/setup/production-environment/tools/kubeadm/kubelet-integration/#the-kubelet-drop-in-file-for-systemd).
### Use kubeadm with CRI runtimes
By default kubeadm attempts to detect your container runtime. For more details on this detection,
see the [kubeadm CRI installation guide](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#installing-runtime).
### Setting the node name
By default, `kubeadm` assigns a node name based on a machine's host address.
You can override this setting with the `--node-name` flag.
The flag passes the appropriate [`--hostname-override`](/docs/reference/command-line-tools-reference/kubelet/#options)
value to the kubelet.
Be aware that overriding the hostname can
[interfere with cloud providers](https://github.com/kubernetes/website/pull/8873).
### Automating kubeadm
Rather than copying the token you obtained from `kubeadm init` to each node, as
in the [basic kubeadm tutorial](/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/),
you can parallelize the token distribution for easier automation. To implement this automation,
you must know the IP address that the control-plane node will have after it is started, or use a
DNS name or an address of a load balancer.
1. Generate a token. This token must have the form `<6 character string>.<16
character string>`. More formally, it must match the regex:
`[a-z0-9]{6}\.[a-z0-9]{16}`.
kubeadm can generate a token for you:
```shell
kubeadm token generate
```
1. Start both the control-plane node and the worker nodes concurrently with this token.
As they come up they should find each other and form the cluster. The same
`--token` argument can be used on both `kubeadm init` and `kubeadm join`.
1. Similar can be done for `--certificate-key` when joining additional control-plane
nodes. The key can be generated using:
```shell
kubeadm certs certificate-key
```
Once the cluster is up, you can use the `/etc/kubernetes/admin.conf` file from
a control-plane node to talk to the cluster with administrator credentials or
[Generating kubeconfig files for additional users](/docs/tasks/administer-cluster/kubeadm/kubeadm-certs#kubeconfig-additional-users).
Note that this style of bootstrap has some relaxed security guarantees because
it does not allow the root CA hash to be validated with
`--discovery-token-ca-cert-hash` (since it's not generated when the nodes are
provisioned). For details, see the [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/).
##
* [kubeadm init phase](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/) to understand more about
`kubeadm init` phases
* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) to bootstrap a Kubernetes
worker node and join it to the cluster
* [kubeadm upgrade](/docs/reference/setup-tools/kubeadm/kubeadm-upgrade/) to upgrade a Kubernetes
cluster to a newer version
* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made
to this host by `kubeadm init` or `kubeadm join`
| kubernetes reference | title kubeadm init content type concept weight 20 overview This command initializes a Kubernetes control plane node body Init workflow init workflow kubeadm init bootstraps a Kubernetes control plane node by executing the following steps 1 Runs a series of pre flight checks to validate the system state before making changes Some checks only trigger warnings others are considered errors and will exit kubeadm until the problem is corrected or the user specifies ignore preflight errors list of errors 1 Generates a self signed CA to set up identities for each component in the cluster The user can provide their own CA cert and or key by dropping it in the cert directory configured via cert dir etc kubernetes pki by default The APIServer certs will have additional SAN entries for any apiserver cert extra sans arguments lowercased if necessary 1 Writes kubeconfig files in etc kubernetes for the kubelet the controller manager and the scheduler to use to connect to the API server each with its own identity Also additional kubeconfig files are written for kubeadm as administrative entity admin conf and for a super admin user that can bypass RBAC super admin conf 1 Generates static Pod manifests for the API server controller manager and scheduler In case an external etcd is not provided an additional static Pod manifest is generated for etcd Static Pod manifests are written to etc kubernetes manifests the kubelet watches this directory for Pods to create on startup Once control plane Pods are up and running the kubeadm init sequence can continue 1 Apply labels and taints to the control plane node so that no additional workloads will run there 1 Generates the token that additional nodes can use to register themselves with a control plane in the future Optionally the user can provide a token via token as described in the kubeadm token docs reference setup tools kubeadm kubeadm token docs 1 Makes all the necessary configurations for allowing node joining with the Bootstrap Tokens docs reference access authn authz bootstrap tokens and TLS Bootstrap docs reference access authn authz kubelet tls bootstrapping mechanism Write a ConfigMap for making available all the information required for joining and set up related RBAC access rules Let Bootstrap Tokens access the CSR signing API Configure auto approval for new CSR requests See kubeadm join docs reference setup tools kubeadm kubeadm join for additional info 1 Installs a DNS server CoreDNS and the kube proxy addon components via the API server In Kubernetes version 1 11 and later CoreDNS is the default DNS server Please note that although the DNS server is deployed it will not be scheduled until CNI is installed kube dns usage with kubeadm is deprecated as of v1 18 and is removed in v1 21 Using init phases with kubeadm init phases Kubeadm allows you to create a control plane node in phases using the kubeadm init phase command To view the ordered list of phases and sub phases you can call kubeadm init help The list will be located at the top of the help screen and each phase will have a description next to it Note that by calling kubeadm init all of the phases and sub phases will be executed in this exact order Some phases have unique flags so if you want to have a look at the list of available options add help for example shell sudo kubeadm init phase control plane controller manager help You can also use help to see the list of sub phases for a certain parent phase shell sudo kubeadm init phase control plane help kubeadm init also exposes a flag called skip phases that can be used to skip certain phases The flag accepts a list of phase names and the names can be taken from the above ordered list An example shell sudo kubeadm init phase control plane all config configfile yaml sudo kubeadm init phase etcd local config configfile yaml you can now modify the control plane and etcd manifest files sudo kubeadm init skip phases control plane etcd config configfile yaml What this example would do is write the manifest files for the control plane and etcd in etc kubernetes manifests based on the configuration in configfile yaml This allows you to modify the files and then skip these phases using skip phases By calling the last command you will create a control plane node with the custom manifest files Alternatively you can use the skipPhases field under InitConfiguration Using kubeadm init with a configuration file config file The config file is still considered beta and may change in future versions It s possible to configure kubeadm init with a configuration file instead of command line flags and some more advanced features may only be available as configuration file options This file is passed using the config flag and it must contain a ClusterConfiguration structure and optionally more structures separated by n Mixing config with others flags may not be allowed in some cases The default configuration can be printed out using the kubeadm config print docs reference setup tools kubeadm kubeadm config command If your configuration is not using the latest version it is recommended that you migrate using the kubeadm config migrate docs reference setup tools kubeadm kubeadm config command For more information on the fields and usage of the configuration you can navigate to our API reference page docs reference config api kubeadm config v1beta4 Using kubeadm init with feature gates feature gates Kubeadm supports a set of feature gates that are unique to kubeadm and can only be applied during cluster creation with kubeadm init These features can control the behavior of the cluster Feature gates are removed after a feature graduates to GA To pass a feature gate you can either use the feature gates flag for kubeadm init or you can add items into the featureGates field when you pass a configuration file docs reference config api kubeadm config v1beta4 kubeadm k8s io v1beta4 ClusterConfiguration using config Passing feature gates for core Kubernetes components docs reference command line tools reference feature gates directly to kubeadm is not supported Instead it is possible to pass them by Customizing components with the kubeadm API docs setup production environment tools kubeadm control plane flags List of feature gates Feature Default Alpha Beta GA ControlPlaneKubeletLocalMode false 1 31 EtcdLearnerMode true 1 27 1 29 PublicKeysECDSA false 1 19 WaitForAllControlPlaneComponents false 1 30 Once a feature gate goes GA its value becomes locked to true by default Feature gate descriptions ControlPlaneKubeletLocalMode With this feature gate enabled when joining a new control plane node kubeadm will configure the kubelet to connect to the local kube apiserver This ensures that there will not be a violation of the version skew policy during rolling upgrades EtcdLearnerMode With this feature gate enabled when joining a new control plane node a new etcd member will be created as a learner and promoted to a voting member only after the etcd data are fully aligned PublicKeysECDSA Can be used to create a cluster that uses ECDSA certificates instead of the default RSA algorithm Renewal of existing ECDSA certificates is also supported using kubeadm certs renew but you cannot switch between the RSA and ECDSA algorithms on the fly or during upgrades Kubernetes has a bug where keys in generated kubeconfig files are set use RSA despite the feature gate being enabled Kubernetes versions before v1 31 had a bug where keys in generated kubeconfig files were set use RSA even when you had enabled the PublicKeysECDSA feature gate WaitForAllControlPlaneComponents With this feature gate enabled kubeadm will wait for all control plane components kube apiserver kube controller manager kube scheduler on a control plane node to report status 200 on their healthz endpoints These checks are performed on https 127 0 0 1 PORT healthz where PORT is taken from secure port of a component If you specify custom secure port values in the kubeadm configuration they will be respected Without the feature gate enabled kubeadm will only wait for the kube apiserver on a control plane node to become ready The wait process starts right after the kubelet on the host is started by kubeadm You are advised to enable this feature gate in case you wish to observe a ready state from all control plane components during the kubeadm init or kubeadm join command execution List of deprecated feature gates Feature Default Alpha Beta GA Deprecated RootlessControlPlane false 1 22 1 31 Feature gate descriptions RootlessControlPlane Setting this flag configures the kubeadm deployed control plane component static Pod containers for kube apiserver kube controller manager kube scheduler and etcd to run as non root users If the flag is not set those components run as root You can change the value of this feature gate before you upgrade to a newer version of Kubernetes List of removed feature gates Feature Alpha Beta GA Removed IPv6DualStack 1 16 1 21 1 23 1 24 UnversionedKubeletConfigMap 1 22 1 23 1 25 1 26 UpgradeAddonsBeforeControlPlane 1 28 1 31 Feature gate descriptions IPv6DualStack This flag helps to configure components dual stack when the feature is in progress For more details on Kubernetes dual stack support see Dual stack support with kubeadm docs setup production environment tools kubeadm dual stack support UnversionedKubeletConfigMap This flag controls the name of the where kubeadm stores kubelet configuration data With this flag not specified or set to true the ConfigMap is named kubelet config If you set this flag to false the name of the ConfigMap includes the major and minor version for Kubernetes for example kubelet config Kubeadm ensures that RBAC rules for reading and writing that ConfigMap are appropriate for the value you set When kubeadm writes this ConfigMap during kubeadm init or kubeadm upgrade apply kubeadm respects the value of UnversionedKubeletConfigMap When reading that ConfigMap during kubeadm join kubeadm reset kubeadm upgrade kubeadm attempts to use unversioned ConfigMap name first if that does not succeed kubeadm falls back to using the legacy versioned name for that ConfigMap UpgradeAddonsBeforeControlPlane This feature gate has been removed It was introduced in v1 28 as a deprecated feature and then removed in v1 31 For documentation on older versions please switch to the corresponding website version Adding kube proxy parameters kube proxy For information about kube proxy parameters in the kubeadm configuration see kube proxy reference docs reference config api kube proxy config v1alpha1 For information about enabling IPVS mode with kubeadm see IPVS https github com kubernetes kubernetes blob master pkg proxy ipvs README md Passing custom flags to control plane components control plane flags For information about passing flags to control plane components see control plane flags docs setup production environment tools kubeadm control plane flags Running kubeadm without an Internet connection without internet connection For running kubeadm without an Internet connection you have to pre pull the required control plane images You can list and pull the images using the kubeadm config images sub command shell kubeadm config images list kubeadm config images pull You can pass config to the above commands with a kubeadm configuration file config file to control the kubernetesVersion and imageRepository fields All default registry k8s io images that kubeadm requires support multiple architectures Using custom images custom images By default kubeadm pulls images from registry k8s io If the requested Kubernetes version is a CI label such as ci latest gcr io k8s staging ci images is used You can override this behavior by using kubeadm with a configuration file config file Allowed customization are To provide kubernetesVersion which affects the version of the images To provide an alternative imageRepository to be used instead of registry k8s io To provide a specific imageRepository and imageTag for etcd or CoreDNS Image paths between the default registry k8s io and a custom repository specified using imageRepository may differ for backwards compatibility reasons For example one image might have a subpath at registry k8s io subpath image but be defaulted to my customrepository io image when using a custom repository To ensure you push the images to your custom repository in paths that kubeadm can consume you must Pull images from the defaults paths at registry k8s io using kubeadm config images list pull Push images to the paths from kubeadm config images list config config yaml where config yaml contains the custom imageRepository and or imageTag for etcd and CoreDNS Pass the same config yaml to kubeadm init Custom sandbox pause images custom pause image To set a custom image for these you need to configure this in your to use the image Consult the documentation for your container runtime to find out how to change this setting for selected container runtimes you can also find advice within the Container Runtimes docs setup production environment container runtimes topic Uploading control plane certificates to the cluster By adding the flag upload certs to kubeadm init you can temporary upload the control plane certificates to a Secret in the cluster Please note that this Secret will expire automatically after 2 hours The certificates are encrypted using a 32byte key that can be specified using certificate key The same key can be used to download the certificates when additional control plane nodes are joining by passing control plane and certificate key to kubeadm join The following phase command can be used to re upload the certificates after expiration shell kubeadm init phase upload certs upload certs config SOME YAML FILE A predefined certificateKey can be provided in InitConfiguration when passing the configuration file docs reference config api kubeadm config v1beta4 with config If a predefined certificate key is not passed to kubeadm init and kubeadm init phase upload certs a new key will be generated automatically The following command can be used to generate a new key on demand shell kubeadm certs certificate key Certificate management with kubeadm For detailed information on certificate management with kubeadm see Certificate Management with kubeadm docs tasks administer cluster kubeadm kubeadm certs The document includes information about using external CA custom certificates and certificate renewal Managing the kubeadm drop in file for the kubelet kubelet drop in The kubeadm package ships with a configuration file for running the kubelet by systemd Note that the kubeadm CLI never touches this drop in file This drop in file is part of the kubeadm DEB RPM package For further information see Managing the kubeadm drop in file for systemd docs setup production environment tools kubeadm kubelet integration the kubelet drop in file for systemd Use kubeadm with CRI runtimes By default kubeadm attempts to detect your container runtime For more details on this detection see the kubeadm CRI installation guide docs setup production environment tools kubeadm install kubeadm installing runtime Setting the node name By default kubeadm assigns a node name based on a machine s host address You can override this setting with the node name flag The flag passes the appropriate hostname override docs reference command line tools reference kubelet options value to the kubelet Be aware that overriding the hostname can interfere with cloud providers https github com kubernetes website pull 8873 Automating kubeadm Rather than copying the token you obtained from kubeadm init to each node as in the basic kubeadm tutorial docs setup production environment tools kubeadm create cluster kubeadm you can parallelize the token distribution for easier automation To implement this automation you must know the IP address that the control plane node will have after it is started or use a DNS name or an address of a load balancer 1 Generate a token This token must have the form 6 character string 16 character string More formally it must match the regex a z0 9 6 a z0 9 16 kubeadm can generate a token for you shell kubeadm token generate 1 Start both the control plane node and the worker nodes concurrently with this token As they come up they should find each other and form the cluster The same token argument can be used on both kubeadm init and kubeadm join 1 Similar can be done for certificate key when joining additional control plane nodes The key can be generated using shell kubeadm certs certificate key Once the cluster is up you can use the etc kubernetes admin conf file from a control plane node to talk to the cluster with administrator credentials or Generating kubeconfig files for additional users docs tasks administer cluster kubeadm kubeadm certs kubeconfig additional users Note that this style of bootstrap has some relaxed security guarantees because it does not allow the root CA hash to be validated with discovery token ca cert hash since it s not generated when the nodes are provisioned For details see the kubeadm join docs reference setup tools kubeadm kubeadm join kubeadm init phase docs reference setup tools kubeadm kubeadm init phase to understand more about kubeadm init phases kubeadm join docs reference setup tools kubeadm kubeadm join to bootstrap a Kubernetes worker node and join it to the cluster kubeadm upgrade docs reference setup tools kubeadm kubeadm upgrade to upgrade a Kubernetes cluster to a newer version kubeadm reset docs reference setup tools kubeadm kubeadm reset to revert any changes made to this host by kubeadm init or kubeadm join |
kubernetes reference weight 100 title Implementation details luxas contenttype concept reviewers jbeda overview | ---
reviewers:
- luxas
- jbeda
title: Implementation details
content_type: concept
weight: 100
---
<!-- overview -->
`kubeadm init` and `kubeadm join` together provide a nice user experience for creating a
bare Kubernetes cluster from scratch, that aligns with the best-practices.
However, it might not be obvious _how_ kubeadm does that.
This document provides additional details on what happens under the hood, with the aim of sharing
knowledge on the best practices for a Kubernetes cluster.
<!-- body -->
## Core design principles
The cluster that `kubeadm init` and `kubeadm join` set up should be:
- **Secure**: It should adopt latest best-practices like:
- enforcing RBAC
- using the Node Authorizer
- using secure communication between the control plane components
- using secure communication between the API server and the kubelets
- lock-down the kubelet API
- locking down access to the API for system components like the kube-proxy and CoreDNS
- locking down what a Bootstrap Token can access
- **User-friendly**: The user should not have to run anything more than a couple of commands:
- `kubeadm init`
- `export KUBECONFIG=/etc/kubernetes/admin.conf`
- `kubectl apply -f <network-of-choice.yaml>`
- `kubeadm join --token <token> <endpoint>:<port>`
- **Extendable**:
- It should _not_ favor any particular network provider. Configuring the cluster network is out-of-scope
- It should provide the possibility to use a config file for customizing various parameters
## Constants and well-known values and paths
In order to reduce complexity and to simplify development of higher level tools that build on top of kubeadm, it uses a
limited set of constant values for well-known paths and file names.
The Kubernetes directory `/etc/kubernetes` is a constant in the application, since it is clearly the given path
in a majority of cases, and the most intuitive location; other constant paths and file names are:
- `/etc/kubernetes/manifests` as the path where the kubelet should look for static Pod manifests.
Names of static Pod manifests are:
- `etcd.yaml`
- `kube-apiserver.yaml`
- `kube-controller-manager.yaml`
- `kube-scheduler.yaml`
- `/etc/kubernetes/` as the path where kubeconfig files with identities for control plane
components are stored. Names of kubeconfig files are:
- `kubelet.conf` (`bootstrap-kubelet.conf` during TLS bootstrap)
- `controller-manager.conf`
- `scheduler.conf`
- `admin.conf` for the cluster admin and kubeadm itself
- `super-admin.conf` for the cluster super-admin that can bypass RBAC
- Names of certificates and key files:
- `ca.crt`, `ca.key` for the Kubernetes certificate authority
- `apiserver.crt`, `apiserver.key` for the API server certificate
- `apiserver-kubelet-client.crt`, `apiserver-kubelet-client.key` for the client certificate used
by the API server to connect to the kubelets securely
- `sa.pub`, `sa.key` for the key used by the controller manager when signing ServiceAccount
- `front-proxy-ca.crt`, `front-proxy-ca.key` for the front proxy certificate authority
- `front-proxy-client.crt`, `front-proxy-client.key` for the front proxy client
## kubeadm init workflow internal design
The `kubeadm init` consists of a sequence of atomic work tasks to perform,
as described in the `kubeadm init` [internal workflow](/docs/reference/setup-tools/kubeadm/kubeadm-init/#init-workflow).
The [`kubeadm init phase`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/) command allows
users to invoke each task individually, and ultimately offers a reusable and composable
API/toolbox that can be used by other Kubernetes bootstrap tools, by any IT automation tool or by
an advanced user for creating custom clusters.
### Preflight checks
Kubeadm executes a set of preflight checks before starting the init, with the aim to verify
preconditions and avoid common cluster startup problems.
The user can skip specific preflight checks or all of them with the `--ignore-preflight-errors` option.
- [Warning] if the Kubernetes version to use (specified with the `--kubernetes-version` flag) is
at least one minor version higher than the kubeadm CLI version.
- Kubernetes system requirements:
- if running on linux:
- [Error] if Kernel is older than the minimum required version
- [Error] if required cgroups subsystem aren't set up
- [Error] if the CRI endpoint does not answer
- [Error] if user is not root
- [Error] if the machine hostname is not a valid DNS subdomain
- [Warning] if the host name cannot be reached via network lookup
- [Error] if kubelet version is lower that the minimum kubelet version supported by kubeadm (current minor -1)
- [Error] if kubelet version is at least one minor higher than the required controlplane version (unsupported version skew)
- [Warning] if kubelet service does not exist or if it is disabled
- [Warning] if firewalld is active
- [Error] if API server bindPort or ports 10250/10251/10252 are used
- [Error] if `/etc/kubernetes/manifest` folder already exists and it is not empty
- [Error] if swap is on
- [Error] if `conntrack`, `ip`, `iptables`, `mount`, `nsenter` commands are not present in the command path
- [Warning] if `ebtables`, `ethtool`, `socat`, `tc`, `touch`, `crictl` commands are not present in the command path
- [Warning] if extra arg flags for API server, controller manager, scheduler contains some invalid options
- [Warning] if connection to https://API.AdvertiseAddress:API.BindPort goes through proxy
- [Warning] if connection to services subnet goes through proxy (only first address checked)
- [Warning] if connection to Pods subnet goes through proxy (only first address checked)
- If external etcd is provided:
- [Error] if etcd version is older than the minimum required version
- [Error] if etcd certificates or keys are specified, but not provided
- If external etcd is NOT provided (and thus local etcd will be installed):
- [Error] if ports 2379 is used
- [Error] if Etcd.DataDir folder already exists and it is not empty
- If authorization mode is ABAC:
- [Error] if abac_policy.json does not exist
- If authorization mode is WebHook
- [Error] if webhook_authz.conf does not exist
Preflight checks can be invoked individually with the
[`kubeadm init phase preflight`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-preflight)
command.
### Generate the necessary certificates
Kubeadm generates certificate and private key pairs for different purposes:
- A self signed certificate authority for the Kubernetes cluster saved into `ca.crt` file and
`ca.key` private key file
- A serving certificate for the API server, generated using `ca.crt` as the CA, and saved into
`apiserver.crt` file with its private key `apiserver.key`. This certificate should contain
the following alternative names:
- The Kubernetes service's internal clusterIP (the first address in the services CIDR, e.g.
`10.96.0.1` if service subnet is `10.96.0.0/12`)
- Kubernetes DNS names, e.g. `kubernetes.default.svc.cluster.local` if `--service-dns-domain`
flag value is `cluster.local`, plus default DNS names `kubernetes.default.svc`,
`kubernetes.default`, `kubernetes`
- The node-name
- The `--apiserver-advertise-address`
- Additional alternative names specified by the user
- A client certificate for the API server to connect to the kubelets securely, generated using
`ca.crt` as the CA and saved into `apiserver-kubelet-client.crt` file with its private key
`apiserver-kubelet-client.key`.
This certificate should be in the `system:masters` organization
- A private key for signing ServiceAccount Tokens saved into `sa.key` file along with its public key `sa.pub`
- A certificate authority for the front proxy saved into `front-proxy-ca.crt` file with its key
`front-proxy-ca.key`
- A client certificate for the front proxy client, generated using `front-proxy-ca.crt` as the CA and
saved into `front-proxy-client.crt` file with its private key`front-proxy-client.key`
Certificates are stored by default in `/etc/kubernetes/pki`, but this directory is configurable
using the `--cert-dir` flag.
Please note that:
1. If a given certificate and private key pair both exist, and their content is evaluated to be compliant with the above specs, the existing files will
be used and the generation phase for the given certificate will be skipped. This means the user can, for example, copy an existing CA to
`/etc/kubernetes/pki/ca.{crt,key}`, and then kubeadm will use those files for signing the rest of the certs.
See also [using custom certificates](/docs/tasks/administer-cluster/kubeadm/kubeadm-certs#custom-certificates)
1. For the CA, it is possible to provide the `ca.crt` file but not the `ca.key` file. If all other certificates and kubeconfig files
are already in place, kubeadm recognizes this condition and activates the ExternalCA, which also implies the `csrsigner` controller in
controller-manager won't be started
1. If kubeadm is running in [external CA mode](/docs/tasks/administer-cluster/kubeadm/kubeadm-certs#external-ca-mode);
all the certificates must be provided by the user, because kubeadm cannot generate them by itself
1. In case kubeadm is executed in the `--dry-run` mode, certificate files are written in a temporary folder
1. Certificate generation can be invoked individually with the
[`kubeadm init phase certs all`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-certs) command
### Generate kubeconfig files for control plane components
Kubeadm generates kubeconfig files with identities for control plane components:
- A kubeconfig file for the kubelet to use during TLS bootstrap -
/etc/kubernetes/bootstrap-kubelet.conf. Inside this file, there is a bootstrap-token or embedded
client certificates for authenticating this node with the cluster.
This client certificate should:
- Be in the `system:nodes` organization, as required by the
[Node Authorization](/docs/reference/access-authn-authz/node/) module
- Have the Common Name (CN) `system:node:<hostname-lowercased>`
- A kubeconfig file for controller-manager, `/etc/kubernetes/controller-manager.conf`; inside this
file is embedded a client certificate with controller-manager identity. This client certificate should
have the CN `system:kube-controller-manager`, as defined by default
[RBAC core components roles](/docs/reference/access-authn-authz/rbac/#core-component-roles)
- A kubeconfig file for scheduler, `/etc/kubernetes/scheduler.conf`; inside this file is embedded
a client certificate with scheduler identity.
This client certificate should have the CN `system:kube-scheduler`, as defined by default
[RBAC core components roles](/docs/reference/access-authn-authz/rbac/#core-component-roles)
Additionally, a kubeconfig file for kubeadm as an administrative entity is generated and stored
in `/etc/kubernetes/admin.conf`. This file includes a certificate with
`Subject: O = kubeadm:cluster-admins, CN = kubernetes-admin`. `kubeadm:cluster-admins`
is a group managed by kubeadm. It is bound to the `cluster-admin` ClusterRole during `kubeadm init`,
by using the `super-admin.conf` file, which does not require RBAC.
This `admin.conf` file must remain on control plane nodes and should not be shared with additional users.
During `kubeadm init` another kubeconfig file is generated and stored in `/etc/kubernetes/super-admin.conf`.
This file includes a certificate with `Subject: O = system:masters, CN = kubernetes-super-admin`.
`system:masters` is a superuser group that bypasses RBAC and makes `super-admin.conf` useful in case
of an emergency where a cluster is locked due to RBAC misconfiguration.
The `super-admin.conf` file must be stored in a safe location and should not be shared with additional users.
See [RBAC user facing role bindings](/docs/reference/access-authn-authz/rbac/#user-facing-roles)
for additional information on RBAC and built-in ClusterRoles and groups.
Please note that:
1. `ca.crt` certificate is embedded in all the kubeconfig files.
1. If a given kubeconfig file exists, and its content is evaluated as compliant with the above specs,
the existing file will be used and the generation phase for the given kubeconfig will be skipped
1. If kubeadm is running in [ExternalCA mode](/docs/reference/setup-tools/kubeadm/kubeadm-init/#external-ca-mode),
all the required kubeconfig must be provided by the user as well, because kubeadm cannot
generate any of them by itself
1. In case kubeadm is executed in the `--dry-run` mode, kubeconfig files are written in a temporary folder
1. Generation of kubeconfig files can be invoked individually with the
[`kubeadm init phase kubeconfig all`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-kubeconfig) command
### Generate static Pod manifests for control plane components
Kubeadm writes static Pod manifest files for control plane components to
`/etc/kubernetes/manifests`. The kubelet watches this directory for Pods to be created on startup.
Static Pod manifests share a set of common properties:
- All static Pods are deployed on `kube-system` namespace
- All static Pods get `tier:control-plane` and `component:{component-name}` labels
- All static Pods use the `system-node-critical` priority class
- `hostNetwork: true` is set on all static Pods to allow control plane startup before a network is
configured; as a consequence:
* The `address` that the controller-manager and the scheduler use to refer to the API server is `127.0.0.1`
* If the etcd server is set up locally, the `etcd-server` address will be set to `127.0.0.1:2379`
- Leader election is enabled for both the controller-manager and the scheduler
- Controller-manager and the scheduler will reference kubeconfig files with their respective, unique identities
- All static Pods get any extra flags specified by the user as described in
[passing custom arguments to control plane components](/docs/setup/production-environment/tools/kubeadm/control-plane-flags/)
- All static Pods get any extra Volumes specified by the user (Host path)
Please note that:
1. All images will be pulled from registry.k8s.io by default.
See [using custom images](/docs/reference/setup-tools/kubeadm/kubeadm-init/#custom-images)
for customizing the image repository
1. In case kubeadm is executed in the `--dry-run` mode, static Pod files are written in a
temporary folder
1. Static Pod manifest generation for control plane components can be invoked individually with
the [`kubeadm init phase control-plane all`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-control-plane) command
#### API server
The static Pod manifest for the API server is affected by the following parameters provided by the users:
- The `apiserver-advertise-address` and `apiserver-bind-port` to bind to; if not provided, those
values default to the IP address of the default network interface on the machine and port 6443
- The `service-cluster-ip-range` to use for services
- If an external etcd server is specified, the `etcd-servers` address and related TLS settings
(`etcd-cafile`, `etcd-certfile`, `etcd-keyfile`);
if an external etcd server is not provided, a local etcd will be used (via host network)
- If a cloud provider is specified, the corresponding `--cloud-provider` parameter is configured together
with the `--cloud-config` path if such file exists (this is experimental, alpha and will be
removed in a future version)
Other API server flags that are set unconditionally are:
- `--insecure-port=0` to avoid insecure connections to the api server
- `--enable-bootstrap-token-auth=true` to enable the `BootstrapTokenAuthenticator` authentication module.
See [TLS Bootstrapping](/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/) for more details
- `--allow-privileged` to `true` (required e.g. by kube proxy)
- `--requestheader-client-ca-file` to `front-proxy-ca.crt`
- `--enable-admission-plugins` to:
- [`NamespaceLifecycle`](/docs/reference/access-authn-authz/admission-controllers/#namespacelifecycle)
e.g. to avoid deletion of system reserved namespaces
- [`LimitRanger`](/docs/reference/access-authn-authz/admission-controllers/#limitranger)
and [`ResourceQuota`](/docs/reference/access-authn-authz/admission-controllers/#resourcequota)
to enforce limits on namespaces
- [`ServiceAccount`](/docs/reference/access-authn-authz/admission-controllers/#serviceaccount)
to enforce service account automation
- [`PersistentVolumeLabel`](/docs/reference/access-authn-authz/admission-controllers/#persistentvolumelabel)
attaches region or zone labels to PersistentVolumes as defined by the cloud provider (This
admission controller is deprecated and will be removed in a future version.
It is not deployed by kubeadm by default with v1.9 onwards when not explicitly opting into
using `gce` or `aws` as cloud providers)
- [`DefaultStorageClass`](/docs/reference/access-authn-authz/admission-controllers/#defaultstorageclass)
to enforce default storage class on `PersistentVolumeClaim` objects
- [`DefaultTolerationSeconds`](/docs/reference/access-authn-authz/admission-controllers/#defaulttolerationseconds)
- [`NodeRestriction`](/docs/reference/access-authn-authz/admission-controllers/#noderestriction)
to limit what a kubelet can modify (e.g. only pods on this node)
- `--kubelet-preferred-address-types` to `InternalIP,ExternalIP,Hostname;` this makes `kubectl
logs` and other API server-kubelet communication work in environments where the hostnames of the
nodes aren't resolvable
- Flags for using certificates generated in previous steps:
- `--client-ca-file` to `ca.crt`
- `--tls-cert-file` to `apiserver.crt`
- `--tls-private-key-file` to `apiserver.key`
- `--kubelet-client-certificate` to `apiserver-kubelet-client.crt`
- `--kubelet-client-key` to `apiserver-kubelet-client.key`
- `--service-account-key-file` to `sa.pub`
- `--requestheader-client-ca-file` to `front-proxy-ca.crt`
- `--proxy-client-cert-file` to `front-proxy-client.crt`
- `--proxy-client-key-file` to `front-proxy-client.key`
- Other flags for securing the front proxy
([API Aggregation](/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/))
communications:
- `--requestheader-username-headers=X-Remote-User`
- `--requestheader-group-headers=X-Remote-Group`
- `--requestheader-extra-headers-prefix=X-Remote-Extra-`
- `--requestheader-allowed-names=front-proxy-client`
#### Controller manager
The static Pod manifest for the controller manager is affected by following parameters provided by
the users:
- If kubeadm is invoked specifying a `--pod-network-cidr`, the subnet manager feature required for
some CNI network plugins is enabled by setting:
- `--allocate-node-cidrs=true`
- `--cluster-cidr` and `--node-cidr-mask-size` flags according to the given CIDR
- If a cloud provider is specified, the corresponding `--cloud-provider` is specified together
with the `--cloud-config` path if such configuration file exists (this is experimental, alpha
and will be removed in a future version)
Other flags that are set unconditionally are:
- `--controllers` enabling all the default controllers plus `BootstrapSigner` and `TokenCleaner`
controllers for TLS bootstrap. See [TLS Bootstrapping](/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/)
for more details.
- `--use-service-account-credentials` to `true`
- Flags for using certificates generated in previous steps:
- `--root-ca-file` to `ca.crt`
- `--cluster-signing-cert-file` to `ca.crt`, if External CA mode is disabled, otherwise to `""`
- `--cluster-signing-key-file` to `ca.key`, if External CA mode is disabled, otherwise to `""`
- `--service-account-private-key-file` to `sa.key`
#### Scheduler
The static Pod manifest for the scheduler is not affected by parameters provided by the users.
### Generate static Pod manifest for local etcd
If you specified an external etcd, this step will be skipped, otherwise kubeadm generates a
static Pod manifest file for creating a local etcd instance running in a Pod with following attributes:
- listen on `localhost:2379` and use `HostNetwork=true`
- make a `hostPath` mount out from the `dataDir` to the host's filesystem
- Any extra flags specified by the user
Please note that:
1. The etcd container image will be pulled from `registry.gcr.io` by default. See
[using custom images](/docs/reference/setup-tools/kubeadm/kubeadm-init/#custom-images)
for customizing the image repository.
1. If you run kubeadm in `--dry-run` mode, the etcd static Pod manifest is written
into a temporary folder.
1. You can directly invoke static Pod manifest generation for local etcd, using the
[`kubeadm init phase etcd local`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-etcd)
command.
### Wait for the control plane to come up
kubeadm waits (upto 4m0s) until `localhost:6443/healthz` (kube-apiserver liveness) returns `ok`.
However, in order to detect deadlock conditions, kubeadm fails fast if `localhost:10255/healthz`
(kubelet liveness) or `localhost:10255/healthz/syncloop` (kubelet readiness) don't return `ok`
within 40s and 60s respectively.
kubeadm relies on the kubelet to pull the control plane images and run them properly as static Pods.
After the control plane is up, kubeadm completes the tasks described in following paragraphs.
### Save the kubeadm ClusterConfiguration in a ConfigMap for later reference
kubeadm saves the configuration passed to `kubeadm init` in a ConfigMap named `kubeadm-config`
under `kube-system` namespace.
This will ensure that kubeadm actions executed in future (e.g `kubeadm upgrade`) will be able to
determine the actual/current cluster state and make new decisions based on that data.
Please note that:
1. Before saving the ClusterConfiguration, sensitive information like the token is stripped from the configuration
1. Upload of control plane node configuration can be invoked individually with the command
[`kubeadm init phase upload-config`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-upload-config).
### Mark the node as control-plane
As soon as the control plane is available, kubeadm executes the following actions:
- Labels the node as control-plane with `node-role.kubernetes.io/control-plane=""`
- Taints the node with `node-role.kubernetes.io/control-plane:NoSchedule`
Please note that the phase to mark the control-plane phase can be invoked
individually with the [`kubeadm init phase mark-control-plane`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-mark-control-plane) command.
### Configure TLS-Bootstrapping for node joining
Kubeadm uses [Authenticating with Bootstrap Tokens](/docs/reference/access-authn-authz/bootstrap-tokens/)
for joining new nodes to an existing cluster; for more details see also
[design proposal](https://git.k8s.io/design-proposals-archive/cluster-lifecycle/bootstrap-discovery.md).
`kubeadm init` ensures that everything is properly configured for this process, and this includes
following steps as well as setting API server and controller flags as already described in
previous paragraphs.
TLS bootstrapping for nodes can be configured with the command
[`kubeadm init phase bootstrap-token`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-bootstrap-token),
executing all the configuration steps described in following paragraphs;
alternatively, each step can be invoked individually.
#### Create a bootstrap token
`kubeadm init` creates a first bootstrap token, either generated automatically or provided by the
user with the `--token` flag; as documented in bootstrap token specification, token should be
saved as a secret with name `bootstrap-token-<token-id>` under `kube-system` namespace.
Please note that:
1. The default token created by `kubeadm init` will be used to validate temporary user during TLS
bootstrap process; those users will be member of
`system:bootstrappers:kubeadm:default-node-token` group
1. The token has a limited validity, default 24 hours (the interval may be changed with the `—token-ttl` flag)
1. Additional tokens can be created with the [`kubeadm token`](/docs/reference/setup-tools/kubeadm/kubeadm-token/)
command, that provide other useful functions for token management as well.
#### Allow joining nodes to call CSR API
Kubeadm ensures that users in `system:bootstrappers:kubeadm:default-node-token` group are able to
access the certificate signing API.
This is implemented by creating a ClusterRoleBinding named `kubeadm:kubelet-bootstrap` between the
group above and the default RBAC role `system:node-bootstrapper`.
#### Set up auto approval for new bootstrap tokens
Kubeadm ensures that the Bootstrap Token will get its CSR request automatically approved by the
csrapprover controller.
This is implemented by creating ClusterRoleBinding named `kubeadm:node-autoapprove-bootstrap`
between the `system:bootstrappers:kubeadm:default-node-token` group and the default role
`system:certificates.k8s.io:certificatesigningrequests:nodeclient`.
The role `system:certificates.k8s.io:certificatesigningrequests:nodeclient` should be created as
well, granting POST permission to
`/apis/certificates.k8s.io/certificatesigningrequests/nodeclient`.
#### Set up nodes certificate rotation with auto approval
Kubeadm ensures that certificate rotation is enabled for nodes, and that a new certificate request
for nodes will get its CSR request automatically approved by the csrapprover controller.
This is implemented by creating ClusterRoleBinding named
`kubeadm:node-autoapprove-certificate-rotation` between the `system:nodes` group and the default
role `system:certificates.k8s.io:certificatesigningrequests:selfnodeclient`.
#### Create the public cluster-info ConfigMap
This phase creates the `cluster-info` ConfigMap in the `kube-public` namespace.
Additionally, it creates a Role and a RoleBinding granting access to the ConfigMap for
unauthenticated users (i.e. users in RBAC group `system:unauthenticated`).
The access to the `cluster-info` ConfigMap _is not_ rate-limited. This may or may not be a
problem if you expose your cluster's API server to the internet; worst-case scenario here is a
DoS attack where an attacker uses all the in-flight requests the kube-apiserver can handle to
serve the `cluster-info` ConfigMap.
### Install addons
Kubeadm installs the internal DNS server and the kube-proxy addon components via the API server.
This phase can be invoked individually with the command
[`kubeadm init phase addon all`](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-addon).
#### proxy
A ServiceAccount for `kube-proxy` is created in the `kube-system` namespace; then kube-proxy is
deployed as a DaemonSet:
- The credentials (`ca.crt` and `token`) to the control plane come from the ServiceAccount
- The location (URL) of the API server comes from a ConfigMap
- The `kube-proxy` ServiceAccount is bound to the privileges in the `system:node-proxier` ClusterRole
#### DNS
- The CoreDNS service is named `kube-dns`. This is done to prevent any interruption
in service when the user is switching the cluster DNS from kube-dns to CoreDNS
through the `--config` method described [here](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-addon).
- A ServiceAccount for CoreDNS is created in the `kube-system` namespace.
- The `coredns` ServiceAccount is bound to the privileges in the `system:coredns` ClusterRole
In Kubernetes version 1.21, support for using `kube-dns` with kubeadm was removed.
You can use CoreDNS with kubeadm even when the related Service is named `kube-dns`.
## kubeadm join phases internal design
Similarly to `kubeadm init`, also `kubeadm join` internal workflow consists of a sequence of
atomic work tasks to perform.
This is split into discovery (having the Node trust the Kubernetes Master) and TLS bootstrap
(having the Kubernetes Master trust the Node).
see [Authenticating with Bootstrap Tokens](/docs/reference/access-authn-authz/bootstrap-tokens/)
or the corresponding [design proposal](https://git.k8s.io/design-proposals-archive/cluster-lifecycle/bootstrap-discovery.md).
### Preflight checks
`kubeadm` executes a set of preflight checks before starting the join, with the aim to verify
preconditions and avoid common cluster startup problems.
Please note that:
1. `kubeadm join` preflight checks are basically a subset of `kubeadm init` preflight checks
1. Starting from 1.24, kubeadm uses crictl to communicate to all known CRI endpoints.
1. Starting from 1.9, kubeadm provides support for joining nodes running on Windows; in that case,
linux specific controls are skipped.
1. In any case the user can skip specific preflight checks (or eventually all preflight checks)
with the `--ignore-preflight-errors` option.
### Discovery cluster-info
There are 2 main schemes for discovery. The first is to use a shared token along with the IP
address of the API server.
The second is to provide a file (that is a subset of the standard kubeconfig file).
#### Shared token discovery
If `kubeadm join` is invoked with `--discovery-token`, token discovery is used; in this case the
node basically retrieves the cluster CA certificates from the `cluster-info` ConfigMap in the
`kube-public` namespace.
In order to prevent "man in the middle" attacks, several steps are taken:
- First, the CA certificate is retrieved via insecure connection (this is possible because
`kubeadm init` is granted access to `cluster-info` users for `system:unauthenticated`)
- Then the CA certificate goes through following validation steps:
- Basic validation: using the token ID against a JWT signature
- Pub key validation: using provided `--discovery-token-ca-cert-hash`. This value is available
in the output of `kubeadm init` or can be calculated using standard tools (the hash is
calculated over the bytes of the Subject Public Key Info (SPKI) object as in RFC7469). The
`--discovery-token-ca-cert-hash flag` may be repeated multiple times to allow more than one public key.
- As an additional validation, the CA certificate is retrieved via secure connection and then
compared with the CA retrieved initially
Pub key validation can be skipped passing `--discovery-token-unsafe-skip-ca-verification` flag;
This weakens the kubeadm security model since others can potentially impersonate the Kubernetes Master.
#### File/https discovery
If `kubeadm join` is invoked with `--discovery-file`, file discovery is used; this file can be a
local file or downloaded via an HTTPS URL; in case of HTTPS, the host installed CA bundle is used
to verify the connection.
With file discovery, the cluster CA certificate is provided into the file itself; in fact, the
discovery file is a kubeconfig file with only `server` and `certificate-authority-data` attributes
set, as described in the [`kubeadm join`](/docs/reference/setup-tools/kubeadm/kubeadm-join/#file-or-https-based-discovery)
reference doc; when the connection with the cluster is established, kubeadm tries to access the
`cluster-info` ConfigMap, and if available, uses it.
## TLS Bootstrap
Once the cluster info is known, the file `bootstrap-kubelet.conf` is written, thus allowing
kubelet to do TLS Bootstrapping.
The TLS bootstrap mechanism uses the shared token to temporarily authenticate with the Kubernetes
API server to submit a certificate signing request (CSR) for a locally created key pair.
The request is then automatically approved and the operation completes saving `ca.crt` file and
`kubelet.conf` file to be used by the kubelet for joining the cluster, while `bootstrap-kubelet.conf`
is deleted.
- The temporary authentication is validated against the token saved during the `kubeadm init`
process (or with additional tokens created with `kubeadm token` command)
- The temporary authentication resolves to a user member of
`system:bootstrappers:kubeadm:default-node-token` group which was granted access to the CSR api
during the `kubeadm init` process
- The automatic CSR approval is managed by the csrapprover controller, according to
the configuration present in the `kubeadm init` process
| kubernetes reference | reviewers luxas jbeda title Implementation details content type concept weight 100 overview kubeadm init and kubeadm join together provide a nice user experience for creating a bare Kubernetes cluster from scratch that aligns with the best practices However it might not be obvious how kubeadm does that This document provides additional details on what happens under the hood with the aim of sharing knowledge on the best practices for a Kubernetes cluster body Core design principles The cluster that kubeadm init and kubeadm join set up should be Secure It should adopt latest best practices like enforcing RBAC using the Node Authorizer using secure communication between the control plane components using secure communication between the API server and the kubelets lock down the kubelet API locking down access to the API for system components like the kube proxy and CoreDNS locking down what a Bootstrap Token can access User friendly The user should not have to run anything more than a couple of commands kubeadm init export KUBECONFIG etc kubernetes admin conf kubectl apply f network of choice yaml kubeadm join token token endpoint port Extendable It should not favor any particular network provider Configuring the cluster network is out of scope It should provide the possibility to use a config file for customizing various parameters Constants and well known values and paths In order to reduce complexity and to simplify development of higher level tools that build on top of kubeadm it uses a limited set of constant values for well known paths and file names The Kubernetes directory etc kubernetes is a constant in the application since it is clearly the given path in a majority of cases and the most intuitive location other constant paths and file names are etc kubernetes manifests as the path where the kubelet should look for static Pod manifests Names of static Pod manifests are etcd yaml kube apiserver yaml kube controller manager yaml kube scheduler yaml etc kubernetes as the path where kubeconfig files with identities for control plane components are stored Names of kubeconfig files are kubelet conf bootstrap kubelet conf during TLS bootstrap controller manager conf scheduler conf admin conf for the cluster admin and kubeadm itself super admin conf for the cluster super admin that can bypass RBAC Names of certificates and key files ca crt ca key for the Kubernetes certificate authority apiserver crt apiserver key for the API server certificate apiserver kubelet client crt apiserver kubelet client key for the client certificate used by the API server to connect to the kubelets securely sa pub sa key for the key used by the controller manager when signing ServiceAccount front proxy ca crt front proxy ca key for the front proxy certificate authority front proxy client crt front proxy client key for the front proxy client kubeadm init workflow internal design The kubeadm init consists of a sequence of atomic work tasks to perform as described in the kubeadm init internal workflow docs reference setup tools kubeadm kubeadm init init workflow The kubeadm init phase docs reference setup tools kubeadm kubeadm init phase command allows users to invoke each task individually and ultimately offers a reusable and composable API toolbox that can be used by other Kubernetes bootstrap tools by any IT automation tool or by an advanced user for creating custom clusters Preflight checks Kubeadm executes a set of preflight checks before starting the init with the aim to verify preconditions and avoid common cluster startup problems The user can skip specific preflight checks or all of them with the ignore preflight errors option Warning if the Kubernetes version to use specified with the kubernetes version flag is at least one minor version higher than the kubeadm CLI version Kubernetes system requirements if running on linux Error if Kernel is older than the minimum required version Error if required cgroups subsystem aren t set up Error if the CRI endpoint does not answer Error if user is not root Error if the machine hostname is not a valid DNS subdomain Warning if the host name cannot be reached via network lookup Error if kubelet version is lower that the minimum kubelet version supported by kubeadm current minor 1 Error if kubelet version is at least one minor higher than the required controlplane version unsupported version skew Warning if kubelet service does not exist or if it is disabled Warning if firewalld is active Error if API server bindPort or ports 10250 10251 10252 are used Error if etc kubernetes manifest folder already exists and it is not empty Error if swap is on Error if conntrack ip iptables mount nsenter commands are not present in the command path Warning if ebtables ethtool socat tc touch crictl commands are not present in the command path Warning if extra arg flags for API server controller manager scheduler contains some invalid options Warning if connection to https API AdvertiseAddress API BindPort goes through proxy Warning if connection to services subnet goes through proxy only first address checked Warning if connection to Pods subnet goes through proxy only first address checked If external etcd is provided Error if etcd version is older than the minimum required version Error if etcd certificates or keys are specified but not provided If external etcd is NOT provided and thus local etcd will be installed Error if ports 2379 is used Error if Etcd DataDir folder already exists and it is not empty If authorization mode is ABAC Error if abac policy json does not exist If authorization mode is WebHook Error if webhook authz conf does not exist Preflight checks can be invoked individually with the kubeadm init phase preflight docs reference setup tools kubeadm kubeadm init phase cmd phase preflight command Generate the necessary certificates Kubeadm generates certificate and private key pairs for different purposes A self signed certificate authority for the Kubernetes cluster saved into ca crt file and ca key private key file A serving certificate for the API server generated using ca crt as the CA and saved into apiserver crt file with its private key apiserver key This certificate should contain the following alternative names The Kubernetes service s internal clusterIP the first address in the services CIDR e g 10 96 0 1 if service subnet is 10 96 0 0 12 Kubernetes DNS names e g kubernetes default svc cluster local if service dns domain flag value is cluster local plus default DNS names kubernetes default svc kubernetes default kubernetes The node name The apiserver advertise address Additional alternative names specified by the user A client certificate for the API server to connect to the kubelets securely generated using ca crt as the CA and saved into apiserver kubelet client crt file with its private key apiserver kubelet client key This certificate should be in the system masters organization A private key for signing ServiceAccount Tokens saved into sa key file along with its public key sa pub A certificate authority for the front proxy saved into front proxy ca crt file with its key front proxy ca key A client certificate for the front proxy client generated using front proxy ca crt as the CA and saved into front proxy client crt file with its private key front proxy client key Certificates are stored by default in etc kubernetes pki but this directory is configurable using the cert dir flag Please note that 1 If a given certificate and private key pair both exist and their content is evaluated to be compliant with the above specs the existing files will be used and the generation phase for the given certificate will be skipped This means the user can for example copy an existing CA to etc kubernetes pki ca crt key and then kubeadm will use those files for signing the rest of the certs See also using custom certificates docs tasks administer cluster kubeadm kubeadm certs custom certificates 1 For the CA it is possible to provide the ca crt file but not the ca key file If all other certificates and kubeconfig files are already in place kubeadm recognizes this condition and activates the ExternalCA which also implies the csrsigner controller in controller manager won t be started 1 If kubeadm is running in external CA mode docs tasks administer cluster kubeadm kubeadm certs external ca mode all the certificates must be provided by the user because kubeadm cannot generate them by itself 1 In case kubeadm is executed in the dry run mode certificate files are written in a temporary folder 1 Certificate generation can be invoked individually with the kubeadm init phase certs all docs reference setup tools kubeadm kubeadm init phase cmd phase certs command Generate kubeconfig files for control plane components Kubeadm generates kubeconfig files with identities for control plane components A kubeconfig file for the kubelet to use during TLS bootstrap etc kubernetes bootstrap kubelet conf Inside this file there is a bootstrap token or embedded client certificates for authenticating this node with the cluster This client certificate should Be in the system nodes organization as required by the Node Authorization docs reference access authn authz node module Have the Common Name CN system node hostname lowercased A kubeconfig file for controller manager etc kubernetes controller manager conf inside this file is embedded a client certificate with controller manager identity This client certificate should have the CN system kube controller manager as defined by default RBAC core components roles docs reference access authn authz rbac core component roles A kubeconfig file for scheduler etc kubernetes scheduler conf inside this file is embedded a client certificate with scheduler identity This client certificate should have the CN system kube scheduler as defined by default RBAC core components roles docs reference access authn authz rbac core component roles Additionally a kubeconfig file for kubeadm as an administrative entity is generated and stored in etc kubernetes admin conf This file includes a certificate with Subject O kubeadm cluster admins CN kubernetes admin kubeadm cluster admins is a group managed by kubeadm It is bound to the cluster admin ClusterRole during kubeadm init by using the super admin conf file which does not require RBAC This admin conf file must remain on control plane nodes and should not be shared with additional users During kubeadm init another kubeconfig file is generated and stored in etc kubernetes super admin conf This file includes a certificate with Subject O system masters CN kubernetes super admin system masters is a superuser group that bypasses RBAC and makes super admin conf useful in case of an emergency where a cluster is locked due to RBAC misconfiguration The super admin conf file must be stored in a safe location and should not be shared with additional users See RBAC user facing role bindings docs reference access authn authz rbac user facing roles for additional information on RBAC and built in ClusterRoles and groups Please note that 1 ca crt certificate is embedded in all the kubeconfig files 1 If a given kubeconfig file exists and its content is evaluated as compliant with the above specs the existing file will be used and the generation phase for the given kubeconfig will be skipped 1 If kubeadm is running in ExternalCA mode docs reference setup tools kubeadm kubeadm init external ca mode all the required kubeconfig must be provided by the user as well because kubeadm cannot generate any of them by itself 1 In case kubeadm is executed in the dry run mode kubeconfig files are written in a temporary folder 1 Generation of kubeconfig files can be invoked individually with the kubeadm init phase kubeconfig all docs reference setup tools kubeadm kubeadm init phase cmd phase kubeconfig command Generate static Pod manifests for control plane components Kubeadm writes static Pod manifest files for control plane components to etc kubernetes manifests The kubelet watches this directory for Pods to be created on startup Static Pod manifests share a set of common properties All static Pods are deployed on kube system namespace All static Pods get tier control plane and component component name labels All static Pods use the system node critical priority class hostNetwork true is set on all static Pods to allow control plane startup before a network is configured as a consequence The address that the controller manager and the scheduler use to refer to the API server is 127 0 0 1 If the etcd server is set up locally the etcd server address will be set to 127 0 0 1 2379 Leader election is enabled for both the controller manager and the scheduler Controller manager and the scheduler will reference kubeconfig files with their respective unique identities All static Pods get any extra flags specified by the user as described in passing custom arguments to control plane components docs setup production environment tools kubeadm control plane flags All static Pods get any extra Volumes specified by the user Host path Please note that 1 All images will be pulled from registry k8s io by default See using custom images docs reference setup tools kubeadm kubeadm init custom images for customizing the image repository 1 In case kubeadm is executed in the dry run mode static Pod files are written in a temporary folder 1 Static Pod manifest generation for control plane components can be invoked individually with the kubeadm init phase control plane all docs reference setup tools kubeadm kubeadm init phase cmd phase control plane command API server The static Pod manifest for the API server is affected by the following parameters provided by the users The apiserver advertise address and apiserver bind port to bind to if not provided those values default to the IP address of the default network interface on the machine and port 6443 The service cluster ip range to use for services If an external etcd server is specified the etcd servers address and related TLS settings etcd cafile etcd certfile etcd keyfile if an external etcd server is not provided a local etcd will be used via host network If a cloud provider is specified the corresponding cloud provider parameter is configured together with the cloud config path if such file exists this is experimental alpha and will be removed in a future version Other API server flags that are set unconditionally are insecure port 0 to avoid insecure connections to the api server enable bootstrap token auth true to enable the BootstrapTokenAuthenticator authentication module See TLS Bootstrapping docs reference access authn authz kubelet tls bootstrapping for more details allow privileged to true required e g by kube proxy requestheader client ca file to front proxy ca crt enable admission plugins to NamespaceLifecycle docs reference access authn authz admission controllers namespacelifecycle e g to avoid deletion of system reserved namespaces LimitRanger docs reference access authn authz admission controllers limitranger and ResourceQuota docs reference access authn authz admission controllers resourcequota to enforce limits on namespaces ServiceAccount docs reference access authn authz admission controllers serviceaccount to enforce service account automation PersistentVolumeLabel docs reference access authn authz admission controllers persistentvolumelabel attaches region or zone labels to PersistentVolumes as defined by the cloud provider This admission controller is deprecated and will be removed in a future version It is not deployed by kubeadm by default with v1 9 onwards when not explicitly opting into using gce or aws as cloud providers DefaultStorageClass docs reference access authn authz admission controllers defaultstorageclass to enforce default storage class on PersistentVolumeClaim objects DefaultTolerationSeconds docs reference access authn authz admission controllers defaulttolerationseconds NodeRestriction docs reference access authn authz admission controllers noderestriction to limit what a kubelet can modify e g only pods on this node kubelet preferred address types to InternalIP ExternalIP Hostname this makes kubectl logs and other API server kubelet communication work in environments where the hostnames of the nodes aren t resolvable Flags for using certificates generated in previous steps client ca file to ca crt tls cert file to apiserver crt tls private key file to apiserver key kubelet client certificate to apiserver kubelet client crt kubelet client key to apiserver kubelet client key service account key file to sa pub requestheader client ca file to front proxy ca crt proxy client cert file to front proxy client crt proxy client key file to front proxy client key Other flags for securing the front proxy API Aggregation docs concepts extend kubernetes api extension apiserver aggregation communications requestheader username headers X Remote User requestheader group headers X Remote Group requestheader extra headers prefix X Remote Extra requestheader allowed names front proxy client Controller manager The static Pod manifest for the controller manager is affected by following parameters provided by the users If kubeadm is invoked specifying a pod network cidr the subnet manager feature required for some CNI network plugins is enabled by setting allocate node cidrs true cluster cidr and node cidr mask size flags according to the given CIDR If a cloud provider is specified the corresponding cloud provider is specified together with the cloud config path if such configuration file exists this is experimental alpha and will be removed in a future version Other flags that are set unconditionally are controllers enabling all the default controllers plus BootstrapSigner and TokenCleaner controllers for TLS bootstrap See TLS Bootstrapping docs reference access authn authz kubelet tls bootstrapping for more details use service account credentials to true Flags for using certificates generated in previous steps root ca file to ca crt cluster signing cert file to ca crt if External CA mode is disabled otherwise to cluster signing key file to ca key if External CA mode is disabled otherwise to service account private key file to sa key Scheduler The static Pod manifest for the scheduler is not affected by parameters provided by the users Generate static Pod manifest for local etcd If you specified an external etcd this step will be skipped otherwise kubeadm generates a static Pod manifest file for creating a local etcd instance running in a Pod with following attributes listen on localhost 2379 and use HostNetwork true make a hostPath mount out from the dataDir to the host s filesystem Any extra flags specified by the user Please note that 1 The etcd container image will be pulled from registry gcr io by default See using custom images docs reference setup tools kubeadm kubeadm init custom images for customizing the image repository 1 If you run kubeadm in dry run mode the etcd static Pod manifest is written into a temporary folder 1 You can directly invoke static Pod manifest generation for local etcd using the kubeadm init phase etcd local docs reference setup tools kubeadm kubeadm init phase cmd phase etcd command Wait for the control plane to come up kubeadm waits upto 4m0s until localhost 6443 healthz kube apiserver liveness returns ok However in order to detect deadlock conditions kubeadm fails fast if localhost 10255 healthz kubelet liveness or localhost 10255 healthz syncloop kubelet readiness don t return ok within 40s and 60s respectively kubeadm relies on the kubelet to pull the control plane images and run them properly as static Pods After the control plane is up kubeadm completes the tasks described in following paragraphs Save the kubeadm ClusterConfiguration in a ConfigMap for later reference kubeadm saves the configuration passed to kubeadm init in a ConfigMap named kubeadm config under kube system namespace This will ensure that kubeadm actions executed in future e g kubeadm upgrade will be able to determine the actual current cluster state and make new decisions based on that data Please note that 1 Before saving the ClusterConfiguration sensitive information like the token is stripped from the configuration 1 Upload of control plane node configuration can be invoked individually with the command kubeadm init phase upload config docs reference setup tools kubeadm kubeadm init phase cmd phase upload config Mark the node as control plane As soon as the control plane is available kubeadm executes the following actions Labels the node as control plane with node role kubernetes io control plane Taints the node with node role kubernetes io control plane NoSchedule Please note that the phase to mark the control plane phase can be invoked individually with the kubeadm init phase mark control plane docs reference setup tools kubeadm kubeadm init phase cmd phase mark control plane command Configure TLS Bootstrapping for node joining Kubeadm uses Authenticating with Bootstrap Tokens docs reference access authn authz bootstrap tokens for joining new nodes to an existing cluster for more details see also design proposal https git k8s io design proposals archive cluster lifecycle bootstrap discovery md kubeadm init ensures that everything is properly configured for this process and this includes following steps as well as setting API server and controller flags as already described in previous paragraphs TLS bootstrapping for nodes can be configured with the command kubeadm init phase bootstrap token docs reference setup tools kubeadm kubeadm init phase cmd phase bootstrap token executing all the configuration steps described in following paragraphs alternatively each step can be invoked individually Create a bootstrap token kubeadm init creates a first bootstrap token either generated automatically or provided by the user with the token flag as documented in bootstrap token specification token should be saved as a secret with name bootstrap token token id under kube system namespace Please note that 1 The default token created by kubeadm init will be used to validate temporary user during TLS bootstrap process those users will be member of system bootstrappers kubeadm default node token group 1 The token has a limited validity default 24 hours the interval may be changed with the token ttl flag 1 Additional tokens can be created with the kubeadm token docs reference setup tools kubeadm kubeadm token command that provide other useful functions for token management as well Allow joining nodes to call CSR API Kubeadm ensures that users in system bootstrappers kubeadm default node token group are able to access the certificate signing API This is implemented by creating a ClusterRoleBinding named kubeadm kubelet bootstrap between the group above and the default RBAC role system node bootstrapper Set up auto approval for new bootstrap tokens Kubeadm ensures that the Bootstrap Token will get its CSR request automatically approved by the csrapprover controller This is implemented by creating ClusterRoleBinding named kubeadm node autoapprove bootstrap between the system bootstrappers kubeadm default node token group and the default role system certificates k8s io certificatesigningrequests nodeclient The role system certificates k8s io certificatesigningrequests nodeclient should be created as well granting POST permission to apis certificates k8s io certificatesigningrequests nodeclient Set up nodes certificate rotation with auto approval Kubeadm ensures that certificate rotation is enabled for nodes and that a new certificate request for nodes will get its CSR request automatically approved by the csrapprover controller This is implemented by creating ClusterRoleBinding named kubeadm node autoapprove certificate rotation between the system nodes group and the default role system certificates k8s io certificatesigningrequests selfnodeclient Create the public cluster info ConfigMap This phase creates the cluster info ConfigMap in the kube public namespace Additionally it creates a Role and a RoleBinding granting access to the ConfigMap for unauthenticated users i e users in RBAC group system unauthenticated The access to the cluster info ConfigMap is not rate limited This may or may not be a problem if you expose your cluster s API server to the internet worst case scenario here is a DoS attack where an attacker uses all the in flight requests the kube apiserver can handle to serve the cluster info ConfigMap Install addons Kubeadm installs the internal DNS server and the kube proxy addon components via the API server This phase can be invoked individually with the command kubeadm init phase addon all docs reference setup tools kubeadm kubeadm init phase cmd phase addon proxy A ServiceAccount for kube proxy is created in the kube system namespace then kube proxy is deployed as a DaemonSet The credentials ca crt and token to the control plane come from the ServiceAccount The location URL of the API server comes from a ConfigMap The kube proxy ServiceAccount is bound to the privileges in the system node proxier ClusterRole DNS The CoreDNS service is named kube dns This is done to prevent any interruption in service when the user is switching the cluster DNS from kube dns to CoreDNS through the config method described here docs reference setup tools kubeadm kubeadm init phase cmd phase addon A ServiceAccount for CoreDNS is created in the kube system namespace The coredns ServiceAccount is bound to the privileges in the system coredns ClusterRole In Kubernetes version 1 21 support for using kube dns with kubeadm was removed You can use CoreDNS with kubeadm even when the related Service is named kube dns kubeadm join phases internal design Similarly to kubeadm init also kubeadm join internal workflow consists of a sequence of atomic work tasks to perform This is split into discovery having the Node trust the Kubernetes Master and TLS bootstrap having the Kubernetes Master trust the Node see Authenticating with Bootstrap Tokens docs reference access authn authz bootstrap tokens or the corresponding design proposal https git k8s io design proposals archive cluster lifecycle bootstrap discovery md Preflight checks kubeadm executes a set of preflight checks before starting the join with the aim to verify preconditions and avoid common cluster startup problems Please note that 1 kubeadm join preflight checks are basically a subset of kubeadm init preflight checks 1 Starting from 1 24 kubeadm uses crictl to communicate to all known CRI endpoints 1 Starting from 1 9 kubeadm provides support for joining nodes running on Windows in that case linux specific controls are skipped 1 In any case the user can skip specific preflight checks or eventually all preflight checks with the ignore preflight errors option Discovery cluster info There are 2 main schemes for discovery The first is to use a shared token along with the IP address of the API server The second is to provide a file that is a subset of the standard kubeconfig file Shared token discovery If kubeadm join is invoked with discovery token token discovery is used in this case the node basically retrieves the cluster CA certificates from the cluster info ConfigMap in the kube public namespace In order to prevent man in the middle attacks several steps are taken First the CA certificate is retrieved via insecure connection this is possible because kubeadm init is granted access to cluster info users for system unauthenticated Then the CA certificate goes through following validation steps Basic validation using the token ID against a JWT signature Pub key validation using provided discovery token ca cert hash This value is available in the output of kubeadm init or can be calculated using standard tools the hash is calculated over the bytes of the Subject Public Key Info SPKI object as in RFC7469 The discovery token ca cert hash flag may be repeated multiple times to allow more than one public key As an additional validation the CA certificate is retrieved via secure connection and then compared with the CA retrieved initially Pub key validation can be skipped passing discovery token unsafe skip ca verification flag This weakens the kubeadm security model since others can potentially impersonate the Kubernetes Master File https discovery If kubeadm join is invoked with discovery file file discovery is used this file can be a local file or downloaded via an HTTPS URL in case of HTTPS the host installed CA bundle is used to verify the connection With file discovery the cluster CA certificate is provided into the file itself in fact the discovery file is a kubeconfig file with only server and certificate authority data attributes set as described in the kubeadm join docs reference setup tools kubeadm kubeadm join file or https based discovery reference doc when the connection with the cluster is established kubeadm tries to access the cluster info ConfigMap and if available uses it TLS Bootstrap Once the cluster info is known the file bootstrap kubelet conf is written thus allowing kubelet to do TLS Bootstrapping The TLS bootstrap mechanism uses the shared token to temporarily authenticate with the Kubernetes API server to submit a certificate signing request CSR for a locally created key pair The request is then automatically approved and the operation completes saving ca crt file and kubelet conf file to be used by the kubelet for joining the cluster while bootstrap kubelet conf is deleted The temporary authentication is validated against the token saved during the kubeadm init process or with additional tokens created with kubeadm token command The temporary authentication resolves to a user member of system bootstrappers kubeadm default node token group which was granted access to the CSR api during the kubeadm init process The automatic CSR approval is managed by the csrapprover controller according to the configuration present in the kubeadm init process |
kubernetes reference title kubeadm init phase enables you to invoke atomic steps of the bootstrap process Hence you can let kubeadm do some of the work and you can fill in the gaps weight 90 contenttype concept if you wish to apply customization | ---
title: kubeadm init phase
weight: 90
content_type: concept
---
`kubeadm init phase` enables you to invoke atomic steps of the bootstrap process.
Hence, you can let kubeadm do some of the work and you can fill in the gaps
if you wish to apply customization.
`kubeadm init phase` is consistent with the [kubeadm init workflow](/docs/reference/setup-tools/kubeadm/kubeadm-init/#init-workflow),
and behind the scene both use the same code.
## kubeadm init phase preflight {#cmd-phase-preflight}
Using this command you can execute preflight checks on a control-plane node.
## kubeadm init phase kubelet-start {#cmd-phase-kubelet-start}
This phase will write the kubelet configuration file and environment file and then start the kubelet.
## kubeadm init phase certs {#cmd-phase-certs}
Can be used to create all required certificates by kubeadm.
## kubeadm init phase kubeconfig {#cmd-phase-kubeconfig}
You can create all required kubeconfig files by calling the `all` subcommand or call them individually.
## kubeadm init phase control-plane {#cmd-phase-control-plane}
Using this phase you can create all required static Pod files for the control plane components.
## kubeadm init phase etcd {#cmd-phase-etcd}
Use the following phase to create a local etcd instance based on a static Pod file.
## kubeadm init phase upload-config {#cmd-phase-upload-config}
You can use this command to upload the kubeadm configuration to your cluster.
Alternatively, you can use [kubeadm config](/docs/reference/setup-tools/kubeadm/kubeadm-config/).
## kubeadm init phase upload-certs {#cmd-phase-upload-certs}
Use the following phase to upload control-plane certificates to the cluster.
By default the certs and encryption key expire after two hours.
## kubeadm init phase mark-control-plane {#cmd-phase-mark-control-plane}
Use the following phase to label and taint the node as a control plane node.
## kubeadm init phase bootstrap-token {#cmd-phase-bootstrap-token}
Use the following phase to configure bootstrap tokens.
## kubeadm init phase kubelet-finalize {#cmd-phase-kubelet-finalize-all}
Use the following phase to update settings relevant to the kubelet after TLS
bootstrap. You can use the `all` subcommand to run all `kubelet-finalize`
phases.
## kubeadm init phase addon {#cmd-phase-addon}
You can install all the available addons with the `all` subcommand, or
install them selectively.
For more details on each field in the `v1beta4` configuration you can navigate to our
[API reference pages.](/docs/reference/config-api/kubeadm-config.v1beta4/)
##
* [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/) to bootstrap a Kubernetes control-plane node
* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) to connect a node to the cluster
* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made to this host by `kubeadm init` or `kubeadm join`
* [kubeadm alpha](/docs/reference/setup-tools/kubeadm/kubeadm-alpha/) to try experimental functionality | kubernetes reference | title kubeadm init phase weight 90 content type concept kubeadm init phase enables you to invoke atomic steps of the bootstrap process Hence you can let kubeadm do some of the work and you can fill in the gaps if you wish to apply customization kubeadm init phase is consistent with the kubeadm init workflow docs reference setup tools kubeadm kubeadm init init workflow and behind the scene both use the same code kubeadm init phase preflight cmd phase preflight Using this command you can execute preflight checks on a control plane node kubeadm init phase kubelet start cmd phase kubelet start This phase will write the kubelet configuration file and environment file and then start the kubelet kubeadm init phase certs cmd phase certs Can be used to create all required certificates by kubeadm kubeadm init phase kubeconfig cmd phase kubeconfig You can create all required kubeconfig files by calling the all subcommand or call them individually kubeadm init phase control plane cmd phase control plane Using this phase you can create all required static Pod files for the control plane components kubeadm init phase etcd cmd phase etcd Use the following phase to create a local etcd instance based on a static Pod file kubeadm init phase upload config cmd phase upload config You can use this command to upload the kubeadm configuration to your cluster Alternatively you can use kubeadm config docs reference setup tools kubeadm kubeadm config kubeadm init phase upload certs cmd phase upload certs Use the following phase to upload control plane certificates to the cluster By default the certs and encryption key expire after two hours kubeadm init phase mark control plane cmd phase mark control plane Use the following phase to label and taint the node as a control plane node kubeadm init phase bootstrap token cmd phase bootstrap token Use the following phase to configure bootstrap tokens kubeadm init phase kubelet finalize cmd phase kubelet finalize all Use the following phase to update settings relevant to the kubelet after TLS bootstrap You can use the all subcommand to run all kubelet finalize phases kubeadm init phase addon cmd phase addon You can install all the available addons with the all subcommand or install them selectively For more details on each field in the v1beta4 configuration you can navigate to our API reference pages docs reference config api kubeadm config v1beta4 kubeadm init docs reference setup tools kubeadm kubeadm init to bootstrap a Kubernetes control plane node kubeadm join docs reference setup tools kubeadm kubeadm join to connect a node to the cluster kubeadm reset docs reference setup tools kubeadm kubeadm reset to revert any changes made to this host by kubeadm init or kubeadm join kubeadm alpha docs reference setup tools kubeadm kubeadm alpha to try experimental functionality |
kubernetes reference luxas weight 30 contenttype concept overview reviewers jbeda This command initializes a new Kubernetes node and joins it to the existing cluster title kubeadm join | ---
reviewers:
- luxas
- jbeda
title: kubeadm join
content_type: concept
weight: 30
---
<!-- overview -->
This command initializes a new Kubernetes node and joins it to the existing cluster.
<!-- body -->
### The join workflow {#join-workflow}
`kubeadm join` bootstraps a Kubernetes worker node or a control-plane node and adds it to the cluster.
This action consists of the following steps for worker nodes:
1. kubeadm downloads necessary cluster information from the API server.
By default, it uses the bootstrap token and the CA key hash to verify the
authenticity of that data. The root CA can also be discovered directly via a
file or URL.
1. Once the cluster information is known, kubelet can start the TLS bootstrapping
process.
The TLS bootstrap uses the shared token to temporarily authenticate
with the Kubernetes API server to submit a certificate signing request (CSR); by
default the control plane signs this CSR request automatically.
1. Finally, kubeadm configures the local kubelet to connect to the API
server with the definitive identity assigned to the node.
For control-plane nodes additional steps are performed:
1. Downloading certificates shared among control-plane nodes from the cluster
(if explicitly requested by the user).
1. Generating control-plane component manifests, certificates and kubeconfig.
1. Adding new local etcd member.
### Using join phases with kubeadm {#join-phases}
Kubeadm allows you join a node to the cluster in phases using `kubeadm join phase`.
To view the ordered list of phases and sub-phases you can call `kubeadm join --help`. The list will be located
at the top of the help screen and each phase will have a description next to it.
Note that by calling `kubeadm join` all of the phases and sub-phases will be executed in this exact order.
Some phases have unique flags, so if you want to have a look at the list of available options add `--help`, for example:
```shell
kubeadm join phase kubelet-start --help
```
Similar to the [kubeadm init phase](/docs/reference/setup-tools/kubeadm/kubeadm-init/#init-phases)
command, `kubeadm join phase` allows you to skip a list of phases using the `--skip-phases` flag.
For example:
```shell
sudo kubeadm join --skip-phases=preflight --config=config.yaml
```
Alternatively, you can use the `skipPhases` field in `JoinConfiguration`.
### Discovering what cluster CA to trust
The kubeadm discovery has several options, each with security tradeoffs.
The right method for your environment depends on how you provision nodes and the
security expectations you have about your network and node lifecycles.
#### Token-based discovery with CA pinning
This is the default mode in kubeadm. In this mode, kubeadm downloads
the cluster configuration (including root CA) and validates it using the token
as well as validating that the root CA public key matches the provided hash and
that the API server certificate is valid under the root CA.
The CA key hash has the format `sha256:<hex_encoded_hash>`.
By default, the hash value is printed at the end of the `kubeadm init` command or
in the output from the `kubeadm token create --print-join-command` command.
It is in a standard format (see [RFC7469](https://tools.ietf.org/html/rfc7469#section-2.4))
and can also be calculated by 3rd party tools or provisioning systems.
For example, using the OpenSSL CLI:
```shell
openssl x509 -pubkey -in /etc/kubernetes/pki/ca.crt | openssl rsa -pubin -outform der 2>/dev/null | openssl dgst -sha256 -hex | sed 's/^.* //'
```
**Example `kubeadm join` commands:**
For worker nodes:
```shell
kubeadm join --discovery-token abcdef.1234567890abcdef --discovery-token-ca-cert-hash sha256:1234..cdef 1.2.3.4:6443
```
For control-plane nodes:
```shell
kubeadm join --discovery-token abcdef.1234567890abcdef --discovery-token-ca-cert-hash sha256:1234..cdef --control-plane 1.2.3.4:6443
```
You can also call `join` for a control-plane node with `--certificate-key` to copy certificates to this node,
if the `kubeadm init` command was called with `--upload-certs`.
**Advantages:**
- Allows bootstrapping nodes to securely discover a root of trust for the
control-plane node even if other worker nodes or the network are compromised.
- Convenient to execute manually since all of the information required fits
into a single `kubeadm join` command.
**Disadvantages:**
- The CA hash is not normally known until the control-plane node has been provisioned,
which can make it more difficult to build automated provisioning tools that
use kubeadm. By generating your CA in beforehand, you may workaround this
limitation.
#### Token-based discovery without CA pinning
This mode relies only on the symmetric token to sign
(HMAC-SHA256) the discovery information that establishes the root of trust for
the control-plane. To use the mode the joining nodes must skip the hash validation of the
CA public key, using `--discovery-token-unsafe-skip-ca-verification`. You should consider
using one of the other modes if possible.
**Example `kubeadm join` command:**
```shell
kubeadm join --token abcdef.1234567890abcdef --discovery-token-unsafe-skip-ca-verification 1.2.3.4:6443
```
**Advantages:**
- Still protects against many network-level attacks.
- The token can be generated ahead of time and shared with the control-plane node and
worker nodes, which can then bootstrap in parallel without coordination. This
allows it to be used in many provisioning scenarios.
**Disadvantages:**
- If an attacker is able to steal a bootstrap token via some vulnerability,
they can use that token (along with network-level access) to impersonate the
control-plane node to other bootstrapping nodes. This may or may not be an appropriate
tradeoff in your environment.
#### File or HTTPS-based discovery
This provides an out-of-band way to establish a root of trust between the control-plane node
and bootstrapping nodes. Consider using this mode if you are building automated provisioning
using kubeadm. The format of the discovery file is a regular Kubernetes
[kubeconfig](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) file.
In case the discovery file does not contain credentials, the TLS discovery token will be used.
**Example `kubeadm join` commands:**
- `kubeadm join --discovery-file path/to/file.conf` (local file)
- `kubeadm join --discovery-file https://url/file.conf` (remote HTTPS URL)
**Advantages:**
- Allows bootstrapping nodes to securely discover a root of trust for the
control-plane node even if the network or other worker nodes are compromised.
**Disadvantages:**
- Requires that you have some way to carry the discovery information from
the control-plane node to the bootstrapping nodes. If the discovery file contains credentials
you must keep it secret and transfer it over a secure channel. This might be possible with your
cloud provider or provisioning tool.
#### Use of custom kubelet credentials with `kubeadm join`
To allow `kubeadm join` to use predefined kubelet credentials and skip client TLS bootstrap
and CSR approval for a new node:
1. From a working control plane node in the cluster that has `/etc/kubernetes/pki/ca.key`
execute `kubeadm kubeconfig user --org system:nodes --client-name system:node:$NODE > kubelet.conf`.
`$NODE` must be set to the name of the new node.
2. Modify the resulted `kubelet.conf` manually to adjust the cluster name and the server endpoint,
or run `kubeadm kubeconfig user --config` (it accepts `InitConfiguration`).
If your cluster does not have the `ca.key` file, you must sign the embedded certificates in
the `kubelet.conf` externally. For additional information, see
[PKI certificates and requirements](/docs/setup/best-practices/certificates/) and
[Certificate Management with kubeadm](/docs/tasks/administer-cluster/kubeadm/kubeadm-certs/#external-ca-mode).
1. Copy the resulting `kubelet.conf` to `/etc/kubernetes/kubelet.conf` on the new node.
2. Execute `kubeadm join` with the flag
`--ignore-preflight-errors=FileAvailable--etc-kubernetes-kubelet.conf` on the new node.
### Securing your installation even more {#securing-more}
The defaults for kubeadm may not work for everyone. This section documents how to tighten up a kubeadm installation
at the cost of some usability.
#### Turning off auto-approval of node client certificates
By default, there is a CSR auto-approver enabled that basically approves any client certificate request
for a kubelet when a Bootstrap Token was used when authenticating. If you don't want the cluster to
automatically approve kubelet client certs, you can turn it off by executing this command:
```shell
kubectl delete clusterrolebinding kubeadm:node-autoapprove-bootstrap
```
After that, `kubeadm join` will block until the admin has manually approved the CSR in flight:
1. Using `kubectl get csr`, you can see that the original CSR is in the Pending state.
```shell
kubectl get csr
```
The output is similar to this:
```
NAME AGE REQUESTOR CONDITION
node-csr-c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ 18s system:bootstrap:878f07 Pending
```
2. `kubectl certificate approve` allows the admin to approve CSR.This action tells a certificate signing
controller to issue a certificate to the requestor with the attributes requested in the CSR.
```shell
kubectl certificate approve node-csr-c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ
```
The output is similar to this:
```
certificatesigningrequest "node-csr-c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ" approved
```
3. This would change the CRS resource to Active state.
```shell
kubectl get csr
```
The output is similar to this:
```
NAME AGE REQUESTOR CONDITION
node-csr-c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ 1m system:bootstrap:878f07 Approved,Issued
```
This forces the workflow that `kubeadm join` will only succeed if `kubectl certificate approve` has been run.
#### Turning off public access to the `cluster-info` ConfigMap
In order to achieve the joining flow using the token as the only piece of validation information, a
ConfigMap with some data needed for validation of the control-plane node's identity is exposed publicly by
default. While there is no private data in this ConfigMap, some users might wish to turn
it off regardless. Doing so will disable the ability to use the `--discovery-token` flag of the
`kubeadm join` flow. Here are the steps to do so:
* Fetch the `cluster-info` file from the API Server:
```shell
kubectl -n kube-public get cm cluster-info -o jsonpath='{.data.kubeconfig}' | tee cluster-info.yaml
```
The output is similar to this:
```yaml
apiVersion: v1
kind: Config
clusters:
- cluster:
certificate-authority-data: <ca-cert>
server: https://<ip>:<port>
name: ""
contexts: []
current-context: ""
preferences: {}
users: []
```
* Use the `cluster-info.yaml` file as an argument to `kubeadm join --discovery-file`.
* Turn off public access to the `cluster-info` ConfigMap:
```shell
kubectl -n kube-public delete rolebinding kubeadm:bootstrap-signer-clusterinfo
```
These commands should be run after `kubeadm init` but before `kubeadm join`.
### Using kubeadm join with a configuration file {#config-file}
The config file is still considered beta and may change in future versions.
It's possible to configure `kubeadm join` with a configuration file instead of command
line flags, and some more advanced features may only be available as
configuration file options. This file is passed using the `--config` flag and it must
contain a `JoinConfiguration` structure. Mixing `--config` with others flags may not be
allowed in some cases.
The default configuration can be printed out using the
[kubeadm config print](/docs/reference/setup-tools/kubeadm/kubeadm-config/#cmd-config-print) command.
If your configuration is not using the latest version it is **recommended** that you migrate using
the [kubeadm config migrate](/docs/reference/setup-tools/kubeadm/kubeadm-config/#cmd-config-migrate) command.
For more information on the fields and usage of the configuration you can navigate to our
[API reference](/docs/reference/config-api/kubeadm-config.v1beta4/).
##
* [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/) to bootstrap a Kubernetes control-plane node.
* [kubeadm token](/docs/reference/setup-tools/kubeadm/kubeadm-token/) to manage tokens for `kubeadm join`.
* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made to this host by `kubeadm init` or `kubeadm join`. | kubernetes reference | reviewers luxas jbeda title kubeadm join content type concept weight 30 overview This command initializes a new Kubernetes node and joins it to the existing cluster body The join workflow join workflow kubeadm join bootstraps a Kubernetes worker node or a control plane node and adds it to the cluster This action consists of the following steps for worker nodes 1 kubeadm downloads necessary cluster information from the API server By default it uses the bootstrap token and the CA key hash to verify the authenticity of that data The root CA can also be discovered directly via a file or URL 1 Once the cluster information is known kubelet can start the TLS bootstrapping process The TLS bootstrap uses the shared token to temporarily authenticate with the Kubernetes API server to submit a certificate signing request CSR by default the control plane signs this CSR request automatically 1 Finally kubeadm configures the local kubelet to connect to the API server with the definitive identity assigned to the node For control plane nodes additional steps are performed 1 Downloading certificates shared among control plane nodes from the cluster if explicitly requested by the user 1 Generating control plane component manifests certificates and kubeconfig 1 Adding new local etcd member Using join phases with kubeadm join phases Kubeadm allows you join a node to the cluster in phases using kubeadm join phase To view the ordered list of phases and sub phases you can call kubeadm join help The list will be located at the top of the help screen and each phase will have a description next to it Note that by calling kubeadm join all of the phases and sub phases will be executed in this exact order Some phases have unique flags so if you want to have a look at the list of available options add help for example shell kubeadm join phase kubelet start help Similar to the kubeadm init phase docs reference setup tools kubeadm kubeadm init init phases command kubeadm join phase allows you to skip a list of phases using the skip phases flag For example shell sudo kubeadm join skip phases preflight config config yaml Alternatively you can use the skipPhases field in JoinConfiguration Discovering what cluster CA to trust The kubeadm discovery has several options each with security tradeoffs The right method for your environment depends on how you provision nodes and the security expectations you have about your network and node lifecycles Token based discovery with CA pinning This is the default mode in kubeadm In this mode kubeadm downloads the cluster configuration including root CA and validates it using the token as well as validating that the root CA public key matches the provided hash and that the API server certificate is valid under the root CA The CA key hash has the format sha256 hex encoded hash By default the hash value is printed at the end of the kubeadm init command or in the output from the kubeadm token create print join command command It is in a standard format see RFC7469 https tools ietf org html rfc7469 section 2 4 and can also be calculated by 3rd party tools or provisioning systems For example using the OpenSSL CLI shell openssl x509 pubkey in etc kubernetes pki ca crt openssl rsa pubin outform der 2 dev null openssl dgst sha256 hex sed s Example kubeadm join commands For worker nodes shell kubeadm join discovery token abcdef 1234567890abcdef discovery token ca cert hash sha256 1234 cdef 1 2 3 4 6443 For control plane nodes shell kubeadm join discovery token abcdef 1234567890abcdef discovery token ca cert hash sha256 1234 cdef control plane 1 2 3 4 6443 You can also call join for a control plane node with certificate key to copy certificates to this node if the kubeadm init command was called with upload certs Advantages Allows bootstrapping nodes to securely discover a root of trust for the control plane node even if other worker nodes or the network are compromised Convenient to execute manually since all of the information required fits into a single kubeadm join command Disadvantages The CA hash is not normally known until the control plane node has been provisioned which can make it more difficult to build automated provisioning tools that use kubeadm By generating your CA in beforehand you may workaround this limitation Token based discovery without CA pinning This mode relies only on the symmetric token to sign HMAC SHA256 the discovery information that establishes the root of trust for the control plane To use the mode the joining nodes must skip the hash validation of the CA public key using discovery token unsafe skip ca verification You should consider using one of the other modes if possible Example kubeadm join command shell kubeadm join token abcdef 1234567890abcdef discovery token unsafe skip ca verification 1 2 3 4 6443 Advantages Still protects against many network level attacks The token can be generated ahead of time and shared with the control plane node and worker nodes which can then bootstrap in parallel without coordination This allows it to be used in many provisioning scenarios Disadvantages If an attacker is able to steal a bootstrap token via some vulnerability they can use that token along with network level access to impersonate the control plane node to other bootstrapping nodes This may or may not be an appropriate tradeoff in your environment File or HTTPS based discovery This provides an out of band way to establish a root of trust between the control plane node and bootstrapping nodes Consider using this mode if you are building automated provisioning using kubeadm The format of the discovery file is a regular Kubernetes kubeconfig docs tasks access application cluster configure access multiple clusters file In case the discovery file does not contain credentials the TLS discovery token will be used Example kubeadm join commands kubeadm join discovery file path to file conf local file kubeadm join discovery file https url file conf remote HTTPS URL Advantages Allows bootstrapping nodes to securely discover a root of trust for the control plane node even if the network or other worker nodes are compromised Disadvantages Requires that you have some way to carry the discovery information from the control plane node to the bootstrapping nodes If the discovery file contains credentials you must keep it secret and transfer it over a secure channel This might be possible with your cloud provider or provisioning tool Use of custom kubelet credentials with kubeadm join To allow kubeadm join to use predefined kubelet credentials and skip client TLS bootstrap and CSR approval for a new node 1 From a working control plane node in the cluster that has etc kubernetes pki ca key execute kubeadm kubeconfig user org system nodes client name system node NODE kubelet conf NODE must be set to the name of the new node 2 Modify the resulted kubelet conf manually to adjust the cluster name and the server endpoint or run kubeadm kubeconfig user config it accepts InitConfiguration If your cluster does not have the ca key file you must sign the embedded certificates in the kubelet conf externally For additional information see PKI certificates and requirements docs setup best practices certificates and Certificate Management with kubeadm docs tasks administer cluster kubeadm kubeadm certs external ca mode 1 Copy the resulting kubelet conf to etc kubernetes kubelet conf on the new node 2 Execute kubeadm join with the flag ignore preflight errors FileAvailable etc kubernetes kubelet conf on the new node Securing your installation even more securing more The defaults for kubeadm may not work for everyone This section documents how to tighten up a kubeadm installation at the cost of some usability Turning off auto approval of node client certificates By default there is a CSR auto approver enabled that basically approves any client certificate request for a kubelet when a Bootstrap Token was used when authenticating If you don t want the cluster to automatically approve kubelet client certs you can turn it off by executing this command shell kubectl delete clusterrolebinding kubeadm node autoapprove bootstrap After that kubeadm join will block until the admin has manually approved the CSR in flight 1 Using kubectl get csr you can see that the original CSR is in the Pending state shell kubectl get csr The output is similar to this NAME AGE REQUESTOR CONDITION node csr c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ 18s system bootstrap 878f07 Pending 2 kubectl certificate approve allows the admin to approve CSR This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR shell kubectl certificate approve node csr c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ The output is similar to this certificatesigningrequest node csr c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ approved 3 This would change the CRS resource to Active state shell kubectl get csr The output is similar to this NAME AGE REQUESTOR CONDITION node csr c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ 1m system bootstrap 878f07 Approved Issued This forces the workflow that kubeadm join will only succeed if kubectl certificate approve has been run Turning off public access to the cluster info ConfigMap In order to achieve the joining flow using the token as the only piece of validation information a ConfigMap with some data needed for validation of the control plane node s identity is exposed publicly by default While there is no private data in this ConfigMap some users might wish to turn it off regardless Doing so will disable the ability to use the discovery token flag of the kubeadm join flow Here are the steps to do so Fetch the cluster info file from the API Server shell kubectl n kube public get cm cluster info o jsonpath data kubeconfig tee cluster info yaml The output is similar to this yaml apiVersion v1 kind Config clusters cluster certificate authority data ca cert server https ip port name contexts current context preferences users Use the cluster info yaml file as an argument to kubeadm join discovery file Turn off public access to the cluster info ConfigMap shell kubectl n kube public delete rolebinding kubeadm bootstrap signer clusterinfo These commands should be run after kubeadm init but before kubeadm join Using kubeadm join with a configuration file config file The config file is still considered beta and may change in future versions It s possible to configure kubeadm join with a configuration file instead of command line flags and some more advanced features may only be available as configuration file options This file is passed using the config flag and it must contain a JoinConfiguration structure Mixing config with others flags may not be allowed in some cases The default configuration can be printed out using the kubeadm config print docs reference setup tools kubeadm kubeadm config cmd config print command If your configuration is not using the latest version it is recommended that you migrate using the kubeadm config migrate docs reference setup tools kubeadm kubeadm config cmd config migrate command For more information on the fields and usage of the configuration you can navigate to our API reference docs reference config api kubeadm config v1beta4 kubeadm init docs reference setup tools kubeadm kubeadm init to bootstrap a Kubernetes control plane node kubeadm token docs reference setup tools kubeadm kubeadm token to manage tokens for kubeadm join kubeadm reset docs reference setup tools kubeadm kubeadm reset to revert any changes made to this host by kubeadm init or kubeadm join |
kubernetes reference The file is auto generated from the Go source code of the component using a generic To learn how To update the reference content please follow the to generate the reference documentation please read project guide You can file document formatting bugs against the | <!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
Output shell completion code for the specified shell (bash or zsh)
### Synopsis
Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive
completion of kubeadm commands. This can be done by sourcing it from
the .bash_profile.
Note: this requires the bash-completion framework.
To install it on Mac use homebrew:
$ brew install bash-completion
Once installed, bash_completion must be evaluated. This can be done by adding the
following line to the .bash_profile
$ source $(brew --prefix)/etc/bash_completion
If bash-completion is not installed on Linux, please install the 'bash-completion' package
via your distribution's package manager.
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
```
kubeadm completion SHELL [flags]
```
### Examples
```
# Install bash completion on a Mac using homebrew
brew install bash-completion
printf "\n# Bash completion support\nsource $(brew --prefix)/etc/bash_completion\n" >> $HOME/.bash_profile
source $HOME/.bash_profile
# Load the kubeadm completion code for bash into the current shell
source <(kubeadm completion bash)
# Write bash completion code to a file and source it from .bash_profile
kubeadm completion bash > ~/.kube/kubeadm_completion.bash.inc
printf "\n# Kubeadm shell completion\nsource '$HOME/.kube/kubeadm_completion.bash.inc'\n" >> $HOME/.bash_profile
source $HOME/.bash_profile
# Load the kubeadm completion code for zsh[1] into the current shell
source <(kubeadm completion zsh)
```
### Options
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for completion</p></td>
</tr>
</tbody>
</table>
### Options inherited from parent commands
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--rootfs string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path to the 'real' host root filesystem. This will cause kubeadm to chroot into the provided path.</p></td>
</tr>
</tbody>
</table>
| kubernetes reference | The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Output shell completion code for the specified shell bash or zsh Synopsis Output shell completion code for the specified shell bash or zsh The shell code must be evaluated to provide interactive completion of kubeadm commands This can be done by sourcing it from the bash profile Note this requires the bash completion framework To install it on Mac use homebrew brew install bash completion Once installed bash completion must be evaluated This can be done by adding the following line to the bash profile source brew prefix etc bash completion If bash completion is not installed on Linux please install the bash completion package via your distribution s package manager Note for zsh users 1 zsh completions are only supported in versions of zsh gt 5 2 kubeadm completion SHELL flags Examples Install bash completion on a Mac using homebrew brew install bash completion printf n Bash completion support nsource brew prefix etc bash completion n HOME bash profile source HOME bash profile Load the kubeadm completion code for bash into the current shell source kubeadm completion bash Write bash completion code to a file and source it from bash profile kubeadm completion bash kube kubeadm completion bash inc printf n Kubeadm shell completion nsource HOME kube kubeadm completion bash inc n HOME bash profile source HOME bash profile Load the kubeadm completion code for zsh 1 into the current shell source kubeadm completion zsh Options table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for completion p td tr tbody table Options inherited from parent commands table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 rootfs string td tr tr td td td style line height 130 word wrap break word p The path to the real host root filesystem This will cause kubeadm to chroot into the provided path p td tr tbody table |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference title kube apiserver weight 30 autogenerated true | ---
title: kube-apiserver
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
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]
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--admission-control-config-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File with admission control configuration.</p></td>
</tr>
<tr>
<td colspan="2">--advertise-address string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--aggregator-reject-forwarding-redirect Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Aggregator reject forwarding redirect response back to client.</p></td>
</tr>
<tr>
<td colspan="2">--allow-metric-labels stringToString Default: []</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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'.</p></td>
</tr>
<tr>
<td colspan="2">--allow-metric-labels-manifest string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path to the manifest file that contains the allow-list mapping. The format of the file is the same as the flag --allow-metric-labels. Note that the flag --allow-metric-labels will override the manifest file.</p></td>
</tr>
<tr>
<td colspan="2">--allow-privileged</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, allow privileged containers. [default=false]</p></td>
</tr>
<tr>
<td colspan="2">--anonymous-auth Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--api-audiences strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-batch-buffer-size int Default: 10000</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The size of the buffer to store events before batching and writing. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-batch-max-size int Default: 1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The maximum size of a batch. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-batch-max-wait duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-batch-throttle-burst int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-batch-throttle-enable</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Whether batching throttling is enabled. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-batch-throttle-qps float</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum average number of batches per second. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-compress</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If set, the rotated log files will be compressed using gzip.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-format string Default: "json"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Format of saved audits. "legacy" indicates 1-line text format for each event. "json" indicates structured json format. Known formats are legacy,json.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-maxage int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-maxbackup int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The maximum number of old audit log files to retain. Setting a value of 0 will mean there's no restriction on the number of files.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-maxsize int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The maximum size in megabytes of the audit log file before it gets rotated.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-mode string Default: "blocking"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-path string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If set, all requests coming to the apiserver will be logged to this file. '-' means standard out.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-truncate-enabled</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Whether event and batch truncating is enabled.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-truncate-max-batch-size int Default: 10485760</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-truncate-max-event-size int Default: 102400</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--audit-log-version string Default: "audit.k8s.io/v1"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>API group and version used for serializing audit events written to log.</p></td>
</tr>
<tr>
<td colspan="2">--audit-policy-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the file that defines the audit policy configuration.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-batch-buffer-size int Default: 10000</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The size of the buffer to store events before batching and writing. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-batch-max-size int Default: 400</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The maximum size of a batch. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-batch-max-wait duration Default: 30s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-batch-throttle-burst int Default: 15</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-batch-throttle-enable Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Whether batching throttling is enabled. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-batch-throttle-qps float Default: 10</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum average number of batches per second. Only used in batch mode.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-config-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a kubeconfig formatted file that defines the audit webhook configuration.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-initial-backoff duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The amount of time to wait before retrying the first failed request.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-mode string Default: "batch"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-truncate-enabled</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Whether event and batch truncating is enabled.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-truncate-max-batch-size int Default: 10485760</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-truncate-max-event-size int Default: 102400</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--audit-webhook-version string Default: "audit.k8s.io/v1"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>API group and version used for serializing audit events written to webhook.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File with Authentication Configuration to configure the JWT Token authenticator or the anonymous authenticator. Note: This feature is in Alpha since v1.29.--feature-gate=StructuredAuthenticationConfiguration=true needs to be set for enabling this feature.This feature is mutually exclusive with the oidc-* flags.To configure anonymous authenticator you need to enable --feature-gate=AnonymousAuthConfigurableEndpoints.When you configure anonymous authenticator in the authentication config you cannot use the --anonymous-auth flag.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-token-webhook-cache-ttl duration Default: 2m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration to cache responses from the webhook token authenticator.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-token-webhook-config-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-token-webhook-version string Default: "v1beta1"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The API version of the authentication.k8s.io TokenReview to send to and expect from the webhook.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File with Authorization Configuration to configure the authorizer chain.Note: This feature is in Alpha since v1.29.--feature-gate=StructuredAuthorizationConfiguration=true feature flag needs to be set to true for enabling the functionality.This feature is mutually exclusive with the other --authorization-mode and --authorization-webhook-* flags.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-mode strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Ordered list of plug-ins to do authorization on secure port. Defaults to AlwaysAllow if --authorization-config is not used. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC,Node.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-policy-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File with authorization policy in json line by line format, used with --authorization-mode=ABAC, on the secure port.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-cache-authorized-ttl duration Default: 5m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration to cache 'authorized' responses from the webhook authorizer.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-cache-unauthorized-ttl duration Default: 30s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration to cache 'unauthorized' responses from the webhook authorizer.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-config-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-version string Default: "v1beta1"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The API version of the authorization.k8s.io SubjectAccessReview to send to and expect from the webhook.</p></td>
</tr>
<tr>
<td colspan="2">--bind-address string Default: 0.0.0.0</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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 and IP address families will be used.</p></td>
</tr>
<tr>
<td colspan="2">--cert-dir string Default: "/var/run/kubernetes"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.</p></td>
</tr>
<tr>
<td colspan="2">--client-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--contention-profiling</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enable block profiling, if profiling is enabled</p></td>
</tr>
<tr>
<td colspan="2">--cors-allowed-origins strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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. Please ensure each expression matches the entire hostname by anchoring to the start with '^' or including the '//' prefix, and by anchoring to the end with '$' or including the ':' port separator suffix. Examples of valid expressions are '//example.com(:|$)' and '^https://example.com(:|$)'</p></td>
</tr>
<tr>
<td colspan="2">--debug-socket-path string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Use an unprotected (no authn/authz) unix-domain socket for profiling with the given path</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--delete-collection-workers int Default: 1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup.</p></td>
</tr>
<tr>
<td colspan="2">--disable-admission-plugins strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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, ClusterTrustBundleAttest, CertificateSubjectRestriction, DefaultIngressClass, MutatingAdmissionWebhook, ValidatingAdmissionPolicy, ValidatingAdmissionWebhook, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, ClusterTrustBundleAttest, DefaultIngressClass, DefaultStorageClass, DefaultTolerationSeconds, DenyServiceExternalIPs, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PodNodeSelector, PodSecurity, PodTolerationRestriction, Priority, ResourceQuota, RuntimeClass, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionPolicy, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.</p></td>
</tr>
<tr>
<td colspan="2">--disable-http2-serving</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, HTTP2 serving will be disabled [default=false]</p></td>
</tr>
<tr>
<td colspan="2">--disabled-metrics strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--egress-selector-config-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File with apiserver egress selector configuration.</p></td>
</tr>
<tr>
<td colspan="2">--emulated-version strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The versions different components emulate their capabilities (APIs, features, ...) of.<br/>If set, the component will emulate the behavior of this version instead of the underlying binary version.<br/>Version format could only be major.minor, for example: '--emulated-version=wardle=1.2,kube=1.31'. Options are:<br/>kube=1.31..1.31 (default=1.31)If the component is not specified, defaults to "kube"</p></td>
</tr>
<tr>
<td colspan="2">--enable-admission-plugins strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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, ClusterTrustBundleAttest, CertificateSubjectRestriction, DefaultIngressClass, MutatingAdmissionWebhook, ValidatingAdmissionPolicy, ValidatingAdmissionWebhook, ResourceQuota). Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, CertificateApproval, CertificateSigning, CertificateSubjectRestriction, ClusterTrustBundleAttest, DefaultIngressClass, DefaultStorageClass, DefaultTolerationSeconds, DenyServiceExternalIPs, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PodNodeSelector, PodSecurity, PodTolerationRestriction, Priority, ResourceQuota, RuntimeClass, ServiceAccount, StorageObjectInUseProtection, TaintNodesByCondition, ValidatingAdmissionPolicy, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.</p></td>
</tr>
<tr>
<td colspan="2">--enable-aggregator-routing</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Turns on aggregator routing requests to endpoints IP rather than cluster IP.</p></td>
</tr>
<tr>
<td colspan="2">--enable-bootstrap-token-auth</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enable to allow secrets of type 'bootstrap.kubernetes.io/token' in the 'kube-system' namespace to be used for TLS bootstrapping authentication.</p></td>
</tr>
<tr>
<td colspan="2">--enable-garbage-collector Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager.</p></td>
</tr>
<tr>
<td colspan="2">--enable-priority-and-fairness Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, replace the max-in-flight handler with an enhanced one that queues and dispatches with priority and fairness</p></td>
</tr>
<tr>
<td colspan="2">--encryption-provider-config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The file containing configuration for encryption providers to be used for storing secrets in etcd</p></td>
</tr>
<tr>
<td colspan="2">--encryption-provider-config-automatic-reload</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Determines if the file set by --encryption-provider-config should be automatically reloaded if the disk contents change. Setting this to true disables the ability to uniquely identify distinct KMS plugins via the API server healthz endpoints.</p></td>
</tr>
<tr>
<td colspan="2">--endpoint-reconciler-type string Default: "lease"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Use an endpoint reconciler (master-count, lease, none) master-count is deprecated, and will be removed in a future version.</p></td>
</tr>
<tr>
<td colspan="2">--etcd-cafile string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>SSL Certificate Authority file used to secure etcd communication.</p></td>
</tr>
<tr>
<td colspan="2">--etcd-certfile string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>SSL certification file used to secure etcd communication.</p></td>
</tr>
<tr>
<td colspan="2">--etcd-compaction-interval duration Default: 5m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The interval of compaction requests. If 0, the compaction request from apiserver is disabled.</p></td>
</tr>
<tr>
<td colspan="2">--etcd-count-metric-poll-period duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Frequency of polling etcd for number of resources per type. 0 disables the metric collection.</p></td>
</tr>
<tr>
<td colspan="2">--etcd-db-metric-poll-interval duration Default: 30s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The interval of requests to poll etcd and update metric. 0 disables the metric collection</p></td>
</tr>
<tr>
<td colspan="2">--etcd-healthcheck-timeout duration Default: 2s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The timeout to use when checking etcd health.</p></td>
</tr>
<tr>
<td colspan="2">--etcd-keyfile string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>SSL key file used to secure etcd communication.</p></td>
</tr>
<tr>
<td colspan="2">--etcd-prefix string Default: "/registry"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The prefix to prepend to all resource paths in etcd.</p></td>
</tr>
<tr>
<td colspan="2">--etcd-readycheck-timeout duration Default: 2s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The timeout to use when checking etcd readiness</p></td>
</tr>
<tr>
<td colspan="2">--etcd-servers strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of etcd servers to connect with (scheme://ip:port), comma separated.</p></td>
</tr>
<tr>
<td colspan="2">--etcd-servers-overrides strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--event-ttl duration Default: 1h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Amount of time to retain events.</p></td>
</tr>
<tr>
<td colspan="2">--external-hostname string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs or OpenID Discovery).</p></td>
</tr>
<tr>
<td colspan="2">--feature-gates colonSeparatedMultimapStringString</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Comma-separated list of component:key=value pairs that describe feature gates for alpha/experimental features of different components.<br/>If the component is not specified, defaults to "kube". This flag can be repeatedly invoked. For example: --feature-gates 'wardle:featureA=true,wardle:featureB=false' --feature-gates 'kube:featureC=true'Options are:<br/>kube:APIResponseCompression=true|false (BETA - default=true)<br/>kube:APIServerIdentity=true|false (BETA - default=true)<br/>kube:APIServerTracing=true|false (BETA - default=true)<br/>kube:APIServingWithRoutine=true|false (ALPHA - default=false)<br/>kube:AllAlpha=true|false (ALPHA - default=false)<br/>kube:AllBeta=true|false (BETA - default=false)<br/>kube:AnonymousAuthConfigurableEndpoints=true|false (ALPHA - default=false)<br/>kube:AnyVolumeDataSource=true|false (BETA - default=true)<br/>kube:AuthorizeNodeWithSelectors=true|false (ALPHA - default=false)<br/>kube:AuthorizeWithSelectors=true|false (ALPHA - default=false)<br/>kube:CPUManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>kube:CPUManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>kube:CPUManagerPolicyOptions=true|false (BETA - default=true)<br/>kube:CRDValidationRatcheting=true|false (BETA - default=true)<br/>kube:CSIMigrationPortworx=true|false (BETA - default=true)<br/>kube:CSIVolumeHealth=true|false (ALPHA - default=false)<br/>kube:CloudControllerManagerWebhook=true|false (ALPHA - default=false)<br/>kube:ClusterTrustBundle=true|false (ALPHA - default=false)<br/>kube:ClusterTrustBundleProjection=true|false (ALPHA - default=false)<br/>kube:ComponentSLIs=true|false (BETA - default=true)<br/>kube:ConcurrentWatchObjectDecode=true|false (BETA - default=false)<br/>kube:ConsistentListFromCache=true|false (BETA - default=true)<br/>kube:ContainerCheckpoint=true|false (BETA - default=true)<br/>kube:ContextualLogging=true|false (BETA - default=true)<br/>kube:CoordinatedLeaderElection=true|false (ALPHA - default=false)<br/>kube:CronJobsScheduledAnnotation=true|false (BETA - default=true)<br/>kube:CrossNamespaceVolumeDataSource=true|false (ALPHA - default=false)<br/>kube:CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)<br/>kube:CustomResourceFieldSelectors=true|false (BETA - default=true)<br/>kube:DRAControlPlaneController=true|false (ALPHA - default=false)<br/>kube:DisableAllocatorDualWrite=true|false (ALPHA - default=false)<br/>kube:DisableNodeKubeProxyVersion=true|false (BETA - default=true)<br/>kube:DynamicResourceAllocation=true|false (ALPHA - default=false)<br/>kube:EventedPLEG=true|false (ALPHA - default=false)<br/>kube:GracefulNodeShutdown=true|false (BETA - default=true)<br/>kube:GracefulNodeShutdownBasedOnPodPriority=true|false (BETA - default=true)<br/>kube:HPAScaleToZero=true|false (ALPHA - default=false)<br/>kube:HonorPVReclaimPolicy=true|false (BETA - default=true)<br/>kube:ImageMaximumGCAge=true|false (BETA - default=true)<br/>kube:ImageVolume=true|false (ALPHA - default=false)<br/>kube:InPlacePodVerticalScaling=true|false (ALPHA - default=false)<br/>kube:InTreePluginPortworxUnregister=true|false (ALPHA - default=false)<br/>kube:InformerResourceVersion=true|false (ALPHA - default=false)<br/>kube:JobBackoffLimitPerIndex=true|false (BETA - default=true)<br/>kube:JobManagedBy=true|false (ALPHA - default=false)<br/>kube:JobPodReplacementPolicy=true|false (BETA - default=true)<br/>kube:JobSuccessPolicy=true|false (BETA - default=true)<br/>kube:KubeletCgroupDriverFromCRI=true|false (BETA - default=true)<br/>kube:KubeletInUserNamespace=true|false (ALPHA - default=false)<br/>kube:KubeletPodResourcesDynamicResources=true|false (ALPHA - default=false)<br/>kube:KubeletPodResourcesGet=true|false (ALPHA - default=false)<br/>kube:KubeletSeparateDiskGC=true|false (BETA - default=true)<br/>kube:KubeletTracing=true|false (BETA - default=true)<br/>kube:LoadBalancerIPMode=true|false (BETA - default=true)<br/>kube:LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (BETA - default=false)<br/>kube:LoggingAlphaOptions=true|false (ALPHA - default=false)<br/>kube:LoggingBetaOptions=true|false (BETA - default=true)<br/>kube:MatchLabelKeysInPodAffinity=true|false (BETA - default=true)<br/>kube:MatchLabelKeysInPodTopologySpread=true|false (BETA - default=true)<br/>kube:MaxUnavailableStatefulSet=true|false (ALPHA - default=false)<br/>kube:MemoryManager=true|false (BETA - default=true)<br/>kube:MemoryQoS=true|false (ALPHA - default=false)<br/>kube:MultiCIDRServiceAllocator=true|false (BETA - default=false)<br/>kube:MutatingAdmissionPolicy=true|false (ALPHA - default=false)<br/>kube:NFTablesProxyMode=true|false (BETA - default=true)<br/>kube:NodeInclusionPolicyInPodTopologySpread=true|false (BETA - default=true)<br/>kube:NodeLogQuery=true|false (BETA - default=false)<br/>kube:NodeSwap=true|false (BETA - default=true)<br/>kube:OpenAPIEnums=true|false (BETA - default=true)<br/>kube:PodAndContainerStatsFromCRI=true|false (ALPHA - default=false)<br/>kube:PodDeletionCost=true|false (BETA - default=true)<br/>kube:PodIndexLabel=true|false (BETA - default=true)<br/>kube:PodLifecycleSleepAction=true|false (BETA - default=true)<br/>kube:PodReadyToStartContainersCondition=true|false (BETA - default=true)<br/>kube:PortForwardWebsockets=true|false (BETA - default=true)<br/>kube:ProcMountType=true|false (BETA - default=false)<br/>kube:QOSReserved=true|false (ALPHA - default=false)<br/>kube:RecoverVolumeExpansionFailure=true|false (ALPHA - default=false)<br/>kube:RecursiveReadOnlyMounts=true|false (BETA - default=true)<br/>kube:RelaxedEnvironmentVariableValidation=true|false (ALPHA - default=false)<br/>kube:ReloadKubeletServerCertificateFile=true|false (BETA - default=true)<br/>kube:ResilientWatchCacheInitialization=true|false (BETA - default=true)<br/>kube:ResourceHealthStatus=true|false (ALPHA - default=false)<br/>kube:RetryGenerateName=true|false (BETA - default=true)<br/>kube:RotateKubeletServerCertificate=true|false (BETA - default=true)<br/>kube:RuntimeClassInImageCriApi=true|false (ALPHA - default=false)<br/>kube:SELinuxMount=true|false (ALPHA - default=false)<br/>kube:SELinuxMountReadWriteOncePod=true|false (BETA - default=true)<br/>kube:SchedulerQueueingHints=true|false (BETA - default=false)<br/>kube:SeparateCacheWatchRPC=true|false (BETA - default=true)<br/>kube:SeparateTaintEvictionController=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenJTI=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenNodeBinding=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenNodeBindingValidation=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenPodNodeInfo=true|false (BETA - default=true)<br/>kube:ServiceTrafficDistribution=true|false (BETA - default=true)<br/>kube:SidecarContainers=true|false (BETA - default=true)<br/>kube:SizeMemoryBackedVolumes=true|false (BETA - default=true)<br/>kube:StatefulSetAutoDeletePVC=true|false (BETA - default=true)<br/>kube:StorageNamespaceIndex=true|false (BETA - default=true)<br/>kube:StorageVersionAPI=true|false (ALPHA - default=false)<br/>kube:StorageVersionHash=true|false (BETA - default=true)<br/>kube:StorageVersionMigrator=true|false (ALPHA - default=false)<br/>kube:StrictCostEnforcementForVAP=true|false (BETA - default=false)<br/>kube:StrictCostEnforcementForWebhooks=true|false (BETA - default=false)<br/>kube:StructuredAuthenticationConfiguration=true|false (BETA - default=true)<br/>kube:StructuredAuthorizationConfiguration=true|false (BETA - default=true)<br/>kube:SupplementalGroupsPolicy=true|false (ALPHA - default=false)<br/>kube:TopologyAwareHints=true|false (BETA - default=true)<br/>kube:TopologyManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>kube:TopologyManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>kube:TopologyManagerPolicyOptions=true|false (BETA - default=true)<br/>kube:TranslateStreamCloseWebsocketRequests=true|false (BETA - default=true)<br/>kube:UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=true)<br/>kube:UnknownVersionInteroperabilityProxy=true|false (ALPHA - default=false)<br/>kube:UserNamespacesPodSecurityStandards=true|false (ALPHA - default=false)<br/>kube:UserNamespacesSupport=true|false (BETA - default=false)<br/>kube:VolumeAttributesClass=true|false (BETA - default=false)<br/>kube:VolumeCapacityPriority=true|false (ALPHA - default=false)<br/>kube:WatchCacheInitializationPostStartHook=true|false (BETA - default=false)<br/>kube:WatchFromStorageWithoutResourceVersion=true|false (BETA - default=false)<br/>kube:WatchList=true|false (ALPHA - default=false)<br/>kube:WatchListClient=true|false (BETA - default=false)<br/>kube:WinDSR=true|false (ALPHA - default=false)<br/>kube:WinOverlay=true|false (BETA - default=true)<br/>kube:WindowsHostNetwork=true|false (ALPHA - default=true)</p></td>
</tr>
<tr>
<td colspan="2">--goaway-chance float</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for kube-apiserver</p></td>
</tr>
<tr>
<td colspan="2">--http2-max-streams-per-connection int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--kubelet-certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority.</p></td>
</tr>
<tr>
<td colspan="2">--kubelet-client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client cert file for TLS.</p></td>
</tr>
<tr>
<td colspan="2">--kubelet-client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS.</p></td>
</tr>
<tr>
<td colspan="2">--kubelet-preferred-address-types strings Default: "Hostname,InternalDNS,InternalIP,ExternalDNS,ExternalIP"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of the preferred NodeAddressTypes to use for kubelet connections.</p></td>
</tr>
<tr>
<td colspan="2">--kubelet-timeout duration Default: 5s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Timeout for kubelet operations.</p></td>
</tr>
<tr>
<td colspan="2">--kubernetes-service-node-port int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--lease-reuse-duration-seconds int Default: 60</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--livez-grace-period duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--log-flush-frequency duration Default: 5s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum number of seconds between log flushes</p></td>
</tr>
<tr>
<td colspan="2">--log-text-info-buffer-size quantity</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this.</p></td>
</tr>
<tr>
<td colspan="2">--log-text-split-stream</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[Alpha] In text format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this.</p></td>
</tr>
<tr>
<td colspan="2">--logging-format string Default: "text"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Sets the log format. Permitted formats: "text".</p></td>
</tr>
<tr>
<td colspan="2">--max-connection-bytes-per-sec int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests.</p></td>
</tr>
<tr>
<td colspan="2">--max-mutating-requests-inflight int Default: 200</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--max-requests-inflight int Default: 400</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--min-request-timeout int Default: 1800</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--oidc-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--oidc-client-id string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.</p></td>
</tr>
<tr>
<td colspan="2">--oidc-groups-claim string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--oidc-groups-prefix string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies.</p></td>
</tr>
<tr>
<td colspan="2">--oidc-issuer-url string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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).</p></td>
</tr>
<tr>
<td colspan="2">--oidc-required-claim <comma-separated 'key=value' pairs></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--oidc-signing-algs strings Default: "RS256"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Comma-separated list of allowed JOSE asymmetric signing algorithms. JWTs with a supported 'alg' header values are: RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512. Values are defined by RFC 7518 https://tools.ietf.org/html/rfc7518#section-3.1.</p></td>
</tr>
<tr>
<td colspan="2">--oidc-username-claim string Default: "sub"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--oidc-username-prefix string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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 '-'.</p></td>
</tr>
<tr>
<td colspan="2">--peer-advertise-ip string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If set and the UnknownVersionInteroperabilityProxy feature gate is enabled, this IP will be used by peer kube-apiservers to proxy requests to this kube-apiserver when the request cannot be handled by the peer due to version skew between the kube-apiservers. This flag is only used in clusters configured with multiple kube-apiservers for high availability.</p></td>
</tr>
<tr>
<td colspan="2">--peer-advertise-port string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If set and the UnknownVersionInteroperabilityProxy feature gate is enabled, this port will be used by peer kube-apiservers to proxy requests to this kube-apiserver when the request cannot be handled by the peer due to version skew between the kube-apiservers. This flag is only used in clusters configured with multiple kube-apiservers for high availability.</p></td>
</tr>
<tr>
<td colspan="2">--peer-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If set and the UnknownVersionInteroperabilityProxy feature gate is enabled, this file will be used to verify serving certificates of peer kube-apiservers. This flag is only used in clusters configured with multiple kube-apiservers for high availability.</p></td>
</tr>
<tr>
<td colspan="2">--permit-address-sharing</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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]</p></td>
</tr>
<tr>
<td colspan="2">--permit-port-sharing</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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]</p></td>
</tr>
<tr>
<td colspan="2">--profiling Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enable profiling via web interface host:port/debug/pprof/</p></td>
</tr>
<tr>
<td colspan="2">--proxy-client-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--proxy-client-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-allowed-names strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-client-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-extra-headers-prefix strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of request header prefixes to inspect. X-Remote-Extra- is suggested.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-group-headers strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of request headers to inspect for groups. X-Remote-Group is suggested.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-username-headers strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of request headers to inspect for usernames. X-Remote-User is common.</p></td>
</tr>
<tr>
<td colspan="2">--runtime-config <comma-separated 'key=value' pairs></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that enable or disable built-in APIs. Supported options are:<br/>v1=true|false for the core API group<br/><group>/<version>=true|false for a specific API group and version (e.g. apps/v1=true)<br/>api/all=true|false controls all API versions<br/>api/ga=true|false controls all API versions of the form v[0-9]+<br/>api/beta=true|false controls all API versions of the form v[0-9]+beta[0-9]+<br/>api/alpha=true|false controls all API versions of the form v[0-9]+alpha[0-9]+<br/>api/legacy is deprecated, and will be removed in a future version</p></td>
</tr>
<tr>
<td colspan="2">--secure-port int Default: 6443</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The port on which to serve HTTPS with authentication and authorization. It cannot be switched off with 0.</p></td>
</tr>
<tr>
<td colspan="2">--service-account-extend-token-expiration Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--service-account-issuer strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--service-account-jwks-uri string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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).</p></td>
</tr>
<tr>
<td colspan="2">--service-account-key-file strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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-file is provided</p></td>
</tr>
<tr>
<td colspan="2">--service-account-lookup Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, validate ServiceAccount tokens exist in etcd as part of authentication.</p></td>
</tr>
<tr>
<td colspan="2">--service-account-max-token-expiration duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--service-account-signing-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--service-cluster-ip-range string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--service-node-port-range <a string in the form 'N1-N2'> Default: 30000-32767</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A port range to reserve for services with NodePort visibility. This must not overlap with the ephemeral port range on nodes. Example: '30000-32767'. Inclusive at both ends of the range.</p></td>
</tr>
<tr>
<td colspan="2">--show-hidden-metrics-for-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--shutdown-delay-duration duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--shutdown-send-retry-after</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true the HTTP Server will continue listening until all non long running request(s) in flight have been drained, during this window all incoming requests will be rejected with a status code 429 and a 'Retry-After' response header, in addition 'Connection: close' response header is set in order to tear down the TCP connection when idle.</p></td>
</tr>
<tr>
<td colspan="2">--shutdown-watch-termination-grace-period duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>This option, if set, represents the maximum amount of grace period the apiserver will wait for active watch request(s) to drain during the graceful server shutdown window.</p></td>
</tr>
<tr>
<td colspan="2">--storage-backend string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The storage backend for persistence. Options: 'etcd3' (default).</p></td>
</tr>
<tr>
<td colspan="2">--storage-initialization-timeout duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum amount of time to wait for storage initialization before declaring apiserver ready. Defaults to 1m.</p></td>
</tr>
<tr>
<td colspan="2">--storage-media-type string Default: "application/vnd.kubernetes.protobuf"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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. Supported media types: [application/json, application/yaml, application/vnd.kubernetes.protobuf]</p></td>
</tr>
<tr>
<td colspan="2">--strict-transport-security-directives strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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'</p></td>
</tr>
<tr>
<td colspan="2">--tls-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--tls-cipher-suites strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used.<br/>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_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.<br/>Insecure values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_RC4_128_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_RC4_128_SHA.</p></td>
</tr>
<tr>
<td colspan="2">--tls-min-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13</p></td>
</tr>
<tr>
<td colspan="2">--tls-private-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File containing the default x509 private key matching --tls-cert-file.</p></td>
</tr>
<tr>
<td colspan="2">--tls-sni-cert-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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".</p></td>
</tr>
<tr>
<td colspan="2">--token-auth-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If set, the file that will be used to secure the secure port of the API server via token authentication.</p></td>
</tr>
<tr>
<td colspan="2">--tracing-config-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File with apiserver tracing configuration.</p></td>
</tr>
<tr>
<td colspan="2">-v, --v int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>number for the log level verbosity</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--vmodule pattern=N,...</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)</p></td>
</tr>
<tr>
<td colspan="2">--watch-cache Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enable watch caching in the apiserver</p></td>
</tr>
<tr>
<td colspan="2">--watch-cache-sizes strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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. This option is only meaningful for resources built into the apiserver, not ones defined by CRDs or aggregated from external servers, and is only consulted if the watch-cache is enabled. The only meaningful size setting to supply here is zero, which means to disable watch caching for the associated resource; all non-zero values are equivalent and mean to not disable watch caching for that resource</p></td>
</tr>
</tbody>
</table>
| kubernetes reference | title kube apiserver content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project 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 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 admission control config file string td tr tr td td td style line height 130 word wrap break word p File with admission control configuration p td tr tr td colspan 2 advertise address string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 aggregator reject forwarding redirect nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Aggregator reject forwarding redirect response back to client p td tr tr td colspan 2 allow metric labels stringToString nbsp nbsp nbsp nbsp nbsp Default td tr tr td td td style line height 130 word wrap break word p The map from metric label to value allow list of this label The key s format is lt MetricName gt lt LabelName gt The value s format is lt allowed value gt lt allowed value gt e g metric1 label1 v1 v2 v3 metric1 label2 v1 v2 v3 metric2 label1 v1 v2 v3 p td tr tr td colspan 2 allow metric labels manifest string td tr tr td td td style line height 130 word wrap break word p The path to the manifest file that contains the allow list mapping The format of the file is the same as the flag allow metric labels Note that the flag allow metric labels will override the manifest file p td tr tr td colspan 2 allow privileged td tr tr td td td style line height 130 word wrap break word p If true allow privileged containers default false p td tr tr td colspan 2 anonymous auth nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 api audiences strings td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 audit log batch buffer size int nbsp nbsp nbsp nbsp nbsp Default 10000 td tr tr td td td style line height 130 word wrap break word p The size of the buffer to store events before batching and writing Only used in batch mode p td tr tr td colspan 2 audit log batch max size int nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p The maximum size of a batch Only used in batch mode p td tr tr td colspan 2 audit log batch max wait duration td tr tr td td td style line height 130 word wrap break word p The amount of time to wait before force writing the batch that hadn t reached the max size Only used in batch mode p td tr tr td colspan 2 audit log batch throttle burst int td tr tr td td td style line height 130 word wrap break word p Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before Only used in batch mode p td tr tr td colspan 2 audit log batch throttle enable td tr tr td td td style line height 130 word wrap break word p Whether batching throttling is enabled Only used in batch mode p td tr tr td colspan 2 audit log batch throttle qps float td tr tr td td td style line height 130 word wrap break word p Maximum average number of batches per second Only used in batch mode p td tr tr td colspan 2 audit log compress td tr tr td td td style line height 130 word wrap break word p If set the rotated log files will be compressed using gzip p td tr tr td colspan 2 audit log format string nbsp nbsp nbsp nbsp nbsp Default json td tr tr td td td style line height 130 word wrap break word p Format of saved audits quot legacy quot indicates 1 line text format for each event quot json quot indicates structured json format Known formats are legacy json p td tr tr td colspan 2 audit log maxage int td tr tr td td td style line height 130 word wrap break word p The maximum number of days to retain old audit log files based on the timestamp encoded in their filename p td tr tr td colspan 2 audit log maxbackup int td tr tr td td td style line height 130 word wrap break word p The maximum number of old audit log files to retain Setting a value of 0 will mean there s no restriction on the number of files p td tr tr td colspan 2 audit log maxsize int td tr tr td td td style line height 130 word wrap break word p The maximum size in megabytes of the audit log file before it gets rotated p td tr tr td colspan 2 audit log mode string nbsp nbsp nbsp nbsp nbsp Default blocking td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 audit log path string td tr tr td td td style line height 130 word wrap break word p If set all requests coming to the apiserver will be logged to this file means standard out p td tr tr td colspan 2 audit log truncate enabled td tr tr td td td style line height 130 word wrap break word p Whether event and batch truncating is enabled p td tr tr td colspan 2 audit log truncate max batch size int nbsp nbsp nbsp nbsp nbsp Default 10485760 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 audit log truncate max event size int nbsp nbsp nbsp nbsp nbsp Default 102400 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 audit log version string nbsp nbsp nbsp nbsp nbsp Default audit k8s io v1 td tr tr td td td style line height 130 word wrap break word p API group and version used for serializing audit events written to log p td tr tr td colspan 2 audit policy file string td tr tr td td td style line height 130 word wrap break word p Path to the file that defines the audit policy configuration p td tr tr td colspan 2 audit webhook batch buffer size int nbsp nbsp nbsp nbsp nbsp Default 10000 td tr tr td td td style line height 130 word wrap break word p The size of the buffer to store events before batching and writing Only used in batch mode p td tr tr td colspan 2 audit webhook batch max size int nbsp nbsp nbsp nbsp nbsp Default 400 td tr tr td td td style line height 130 word wrap break word p The maximum size of a batch Only used in batch mode p td tr tr td colspan 2 audit webhook batch max wait duration nbsp nbsp nbsp nbsp nbsp Default 30s td tr tr td td td style line height 130 word wrap break word p The amount of time to wait before force writing the batch that hadn t reached the max size Only used in batch mode p td tr tr td colspan 2 audit webhook batch throttle burst int nbsp nbsp nbsp nbsp nbsp Default 15 td tr tr td td td style line height 130 word wrap break word p Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before Only used in batch mode p td tr tr td colspan 2 audit webhook batch throttle enable nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Whether batching throttling is enabled Only used in batch mode p td tr tr td colspan 2 audit webhook batch throttle qps float nbsp nbsp nbsp nbsp nbsp Default 10 td tr tr td td td style line height 130 word wrap break word p Maximum average number of batches per second Only used in batch mode p td tr tr td colspan 2 audit webhook config file string td tr tr td td td style line height 130 word wrap break word p Path to a kubeconfig formatted file that defines the audit webhook configuration p td tr tr td colspan 2 audit webhook initial backoff duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The amount of time to wait before retrying the first failed request p td tr tr td colspan 2 audit webhook mode string nbsp nbsp nbsp nbsp nbsp Default batch td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 audit webhook truncate enabled td tr tr td td td style line height 130 word wrap break word p Whether event and batch truncating is enabled p td tr tr td colspan 2 audit webhook truncate max batch size int nbsp nbsp nbsp nbsp nbsp Default 10485760 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 audit webhook truncate max event size int nbsp nbsp nbsp nbsp nbsp Default 102400 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 audit webhook version string nbsp nbsp nbsp nbsp nbsp Default audit k8s io v1 td tr tr td td td style line height 130 word wrap break word p API group and version used for serializing audit events written to webhook p td tr tr td colspan 2 authentication config string td tr tr td td td style line height 130 word wrap break word p File with Authentication Configuration to configure the JWT Token authenticator or the anonymous authenticator Note This feature is in Alpha since v1 29 feature gate StructuredAuthenticationConfiguration true needs to be set for enabling this feature This feature is mutually exclusive with the oidc flags To configure anonymous authenticator you need to enable feature gate AnonymousAuthConfigurableEndpoints When you configure anonymous authenticator in the authentication config you cannot use the anonymous auth flag p td tr tr td colspan 2 authentication token webhook cache ttl duration nbsp nbsp nbsp nbsp nbsp Default 2m0s td tr tr td td td style line height 130 word wrap break word p The duration to cache responses from the webhook token authenticator p td tr tr td colspan 2 authentication token webhook config file string td tr tr td td td style line height 130 word wrap break word p File with webhook configuration for token authentication in kubeconfig format The API server will query the remote service to determine authentication for bearer tokens p td tr tr td colspan 2 authentication token webhook version string nbsp nbsp nbsp nbsp nbsp Default v1beta1 td tr tr td td td style line height 130 word wrap break word p The API version of the authentication k8s io TokenReview to send to and expect from the webhook p td tr tr td colspan 2 authorization config string td tr tr td td td style line height 130 word wrap break word p File with Authorization Configuration to configure the authorizer chain Note This feature is in Alpha since v1 29 feature gate StructuredAuthorizationConfiguration true feature flag needs to be set to true for enabling the functionality This feature is mutually exclusive with the other authorization mode and authorization webhook flags p td tr tr td colspan 2 authorization mode strings td tr tr td td td style line height 130 word wrap break word p Ordered list of plug ins to do authorization on secure port Defaults to AlwaysAllow if authorization config is not used Comma delimited list of AlwaysAllow AlwaysDeny ABAC Webhook RBAC Node p td tr tr td colspan 2 authorization policy file string td tr tr td td td style line height 130 word wrap break word p File with authorization policy in json line by line format used with authorization mode ABAC on the secure port p td tr tr td colspan 2 authorization webhook cache authorized ttl duration nbsp nbsp nbsp nbsp nbsp Default 5m0s td tr tr td td td style line height 130 word wrap break word p The duration to cache authorized responses from the webhook authorizer p td tr tr td colspan 2 authorization webhook cache unauthorized ttl duration nbsp nbsp nbsp nbsp nbsp Default 30s td tr tr td td td style line height 130 word wrap break word p The duration to cache unauthorized responses from the webhook authorizer p td tr tr td colspan 2 authorization webhook config file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 authorization webhook version string nbsp nbsp nbsp nbsp nbsp Default v1beta1 td tr tr td td td style line height 130 word wrap break word p The API version of the authorization k8s io SubjectAccessReview to send to and expect from the webhook p td tr tr td colspan 2 bind address string nbsp nbsp nbsp nbsp nbsp Default 0 0 0 0 td tr tr td td td style line height 130 word wrap break word p 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 and IP address families will be used p td tr tr td colspan 2 cert dir string nbsp nbsp nbsp nbsp nbsp Default var run kubernetes td tr tr td td td style line height 130 word wrap break word p The directory where the TLS certs are located If tls cert file and tls private key file are provided this flag will be ignored p td tr tr td colspan 2 client ca file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 contention profiling td tr tr td td td style line height 130 word wrap break word p Enable block profiling if profiling is enabled p td tr tr td colspan 2 cors allowed origins strings td tr tr td td td style line height 130 word wrap break word p 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 Please ensure each expression matches the entire hostname by anchoring to the start with or including the prefix and by anchoring to the end with or including the port separator suffix Examples of valid expressions are example com and https example com p td tr tr td colspan 2 debug socket path string td tr tr td td td style line height 130 word wrap break word p Use an unprotected no authn authz unix domain socket for profiling with the given path p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 delete collection workers int nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p Number of workers spawned for DeleteCollection call These are used to speed up namespace cleanup p td tr tr td colspan 2 disable admission plugins strings td tr tr td td td style line height 130 word wrap break word p 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 ClusterTrustBundleAttest CertificateSubjectRestriction DefaultIngressClass MutatingAdmissionWebhook ValidatingAdmissionPolicy ValidatingAdmissionWebhook ResourceQuota Comma delimited list of admission plugins AlwaysAdmit AlwaysDeny AlwaysPullImages CertificateApproval CertificateSigning CertificateSubjectRestriction ClusterTrustBundleAttest DefaultIngressClass DefaultStorageClass DefaultTolerationSeconds DenyServiceExternalIPs EventRateLimit ExtendedResourceToleration ImagePolicyWebhook LimitPodHardAntiAffinityTopology LimitRanger MutatingAdmissionWebhook NamespaceAutoProvision NamespaceExists NamespaceLifecycle NodeRestriction OwnerReferencesPermissionEnforcement PersistentVolumeClaimResize PodNodeSelector PodSecurity PodTolerationRestriction Priority ResourceQuota RuntimeClass ServiceAccount StorageObjectInUseProtection TaintNodesByCondition ValidatingAdmissionPolicy ValidatingAdmissionWebhook The order of plugins in this flag does not matter p td tr tr td colspan 2 disable http2 serving td tr tr td td td style line height 130 word wrap break word p If true HTTP2 serving will be disabled default false p td tr tr td colspan 2 disabled metrics strings td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 egress selector config file string td tr tr td td td style line height 130 word wrap break word p File with apiserver egress selector configuration p td tr tr td colspan 2 emulated version strings td tr tr td td td style line height 130 word wrap break word p The versions different components emulate their capabilities APIs features of br If set the component will emulate the behavior of this version instead of the underlying binary version br Version format could only be major minor for example emulated version wardle 1 2 kube 1 31 Options are br kube 1 31 1 31 default 1 31 If the component is not specified defaults to quot kube quot p td tr tr td colspan 2 enable admission plugins strings td tr tr td td td style line height 130 word wrap break word p 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 ClusterTrustBundleAttest CertificateSubjectRestriction DefaultIngressClass MutatingAdmissionWebhook ValidatingAdmissionPolicy ValidatingAdmissionWebhook ResourceQuota Comma delimited list of admission plugins AlwaysAdmit AlwaysDeny AlwaysPullImages CertificateApproval CertificateSigning CertificateSubjectRestriction ClusterTrustBundleAttest DefaultIngressClass DefaultStorageClass DefaultTolerationSeconds DenyServiceExternalIPs EventRateLimit ExtendedResourceToleration ImagePolicyWebhook LimitPodHardAntiAffinityTopology LimitRanger MutatingAdmissionWebhook NamespaceAutoProvision NamespaceExists NamespaceLifecycle NodeRestriction OwnerReferencesPermissionEnforcement PersistentVolumeClaimResize PodNodeSelector PodSecurity PodTolerationRestriction Priority ResourceQuota RuntimeClass ServiceAccount StorageObjectInUseProtection TaintNodesByCondition ValidatingAdmissionPolicy ValidatingAdmissionWebhook The order of plugins in this flag does not matter p td tr tr td colspan 2 enable aggregator routing td tr tr td td td style line height 130 word wrap break word p Turns on aggregator routing requests to endpoints IP rather than cluster IP p td tr tr td colspan 2 enable bootstrap token auth td tr tr td td td style line height 130 word wrap break word p Enable to allow secrets of type bootstrap kubernetes io token in the kube system namespace to be used for TLS bootstrapping authentication p td tr tr td colspan 2 enable garbage collector nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Enables the generic garbage collector MUST be synced with the corresponding flag of the kube controller manager p td tr tr td colspan 2 enable priority and fairness nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true replace the max in flight handler with an enhanced one that queues and dispatches with priority and fairness p td tr tr td colspan 2 encryption provider config string td tr tr td td td style line height 130 word wrap break word p The file containing configuration for encryption providers to be used for storing secrets in etcd p td tr tr td colspan 2 encryption provider config automatic reload td tr tr td td td style line height 130 word wrap break word p Determines if the file set by encryption provider config should be automatically reloaded if the disk contents change Setting this to true disables the ability to uniquely identify distinct KMS plugins via the API server healthz endpoints p td tr tr td colspan 2 endpoint reconciler type string nbsp nbsp nbsp nbsp nbsp Default lease td tr tr td td td style line height 130 word wrap break word p Use an endpoint reconciler master count lease none master count is deprecated and will be removed in a future version p td tr tr td colspan 2 etcd cafile string td tr tr td td td style line height 130 word wrap break word p SSL Certificate Authority file used to secure etcd communication p td tr tr td colspan 2 etcd certfile string td tr tr td td td style line height 130 word wrap break word p SSL certification file used to secure etcd communication p td tr tr td colspan 2 etcd compaction interval duration nbsp nbsp nbsp nbsp nbsp Default 5m0s td tr tr td td td style line height 130 word wrap break word p The interval of compaction requests If 0 the compaction request from apiserver is disabled p td tr tr td colspan 2 etcd count metric poll period duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Frequency of polling etcd for number of resources per type 0 disables the metric collection p td tr tr td colspan 2 etcd db metric poll interval duration nbsp nbsp nbsp nbsp nbsp Default 30s td tr tr td td td style line height 130 word wrap break word p The interval of requests to poll etcd and update metric 0 disables the metric collection p td tr tr td colspan 2 etcd healthcheck timeout duration nbsp nbsp nbsp nbsp nbsp Default 2s td tr tr td td td style line height 130 word wrap break word p The timeout to use when checking etcd health p td tr tr td colspan 2 etcd keyfile string td tr tr td td td style line height 130 word wrap break word p SSL key file used to secure etcd communication p td tr tr td colspan 2 etcd prefix string nbsp nbsp nbsp nbsp nbsp Default registry td tr tr td td td style line height 130 word wrap break word p The prefix to prepend to all resource paths in etcd p td tr tr td colspan 2 etcd readycheck timeout duration nbsp nbsp nbsp nbsp nbsp Default 2s td tr tr td td td style line height 130 word wrap break word p The timeout to use when checking etcd readiness p td tr tr td colspan 2 etcd servers strings td tr tr td td td style line height 130 word wrap break word p List of etcd servers to connect with scheme ip port comma separated p td tr tr td colspan 2 etcd servers overrides strings td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 event ttl duration nbsp nbsp nbsp nbsp nbsp Default 1h0m0s td tr tr td td td style line height 130 word wrap break word p Amount of time to retain events p td tr tr td colspan 2 external hostname string td tr tr td td td style line height 130 word wrap break word p The hostname to use when generating externalized URLs for this master e g Swagger API Docs or OpenID Discovery p td tr tr td colspan 2 feature gates colonSeparatedMultimapStringString td tr tr td td td style line height 130 word wrap break word p Comma separated list of component key value pairs that describe feature gates for alpha experimental features of different components br If the component is not specified defaults to quot kube quot This flag can be repeatedly invoked For example feature gates wardle featureA true wardle featureB false feature gates kube featureC true Options are br kube APIResponseCompression true false BETA default true br kube APIServerIdentity true false BETA default true br kube APIServerTracing true false BETA default true br kube APIServingWithRoutine true false ALPHA default false br kube AllAlpha true false ALPHA default false br kube AllBeta true false BETA default false br kube AnonymousAuthConfigurableEndpoints true false ALPHA default false br kube AnyVolumeDataSource true false BETA default true br kube AuthorizeNodeWithSelectors true false ALPHA default false br kube AuthorizeWithSelectors true false ALPHA default false br kube CPUManagerPolicyAlphaOptions true false ALPHA default false br kube CPUManagerPolicyBetaOptions true false BETA default true br kube CPUManagerPolicyOptions true false BETA default true br kube CRDValidationRatcheting true false BETA default true br kube CSIMigrationPortworx true false BETA default true br kube CSIVolumeHealth true false ALPHA default false br kube CloudControllerManagerWebhook true false ALPHA default false br kube ClusterTrustBundle true false ALPHA default false br kube ClusterTrustBundleProjection true false ALPHA default false br kube ComponentSLIs true false BETA default true br kube ConcurrentWatchObjectDecode true false BETA default false br kube ConsistentListFromCache true false BETA default true br kube ContainerCheckpoint true false BETA default true br kube ContextualLogging true false BETA default true br kube CoordinatedLeaderElection true false ALPHA default false br kube CronJobsScheduledAnnotation true false BETA default true br kube CrossNamespaceVolumeDataSource true false ALPHA default false br kube CustomCPUCFSQuotaPeriod true false ALPHA default false br kube CustomResourceFieldSelectors true false BETA default true br kube DRAControlPlaneController true false ALPHA default false br kube DisableAllocatorDualWrite true false ALPHA default false br kube DisableNodeKubeProxyVersion true false BETA default true br kube DynamicResourceAllocation true false ALPHA default false br kube EventedPLEG true false ALPHA default false br kube GracefulNodeShutdown true false BETA default true br kube GracefulNodeShutdownBasedOnPodPriority true false BETA default true br kube HPAScaleToZero true false ALPHA default false br kube HonorPVReclaimPolicy true false BETA default true br kube ImageMaximumGCAge true false BETA default true br kube ImageVolume true false ALPHA default false br kube InPlacePodVerticalScaling true false ALPHA default false br kube InTreePluginPortworxUnregister true false ALPHA default false br kube InformerResourceVersion true false ALPHA default false br kube JobBackoffLimitPerIndex true false BETA default true br kube JobManagedBy true false ALPHA default false br kube JobPodReplacementPolicy true false BETA default true br kube JobSuccessPolicy true false BETA default true br kube KubeletCgroupDriverFromCRI true false BETA default true br kube KubeletInUserNamespace true false ALPHA default false br kube KubeletPodResourcesDynamicResources true false ALPHA default false br kube KubeletPodResourcesGet true false ALPHA default false br kube KubeletSeparateDiskGC true false BETA default true br kube KubeletTracing true false BETA default true br kube LoadBalancerIPMode true false BETA default true br kube LocalStorageCapacityIsolationFSQuotaMonitoring true false BETA default false br kube LoggingAlphaOptions true false ALPHA default false br kube LoggingBetaOptions true false BETA default true br kube MatchLabelKeysInPodAffinity true false BETA default true br kube MatchLabelKeysInPodTopologySpread true false BETA default true br kube MaxUnavailableStatefulSet true false ALPHA default false br kube MemoryManager true false BETA default true br kube MemoryQoS true false ALPHA default false br kube MultiCIDRServiceAllocator true false BETA default false br kube MutatingAdmissionPolicy true false ALPHA default false br kube NFTablesProxyMode true false BETA default true br kube NodeInclusionPolicyInPodTopologySpread true false BETA default true br kube NodeLogQuery true false BETA default false br kube NodeSwap true false BETA default true br kube OpenAPIEnums true false BETA default true br kube PodAndContainerStatsFromCRI true false ALPHA default false br kube PodDeletionCost true false BETA default true br kube PodIndexLabel true false BETA default true br kube PodLifecycleSleepAction true false BETA default true br kube PodReadyToStartContainersCondition true false BETA default true br kube PortForwardWebsockets true false BETA default true br kube ProcMountType true false BETA default false br kube QOSReserved true false ALPHA default false br kube RecoverVolumeExpansionFailure true false ALPHA default false br kube RecursiveReadOnlyMounts true false BETA default true br kube RelaxedEnvironmentVariableValidation true false ALPHA default false br kube ReloadKubeletServerCertificateFile true false BETA default true br kube ResilientWatchCacheInitialization true false BETA default true br kube ResourceHealthStatus true false ALPHA default false br kube RetryGenerateName true false BETA default true br kube RotateKubeletServerCertificate true false BETA default true br kube RuntimeClassInImageCriApi true false ALPHA default false br kube SELinuxMount true false ALPHA default false br kube SELinuxMountReadWriteOncePod true false BETA default true br kube SchedulerQueueingHints true false BETA default false br kube SeparateCacheWatchRPC true false BETA default true br kube SeparateTaintEvictionController true false BETA default true br kube ServiceAccountTokenJTI true false BETA default true br kube ServiceAccountTokenNodeBinding true false BETA default true br kube ServiceAccountTokenNodeBindingValidation true false BETA default true br kube ServiceAccountTokenPodNodeInfo true false BETA default true br kube ServiceTrafficDistribution true false BETA default true br kube SidecarContainers true false BETA default true br kube SizeMemoryBackedVolumes true false BETA default true br kube StatefulSetAutoDeletePVC true false BETA default true br kube StorageNamespaceIndex true false BETA default true br kube StorageVersionAPI true false ALPHA default false br kube StorageVersionHash true false BETA default true br kube StorageVersionMigrator true false ALPHA default false br kube StrictCostEnforcementForVAP true false BETA default false br kube StrictCostEnforcementForWebhooks true false BETA default false br kube StructuredAuthenticationConfiguration true false BETA default true br kube StructuredAuthorizationConfiguration true false BETA default true br kube SupplementalGroupsPolicy true false ALPHA default false br kube TopologyAwareHints true false BETA default true br kube TopologyManagerPolicyAlphaOptions true false ALPHA default false br kube TopologyManagerPolicyBetaOptions true false BETA default true br kube TopologyManagerPolicyOptions true false BETA default true br kube TranslateStreamCloseWebsocketRequests true false BETA default true br kube UnauthenticatedHTTP2DOSMitigation true false BETA default true br kube UnknownVersionInteroperabilityProxy true false ALPHA default false br kube UserNamespacesPodSecurityStandards true false ALPHA default false br kube UserNamespacesSupport true false BETA default false br kube VolumeAttributesClass true false BETA default false br kube VolumeCapacityPriority true false ALPHA default false br kube WatchCacheInitializationPostStartHook true false BETA default false br kube WatchFromStorageWithoutResourceVersion true false BETA default false br kube WatchList true false ALPHA default false br kube WatchListClient true false BETA default false br kube WinDSR true false ALPHA default false br kube WinOverlay true false BETA default true br kube WindowsHostNetwork true false ALPHA default true p td tr tr td colspan 2 goaway chance float td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for kube apiserver p td tr tr td colspan 2 http2 max streams per connection int td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 kubelet certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 kubelet client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client cert file for TLS p td tr tr td colspan 2 kubelet client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 kubelet preferred address types strings nbsp nbsp nbsp nbsp nbsp Default Hostname InternalDNS InternalIP ExternalDNS ExternalIP td tr tr td td td style line height 130 word wrap break word p List of the preferred NodeAddressTypes to use for kubelet connections p td tr tr td colspan 2 kubelet timeout duration nbsp nbsp nbsp nbsp nbsp Default 5s td tr tr td td td style line height 130 word wrap break word p Timeout for kubelet operations p td tr tr td colspan 2 kubernetes service node port int td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 lease reuse duration seconds int nbsp nbsp nbsp nbsp nbsp Default 60 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 livez grace period duration td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 log flush frequency duration nbsp nbsp nbsp nbsp nbsp Default 5s td tr tr td td td style line height 130 word wrap break word p Maximum number of seconds between log flushes p td tr tr td colspan 2 log text info buffer size quantity td tr tr td td td style line height 130 word wrap break word p Alpha In text format with split output streams the info messages can be buffered for a while to increase performance The default value of zero bytes disables buffering The size can be specified as number of bytes 512 multiples of 1000 1K multiples of 1024 2Ki or powers of those 3M 4G 5Mi 6Gi Enable the LoggingAlphaOptions feature gate to use this p td tr tr td colspan 2 log text split stream td tr tr td td td style line height 130 word wrap break word p Alpha In text format write error messages to stderr and info messages to stdout The default is to write a single stream to stdout Enable the LoggingAlphaOptions feature gate to use this p td tr tr td colspan 2 logging format string nbsp nbsp nbsp nbsp nbsp Default text td tr tr td td td style line height 130 word wrap break word p Sets the log format Permitted formats quot text quot p td tr tr td colspan 2 max connection bytes per sec int td tr tr td td td style line height 130 word wrap break word p If non zero throttle each user connection to this number of bytes sec Currently only applies to long running requests p td tr tr td colspan 2 max mutating requests inflight int nbsp nbsp nbsp nbsp nbsp Default 200 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 max requests inflight int nbsp nbsp nbsp nbsp nbsp Default 400 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 min request timeout int nbsp nbsp nbsp nbsp nbsp Default 1800 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 oidc ca file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 oidc client id string td tr tr td td td style line height 130 word wrap break word p The client ID for the OpenID Connect client must be set if oidc issuer url is set p td tr tr td colspan 2 oidc groups claim string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 oidc groups prefix string td tr tr td td td style line height 130 word wrap break word p If provided all groups will be prefixed with this value to prevent conflicts with other authentication strategies p td tr tr td colspan 2 oidc issuer url string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 oidc required claim lt comma separated key value pairs gt td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 oidc signing algs strings nbsp nbsp nbsp nbsp nbsp Default RS256 td tr tr td td td style line height 130 word wrap break word p Comma separated list of allowed JOSE asymmetric signing algorithms JWTs with a supported alg header values are RS256 RS384 RS512 ES256 ES384 ES512 PS256 PS384 PS512 Values are defined by RFC 7518 https tools ietf org html rfc7518 section 3 1 p td tr tr td colspan 2 oidc username claim string nbsp nbsp nbsp nbsp nbsp Default sub td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 oidc username prefix string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 peer advertise ip string td tr tr td td td style line height 130 word wrap break word p If set and the UnknownVersionInteroperabilityProxy feature gate is enabled this IP will be used by peer kube apiservers to proxy requests to this kube apiserver when the request cannot be handled by the peer due to version skew between the kube apiservers This flag is only used in clusters configured with multiple kube apiservers for high availability p td tr tr td colspan 2 peer advertise port string td tr tr td td td style line height 130 word wrap break word p If set and the UnknownVersionInteroperabilityProxy feature gate is enabled this port will be used by peer kube apiservers to proxy requests to this kube apiserver when the request cannot be handled by the peer due to version skew between the kube apiservers This flag is only used in clusters configured with multiple kube apiservers for high availability p td tr tr td colspan 2 peer ca file string td tr tr td td td style line height 130 word wrap break word p If set and the UnknownVersionInteroperabilityProxy feature gate is enabled this file will be used to verify serving certificates of peer kube apiservers This flag is only used in clusters configured with multiple kube apiservers for high availability p td tr tr td colspan 2 permit address sharing td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 permit port sharing td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 profiling nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Enable profiling via web interface host port debug pprof p td tr tr td colspan 2 proxy client cert file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 proxy client key file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 request timeout duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 requestheader allowed names strings td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 requestheader client ca file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 requestheader extra headers prefix strings td tr tr td td td style line height 130 word wrap break word p List of request header prefixes to inspect X Remote Extra is suggested p td tr tr td colspan 2 requestheader group headers strings td tr tr td td td style line height 130 word wrap break word p List of request headers to inspect for groups X Remote Group is suggested p td tr tr td colspan 2 requestheader username headers strings td tr tr td td td style line height 130 word wrap break word p List of request headers to inspect for usernames X Remote User is common p td tr tr td colspan 2 runtime config lt comma separated key value pairs gt td tr tr td td td style line height 130 word wrap break word p A set of key value pairs that enable or disable built in APIs Supported options are br v1 true false for the core API group br lt group gt lt version gt true false for a specific API group and version e g apps v1 true br api all true false controls all API versions br api ga true false controls all API versions of the form v 0 9 br api beta true false controls all API versions of the form v 0 9 beta 0 9 br api alpha true false controls all API versions of the form v 0 9 alpha 0 9 br api legacy is deprecated and will be removed in a future version p td tr tr td colspan 2 secure port int nbsp nbsp nbsp nbsp nbsp Default 6443 td tr tr td td td style line height 130 word wrap break word p The port on which to serve HTTPS with authentication and authorization It cannot be switched off with 0 p td tr tr td colspan 2 service account extend token expiration nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 service account issuer strings td tr tr td td td style line height 130 word wrap break word p Identifier of the service account token issuer The issuer will assert this identifier in quot iss quot 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 p td tr tr td colspan 2 service account jwks uri string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 service account key file strings td tr tr td td td style line height 130 word wrap break word p 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 file is provided p td tr tr td colspan 2 service account lookup nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true validate ServiceAccount tokens exist in etcd as part of authentication p td tr tr td colspan 2 service account max token expiration duration td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 service account signing key file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 service cluster ip range string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 service node port range lt a string in the form N1 N2 gt nbsp nbsp nbsp nbsp nbsp Default 30000 32767 td tr tr td td td style line height 130 word wrap break word p A port range to reserve for services with NodePort visibility This must not overlap with the ephemeral port range on nodes Example 30000 32767 Inclusive at both ends of the range p td tr tr td colspan 2 show hidden metrics for version string td tr tr td td td style line height 130 word wrap break word p 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 lt major gt lt minor gt 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 p td tr tr td colspan 2 shutdown delay duration duration td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 shutdown send retry after td tr tr td td td style line height 130 word wrap break word p If true the HTTP Server will continue listening until all non long running request s in flight have been drained during this window all incoming requests will be rejected with a status code 429 and a Retry After response header in addition Connection close response header is set in order to tear down the TCP connection when idle p td tr tr td colspan 2 shutdown watch termination grace period duration td tr tr td td td style line height 130 word wrap break word p This option if set represents the maximum amount of grace period the apiserver will wait for active watch request s to drain during the graceful server shutdown window p td tr tr td colspan 2 storage backend string td tr tr td td td style line height 130 word wrap break word p The storage backend for persistence Options etcd3 default p td tr tr td colspan 2 storage initialization timeout duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Maximum amount of time to wait for storage initialization before declaring apiserver ready Defaults to 1m p td tr tr td colspan 2 storage media type string nbsp nbsp nbsp nbsp nbsp Default application vnd kubernetes protobuf td tr tr td td td style line height 130 word wrap break word p 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 Supported media types application json application yaml application vnd kubernetes protobuf p td tr tr td colspan 2 strict transport security directives strings td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 tls cert file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 tls cipher suites strings td tr tr td td td style line height 130 word wrap break word p Comma separated list of cipher suites for the server If omitted the default Go cipher suites will be used br 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 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 br Insecure values TLS ECDHE ECDSA WITH AES 128 CBC SHA256 TLS ECDHE ECDSA WITH RC4 128 SHA TLS ECDHE RSA WITH 3DES EDE CBC SHA TLS ECDHE RSA WITH AES 128 CBC SHA256 TLS ECDHE RSA WITH RC4 128 SHA TLS RSA WITH 3DES EDE CBC SHA TLS RSA WITH AES 128 CBC SHA TLS RSA WITH AES 128 CBC SHA256 TLS RSA WITH AES 128 GCM SHA256 TLS RSA WITH AES 256 CBC SHA TLS RSA WITH AES 256 GCM SHA384 TLS RSA WITH RC4 128 SHA p td tr tr td colspan 2 tls min version string td tr tr td td td style line height 130 word wrap break word p Minimum TLS version supported Possible values VersionTLS10 VersionTLS11 VersionTLS12 VersionTLS13 p td tr tr td colspan 2 tls private key file string td tr tr td td td style line height 130 word wrap break word p File containing the default x509 private key matching tls cert file p td tr tr td colspan 2 tls sni cert key string td tr tr td td td style line height 130 word wrap break word p 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 quot example crt example key quot or quot foo crt foo key foo com foo com quot p td tr tr td colspan 2 token auth file string td tr tr td td td style line height 130 word wrap break word p If set the file that will be used to secure the secure port of the API server via token authentication p td tr tr td colspan 2 tracing config file string td tr tr td td td style line height 130 word wrap break word p File with apiserver tracing configuration p td tr tr td colspan 2 v v int td tr tr td td td style line height 130 word wrap break word p number for the log level verbosity p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 vmodule pattern N td tr tr td td td style line height 130 word wrap break word p comma separated list of pattern N settings for file filtered logging only works for text log format p td tr tr td colspan 2 watch cache nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Enable watch caching in the apiserver p td tr tr td colspan 2 watch cache sizes strings td tr tr td td td style line height 130 word wrap break word p 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 This option is only meaningful for resources built into the apiserver not ones defined by CRDs or aggregated from external servers and is only consulted if the watch cache is enabled The only meaningful size setting to supply here is zero which means to disable watch caching for the associated resource all non zero values are equivalent and mean to not disable watch caching for that resource p td tr tbody table |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kube controller manager contenttype tool reference weight 30 autogenerated true | ---
title: kube-controller-manager
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
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]
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allocate-node-cidrs</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Should CIDRs for Pods be allocated and set on the cloud provider.</p></td>
</tr>
<tr>
<td colspan="2">--allow-metric-labels stringToString Default: []</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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'.</p></td>
</tr>
<tr>
<td colspan="2">--allow-metric-labels-manifest string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path to the manifest file that contains the allow-list mapping. The format of the file is the same as the flag --allow-metric-labels. Note that the flag --allow-metric-labels will override the manifest file.</p></td>
</tr>
<tr>
<td colspan="2">--attach-detach-reconcile-sync-period duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-skip-lookup</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If false, the authentication-kubeconfig will be used to lookup missing authentication configuration from the cluster.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-token-webhook-cache-ttl duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration to cache responses from the webhook token authenticator.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-tolerate-lookup-failure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-always-allow-paths strings Default: "/healthz,/readyz,/livez"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A list of HTTP paths to skip during authorization, i.e. these are authorized without contacting the 'core' kubernetes server.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-cache-authorized-ttl duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration to cache 'authorized' responses from the webhook authorizer.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-cache-unauthorized-ttl duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration to cache 'unauthorized' responses from the webhook authorizer.</p></td>
</tr>
<tr>
<td colspan="2">--bind-address string Default: 0.0.0.0</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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 and IP address families will be used.</p></td>
</tr>
<tr>
<td colspan="2">--cert-dir string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.</p></td>
</tr>
<tr>
<td colspan="2">--cidr-allocator-type string Default: "RangeAllocator"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Type of CIDR allocator to use</p></td>
</tr>
<tr>
<td colspan="2">--client-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cloud-config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path to the cloud provider configuration file. Empty string for no configuration file.</p></td>
</tr>
<tr>
<td colspan="2">--cloud-provider string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The provider for cloud services. Empty string for no provider.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-cidr string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>CIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be true</p></td>
</tr>
<tr>
<td colspan="2">--cluster-name string Default: "kubernetes"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The instance prefix for the cluster.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-duration duration Default: 8760h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The max length of duration signed certificates will be given. Individual CSRs may request shorter certs by setting spec.expirationSeconds.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-kube-apiserver-client-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-kube-apiserver-client-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-kubelet-client-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-kubelet-client-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-kubelet-serving-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-kubelet-serving-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-legacy-unknown-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-signing-legacy-unknown-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-cron-job-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of cron job objects that are allowed to sync concurrently. Larger number = more responsive jobs, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-deployment-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-endpoint-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-ephemeralvolume-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of ephemeral volume syncing operations that will be done concurrently. Larger number = faster ephemeral volume updating, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-gc-syncs int32 Default: 20</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of garbage collector workers that are allowed to sync concurrently.</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-horizontal-pod-autoscaler-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of horizontal pod autoscaler objects that are allowed to sync concurrently. Larger number = more responsive horizontal pod autoscaler objects processing, but more CPU (and network) load.</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-job-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of job objects that are allowed to sync concurrently. Larger number = more responsive jobs, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-namespace-syncs int32 Default: 10</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-rc-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-replicaset-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-resource-quota-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-service-endpoint-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-service-syncs int32 Default: 1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-serviceaccount-token-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-statefulset-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of statefulset objects that are allowed to sync concurrently. Larger number = more responsive statefulsets, but more CPU (and network) load</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-ttl-after-finished-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of ttl-after-finished-controller workers that are allowed to sync concurrently.</p></td>
</tr>
<tr>
<td colspan="2">--concurrent-validating-admission-policy-status-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of ValidatingAdmissionPolicyStatusController workers that are allowed to sync concurrently.</p></td>
</tr>
<tr>
<td colspan="2">--configure-cloud-routes Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider.</p></td>
</tr>
<tr>
<td colspan="2">--contention-profiling</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enable block profiling, if profiling is enabled</p></td>
</tr>
<tr>
<td colspan="2">--controller-start-interval duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Interval between starting controller managers.</p></td>
</tr>
<tr>
<td colspan="2">--controllers strings Default: "*"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'.<br/>All controllers: bootstrap-signer-controller, certificatesigningrequest-approving-controller, certificatesigningrequest-cleaner-controller, certificatesigningrequest-signing-controller, cloud-node-lifecycle-controller, clusterrole-aggregation-controller, cronjob-controller, daemonset-controller, deployment-controller, disruption-controller, endpoints-controller, endpointslice-controller, endpointslice-mirroring-controller, ephemeral-volume-controller, garbage-collector-controller, horizontal-pod-autoscaler-controller, job-controller, legacy-serviceaccount-token-cleaner-controller, namespace-controller, node-ipam-controller, node-lifecycle-controller, node-route-controller, persistentvolume-attach-detach-controller, persistentvolume-binder-controller, persistentvolume-expander-controller, persistentvolume-protection-controller, persistentvolumeclaim-protection-controller, pod-garbage-collector-controller, replicaset-controller, replicationcontroller-controller, resourceclaim-controller, resourcequota-controller, root-ca-certificate-publisher-controller, service-cidr-controller, service-lb-controller, serviceaccount-controller, serviceaccount-token-controller, statefulset-controller, storage-version-migrator-controller, storageversion-garbage-collector-controller, taint-eviction-controller, token-cleaner-controller, ttl-after-finished-controller, ttl-controller, validatingadmissionpolicy-status-controller<br/>Disabled-by-default controllers: bootstrap-signer-controller, token-cleaner-controller</p></td>
</tr>
<tr>
<td colspan="2">--disable-attach-detach-reconcile-sync</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Disable volume attach detach reconciler sync. Disabling this may cause volumes to be mismatched with pods. Use wisely.</p></td>
</tr>
<tr>
<td colspan="2">--disable-force-detach-on-timeout</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Prevent force detaching volumes based on maximum unmount time and node status. If this flag is set to true, the non-graceful node shutdown feature must be used to recover from node failure. See https://k8s.io/docs/storage-disable-force-detach-on-timeout/.</p></td>
</tr>
<tr>
<td colspan="2">--disable-http2-serving</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, HTTP2 serving will be disabled [default=false]</p></td>
</tr>
<tr>
<td colspan="2">--disabled-metrics strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--emulated-version strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The versions different components emulate their capabilities (APIs, features, ...) of.<br/>If set, the component will emulate the behavior of this version instead of the underlying binary version.<br/>Version format could only be major.minor, for example: '--emulated-version=wardle=1.2,kube=1.31'. Options are:<br/>kube=1.31..1.31 (default=1.31)If the component is not specified, defaults to "kube"</p></td>
</tr>
<tr>
<td colspan="2">--enable-dynamic-provisioning Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enable dynamic provisioning for environments that support it.</p></td>
</tr>
<tr>
<td colspan="2">--enable-garbage-collector Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver.</p></td>
</tr>
<tr>
<td colspan="2">--enable-hostpath-provisioner</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--enable-leader-migration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Whether to enable controller leader migration.</p></td>
</tr>
<tr>
<td colspan="2">--endpoint-updates-batch-period duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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</p></td>
</tr>
<tr>
<td colspan="2">--endpointslice-updates-batch-period duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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</p></td>
</tr>
<tr>
<td colspan="2">--external-cloud-volume-plugin string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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-ipam-controller, persistentvolume-binder-controller, persistentvolume-expander-controller and attach-detach-controller to work for in tree cloud providers.</p></td>
</tr>
<tr>
<td colspan="2">--feature-gates colonSeparatedMultimapStringString</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Comma-separated list of component:key=value pairs that describe feature gates for alpha/experimental features of different components.<br/>If the component is not specified, defaults to "kube". This flag can be repeatedly invoked. For example: --feature-gates 'wardle:featureA=true,wardle:featureB=false' --feature-gates 'kube:featureC=true'Options are:<br/>kube:APIResponseCompression=true|false (BETA - default=true)<br/>kube:APIServerIdentity=true|false (BETA - default=true)<br/>kube:APIServerTracing=true|false (BETA - default=true)<br/>kube:APIServingWithRoutine=true|false (ALPHA - default=false)<br/>kube:AllAlpha=true|false (ALPHA - default=false)<br/>kube:AllBeta=true|false (BETA - default=false)<br/>kube:AnonymousAuthConfigurableEndpoints=true|false (ALPHA - default=false)<br/>kube:AnyVolumeDataSource=true|false (BETA - default=true)<br/>kube:AuthorizeNodeWithSelectors=true|false (ALPHA - default=false)<br/>kube:AuthorizeWithSelectors=true|false (ALPHA - default=false)<br/>kube:CPUManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>kube:CPUManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>kube:CPUManagerPolicyOptions=true|false (BETA - default=true)<br/>kube:CRDValidationRatcheting=true|false (BETA - default=true)<br/>kube:CSIMigrationPortworx=true|false (BETA - default=true)<br/>kube:CSIVolumeHealth=true|false (ALPHA - default=false)<br/>kube:CloudControllerManagerWebhook=true|false (ALPHA - default=false)<br/>kube:ClusterTrustBundle=true|false (ALPHA - default=false)<br/>kube:ClusterTrustBundleProjection=true|false (ALPHA - default=false)<br/>kube:ComponentSLIs=true|false (BETA - default=true)<br/>kube:ConcurrentWatchObjectDecode=true|false (BETA - default=false)<br/>kube:ConsistentListFromCache=true|false (BETA - default=true)<br/>kube:ContainerCheckpoint=true|false (BETA - default=true)<br/>kube:ContextualLogging=true|false (BETA - default=true)<br/>kube:CoordinatedLeaderElection=true|false (ALPHA - default=false)<br/>kube:CronJobsScheduledAnnotation=true|false (BETA - default=true)<br/>kube:CrossNamespaceVolumeDataSource=true|false (ALPHA - default=false)<br/>kube:CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)<br/>kube:CustomResourceFieldSelectors=true|false (BETA - default=true)<br/>kube:DRAControlPlaneController=true|false (ALPHA - default=false)<br/>kube:DisableAllocatorDualWrite=true|false (ALPHA - default=false)<br/>kube:DisableNodeKubeProxyVersion=true|false (BETA - default=true)<br/>kube:DynamicResourceAllocation=true|false (ALPHA - default=false)<br/>kube:EventedPLEG=true|false (ALPHA - default=false)<br/>kube:GracefulNodeShutdown=true|false (BETA - default=true)<br/>kube:GracefulNodeShutdownBasedOnPodPriority=true|false (BETA - default=true)<br/>kube:HPAScaleToZero=true|false (ALPHA - default=false)<br/>kube:HonorPVReclaimPolicy=true|false (BETA - default=true)<br/>kube:ImageMaximumGCAge=true|false (BETA - default=true)<br/>kube:ImageVolume=true|false (ALPHA - default=false)<br/>kube:InPlacePodVerticalScaling=true|false (ALPHA - default=false)<br/>kube:InTreePluginPortworxUnregister=true|false (ALPHA - default=false)<br/>kube:InformerResourceVersion=true|false (ALPHA - default=false)<br/>kube:JobBackoffLimitPerIndex=true|false (BETA - default=true)<br/>kube:JobManagedBy=true|false (ALPHA - default=false)<br/>kube:JobPodReplacementPolicy=true|false (BETA - default=true)<br/>kube:JobSuccessPolicy=true|false (BETA - default=true)<br/>kube:KubeletCgroupDriverFromCRI=true|false (BETA - default=true)<br/>kube:KubeletInUserNamespace=true|false (ALPHA - default=false)<br/>kube:KubeletPodResourcesDynamicResources=true|false (ALPHA - default=false)<br/>kube:KubeletPodResourcesGet=true|false (ALPHA - default=false)<br/>kube:KubeletSeparateDiskGC=true|false (BETA - default=true)<br/>kube:KubeletTracing=true|false (BETA - default=true)<br/>kube:LoadBalancerIPMode=true|false (BETA - default=true)<br/>kube:LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (BETA - default=false)<br/>kube:LoggingAlphaOptions=true|false (ALPHA - default=false)<br/>kube:LoggingBetaOptions=true|false (BETA - default=true)<br/>kube:MatchLabelKeysInPodAffinity=true|false (BETA - default=true)<br/>kube:MatchLabelKeysInPodTopologySpread=true|false (BETA - default=true)<br/>kube:MaxUnavailableStatefulSet=true|false (ALPHA - default=false)<br/>kube:MemoryManager=true|false (BETA - default=true)<br/>kube:MemoryQoS=true|false (ALPHA - default=false)<br/>kube:MultiCIDRServiceAllocator=true|false (BETA - default=false)<br/>kube:MutatingAdmissionPolicy=true|false (ALPHA - default=false)<br/>kube:NFTablesProxyMode=true|false (BETA - default=true)<br/>kube:NodeInclusionPolicyInPodTopologySpread=true|false (BETA - default=true)<br/>kube:NodeLogQuery=true|false (BETA - default=false)<br/>kube:NodeSwap=true|false (BETA - default=true)<br/>kube:OpenAPIEnums=true|false (BETA - default=true)<br/>kube:PodAndContainerStatsFromCRI=true|false (ALPHA - default=false)<br/>kube:PodDeletionCost=true|false (BETA - default=true)<br/>kube:PodIndexLabel=true|false (BETA - default=true)<br/>kube:PodLifecycleSleepAction=true|false (BETA - default=true)<br/>kube:PodReadyToStartContainersCondition=true|false (BETA - default=true)<br/>kube:PortForwardWebsockets=true|false (BETA - default=true)<br/>kube:ProcMountType=true|false (BETA - default=false)<br/>kube:QOSReserved=true|false (ALPHA - default=false)<br/>kube:RecoverVolumeExpansionFailure=true|false (ALPHA - default=false)<br/>kube:RecursiveReadOnlyMounts=true|false (BETA - default=true)<br/>kube:RelaxedEnvironmentVariableValidation=true|false (ALPHA - default=false)<br/>kube:ReloadKubeletServerCertificateFile=true|false (BETA - default=true)<br/>kube:ResilientWatchCacheInitialization=true|false (BETA - default=true)<br/>kube:ResourceHealthStatus=true|false (ALPHA - default=false)<br/>kube:RetryGenerateName=true|false (BETA - default=true)<br/>kube:RotateKubeletServerCertificate=true|false (BETA - default=true)<br/>kube:RuntimeClassInImageCriApi=true|false (ALPHA - default=false)<br/>kube:SELinuxMount=true|false (ALPHA - default=false)<br/>kube:SELinuxMountReadWriteOncePod=true|false (BETA - default=true)<br/>kube:SchedulerQueueingHints=true|false (BETA - default=false)<br/>kube:SeparateCacheWatchRPC=true|false (BETA - default=true)<br/>kube:SeparateTaintEvictionController=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenJTI=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenNodeBinding=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenNodeBindingValidation=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenPodNodeInfo=true|false (BETA - default=true)<br/>kube:ServiceTrafficDistribution=true|false (BETA - default=true)<br/>kube:SidecarContainers=true|false (BETA - default=true)<br/>kube:SizeMemoryBackedVolumes=true|false (BETA - default=true)<br/>kube:StatefulSetAutoDeletePVC=true|false (BETA - default=true)<br/>kube:StorageNamespaceIndex=true|false (BETA - default=true)<br/>kube:StorageVersionAPI=true|false (ALPHA - default=false)<br/>kube:StorageVersionHash=true|false (BETA - default=true)<br/>kube:StorageVersionMigrator=true|false (ALPHA - default=false)<br/>kube:StrictCostEnforcementForVAP=true|false (BETA - default=false)<br/>kube:StrictCostEnforcementForWebhooks=true|false (BETA - default=false)<br/>kube:StructuredAuthenticationConfiguration=true|false (BETA - default=true)<br/>kube:StructuredAuthorizationConfiguration=true|false (BETA - default=true)<br/>kube:SupplementalGroupsPolicy=true|false (ALPHA - default=false)<br/>kube:TopologyAwareHints=true|false (BETA - default=true)<br/>kube:TopologyManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>kube:TopologyManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>kube:TopologyManagerPolicyOptions=true|false (BETA - default=true)<br/>kube:TranslateStreamCloseWebsocketRequests=true|false (BETA - default=true)<br/>kube:UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=true)<br/>kube:UnknownVersionInteroperabilityProxy=true|false (ALPHA - default=false)<br/>kube:UserNamespacesPodSecurityStandards=true|false (ALPHA - default=false)<br/>kube:UserNamespacesSupport=true|false (BETA - default=false)<br/>kube:VolumeAttributesClass=true|false (BETA - default=false)<br/>kube:VolumeCapacityPriority=true|false (ALPHA - default=false)<br/>kube:WatchCacheInitializationPostStartHook=true|false (BETA - default=false)<br/>kube:WatchFromStorageWithoutResourceVersion=true|false (BETA - default=false)<br/>kube:WatchList=true|false (ALPHA - default=false)<br/>kube:WatchListClient=true|false (BETA - default=false)<br/>kube:WinDSR=true|false (ALPHA - default=false)<br/>kube:WinOverlay=true|false (BETA - default=true)<br/>kube:WindowsHostNetwork=true|false (ALPHA - default=true)</p></td>
</tr>
<tr>
<td colspan="2">--flex-volume-plugin-dir string Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Full path of the directory in which the flex volume plugin should search for additional third party volume plugins.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for kube-controller-manager</p></td>
</tr>
<tr>
<td colspan="2">--horizontal-pod-autoscaler-cpu-initialization-period duration Default: 5m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period after pod start when CPU samples might be skipped.</p></td>
</tr>
<tr>
<td colspan="2">--horizontal-pod-autoscaler-downscale-stabilization duration Default: 5m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period for which autoscaler will look backwards and not scale down below any recommendation it made during that period.</p></td>
</tr>
<tr>
<td colspan="2">--horizontal-pod-autoscaler-initial-readiness-delay duration Default: 30s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period after pod start during which readiness changes will be treated as initial readiness.</p></td>
</tr>
<tr>
<td colspan="2">--horizontal-pod-autoscaler-sync-period duration Default: 15s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period for syncing the number of pods in horizontal pod autoscaler.</p></td>
</tr>
<tr>
<td colspan="2">--horizontal-pod-autoscaler-tolerance float Default: 0.1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The minimum change (from 1.0) in the desired-to-actual metrics ratio for the horizontal pod autoscaler to consider scaling.</p></td>
</tr>
<tr>
<td colspan="2">--http2-max-streams-per-connection int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--kube-api-burst int32 Default: 30</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Burst to use while talking with kubernetes apiserver.</p></td>
</tr>
<tr>
<td colspan="2">--kube-api-content-type string Default: "application/vnd.kubernetes.protobuf"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Content type of requests sent to apiserver.</p></td>
</tr>
<tr>
<td colspan="2">--kube-api-qps float Default: 20</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>QPS to use while talking with kubernetes apiserver.</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to kubeconfig file with authorization and master location information (the master location can be overridden by the master flag).</p></td>
</tr>
<tr>
<td colspan="2">--large-cluster-size-threshold int32 Default: 50</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Number of nodes from which node-lifecycle-controller 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. Notice: If nodes reside in multiple zones, this threshold will be considered as zone node size threshold for each zone to determine node eviction rate independently.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-lease-duration duration Default: 15s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-renew-deadline duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than the lease duration. This is only applicable if leader election is enabled.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-resource-lock string Default: "leases"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The type of resource object that is used for locking during leader election. Supported options are 'leases', 'endpointsleases' and 'configmapsleases'.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-resource-name string Default: "kube-controller-manager"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of resource object that is used for locking during leader election.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-resource-namespace string Default: "kube-system"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The namespace of resource object that is used for locking during leader election.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-retry-period duration Default: 2s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.</p></td>
</tr>
<tr>
<td colspan="2">--leader-migration-config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--legacy-service-account-token-clean-up-period duration Default: 8760h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period of time since the last usage of an legacy service account token before it can be deleted.</p></td>
</tr>
<tr>
<td colspan="2">--log-flush-frequency duration Default: 5s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum number of seconds between log flushes</p></td>
</tr>
<tr>
<td colspan="2">--log-text-info-buffer-size quantity</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this.</p></td>
</tr>
<tr>
<td colspan="2">--log-text-split-stream</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[Alpha] In text format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this.</p></td>
</tr>
<tr>
<td colspan="2">--logging-format string Default: "text"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Sets the log format. Permitted formats: "text".</p></td>
</tr>
<tr>
<td colspan="2">--master string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address of the Kubernetes API server (overrides any value in kubeconfig).</p></td>
</tr>
<tr>
<td colspan="2">--max-endpoints-per-slice int32 Default: 100</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--min-resync-period duration Default: 12h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.</p></td>
</tr>
<tr>
<td colspan="2">--mirroring-concurrent-service-endpoint-syncs int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The number of service endpoint syncing operations that will be done concurrently by the endpointslice-mirroring-controller. Larger number = faster endpoint slice updating, but more CPU (and network) load. Defaults to 5.</p></td>
</tr>
<tr>
<td colspan="2">--mirroring-endpointslice-updates-batch-period duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of EndpointSlice updates batching period for endpointslice-mirroring-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</p></td>
</tr>
<tr>
<td colspan="2">--mirroring-max-endpoints-per-subset int32 Default: 1000</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The maximum number of endpoints that will be added to an EndpointSlice by the endpointslice-mirroring-controller. More endpoints per slice will result in less endpoint slices, but larger resources. Defaults to 100.</p></td>
</tr>
<tr>
<td colspan="2">--namespace-sync-period duration Default: 5m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period for syncing namespace life-cycle updates</p></td>
</tr>
<tr>
<td colspan="2">--node-cidr-mask-size int32</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Mask size for node cidr in cluster. Default is 24 for IPv4 and 64 for IPv6.</p></td>
</tr>
<tr>
<td colspan="2">--node-cidr-mask-size-ipv4 int32</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Mask size for IPv4 node cidr in dual-stack cluster. Default is 24.</p></td>
</tr>
<tr>
<td colspan="2">--node-cidr-mask-size-ipv6 int32</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Mask size for IPv6 node cidr in dual-stack cluster. Default is 64.</p></td>
</tr>
<tr>
<td colspan="2">--node-eviction-rate float Default: 0.1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--node-monitor-grace-period duration Default: 40s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--node-monitor-period duration Default: 5s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period for syncing NodeStatus in cloud-node-lifecycle-controller.</p></td>
</tr>
<tr>
<td colspan="2">--node-startup-grace-period duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Amount of time which we allow starting Node to be unresponsive before marking it unhealthy.</p></td>
</tr>
<tr>
<td colspan="2">--permit-address-sharing</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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]</p></td>
</tr>
<tr>
<td colspan="2">--permit-port-sharing</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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]</p></td>
</tr>
<tr>
<td colspan="2">--profiling Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enable profiling via web interface host:port/debug/pprof/</p></td>
</tr>
<tr>
<td colspan="2">--pv-recycler-increment-timeout-nfs int32 Default: 30</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod</p></td>
</tr>
<tr>
<td colspan="2">--pv-recycler-minimum-timeout-hostpath int32 Default: 60</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--pv-recycler-minimum-timeout-nfs int32 Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The minimum ActiveDeadlineSeconds to use for an NFS Recycler pod</p></td>
</tr>
<tr>
<td colspan="2">--pv-recycler-pod-template-filepath-hostpath string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--pv-recycler-pod-template-filepath-nfs string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The file path to a pod definition used as a template for NFS persistent volume recycling</p></td>
</tr>
<tr>
<td colspan="2">--pv-recycler-timeout-increment-hostpath int32 Default: 30</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--pvclaimbinder-sync-period duration Default: 15s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period for syncing persistent volumes and persistent volume claims</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-allowed-names strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-client-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-extra-headers-prefix strings Default: "x-remote-extra-"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of request header prefixes to inspect. X-Remote-Extra- is suggested.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-group-headers strings Default: "x-remote-group"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of request headers to inspect for groups. X-Remote-Group is suggested.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-username-headers strings Default: "x-remote-user"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of request headers to inspect for usernames. X-Remote-User is common.</p></td>
</tr>
<tr>
<td colspan="2">--resource-quota-sync-period duration Default: 5m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period for syncing quota usage status in the system</p></td>
</tr>
<tr>
<td colspan="2">--root-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle.</p></td>
</tr>
<tr>
<td colspan="2">--route-reconciliation-period duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The period for reconciling routes created for Nodes by cloud provider.</p></td>
</tr>
<tr>
<td colspan="2">--secondary-node-eviction-rate float Default: 0.01</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--secure-port int Default: 10257</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.</p></td>
</tr>
<tr>
<td colspan="2">--service-account-private-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename containing a PEM-encoded private RSA or ECDSA key used to sign service account tokens.</p></td>
</tr>
<tr>
<td colspan="2">--service-cluster-ip-range string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>CIDR Range for Services in cluster. Requires --allocate-node-cidrs to be true</p></td>
</tr>
<tr>
<td colspan="2">--show-hidden-metrics-for-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--terminated-pod-gc-threshold int32 Default: 12500</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--tls-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--tls-cipher-suites strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used.<br/>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_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.<br/>Insecure values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_RC4_128_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_RC4_128_SHA.</p></td>
</tr>
<tr>
<td colspan="2">--tls-min-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13</p></td>
</tr>
<tr>
<td colspan="2">--tls-private-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File containing the default x509 private key matching --tls-cert-file.</p></td>
</tr>
<tr>
<td colspan="2">--tls-sni-cert-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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".</p></td>
</tr>
<tr>
<td colspan="2">--unhealthy-zone-threshold float Default: 0.55</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy.</p></td>
</tr>
<tr>
<td colspan="2">--use-service-account-credentials</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, use individual service account credentials for each controller.</p></td>
</tr>
<tr>
<td colspan="2">-v, --v int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>number for the log level verbosity</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--vmodule pattern=N,...</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)</p></td>
</tr>
</tbody>
</table>
| kubernetes reference | title kube controller manager content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project 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 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allocate node cidrs td tr tr td td td style line height 130 word wrap break word p Should CIDRs for Pods be allocated and set on the cloud provider p td tr tr td colspan 2 allow metric labels stringToString nbsp nbsp nbsp nbsp nbsp Default td tr tr td td td style line height 130 word wrap break word p The map from metric label to value allow list of this label The key s format is lt MetricName gt lt LabelName gt The value s format is lt allowed value gt lt allowed value gt e g metric1 label1 v1 v2 v3 metric1 label2 v1 v2 v3 metric2 label1 v1 v2 v3 p td tr tr td colspan 2 allow metric labels manifest string td tr tr td td td style line height 130 word wrap break word p The path to the manifest file that contains the allow list mapping The format of the file is the same as the flag allow metric labels Note that the flag allow metric labels will override the manifest file p td tr tr td colspan 2 attach detach reconcile sync period duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 authentication kubeconfig string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 authentication skip lookup td tr tr td td td style line height 130 word wrap break word p If false the authentication kubeconfig will be used to lookup missing authentication configuration from the cluster p td tr tr td colspan 2 authentication token webhook cache ttl duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The duration to cache responses from the webhook token authenticator p td tr tr td colspan 2 authentication tolerate lookup failure td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 authorization always allow paths strings nbsp nbsp nbsp nbsp nbsp Default healthz readyz livez td tr tr td td td style line height 130 word wrap break word p A list of HTTP paths to skip during authorization i e these are authorized without contacting the core kubernetes server p td tr tr td colspan 2 authorization kubeconfig string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 authorization webhook cache authorized ttl duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The duration to cache authorized responses from the webhook authorizer p td tr tr td colspan 2 authorization webhook cache unauthorized ttl duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The duration to cache unauthorized responses from the webhook authorizer p td tr tr td colspan 2 bind address string nbsp nbsp nbsp nbsp nbsp Default 0 0 0 0 td tr tr td td td style line height 130 word wrap break word p 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 and IP address families will be used p td tr tr td colspan 2 cert dir string td tr tr td td td style line height 130 word wrap break word p The directory where the TLS certs are located If tls cert file and tls private key file are provided this flag will be ignored p td tr tr td colspan 2 cidr allocator type string nbsp nbsp nbsp nbsp nbsp Default RangeAllocator td tr tr td td td style line height 130 word wrap break word p Type of CIDR allocator to use p td tr tr td colspan 2 client ca file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cloud config string td tr tr td td td style line height 130 word wrap break word p The path to the cloud provider configuration file Empty string for no configuration file p td tr tr td colspan 2 cloud provider string td tr tr td td td style line height 130 word wrap break word p The provider for cloud services Empty string for no provider p td tr tr td colspan 2 cluster cidr string td tr tr td td td style line height 130 word wrap break word p CIDR Range for Pods in cluster Requires allocate node cidrs to be true p td tr tr td colspan 2 cluster name string nbsp nbsp nbsp nbsp nbsp Default kubernetes td tr tr td td td style line height 130 word wrap break word p The instance prefix for the cluster p td tr tr td colspan 2 cluster signing cert file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cluster signing duration duration nbsp nbsp nbsp nbsp nbsp Default 8760h0m0s td tr tr td td td style line height 130 word wrap break word p The max length of duration signed certificates will be given Individual CSRs may request shorter certs by setting spec expirationSeconds p td tr tr td colspan 2 cluster signing key file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cluster signing kube apiserver client cert file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cluster signing kube apiserver client key file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cluster signing kubelet client cert file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cluster signing kubelet client key file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cluster signing kubelet serving cert file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cluster signing kubelet serving key file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cluster signing legacy unknown cert file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 cluster signing legacy unknown key file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 concurrent cron job syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of cron job objects that are allowed to sync concurrently Larger number more responsive jobs but more CPU and network load p td tr tr td colspan 2 concurrent deployment syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of deployment objects that are allowed to sync concurrently Larger number more responsive deployments but more CPU and network load p td tr tr td colspan 2 concurrent endpoint syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of endpoint syncing operations that will be done concurrently Larger number faster endpoint updating but more CPU and network load p td tr tr td colspan 2 concurrent ephemeralvolume syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of ephemeral volume syncing operations that will be done concurrently Larger number faster ephemeral volume updating but more CPU and network load p td tr tr td colspan 2 concurrent gc syncs int32 nbsp nbsp nbsp nbsp nbsp Default 20 td tr tr td td td style line height 130 word wrap break word p The number of garbage collector workers that are allowed to sync concurrently p td tr tr td colspan 2 concurrent horizontal pod autoscaler syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of horizontal pod autoscaler objects that are allowed to sync concurrently Larger number more responsive horizontal pod autoscaler objects processing but more CPU and network load p td tr tr td colspan 2 concurrent job syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of job objects that are allowed to sync concurrently Larger number more responsive jobs but more CPU and network load p td tr tr td colspan 2 concurrent namespace syncs int32 nbsp nbsp nbsp nbsp nbsp Default 10 td tr tr td td td style line height 130 word wrap break word p The number of namespace objects that are allowed to sync concurrently Larger number more responsive namespace termination but more CPU and network load p td tr tr td colspan 2 concurrent rc syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of replication controllers that are allowed to sync concurrently Larger number more responsive replica management but more CPU and network load p td tr tr td colspan 2 concurrent replicaset syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of replica sets that are allowed to sync concurrently Larger number more responsive replica management but more CPU and network load p td tr tr td colspan 2 concurrent resource quota syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of resource quotas that are allowed to sync concurrently Larger number more responsive quota management but more CPU and network load p td tr tr td colspan 2 concurrent service endpoint syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 concurrent service syncs int32 nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p The number of services that are allowed to sync concurrently Larger number more responsive service management but more CPU and network load p td tr tr td colspan 2 concurrent serviceaccount token syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 concurrent statefulset syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of statefulset objects that are allowed to sync concurrently Larger number more responsive statefulsets but more CPU and network load p td tr tr td colspan 2 concurrent ttl after finished syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of ttl after finished controller workers that are allowed to sync concurrently p td tr tr td colspan 2 concurrent validating admission policy status syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of ValidatingAdmissionPolicyStatusController workers that are allowed to sync concurrently p td tr tr td colspan 2 configure cloud routes nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Should CIDRs allocated by allocate node cidrs be configured on the cloud provider p td tr tr td colspan 2 contention profiling td tr tr td td td style line height 130 word wrap break word p Enable block profiling if profiling is enabled p td tr tr td colspan 2 controller start interval duration td tr tr td td td style line height 130 word wrap break word p Interval between starting controller managers p td tr tr td colspan 2 controllers strings nbsp nbsp nbsp nbsp nbsp Default td tr tr td td td style line height 130 word wrap break word p A list of controllers to enable enables all on by default controllers foo enables the controller named foo foo disables the controller named foo br All controllers bootstrap signer controller certificatesigningrequest approving controller certificatesigningrequest cleaner controller certificatesigningrequest signing controller cloud node lifecycle controller clusterrole aggregation controller cronjob controller daemonset controller deployment controller disruption controller endpoints controller endpointslice controller endpointslice mirroring controller ephemeral volume controller garbage collector controller horizontal pod autoscaler controller job controller legacy serviceaccount token cleaner controller namespace controller node ipam controller node lifecycle controller node route controller persistentvolume attach detach controller persistentvolume binder controller persistentvolume expander controller persistentvolume protection controller persistentvolumeclaim protection controller pod garbage collector controller replicaset controller replicationcontroller controller resourceclaim controller resourcequota controller root ca certificate publisher controller service cidr controller service lb controller serviceaccount controller serviceaccount token controller statefulset controller storage version migrator controller storageversion garbage collector controller taint eviction controller token cleaner controller ttl after finished controller ttl controller validatingadmissionpolicy status controller br Disabled by default controllers bootstrap signer controller token cleaner controller p td tr tr td colspan 2 disable attach detach reconcile sync td tr tr td td td style line height 130 word wrap break word p Disable volume attach detach reconciler sync Disabling this may cause volumes to be mismatched with pods Use wisely p td tr tr td colspan 2 disable force detach on timeout td tr tr td td td style line height 130 word wrap break word p Prevent force detaching volumes based on maximum unmount time and node status If this flag is set to true the non graceful node shutdown feature must be used to recover from node failure See https k8s io docs storage disable force detach on timeout p td tr tr td colspan 2 disable http2 serving td tr tr td td td style line height 130 word wrap break word p If true HTTP2 serving will be disabled default false p td tr tr td colspan 2 disabled metrics strings td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 emulated version strings td tr tr td td td style line height 130 word wrap break word p The versions different components emulate their capabilities APIs features of br If set the component will emulate the behavior of this version instead of the underlying binary version br Version format could only be major minor for example emulated version wardle 1 2 kube 1 31 Options are br kube 1 31 1 31 default 1 31 If the component is not specified defaults to quot kube quot p td tr tr td colspan 2 enable dynamic provisioning nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Enable dynamic provisioning for environments that support it p td tr tr td colspan 2 enable garbage collector nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Enables the generic garbage collector MUST be synced with the corresponding flag of the kube apiserver p td tr tr td colspan 2 enable hostpath provisioner td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 enable leader migration td tr tr td td td style line height 130 word wrap break word p Whether to enable controller leader migration p td tr tr td colspan 2 endpoint updates batch period duration td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 endpointslice updates batch period duration td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 external cloud volume plugin string td tr tr td td td style line height 130 word wrap break word p 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 ipam controller persistentvolume binder controller persistentvolume expander controller and attach detach controller to work for in tree cloud providers p td tr tr td colspan 2 feature gates colonSeparatedMultimapStringString td tr tr td td td style line height 130 word wrap break word p Comma separated list of component key value pairs that describe feature gates for alpha experimental features of different components br If the component is not specified defaults to quot kube quot This flag can be repeatedly invoked For example feature gates wardle featureA true wardle featureB false feature gates kube featureC true Options are br kube APIResponseCompression true false BETA default true br kube APIServerIdentity true false BETA default true br kube APIServerTracing true false BETA default true br kube APIServingWithRoutine true false ALPHA default false br kube AllAlpha true false ALPHA default false br kube AllBeta true false BETA default false br kube AnonymousAuthConfigurableEndpoints true false ALPHA default false br kube AnyVolumeDataSource true false BETA default true br kube AuthorizeNodeWithSelectors true false ALPHA default false br kube AuthorizeWithSelectors true false ALPHA default false br kube CPUManagerPolicyAlphaOptions true false ALPHA default false br kube CPUManagerPolicyBetaOptions true false BETA default true br kube CPUManagerPolicyOptions true false BETA default true br kube CRDValidationRatcheting true false BETA default true br kube CSIMigrationPortworx true false BETA default true br kube CSIVolumeHealth true false ALPHA default false br kube CloudControllerManagerWebhook true false ALPHA default false br kube ClusterTrustBundle true false ALPHA default false br kube ClusterTrustBundleProjection true false ALPHA default false br kube ComponentSLIs true false BETA default true br kube ConcurrentWatchObjectDecode true false BETA default false br kube ConsistentListFromCache true false BETA default true br kube ContainerCheckpoint true false BETA default true br kube ContextualLogging true false BETA default true br kube CoordinatedLeaderElection true false ALPHA default false br kube CronJobsScheduledAnnotation true false BETA default true br kube CrossNamespaceVolumeDataSource true false ALPHA default false br kube CustomCPUCFSQuotaPeriod true false ALPHA default false br kube CustomResourceFieldSelectors true false BETA default true br kube DRAControlPlaneController true false ALPHA default false br kube DisableAllocatorDualWrite true false ALPHA default false br kube DisableNodeKubeProxyVersion true false BETA default true br kube DynamicResourceAllocation true false ALPHA default false br kube EventedPLEG true false ALPHA default false br kube GracefulNodeShutdown true false BETA default true br kube GracefulNodeShutdownBasedOnPodPriority true false BETA default true br kube HPAScaleToZero true false ALPHA default false br kube HonorPVReclaimPolicy true false BETA default true br kube ImageMaximumGCAge true false BETA default true br kube ImageVolume true false ALPHA default false br kube InPlacePodVerticalScaling true false ALPHA default false br kube InTreePluginPortworxUnregister true false ALPHA default false br kube InformerResourceVersion true false ALPHA default false br kube JobBackoffLimitPerIndex true false BETA default true br kube JobManagedBy true false ALPHA default false br kube JobPodReplacementPolicy true false BETA default true br kube JobSuccessPolicy true false BETA default true br kube KubeletCgroupDriverFromCRI true false BETA default true br kube KubeletInUserNamespace true false ALPHA default false br kube KubeletPodResourcesDynamicResources true false ALPHA default false br kube KubeletPodResourcesGet true false ALPHA default false br kube KubeletSeparateDiskGC true false BETA default true br kube KubeletTracing true false BETA default true br kube LoadBalancerIPMode true false BETA default true br kube LocalStorageCapacityIsolationFSQuotaMonitoring true false BETA default false br kube LoggingAlphaOptions true false ALPHA default false br kube LoggingBetaOptions true false BETA default true br kube MatchLabelKeysInPodAffinity true false BETA default true br kube MatchLabelKeysInPodTopologySpread true false BETA default true br kube MaxUnavailableStatefulSet true false ALPHA default false br kube MemoryManager true false BETA default true br kube MemoryQoS true false ALPHA default false br kube MultiCIDRServiceAllocator true false BETA default false br kube MutatingAdmissionPolicy true false ALPHA default false br kube NFTablesProxyMode true false BETA default true br kube NodeInclusionPolicyInPodTopologySpread true false BETA default true br kube NodeLogQuery true false BETA default false br kube NodeSwap true false BETA default true br kube OpenAPIEnums true false BETA default true br kube PodAndContainerStatsFromCRI true false ALPHA default false br kube PodDeletionCost true false BETA default true br kube PodIndexLabel true false BETA default true br kube PodLifecycleSleepAction true false BETA default true br kube PodReadyToStartContainersCondition true false BETA default true br kube PortForwardWebsockets true false BETA default true br kube ProcMountType true false BETA default false br kube QOSReserved true false ALPHA default false br kube RecoverVolumeExpansionFailure true false ALPHA default false br kube RecursiveReadOnlyMounts true false BETA default true br kube RelaxedEnvironmentVariableValidation true false ALPHA default false br kube ReloadKubeletServerCertificateFile true false BETA default true br kube ResilientWatchCacheInitialization true false BETA default true br kube ResourceHealthStatus true false ALPHA default false br kube RetryGenerateName true false BETA default true br kube RotateKubeletServerCertificate true false BETA default true br kube RuntimeClassInImageCriApi true false ALPHA default false br kube SELinuxMount true false ALPHA default false br kube SELinuxMountReadWriteOncePod true false BETA default true br kube SchedulerQueueingHints true false BETA default false br kube SeparateCacheWatchRPC true false BETA default true br kube SeparateTaintEvictionController true false BETA default true br kube ServiceAccountTokenJTI true false BETA default true br kube ServiceAccountTokenNodeBinding true false BETA default true br kube ServiceAccountTokenNodeBindingValidation true false BETA default true br kube ServiceAccountTokenPodNodeInfo true false BETA default true br kube ServiceTrafficDistribution true false BETA default true br kube SidecarContainers true false BETA default true br kube SizeMemoryBackedVolumes true false BETA default true br kube StatefulSetAutoDeletePVC true false BETA default true br kube StorageNamespaceIndex true false BETA default true br kube StorageVersionAPI true false ALPHA default false br kube StorageVersionHash true false BETA default true br kube StorageVersionMigrator true false ALPHA default false br kube StrictCostEnforcementForVAP true false BETA default false br kube StrictCostEnforcementForWebhooks true false BETA default false br kube StructuredAuthenticationConfiguration true false BETA default true br kube StructuredAuthorizationConfiguration true false BETA default true br kube SupplementalGroupsPolicy true false ALPHA default false br kube TopologyAwareHints true false BETA default true br kube TopologyManagerPolicyAlphaOptions true false ALPHA default false br kube TopologyManagerPolicyBetaOptions true false BETA default true br kube TopologyManagerPolicyOptions true false BETA default true br kube TranslateStreamCloseWebsocketRequests true false BETA default true br kube UnauthenticatedHTTP2DOSMitigation true false BETA default true br kube UnknownVersionInteroperabilityProxy true false ALPHA default false br kube UserNamespacesPodSecurityStandards true false ALPHA default false br kube UserNamespacesSupport true false BETA default false br kube VolumeAttributesClass true false BETA default false br kube VolumeCapacityPriority true false ALPHA default false br kube WatchCacheInitializationPostStartHook true false BETA default false br kube WatchFromStorageWithoutResourceVersion true false BETA default false br kube WatchList true false ALPHA default false br kube WatchListClient true false BETA default false br kube WinDSR true false ALPHA default false br kube WinOverlay true false BETA default true br kube WindowsHostNetwork true false ALPHA default true p td tr tr td colspan 2 flex volume plugin dir string nbsp nbsp nbsp nbsp nbsp Default usr libexec kubernetes kubelet plugins volume exec td tr tr td td td style line height 130 word wrap break word p Full path of the directory in which the flex volume plugin should search for additional third party volume plugins p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for kube controller manager p td tr tr td colspan 2 horizontal pod autoscaler cpu initialization period duration nbsp nbsp nbsp nbsp nbsp Default 5m0s td tr tr td td td style line height 130 word wrap break word p The period after pod start when CPU samples might be skipped p td tr tr td colspan 2 horizontal pod autoscaler downscale stabilization duration nbsp nbsp nbsp nbsp nbsp Default 5m0s td tr tr td td td style line height 130 word wrap break word p The period for which autoscaler will look backwards and not scale down below any recommendation it made during that period p td tr tr td colspan 2 horizontal pod autoscaler initial readiness delay duration nbsp nbsp nbsp nbsp nbsp Default 30s td tr tr td td td style line height 130 word wrap break word p The period after pod start during which readiness changes will be treated as initial readiness p td tr tr td colspan 2 horizontal pod autoscaler sync period duration nbsp nbsp nbsp nbsp nbsp Default 15s td tr tr td td td style line height 130 word wrap break word p The period for syncing the number of pods in horizontal pod autoscaler p td tr tr td colspan 2 horizontal pod autoscaler tolerance float nbsp nbsp nbsp nbsp nbsp Default 0 1 td tr tr td td td style line height 130 word wrap break word p The minimum change from 1 0 in the desired to actual metrics ratio for the horizontal pod autoscaler to consider scaling p td tr tr td colspan 2 http2 max streams per connection int td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 kube api burst int32 nbsp nbsp nbsp nbsp nbsp Default 30 td tr tr td td td style line height 130 word wrap break word p Burst to use while talking with kubernetes apiserver p td tr tr td colspan 2 kube api content type string nbsp nbsp nbsp nbsp nbsp Default application vnd kubernetes protobuf td tr tr td td td style line height 130 word wrap break word p Content type of requests sent to apiserver p td tr tr td colspan 2 kube api qps float nbsp nbsp nbsp nbsp nbsp Default 20 td tr tr td td td style line height 130 word wrap break word p QPS to use while talking with kubernetes apiserver p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to kubeconfig file with authorization and master location information the master location can be overridden by the master flag p td tr tr td colspan 2 large cluster size threshold int32 nbsp nbsp nbsp nbsp nbsp Default 50 td tr tr td td td style line height 130 word wrap break word p Number of nodes from which node lifecycle controller 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 Notice If nodes reside in multiple zones this threshold will be considered as zone node size threshold for each zone to determine node eviction rate independently p td tr tr td colspan 2 leader elect nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Start a leader election client and gain leadership before executing the main loop Enable this when running replicated components for high availability p td tr tr td colspan 2 leader elect lease duration duration nbsp nbsp nbsp nbsp nbsp Default 15s td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 leader elect renew deadline duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The interval between attempts by the acting master to renew a leadership slot before it stops leading This must be less than the lease duration This is only applicable if leader election is enabled p td tr tr td colspan 2 leader elect resource lock string nbsp nbsp nbsp nbsp nbsp Default leases td tr tr td td td style line height 130 word wrap break word p The type of resource object that is used for locking during leader election Supported options are leases endpointsleases and configmapsleases p td tr tr td colspan 2 leader elect resource name string nbsp nbsp nbsp nbsp nbsp Default kube controller manager td tr tr td td td style line height 130 word wrap break word p The name of resource object that is used for locking during leader election p td tr tr td colspan 2 leader elect resource namespace string nbsp nbsp nbsp nbsp nbsp Default kube system td tr tr td td td style line height 130 word wrap break word p The namespace of resource object that is used for locking during leader election p td tr tr td colspan 2 leader elect retry period duration nbsp nbsp nbsp nbsp nbsp Default 2s td tr tr td td td style line height 130 word wrap break word p The duration the clients should wait between attempting acquisition and renewal of a leadership This is only applicable if leader election is enabled p td tr tr td colspan 2 leader migration config string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 legacy service account token clean up period duration nbsp nbsp nbsp nbsp nbsp Default 8760h0m0s td tr tr td td td style line height 130 word wrap break word p The period of time since the last usage of an legacy service account token before it can be deleted p td tr tr td colspan 2 log flush frequency duration nbsp nbsp nbsp nbsp nbsp Default 5s td tr tr td td td style line height 130 word wrap break word p Maximum number of seconds between log flushes p td tr tr td colspan 2 log text info buffer size quantity td tr tr td td td style line height 130 word wrap break word p Alpha In text format with split output streams the info messages can be buffered for a while to increase performance The default value of zero bytes disables buffering The size can be specified as number of bytes 512 multiples of 1000 1K multiples of 1024 2Ki or powers of those 3M 4G 5Mi 6Gi Enable the LoggingAlphaOptions feature gate to use this p td tr tr td colspan 2 log text split stream td tr tr td td td style line height 130 word wrap break word p Alpha In text format write error messages to stderr and info messages to stdout The default is to write a single stream to stdout Enable the LoggingAlphaOptions feature gate to use this p td tr tr td colspan 2 logging format string nbsp nbsp nbsp nbsp nbsp Default text td tr tr td td td style line height 130 word wrap break word p Sets the log format Permitted formats quot text quot p td tr tr td colspan 2 master string td tr tr td td td style line height 130 word wrap break word p The address of the Kubernetes API server overrides any value in kubeconfig p td tr tr td colspan 2 max endpoints per slice int32 nbsp nbsp nbsp nbsp nbsp Default 100 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 min resync period duration nbsp nbsp nbsp nbsp nbsp Default 12h0m0s td tr tr td td td style line height 130 word wrap break word p The resync period in reflectors will be random between MinResyncPeriod and 2 MinResyncPeriod p td tr tr td colspan 2 mirroring concurrent service endpoint syncs int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p The number of service endpoint syncing operations that will be done concurrently by the endpointslice mirroring controller Larger number faster endpoint slice updating but more CPU and network load Defaults to 5 p td tr tr td colspan 2 mirroring endpointslice updates batch period duration td tr tr td td td style line height 130 word wrap break word p The length of EndpointSlice updates batching period for endpointslice mirroring 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 p td tr tr td colspan 2 mirroring max endpoints per subset int32 nbsp nbsp nbsp nbsp nbsp Default 1000 td tr tr td td td style line height 130 word wrap break word p The maximum number of endpoints that will be added to an EndpointSlice by the endpointslice mirroring controller More endpoints per slice will result in less endpoint slices but larger resources Defaults to 100 p td tr tr td colspan 2 namespace sync period duration nbsp nbsp nbsp nbsp nbsp Default 5m0s td tr tr td td td style line height 130 word wrap break word p The period for syncing namespace life cycle updates p td tr tr td colspan 2 node cidr mask size int32 td tr tr td td td style line height 130 word wrap break word p Mask size for node cidr in cluster Default is 24 for IPv4 and 64 for IPv6 p td tr tr td colspan 2 node cidr mask size ipv4 int32 td tr tr td td td style line height 130 word wrap break word p Mask size for IPv4 node cidr in dual stack cluster Default is 24 p td tr tr td colspan 2 node cidr mask size ipv6 int32 td tr tr td td td style line height 130 word wrap break word p Mask size for IPv6 node cidr in dual stack cluster Default is 64 p td tr tr td colspan 2 node eviction rate float nbsp nbsp nbsp nbsp nbsp Default 0 1 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 node monitor grace period duration nbsp nbsp nbsp nbsp nbsp Default 40s td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 node monitor period duration nbsp nbsp nbsp nbsp nbsp Default 5s td tr tr td td td style line height 130 word wrap break word p The period for syncing NodeStatus in cloud node lifecycle controller p td tr tr td colspan 2 node startup grace period duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Amount of time which we allow starting Node to be unresponsive before marking it unhealthy p td tr tr td colspan 2 permit address sharing td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 permit port sharing td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 profiling nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Enable profiling via web interface host port debug pprof p td tr tr td colspan 2 pv recycler increment timeout nfs int32 nbsp nbsp nbsp nbsp nbsp Default 30 td tr tr td td td style line height 130 word wrap break word p the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod p td tr tr td colspan 2 pv recycler minimum timeout hostpath int32 nbsp nbsp nbsp nbsp nbsp Default 60 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 pv recycler minimum timeout nfs int32 nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p The minimum ActiveDeadlineSeconds to use for an NFS Recycler pod p td tr tr td colspan 2 pv recycler pod template filepath hostpath string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 pv recycler pod template filepath nfs string td tr tr td td td style line height 130 word wrap break word p The file path to a pod definition used as a template for NFS persistent volume recycling p td tr tr td colspan 2 pv recycler timeout increment hostpath int32 nbsp nbsp nbsp nbsp nbsp Default 30 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 pvclaimbinder sync period duration nbsp nbsp nbsp nbsp nbsp Default 15s td tr tr td td td style line height 130 word wrap break word p The period for syncing persistent volumes and persistent volume claims p td tr tr td colspan 2 requestheader allowed names strings td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 requestheader client ca file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 requestheader extra headers prefix strings nbsp nbsp nbsp nbsp nbsp Default x remote extra td tr tr td td td style line height 130 word wrap break word p List of request header prefixes to inspect X Remote Extra is suggested p td tr tr td colspan 2 requestheader group headers strings nbsp nbsp nbsp nbsp nbsp Default x remote group td tr tr td td td style line height 130 word wrap break word p List of request headers to inspect for groups X Remote Group is suggested p td tr tr td colspan 2 requestheader username headers strings nbsp nbsp nbsp nbsp nbsp Default x remote user td tr tr td td td style line height 130 word wrap break word p List of request headers to inspect for usernames X Remote User is common p td tr tr td colspan 2 resource quota sync period duration nbsp nbsp nbsp nbsp nbsp Default 5m0s td tr tr td td td style line height 130 word wrap break word p The period for syncing quota usage status in the system p td tr tr td colspan 2 root ca file string td tr tr td td td style line height 130 word wrap break word p If set this root certificate authority will be included in service account s token secret This must be a valid PEM encoded CA bundle p td tr tr td colspan 2 route reconciliation period duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The period for reconciling routes created for Nodes by cloud provider p td tr tr td colspan 2 secondary node eviction rate float nbsp nbsp nbsp nbsp nbsp Default 0 01 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 secure port int nbsp nbsp nbsp nbsp nbsp Default 10257 td tr tr td td td style line height 130 word wrap break word p The port on which to serve HTTPS with authentication and authorization If 0 don t serve HTTPS at all p td tr tr td colspan 2 service account private key file string td tr tr td td td style line height 130 word wrap break word p Filename containing a PEM encoded private RSA or ECDSA key used to sign service account tokens p td tr tr td colspan 2 service cluster ip range string td tr tr td td td style line height 130 word wrap break word p CIDR Range for Services in cluster Requires allocate node cidrs to be true p td tr tr td colspan 2 show hidden metrics for version string td tr tr td td td style line height 130 word wrap break word p 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 lt major gt lt minor gt 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 p td tr tr td colspan 2 terminated pod gc threshold int32 nbsp nbsp nbsp nbsp nbsp Default 12500 td tr tr td td td style line height 130 word wrap break word p Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods If lt 0 the terminated pod garbage collector is disabled p td tr tr td colspan 2 tls cert file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 tls cipher suites strings td tr tr td td td style line height 130 word wrap break word p Comma separated list of cipher suites for the server If omitted the default Go cipher suites will be used br 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 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 br Insecure values TLS ECDHE ECDSA WITH AES 128 CBC SHA256 TLS ECDHE ECDSA WITH RC4 128 SHA TLS ECDHE RSA WITH 3DES EDE CBC SHA TLS ECDHE RSA WITH AES 128 CBC SHA256 TLS ECDHE RSA WITH RC4 128 SHA TLS RSA WITH 3DES EDE CBC SHA TLS RSA WITH AES 128 CBC SHA TLS RSA WITH AES 128 CBC SHA256 TLS RSA WITH AES 128 GCM SHA256 TLS RSA WITH AES 256 CBC SHA TLS RSA WITH AES 256 GCM SHA384 TLS RSA WITH RC4 128 SHA p td tr tr td colspan 2 tls min version string td tr tr td td td style line height 130 word wrap break word p Minimum TLS version supported Possible values VersionTLS10 VersionTLS11 VersionTLS12 VersionTLS13 p td tr tr td colspan 2 tls private key file string td tr tr td td td style line height 130 word wrap break word p File containing the default x509 private key matching tls cert file p td tr tr td colspan 2 tls sni cert key string td tr tr td td td style line height 130 word wrap break word p 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 quot example crt example key quot or quot foo crt foo key foo com foo com quot p td tr tr td colspan 2 unhealthy zone threshold float nbsp nbsp nbsp nbsp nbsp Default 0 55 td tr tr td td td style line height 130 word wrap break word p Fraction of Nodes in a zone which needs to be not Ready minimum 3 for zone to be treated as unhealthy p td tr tr td colspan 2 use service account credentials td tr tr td td td style line height 130 word wrap break word p If true use individual service account credentials for each controller p td tr tr td colspan 2 v v int td tr tr td td td style line height 130 word wrap break word p number for the log level verbosity p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 vmodule pattern N td tr tr td td td style line height 130 word wrap break word p comma separated list of pattern N settings for file filtered logging only works for text log format p td tr tbody table |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference title kube proxy weight 30 autogenerated true | ---
title: kube-proxy
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
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]
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--add_dir_header</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, adds the file directory to the header of the log messages</p></td>
</tr>
<tr>
<td colspan="2">--alsologtostderr</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>log to standard error as well as files (no effect when -logtostderr=true)</p></td>
</tr>
<tr>
<td colspan="2">--bind-address string Default: 0.0.0.0</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Overrides kube-proxy's idea of what its node's primary IP is. Note that the name is a historical artifact, and kube-proxy does not actually bind any sockets to this IP. This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--bind-address-hard-fail</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true kube-proxy will treat failure to bind to a port as fatal and exit</p></td>
</tr>
<tr>
<td colspan="2">--cleanup</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true cleanup iptables and ipvs rules and exit.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-cidr string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The CIDR range of the pods in the cluster. (For dual-stack clusters, this can be a comma-separated dual-stack pair of CIDR ranges.). When --detect-local-mode is set to ClusterCIDR, kube-proxy will consider traffic to be local if its source IP is in this range. (Otherwise it is not used.) This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path to the configuration file.</p></td>
</tr>
<tr>
<td colspan="2">--config-sync-period duration Default: 15m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>How often configuration from the apiserver is refreshed. Must be greater than 0.</p></td>
</tr>
<tr>
<td colspan="2">--conntrack-max-per-core int32 Default: 32768</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min).</p></td>
</tr>
<tr>
<td colspan="2">--conntrack-min int32 Default: 131072</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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).</p></td>
</tr>
<tr>
<td colspan="2">--conntrack-tcp-be-liberal</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enable liberal mode for tracking TCP packets by setting nf_conntrack_tcp_be_liberal to 1</p></td>
</tr>
<tr>
<td colspan="2">--conntrack-tcp-timeout-close-wait duration Default: 1h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>NAT timeout for TCP connections in the CLOSE_WAIT state</p></td>
</tr>
<tr>
<td colspan="2">--conntrack-tcp-timeout-established duration Default: 24h0m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Idle timeout for established TCP connections (0 to leave as-is)</p></td>
</tr>
<tr>
<td colspan="2">--conntrack-udp-timeout duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Idle timeout for UNREPLIED UDP connections (0 to leave as-is)</p></td>
</tr>
<tr>
<td colspan="2">--conntrack-udp-timeout-stream duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Idle timeout for ASSURED UDP connections (0 to leave as-is)</p></td>
</tr>
<tr>
<td colspan="2">--detect-local-mode LocalMode</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Mode to use to detect local traffic. This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--feature-gates <comma-separated 'key=True|False' pairs></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:<br/>APIResponseCompression=true|false (BETA - default=true)<br/>APIServerIdentity=true|false (BETA - default=true)<br/>APIServerTracing=true|false (BETA - default=true)<br/>APIServingWithRoutine=true|false (ALPHA - default=false)<br/>AllAlpha=true|false (ALPHA - default=false)<br/>AllBeta=true|false (BETA - default=false)<br/>AnonymousAuthConfigurableEndpoints=true|false (ALPHA - default=false)<br/>AnyVolumeDataSource=true|false (BETA - default=true)<br/>AuthorizeNodeWithSelectors=true|false (ALPHA - default=false)<br/>AuthorizeWithSelectors=true|false (ALPHA - default=false)<br/>CPUManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>CPUManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>CPUManagerPolicyOptions=true|false (BETA - default=true)<br/>CRDValidationRatcheting=true|false (BETA - default=true)<br/>CSIMigrationPortworx=true|false (BETA - default=true)<br/>CSIVolumeHealth=true|false (ALPHA - default=false)<br/>CloudControllerManagerWebhook=true|false (ALPHA - default=false)<br/>ClusterTrustBundle=true|false (ALPHA - default=false)<br/>ClusterTrustBundleProjection=true|false (ALPHA - default=false)<br/>ComponentSLIs=true|false (BETA - default=true)<br/>ConcurrentWatchObjectDecode=true|false (BETA - default=false)<br/>ConsistentListFromCache=true|false (BETA - default=true)<br/>ContainerCheckpoint=true|false (BETA - default=true)<br/>ContextualLogging=true|false (BETA - default=true)<br/>CoordinatedLeaderElection=true|false (ALPHA - default=false)<br/>CronJobsScheduledAnnotation=true|false (BETA - default=true)<br/>CrossNamespaceVolumeDataSource=true|false (ALPHA - default=false)<br/>CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)<br/>CustomResourceFieldSelectors=true|false (BETA - default=true)<br/>DRAControlPlaneController=true|false (ALPHA - default=false)<br/>DisableAllocatorDualWrite=true|false (ALPHA - default=false)<br/>DisableNodeKubeProxyVersion=true|false (BETA - default=true)<br/>DynamicResourceAllocation=true|false (ALPHA - default=false)<br/>EventedPLEG=true|false (ALPHA - default=false)<br/>GracefulNodeShutdown=true|false (BETA - default=true)<br/>GracefulNodeShutdownBasedOnPodPriority=true|false (BETA - default=true)<br/>HPAScaleToZero=true|false (ALPHA - default=false)<br/>HonorPVReclaimPolicy=true|false (BETA - default=true)<br/>ImageMaximumGCAge=true|false (BETA - default=true)<br/>ImageVolume=true|false (ALPHA - default=false)<br/>InPlacePodVerticalScaling=true|false (ALPHA - default=false)<br/>InTreePluginPortworxUnregister=true|false (ALPHA - default=false)<br/>InformerResourceVersion=true|false (ALPHA - default=false)<br/>JobBackoffLimitPerIndex=true|false (BETA - default=true)<br/>JobManagedBy=true|false (ALPHA - default=false)<br/>JobPodReplacementPolicy=true|false (BETA - default=true)<br/>JobSuccessPolicy=true|false (BETA - default=true)<br/>KubeletCgroupDriverFromCRI=true|false (BETA - default=true)<br/>KubeletInUserNamespace=true|false (ALPHA - default=false)<br/>KubeletPodResourcesDynamicResources=true|false (ALPHA - default=false)<br/>KubeletPodResourcesGet=true|false (ALPHA - default=false)<br/>KubeletSeparateDiskGC=true|false (BETA - default=true)<br/>KubeletTracing=true|false (BETA - default=true)<br/>LoadBalancerIPMode=true|false (BETA - default=true)<br/>LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (BETA - default=false)<br/>LoggingAlphaOptions=true|false (ALPHA - default=false)<br/>LoggingBetaOptions=true|false (BETA - default=true)<br/>MatchLabelKeysInPodAffinity=true|false (BETA - default=true)<br/>MatchLabelKeysInPodTopologySpread=true|false (BETA - default=true)<br/>MaxUnavailableStatefulSet=true|false (ALPHA - default=false)<br/>MemoryManager=true|false (BETA - default=true)<br/>MemoryQoS=true|false (ALPHA - default=false)<br/>MultiCIDRServiceAllocator=true|false (BETA - default=false)<br/>MutatingAdmissionPolicy=true|false (ALPHA - default=false)<br/>NFTablesProxyMode=true|false (BETA - default=true)<br/>NodeInclusionPolicyInPodTopologySpread=true|false (BETA - default=true)<br/>NodeLogQuery=true|false (BETA - default=false)<br/>NodeSwap=true|false (BETA - default=true)<br/>OpenAPIEnums=true|false (BETA - default=true)<br/>PodAndContainerStatsFromCRI=true|false (ALPHA - default=false)<br/>PodDeletionCost=true|false (BETA - default=true)<br/>PodIndexLabel=true|false (BETA - default=true)<br/>PodLifecycleSleepAction=true|false (BETA - default=true)<br/>PodReadyToStartContainersCondition=true|false (BETA - default=true)<br/>PortForwardWebsockets=true|false (BETA - default=true)<br/>ProcMountType=true|false (BETA - default=false)<br/>QOSReserved=true|false (ALPHA - default=false)<br/>RecoverVolumeExpansionFailure=true|false (ALPHA - default=false)<br/>RecursiveReadOnlyMounts=true|false (BETA - default=true)<br/>RelaxedEnvironmentVariableValidation=true|false (ALPHA - default=false)<br/>ReloadKubeletServerCertificateFile=true|false (BETA - default=true)<br/>ResilientWatchCacheInitialization=true|false (BETA - default=true)<br/>ResourceHealthStatus=true|false (ALPHA - default=false)<br/>RetryGenerateName=true|false (BETA - default=true)<br/>RotateKubeletServerCertificate=true|false (BETA - default=true)<br/>RuntimeClassInImageCriApi=true|false (ALPHA - default=false)<br/>SELinuxMount=true|false (ALPHA - default=false)<br/>SELinuxMountReadWriteOncePod=true|false (BETA - default=true)<br/>SchedulerQueueingHints=true|false (BETA - default=false)<br/>SeparateCacheWatchRPC=true|false (BETA - default=true)<br/>SeparateTaintEvictionController=true|false (BETA - default=true)<br/>ServiceAccountTokenJTI=true|false (BETA - default=true)<br/>ServiceAccountTokenNodeBinding=true|false (BETA - default=true)<br/>ServiceAccountTokenNodeBindingValidation=true|false (BETA - default=true)<br/>ServiceAccountTokenPodNodeInfo=true|false (BETA - default=true)<br/>ServiceTrafficDistribution=true|false (BETA - default=true)<br/>SidecarContainers=true|false (BETA - default=true)<br/>SizeMemoryBackedVolumes=true|false (BETA - default=true)<br/>StatefulSetAutoDeletePVC=true|false (BETA - default=true)<br/>StorageNamespaceIndex=true|false (BETA - default=true)<br/>StorageVersionAPI=true|false (ALPHA - default=false)<br/>StorageVersionHash=true|false (BETA - default=true)<br/>StorageVersionMigrator=true|false (ALPHA - default=false)<br/>StrictCostEnforcementForVAP=true|false (BETA - default=false)<br/>StrictCostEnforcementForWebhooks=true|false (BETA - default=false)<br/>StructuredAuthenticationConfiguration=true|false (BETA - default=true)<br/>StructuredAuthorizationConfiguration=true|false (BETA - default=true)<br/>SupplementalGroupsPolicy=true|false (ALPHA - default=false)<br/>TopologyAwareHints=true|false (BETA - default=true)<br/>TopologyManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>TopologyManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>TopologyManagerPolicyOptions=true|false (BETA - default=true)<br/>TranslateStreamCloseWebsocketRequests=true|false (BETA - default=true)<br/>UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=true)<br/>UnknownVersionInteroperabilityProxy=true|false (ALPHA - default=false)<br/>UserNamespacesPodSecurityStandards=true|false (ALPHA - default=false)<br/>UserNamespacesSupport=true|false (BETA - default=false)<br/>VolumeAttributesClass=true|false (BETA - default=false)<br/>VolumeCapacityPriority=true|false (ALPHA - default=false)<br/>WatchCacheInitializationPostStartHook=true|false (BETA - default=false)<br/>WatchFromStorageWithoutResourceVersion=true|false (BETA - default=false)<br/>WatchList=true|false (ALPHA - default=false)<br/>WatchListClient=true|false (BETA - default=false)<br/>WinDSR=true|false (ALPHA - default=false)<br/>WinOverlay=true|false (BETA - default=true)<br/>WindowsHostNetwork=true|false (ALPHA - default=true)<br/>This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--healthz-bind-address ipport Default: 0.0.0.0:10256</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The IP address and port for the health check server to serve on, defaulting to "0.0.0.0:10256". This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for kube-proxy</p></td>
</tr>
<tr>
<td colspan="2">--hostname-override string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-empty, will be used as the name of the Node that kube-proxy is running on. If unset, the node name is assumed to be the same as the node's hostname.</p></td>
</tr>
<tr>
<td colspan="2">--init-only</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, perform any initialization steps that must be done with full root privileges, and then exit. After doing this, you can run kube-proxy again with only the CAP_NET_ADMIN capability.</p></td>
</tr>
<tr>
<td colspan="2">--iptables-localhost-nodeports Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If false, kube-proxy will disable the legacy behavior of allowing NodePort services to be accessed via localhost. (Applies only to iptables mode and IPv4; localhost NodePorts are never allowed with other proxy modes or with IPv6.)</p></td>
</tr>
<tr>
<td colspan="2">--iptables-masquerade-bit int32 Default: 14</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If using the iptables or ipvs proxy mode, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31].</p></td>
</tr>
<tr>
<td colspan="2">--iptables-min-sync-period duration Default: 1s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The minimum period between iptables rule resyncs (e.g. '5s', '1m', '2h22m'). A value of 0 means every Service or EndpointSlice change will result in an immediate iptables resync.</p></td>
</tr>
<tr>
<td colspan="2">--iptables-sync-period duration Default: 30s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>An interval (e.g. '5s', '1m', '2h22m') indicating how frequently various re-synchronizing and cleanup operations are performed. Must be greater than 0.</p></td>
</tr>
<tr>
<td colspan="2">--ipvs-exclude-cidrs strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A comma-separated list of CIDRs which the ipvs proxier should not touch when cleaning up IPVS rules.</p></td>
</tr>
<tr>
<td colspan="2">--ipvs-min-sync-period duration Default: 1s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The minimum period between IPVS rule resyncs (e.g. '5s', '1m', '2h22m'). A value of 0 means every Service or EndpointSlice change will result in an immediate IPVS resync.</p></td>
</tr>
<tr>
<td colspan="2">--ipvs-scheduler string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The ipvs scheduler type when proxy mode is ipvs</p></td>
</tr>
<tr>
<td colspan="2">--ipvs-strict-arp</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Enable strict ARP by setting arp_ignore to 1 and arp_announce to 2</p></td>
</tr>
<tr>
<td colspan="2">--ipvs-sync-period duration Default: 30s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>An interval (e.g. '5s', '1m', '2h22m') indicating how frequently various re-synchronizing and cleanup operations are performed. Must be greater than 0.</p></td>
</tr>
<tr>
<td colspan="2">--ipvs-tcp-timeout duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The timeout for idle IPVS TCP connections, 0 to leave as-is. (e.g. '5s', '1m', '2h22m').</p></td>
</tr>
<tr>
<td colspan="2">--ipvs-tcpfin-timeout duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The timeout for IPVS TCP connections after receiving a FIN packet, 0 to leave as-is. (e.g. '5s', '1m', '2h22m').</p></td>
</tr>
<tr>
<td colspan="2">--ipvs-udp-timeout duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The timeout for IPVS UDP packets, 0 to leave as-is. (e.g. '5s', '1m', '2h22m').</p></td>
</tr>
<tr>
<td colspan="2">--kube-api-burst int32 Default: 10</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Burst to use while talking with kubernetes apiserver</p></td>
</tr>
<tr>
<td colspan="2">--kube-api-content-type string Default: "application/vnd.kubernetes.protobuf"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Content type of requests sent to apiserver.</p></td>
</tr>
<tr>
<td colspan="2">--kube-api-qps float Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>QPS to use while talking with kubernetes apiserver</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to kubeconfig file with authorization information (the master location can be overridden by the master flag).</p></td>
</tr>
<tr>
<td colspan="2">--log-flush-frequency duration Default: 5s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum number of seconds between log flushes</p></td>
</tr>
<tr>
<td colspan="2">--log-text-info-buffer-size quantity</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this.</p></td>
</tr>
<tr>
<td colspan="2">--log-text-split-stream</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[Alpha] In text format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this.</p></td>
</tr>
<tr>
<td colspan="2">--log_backtrace_at <a string in the form 'file:N'> Default: :0</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>when logging hits line file:N, emit a stack trace</p></td>
</tr>
<tr>
<td colspan="2">--log_dir string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-empty, write log files in this directory (no effect when -logtostderr=true)</p></td>
</tr>
<tr>
<td colspan="2">--log_file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-empty, use this log file (no effect when -logtostderr=true)</p></td>
</tr>
<tr>
<td colspan="2">--log_file_max_size uint Default: 1800</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited.</p></td>
</tr>
<tr>
<td colspan="2">--logging-format string Default: "text"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Sets the log format. Permitted formats: "text".</p></td>
</tr>
<tr>
<td colspan="2">--logtostderr Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>log to standard error instead of files</p></td>
</tr>
<tr>
<td colspan="2">--masquerade-all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>SNAT all traffic sent via Service cluster IPs. This may be required with some CNI plugins. Only supported on Linux.</p></td>
</tr>
<tr>
<td colspan="2">--master string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address of the Kubernetes API server (overrides any value in kubeconfig)</p></td>
</tr>
<tr>
<td colspan="2">--metrics-bind-address ipport Default: 127.0.0.1:10249</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The IP address and port for the metrics server to serve on, defaulting to "127.0.0.1:10249". (Set to "0.0.0.0:10249" / "[::]:10249" to bind on all interfaces.) Set empty to disable. This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--nodeport-addresses strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A list of CIDR ranges that contain valid node IPs, or alternatively, the single string 'primary'. If set to a list of CIDRs, connections to NodePort services will only be accepted on node IPs in one of the indicated ranges. If set to 'primary', NodePort services will only be accepted on the node's primary IP(s) according to the Node object. If unset, NodePort connections will be accepted on all local IPs. This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--one_output</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)</p></td>
</tr>
<tr>
<td colspan="2">--oom-score-adj int32 Default: -999</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000]. This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--pod-bridge-interface string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A bridge interface name. When --detect-local-mode is set to BridgeInterface, kube-proxy will consider traffic to be local if it originates from this bridge.</p></td>
</tr>
<tr>
<td colspan="2">--pod-interface-name-prefix string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>An interface name prefix. When --detect-local-mode is set to InterfaceNamePrefix, kube-proxy will consider traffic to be local if it originates from any interface whose name begins with this prefix.</p></td>
</tr>
<tr>
<td colspan="2">--profiling</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true enables profiling via web interface on /debug/pprof handler. This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--proxy-mode ProxyMode</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Which proxy mode to use: on Linux this can be 'iptables' (default) or 'ipvs'. On Windows the only supported value is 'kernelspace'.This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--show-hidden-metrics-for-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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. This parameter is ignored if a config file is specified by --config.</p></td>
</tr>
<tr>
<td colspan="2">--skip_headers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, avoid header prefixes in the log messages</p></td>
</tr>
<tr>
<td colspan="2">--skip_log_headers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, avoid headers when opening log files (no effect when -logtostderr=true)</p></td>
</tr>
<tr>
<td colspan="2">--stderrthreshold int Default: 2</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true)</p></td>
</tr>
<tr>
<td colspan="2">-v, --v int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>number for the log level verbosity</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--vmodule pattern=N,...</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)</p></td>
</tr>
<tr>
<td colspan="2">--write-config-to string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If set, write the default configuration values to this file and exit.</p></td>
</tr>
</tbody>
</table>
| kubernetes reference | title kube proxy content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project 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 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 add dir header td tr tr td td td style line height 130 word wrap break word p If true adds the file directory to the header of the log messages p td tr tr td colspan 2 alsologtostderr td tr tr td td td style line height 130 word wrap break word p log to standard error as well as files no effect when logtostderr true p td tr tr td colspan 2 bind address string nbsp nbsp nbsp nbsp nbsp Default 0 0 0 0 td tr tr td td td style line height 130 word wrap break word p Overrides kube proxy s idea of what its node s primary IP is Note that the name is a historical artifact and kube proxy does not actually bind any sockets to this IP This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 bind address hard fail td tr tr td td td style line height 130 word wrap break word p If true kube proxy will treat failure to bind to a port as fatal and exit p td tr tr td colspan 2 cleanup td tr tr td td td style line height 130 word wrap break word p If true cleanup iptables and ipvs rules and exit p td tr tr td colspan 2 cluster cidr string td tr tr td td td style line height 130 word wrap break word p The CIDR range of the pods in the cluster For dual stack clusters this can be a comma separated dual stack pair of CIDR ranges When detect local mode is set to ClusterCIDR kube proxy will consider traffic to be local if its source IP is in this range Otherwise it is not used This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 config string td tr tr td td td style line height 130 word wrap break word p The path to the configuration file p td tr tr td colspan 2 config sync period duration nbsp nbsp nbsp nbsp nbsp Default 15m0s td tr tr td td td style line height 130 word wrap break word p How often configuration from the apiserver is refreshed Must be greater than 0 p td tr tr td colspan 2 conntrack max per core int32 nbsp nbsp nbsp nbsp nbsp Default 32768 td tr tr td td td style line height 130 word wrap break word p Maximum number of NAT connections to track per CPU core 0 to leave the limit as is and ignore conntrack min p td tr tr td colspan 2 conntrack min int32 nbsp nbsp nbsp nbsp nbsp Default 131072 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 conntrack tcp be liberal td tr tr td td td style line height 130 word wrap break word p Enable liberal mode for tracking TCP packets by setting nf conntrack tcp be liberal to 1 p td tr tr td colspan 2 conntrack tcp timeout close wait duration nbsp nbsp nbsp nbsp nbsp Default 1h0m0s td tr tr td td td style line height 130 word wrap break word p NAT timeout for TCP connections in the CLOSE WAIT state p td tr tr td colspan 2 conntrack tcp timeout established duration nbsp nbsp nbsp nbsp nbsp Default 24h0m0s td tr tr td td td style line height 130 word wrap break word p Idle timeout for established TCP connections 0 to leave as is p td tr tr td colspan 2 conntrack udp timeout duration td tr tr td td td style line height 130 word wrap break word p Idle timeout for UNREPLIED UDP connections 0 to leave as is p td tr tr td colspan 2 conntrack udp timeout stream duration td tr tr td td td style line height 130 word wrap break word p Idle timeout for ASSURED UDP connections 0 to leave as is p td tr tr td colspan 2 detect local mode LocalMode td tr tr td td td style line height 130 word wrap break word p Mode to use to detect local traffic This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 feature gates lt comma separated key True False pairs gt td tr tr td td td style line height 130 word wrap break word p A set of key value pairs that describe feature gates for alpha experimental features Options are br APIResponseCompression true false BETA default true br APIServerIdentity true false BETA default true br APIServerTracing true false BETA default true br APIServingWithRoutine true false ALPHA default false br AllAlpha true false ALPHA default false br AllBeta true false BETA default false br AnonymousAuthConfigurableEndpoints true false ALPHA default false br AnyVolumeDataSource true false BETA default true br AuthorizeNodeWithSelectors true false ALPHA default false br AuthorizeWithSelectors true false ALPHA default false br CPUManagerPolicyAlphaOptions true false ALPHA default false br CPUManagerPolicyBetaOptions true false BETA default true br CPUManagerPolicyOptions true false BETA default true br CRDValidationRatcheting true false BETA default true br CSIMigrationPortworx true false BETA default true br CSIVolumeHealth true false ALPHA default false br CloudControllerManagerWebhook true false ALPHA default false br ClusterTrustBundle true false ALPHA default false br ClusterTrustBundleProjection true false ALPHA default false br ComponentSLIs true false BETA default true br ConcurrentWatchObjectDecode true false BETA default false br ConsistentListFromCache true false BETA default true br ContainerCheckpoint true false BETA default true br ContextualLogging true false BETA default true br CoordinatedLeaderElection true false ALPHA default false br CronJobsScheduledAnnotation true false BETA default true br CrossNamespaceVolumeDataSource true false ALPHA default false br CustomCPUCFSQuotaPeriod true false ALPHA default false br CustomResourceFieldSelectors true false BETA default true br DRAControlPlaneController true false ALPHA default false br DisableAllocatorDualWrite true false ALPHA default false br DisableNodeKubeProxyVersion true false BETA default true br DynamicResourceAllocation true false ALPHA default false br EventedPLEG true false ALPHA default false br GracefulNodeShutdown true false BETA default true br GracefulNodeShutdownBasedOnPodPriority true false BETA default true br HPAScaleToZero true false ALPHA default false br HonorPVReclaimPolicy true false BETA default true br ImageMaximumGCAge true false BETA default true br ImageVolume true false ALPHA default false br InPlacePodVerticalScaling true false ALPHA default false br InTreePluginPortworxUnregister true false ALPHA default false br InformerResourceVersion true false ALPHA default false br JobBackoffLimitPerIndex true false BETA default true br JobManagedBy true false ALPHA default false br JobPodReplacementPolicy true false BETA default true br JobSuccessPolicy true false BETA default true br KubeletCgroupDriverFromCRI true false BETA default true br KubeletInUserNamespace true false ALPHA default false br KubeletPodResourcesDynamicResources true false ALPHA default false br KubeletPodResourcesGet true false ALPHA default false br KubeletSeparateDiskGC true false BETA default true br KubeletTracing true false BETA default true br LoadBalancerIPMode true false BETA default true br LocalStorageCapacityIsolationFSQuotaMonitoring true false BETA default false br LoggingAlphaOptions true false ALPHA default false br LoggingBetaOptions true false BETA default true br MatchLabelKeysInPodAffinity true false BETA default true br MatchLabelKeysInPodTopologySpread true false BETA default true br MaxUnavailableStatefulSet true false ALPHA default false br MemoryManager true false BETA default true br MemoryQoS true false ALPHA default false br MultiCIDRServiceAllocator true false BETA default false br MutatingAdmissionPolicy true false ALPHA default false br NFTablesProxyMode true false BETA default true br NodeInclusionPolicyInPodTopologySpread true false BETA default true br NodeLogQuery true false BETA default false br NodeSwap true false BETA default true br OpenAPIEnums true false BETA default true br PodAndContainerStatsFromCRI true false ALPHA default false br PodDeletionCost true false BETA default true br PodIndexLabel true false BETA default true br PodLifecycleSleepAction true false BETA default true br PodReadyToStartContainersCondition true false BETA default true br PortForwardWebsockets true false BETA default true br ProcMountType true false BETA default false br QOSReserved true false ALPHA default false br RecoverVolumeExpansionFailure true false ALPHA default false br RecursiveReadOnlyMounts true false BETA default true br RelaxedEnvironmentVariableValidation true false ALPHA default false br ReloadKubeletServerCertificateFile true false BETA default true br ResilientWatchCacheInitialization true false BETA default true br ResourceHealthStatus true false ALPHA default false br RetryGenerateName true false BETA default true br RotateKubeletServerCertificate true false BETA default true br RuntimeClassInImageCriApi true false ALPHA default false br SELinuxMount true false ALPHA default false br SELinuxMountReadWriteOncePod true false BETA default true br SchedulerQueueingHints true false BETA default false br SeparateCacheWatchRPC true false BETA default true br SeparateTaintEvictionController true false BETA default true br ServiceAccountTokenJTI true false BETA default true br ServiceAccountTokenNodeBinding true false BETA default true br ServiceAccountTokenNodeBindingValidation true false BETA default true br ServiceAccountTokenPodNodeInfo true false BETA default true br ServiceTrafficDistribution true false BETA default true br SidecarContainers true false BETA default true br SizeMemoryBackedVolumes true false BETA default true br StatefulSetAutoDeletePVC true false BETA default true br StorageNamespaceIndex true false BETA default true br StorageVersionAPI true false ALPHA default false br StorageVersionHash true false BETA default true br StorageVersionMigrator true false ALPHA default false br StrictCostEnforcementForVAP true false BETA default false br StrictCostEnforcementForWebhooks true false BETA default false br StructuredAuthenticationConfiguration true false BETA default true br StructuredAuthorizationConfiguration true false BETA default true br SupplementalGroupsPolicy true false ALPHA default false br TopologyAwareHints true false BETA default true br TopologyManagerPolicyAlphaOptions true false ALPHA default false br TopologyManagerPolicyBetaOptions true false BETA default true br TopologyManagerPolicyOptions true false BETA default true br TranslateStreamCloseWebsocketRequests true false BETA default true br UnauthenticatedHTTP2DOSMitigation true false BETA default true br UnknownVersionInteroperabilityProxy true false ALPHA default false br UserNamespacesPodSecurityStandards true false ALPHA default false br UserNamespacesSupport true false BETA default false br VolumeAttributesClass true false BETA default false br VolumeCapacityPriority true false ALPHA default false br WatchCacheInitializationPostStartHook true false BETA default false br WatchFromStorageWithoutResourceVersion true false BETA default false br WatchList true false ALPHA default false br WatchListClient true false BETA default false br WinDSR true false ALPHA default false br WinOverlay true false BETA default true br WindowsHostNetwork true false ALPHA default true br This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 healthz bind address ipport nbsp nbsp nbsp nbsp nbsp Default 0 0 0 0 10256 td tr tr td td td style line height 130 word wrap break word p The IP address and port for the health check server to serve on defaulting to quot 0 0 0 0 10256 quot This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for kube proxy p td tr tr td colspan 2 hostname override string td tr tr td td td style line height 130 word wrap break word p If non empty will be used as the name of the Node that kube proxy is running on If unset the node name is assumed to be the same as the node s hostname p td tr tr td colspan 2 init only td tr tr td td td style line height 130 word wrap break word p If true perform any initialization steps that must be done with full root privileges and then exit After doing this you can run kube proxy again with only the CAP NET ADMIN capability p td tr tr td colspan 2 iptables localhost nodeports nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If false kube proxy will disable the legacy behavior of allowing NodePort services to be accessed via localhost Applies only to iptables mode and IPv4 localhost NodePorts are never allowed with other proxy modes or with IPv6 p td tr tr td colspan 2 iptables masquerade bit int32 nbsp nbsp nbsp nbsp nbsp Default 14 td tr tr td td td style line height 130 word wrap break word p If using the iptables or ipvs proxy mode the bit of the fwmark space to mark packets requiring SNAT with Must be within the range 0 31 p td tr tr td colspan 2 iptables min sync period duration nbsp nbsp nbsp nbsp nbsp Default 1s td tr tr td td td style line height 130 word wrap break word p The minimum period between iptables rule resyncs e g 5s 1m 2h22m A value of 0 means every Service or EndpointSlice change will result in an immediate iptables resync p td tr tr td colspan 2 iptables sync period duration nbsp nbsp nbsp nbsp nbsp Default 30s td tr tr td td td style line height 130 word wrap break word p An interval e g 5s 1m 2h22m indicating how frequently various re synchronizing and cleanup operations are performed Must be greater than 0 p td tr tr td colspan 2 ipvs exclude cidrs strings td tr tr td td td style line height 130 word wrap break word p A comma separated list of CIDRs which the ipvs proxier should not touch when cleaning up IPVS rules p td tr tr td colspan 2 ipvs min sync period duration nbsp nbsp nbsp nbsp nbsp Default 1s td tr tr td td td style line height 130 word wrap break word p The minimum period between IPVS rule resyncs e g 5s 1m 2h22m A value of 0 means every Service or EndpointSlice change will result in an immediate IPVS resync p td tr tr td colspan 2 ipvs scheduler string td tr tr td td td style line height 130 word wrap break word p The ipvs scheduler type when proxy mode is ipvs p td tr tr td colspan 2 ipvs strict arp td tr tr td td td style line height 130 word wrap break word p Enable strict ARP by setting arp ignore to 1 and arp announce to 2 p td tr tr td colspan 2 ipvs sync period duration nbsp nbsp nbsp nbsp nbsp Default 30s td tr tr td td td style line height 130 word wrap break word p An interval e g 5s 1m 2h22m indicating how frequently various re synchronizing and cleanup operations are performed Must be greater than 0 p td tr tr td colspan 2 ipvs tcp timeout duration td tr tr td td td style line height 130 word wrap break word p The timeout for idle IPVS TCP connections 0 to leave as is e g 5s 1m 2h22m p td tr tr td colspan 2 ipvs tcpfin timeout duration td tr tr td td td style line height 130 word wrap break word p The timeout for IPVS TCP connections after receiving a FIN packet 0 to leave as is e g 5s 1m 2h22m p td tr tr td colspan 2 ipvs udp timeout duration td tr tr td td td style line height 130 word wrap break word p The timeout for IPVS UDP packets 0 to leave as is e g 5s 1m 2h22m p td tr tr td colspan 2 kube api burst int32 nbsp nbsp nbsp nbsp nbsp Default 10 td tr tr td td td style line height 130 word wrap break word p Burst to use while talking with kubernetes apiserver p td tr tr td colspan 2 kube api content type string nbsp nbsp nbsp nbsp nbsp Default application vnd kubernetes protobuf td tr tr td td td style line height 130 word wrap break word p Content type of requests sent to apiserver p td tr tr td colspan 2 kube api qps float nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p QPS to use while talking with kubernetes apiserver p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to kubeconfig file with authorization information the master location can be overridden by the master flag p td tr tr td colspan 2 log flush frequency duration nbsp nbsp nbsp nbsp nbsp Default 5s td tr tr td td td style line height 130 word wrap break word p Maximum number of seconds between log flushes p td tr tr td colspan 2 log text info buffer size quantity td tr tr td td td style line height 130 word wrap break word p Alpha In text format with split output streams the info messages can be buffered for a while to increase performance The default value of zero bytes disables buffering The size can be specified as number of bytes 512 multiples of 1000 1K multiples of 1024 2Ki or powers of those 3M 4G 5Mi 6Gi Enable the LoggingAlphaOptions feature gate to use this p td tr tr td colspan 2 log text split stream td tr tr td td td style line height 130 word wrap break word p Alpha In text format write error messages to stderr and info messages to stdout The default is to write a single stream to stdout Enable the LoggingAlphaOptions feature gate to use this p td tr tr td colspan 2 log backtrace at lt a string in the form file N gt nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p when logging hits line file N emit a stack trace p td tr tr td colspan 2 log dir string td tr tr td td td style line height 130 word wrap break word p If non empty write log files in this directory no effect when logtostderr true p td tr tr td colspan 2 log file string td tr tr td td td style line height 130 word wrap break word p If non empty use this log file no effect when logtostderr true p td tr tr td colspan 2 log file max size uint nbsp nbsp nbsp nbsp nbsp Default 1800 td tr tr td td td style line height 130 word wrap break word p Defines the maximum size a log file can grow to no effect when logtostderr true Unit is megabytes If the value is 0 the maximum file size is unlimited p td tr tr td colspan 2 logging format string nbsp nbsp nbsp nbsp nbsp Default text td tr tr td td td style line height 130 word wrap break word p Sets the log format Permitted formats quot text quot p td tr tr td colspan 2 logtostderr nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p log to standard error instead of files p td tr tr td colspan 2 masquerade all td tr tr td td td style line height 130 word wrap break word p SNAT all traffic sent via Service cluster IPs This may be required with some CNI plugins Only supported on Linux p td tr tr td colspan 2 master string td tr tr td td td style line height 130 word wrap break word p The address of the Kubernetes API server overrides any value in kubeconfig p td tr tr td colspan 2 metrics bind address ipport nbsp nbsp nbsp nbsp nbsp Default 127 0 0 1 10249 td tr tr td td td style line height 130 word wrap break word p The IP address and port for the metrics server to serve on defaulting to quot 127 0 0 1 10249 quot Set to quot 0 0 0 0 10249 quot quot 10249 quot to bind on all interfaces Set empty to disable This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 nodeport addresses strings td tr tr td td td style line height 130 word wrap break word p A list of CIDR ranges that contain valid node IPs or alternatively the single string primary If set to a list of CIDRs connections to NodePort services will only be accepted on node IPs in one of the indicated ranges If set to primary NodePort services will only be accepted on the node s primary IP s according to the Node object If unset NodePort connections will be accepted on all local IPs This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 one output td tr tr td td td style line height 130 word wrap break word p If true only write logs to their native severity level vs also writing to each lower severity level no effect when logtostderr true p td tr tr td colspan 2 oom score adj int32 nbsp nbsp nbsp nbsp nbsp Default 999 td tr tr td td td style line height 130 word wrap break word p The oom score adj value for kube proxy process Values must be within the range 1000 1000 This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 pod bridge interface string td tr tr td td td style line height 130 word wrap break word p A bridge interface name When detect local mode is set to BridgeInterface kube proxy will consider traffic to be local if it originates from this bridge p td tr tr td colspan 2 pod interface name prefix string td tr tr td td td style line height 130 word wrap break word p An interface name prefix When detect local mode is set to InterfaceNamePrefix kube proxy will consider traffic to be local if it originates from any interface whose name begins with this prefix p td tr tr td colspan 2 profiling td tr tr td td td style line height 130 word wrap break word p If true enables profiling via web interface on debug pprof handler This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 proxy mode ProxyMode td tr tr td td td style line height 130 word wrap break word p Which proxy mode to use on Linux this can be iptables default or ipvs On Windows the only supported value is kernelspace This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 show hidden metrics for version string td tr tr td td td style line height 130 word wrap break word p 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 lt major gt lt minor gt 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 This parameter is ignored if a config file is specified by config p td tr tr td colspan 2 skip headers td tr tr td td td style line height 130 word wrap break word p If true avoid header prefixes in the log messages p td tr tr td colspan 2 skip log headers td tr tr td td td style line height 130 word wrap break word p If true avoid headers when opening log files no effect when logtostderr true p td tr tr td colspan 2 stderrthreshold int nbsp nbsp nbsp nbsp nbsp Default 2 td tr tr td td td style line height 130 word wrap break word p logs at or above this threshold go to stderr when writing to files and stderr no effect when logtostderr true or alsologtostderr true p td tr tr td colspan 2 v v int td tr tr td td td style line height 130 word wrap break word p number for the log level verbosity p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 vmodule pattern N td tr tr td td td style line height 130 word wrap break word p comma separated list of pattern N settings for file filtered logging only works for text log format p td tr tr td colspan 2 write config to string td tr tr td td td style line height 130 word wrap break word p If set write the default configuration values to this file and exit p td tr tbody table |
kubernetes reference The kubelet is the primary node agent that runs on each node It can weight 20 register the node with the apiserver using one of the hostname a flag to contenttype tool reference heading synopsis title kubelet | ---
title: kubelet
content_type: tool-reference
weight: 20
---
##
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 two 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).
```
kubelet [flags]
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--address string Default: 0.0.0.0 </td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The IP address for the kubelet to serve on (set to <code>0.0.0.0</code> or <code>::</code> for listening on all interfaces and IP address families) (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--allowed-unsafe-sysctls strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Comma-separated whitelist of unsafe sysctls or unsafe sysctl patterns (ending in <code>*</code>). Use these at your own risk. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--anonymous-auth Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>system:anonymous</code>, and a group name of <code>system:unauthenticated</code>. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--authentication-token-webhook</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Use the <code>TokenReview</code> API to determine authentication for bearer tokens. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--authentication-token-webhook-cache-ttl duration Default: <code>2m0s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--authorization-mode string Default: <code>AlwaysAllow</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Authorization mode for kubelet server. Valid options are "<code>AlwaysAllow</code>" or "<code>Webhook</code>". Webhook mode uses the <code>SubjectAccessReview</code> API to determine authorization. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-cache-authorized-ttl duration Default: <code>5m0s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-cache-unauthorized-ttl duration Default: <code>30s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--bootstrap-kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to a kubeconfig file that will be used to get client certificate for kubelet. If the file specified by <code>--kubeconfig</code> 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 <code>--kubeconfig</code>. The client certificate and key file will be stored in the directory pointed by <code>--cert-dir</code>.</td>
</tr>
<tr>
<td colspan="2">--cert-dir string Default: <code>/var/lib/kubelet/pki</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The directory where the TLS certs are located. If <code>--tls-cert-file</code> and <code>--tls-private-key-file</code> are provided, this flag will be ignored.</td>
</tr>
<tr>
<td colspan="2">--cgroup-driver string Default: <code>cgroupfs</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Driver that the kubelet uses to manipulate cgroups on the host. Possible values: "<code>cgroupfs</code>", "<code>systemd</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--cgroup-root string Default: <code>''</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--cgroups-per-qos Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--client-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>CommonName</code> of the client certificate. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--cloud-config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The path to the cloud provider configuration file. Empty string for no configuration file. (DEPRECATED: will be removed in 1.25 or later, in favor of removing cloud providers code from kubelet.)</td>
</tr>
<tr>
<td colspan="2">--cloud-provider string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The provider for cloud services. Set to empty string for running with no cloud provider. Set to 'external' for running with an external 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).</td>
</tr>
<tr>
<td colspan="2">--cluster-dns strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Comma-separated list of DNS server IP address. This value is used for containers DNS server in case of Pods with "<code>dnsPolicy: ClusterFirst</code>".<br/><B>Note:</B> 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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--cluster-domain string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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.</td>
</tr>
<tr>
<td colspan="2">--config-dir string Default: ''</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to a directory to specify drop-ins, allows the user to optionally specify additional configs to overwrite what is provided by default and in the `--config` flag.<br/><B>Note</B>: Set the '<code>KUBELET_CONFIG_DROPIN_DIR_ALPHA</code>' environment variable to specify the directory.</td>
</tr>
<tr>
<td colspan="2">--container-log-max-files int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><Warning: Beta feature> Set the maximum number of container log files that can be present for a container. The number must be >= 2. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--container-log-max-size string Default: <code>10Mi</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><Warning: Beta feature> Set the maximum size (e.g. <code>10Mi</code>) of container log file before it is rotated. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--container-runtime-endpoint string Default: <code>"unix:///run/containerd/containerd.sock"</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The endpoint of remote runtime service. UNIX domain sockets are supported on Linux, while 'npipe' and 'tcp' endpoints are supported on windows. Examples: <code>'unix:///path/to/runtime.sock'</code>, <code>'npipe:////./pipe/runtime'</code>. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--contention-profiling</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Enable block profiling, if profiling is enabled. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--cpu-cfs-quota Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--cpu-cfs-quota-period duration Default: <code>100ms</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Sets CPU CFS quota period value, <code>cpu.cfs_period_us</code>, defaults to Linux Kernel default. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--cpu-manager-policy string Default: <code>none</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The CPU manager policy to use. Possible values: "<code>none</code>", "<code>static</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--cpu-manager-policy-options string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of 'key=value' CPU manager policy options to use, to fine tune their behaviour. If not supplied, keep the default behaviour. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--cpu-manager-reconcile-period duration Default: <code>10s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><Warning: Alpha feature> CPU manager reconciliation period. Examples: "<code>10s</code>", or "<code>1m</code>". If not supplied, defaults to node status update frequency. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--enable-controller-attach-detach Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--enable-debugging-handlers Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--enable-server Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Enable the kubelet's server. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--enforce-node-allocatable strings Default: <code>pods</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A comma separated list of levels of node allocatable enforcement to be enforced by kubelet. Acceptable options are "<code>none</code>", "<code>pods</code>", "<code>system-reserved</code>", and "<code>kube-reserved</code>". If the latter two options are specified, <code>--system-reserved-cgroup</code> and <code>--kube-reserved-cgroup</code> must also be set, respectively. If "<code>none</code>" is specified, no additional options should be set. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/">official documentation</a> for more details. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--event-burst int32 Default: 100</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding <code>--event-qps</code>. The number must be >= 0. If 0 will use default burst (100). (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--event-qps int32 Default: 50</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">QPS to limit event creations. The number must be >= 0. If 0 will use default QPS (50). (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--eviction-hard strings Default: <code>imagefs.available<15%,memory.available<100Mi,nodefs.available<10%</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of eviction thresholds (e.g. "<code>memory.available<1Gi</code>") that if met would trigger a pod eviction. On a Linux node, the default value also includes "<code>nodefs.inodesFree<5%</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--eviction-max-pod-grace-period int32</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"> 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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--eviction-minimum-reclaim strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of minimum reclaims (e.g. "<code>imagefs.available=2Gi</code>") 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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--eviction-pressure-transition-period duration Default: <code>5m0s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--eviction-soft strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of eviction thresholds (e.g. "<code>memory.available<1.5Gi</code>") 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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--eviction-soft-grace-period strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of eviction grace periods (e.g. "<code>memory.available=1m30s</code>") 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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--exit-on-lock-contention</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Whether kubelet should exit upon lock-file contention.</td>
</tr>
<tr>
<td colspan="2">--experimental-allocatable-ignore-eviction Default: <code>false</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">When set to <code>true</code>, hard eviction thresholds will be ignored while calculating node allocatable. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/">here</a> for more details. (DEPRECATED: will be removed in 1.25 or later)</td>
</tr>
<tr>
<td colspan="2">--experimental-mounter-path string Default: <code>mount</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[Experimental] Path of mounter binary. Leave empty to use the default <code>mount</code>. (DEPRECATED: will be removed in 1.24 or later, in favor of using CSI.)</td>
</tr>
<tr>
<td colspan="2">--fail-swap-on Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--feature-gates <A list of 'key=true/false' pairs></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of <code>key=value</code> pairs that describe feature gates for alpha/experimental features. Options are:<br/>
APIResponseCompression=true|false (BETA - default=true)<br/>
APIServerIdentity=true|false (BETA - default=true)<br/>
APIServerTracing=true|false (BETA - default=true)<br/>
APIServingWithRoutine=true|false (BETA - default=true)<br/>
AllAlpha=true|false (ALPHA - default=false)<br/>
AllBeta=true|false (BETA - default=false)<br/>
AnyVolumeDataSource=true|false (BETA - default=true)<br/>
AppArmor=true|false (BETA - default=true)<br/>
AppArmorFields=true|false (BETA - default=true)<br/>
CPUManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>
CPUManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>
CPUManagerPolicyOptions=true|false (BETA - default=true)<br/>
CRDValidationRatcheting=true|false (BETA - default=true)<br/>
CSIMigrationPortworx=true|false (BETA - default=false)<br/>
CSIVolumeHealth=true|false (ALPHA - default=false)<br/>
CloudControllerManagerWebhook=true|false (ALPHA - default=false)<br/>
ClusterTrustBundle=true|false (ALPHA - default=false)<br/>
ClusterTrustBundleProjection=true|false (ALPHA - default=false)<br/>
ComponentSLIs=true|false (BETA - default=true)<br/>
ConsistentListFromCache=true|false (ALPHA - default=false)<br/>
ContainerCheckpoint=true|false (BETA - default=true)<br/>
ContextualLogging=true|false (BETA - default=true)<br/>
CronJobsScheduledAnnotation=true|false (BETA - default=true)<br/>
CrossNamespaceVolumeDataSource=true|false (ALPHA - default=false)<br/>
CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)<br/>
CustomResourceFieldSelectors=true|false (ALPHA - default=false)<br/>
DevicePluginCDIDevices=true|false (BETA - default=true)<br/>
DisableCloudProviders=true|false (BETA - default=true)<br/>
DisableKubeletCloudCredentialProviders=true|false (BETA - default=true)<br/>
DisableNodeKubeProxyVersion=true|false (ALPHA - default=false)<br/>
DynamicResourceAllocation=true|false (ALPHA - default=false)<br/>
ElasticIndexedJob=true|false (BETA - default=true)<br/>
EventedPLEG=true|false (ALPHA - default=false)<br/>
GracefulNodeShutdown=true|false (BETA - default=true)<br/>
GracefulNodeShutdownBasedOnPodPriority=true|false (BETA - default=true)<br/>
HPAScaleToZero=true|false (ALPHA - default=false)<br/>
HonorPVReclaimPolicy=true|false (ALPHA - default=false)<br/>
ImageMaximumGCAge=true|false (BETA - default=true)<br/>
InPlacePodVerticalScaling=true|false (ALPHA - default=false)<br/>
InTreePluginAWSUnregister=true|false (ALPHA - default=false)<br/>
InTreePluginAzureDiskUnregister=true|false (ALPHA - default=false)<br/>
InTreePluginAzureFileUnregister=true|false (ALPHA - default=false)<br/>
InTreePluginGCEUnregister=true|false (ALPHA - default=false)<br/>
InTreePluginOpenStackUnregister=true|false (ALPHA - default=false)<br/>
InTreePluginPortworxUnregister=true|false (ALPHA - default=false)<br/>
InTreePluginvSphereUnregister=true|false (ALPHA - default=false)<br/>
InformerResourceVersion=true|false (ALPHA - default=false)<br/>
JobBackoffLimitPerIndex=true|false (BETA - default=true)<br/>
JobManagedBy=true|false (ALPHA - default=false)<br/>
JobPodFailurePolicy=true|false (BETA - default=true)<br/>
JobPodReplacementPolicy=true|false (BETA - default=true)<br/>
JobSuccessPolicy=true|false (ALPHA - default=false)<br/>
KubeProxyDrainingTerminatingNodes=true|false (BETA - default=true)<br/>
KubeletCgroupDriverFromCRI=true|false (ALPHA - default=false)<br/>
KubeletInUserNamespace=true|false (ALPHA - default=false)<br/>
KubeletPodResourcesDynamicResources=true|false (ALPHA - default=false)<br/>
KubeletPodResourcesGet=true|false (ALPHA - default=false)<br/>
KubeletSeparateDiskGC=true|false (ALPHA - default=false)<br/>
KubeletTracing=true|false (BETA - default=true)<br/>
LoadBalancerIPMode=true|false (BETA - default=true)<br/>
LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)<br/>
LogarithmicScaleDown=true|false (BETA - default=true)<br/>
LoggingAlphaOptions=true|false (ALPHA - default=false)<br/>
LoggingBetaOptions=true|false (BETA - default=true)<br/>
MatchLabelKeysInPodAffinity=true|false (ALPHA - default=false)<br/>
MatchLabelKeysInPodTopologySpread=true|false (BETA - default=true)<br/>
MaxUnavailableStatefulSet=true|false (ALPHA - default=false)<br/>
MemoryManager=true|false (BETA - default=true)<br/>
MemoryQoS=true|false (ALPHA - default=false)<br/>
MultiCIDRServiceAllocator=true|false (ALPHA - default=false)<br/>
MutatingAdmissionPolicy=true|false (ALPHA - default=false)<br/>
NFTablesProxyMode=true|false (ALPHA - default=false)<br/>
NodeInclusionPolicyInPodTopologySpread=true|false (BETA - default=true)<br/>
NodeLogQuery=true|false (BETA - default=false)<br/>
NodeSwap=true|false (BETA - default=true)<br/>
OpenAPIEnums=true|false (BETA - default=true)<br/>
PDBUnhealthyPodEvictionPolicy=true|false (BETA - default=true)<br/>
PersistentVolumeLastPhaseTransitionTime=true|false (BETA - default=true)<br/>
PodAndContainerStatsFromCRI=true|false (ALPHA - default=false)<br/>
PodDeletionCost=true|false (BETA - default=true)<br/>
PodDisruptionConditions=true|false (BETA - default=true)<br/>
PodIndexLabel=true|false (BETA - default=true)<br/>
PodLifecycleSleepAction=true|false (BETA - default=true)<br/>
PodReadyToStartContainersCondition=true|false (BETA - default=true)<br/>
PortForwardWebsockets=true|false (ALPHA - default=false)<br/>
ProcMountType=true|false (ALPHA - default=false)<br/>
QOSReserved=true|false (ALPHA - default=false)<br/>
RecoverVolumeExpansionFailure=true|false (ALPHA - default=false)<br/>
RecursiveReadOnlyMounts=true|false (ALPHA - default=false)<br/>
RelaxedEnvironmentVariableValidation=true|false (ALPHA - default=false)<br/>
RetryGenerateName=true|false (ALPHA - default=false)<br/>
RotateKubeletServerCertificate=true|false (BETA - default=true)<br/>
RuntimeClassInImageCriApi=true|false (ALPHA - default=false)<br/>
SELinuxMount=true|false (ALPHA - default=false)<br/>
SELinuxMountReadWriteOncePod=true|false (BETA - default=true)<br/>
SchedulerQueueingHints=true|false (BETA - default=false)<br/>
SeparateCacheWatchRPC=true|false (BETA - default=true)<br/>
SeparateTaintEvictionController=true|false (BETA - default=true)<br/>
ServiceAccountTokenJTI=true|false (BETA - default=true)<br/>
ServiceAccountTokenNodeBinding=true|false (ALPHA - default=false)<br/>
ServiceAccountTokenNodeBindingValidation=true|false (BETA - default=true)<br/>
ServiceAccountTokenPodNodeInfo=true|false (BETA - default=true)<br/>
ServiceTrafficDistribution=true|false (ALPHA - default=false)<br/>
SidecarContainers=true|false (BETA - default=true)<br/>
SizeMemoryBackedVolumes=true|false (BETA - default=true)<br/>
StatefulSetAutoDeletePVC=true|false (BETA - default=true)<br/>
StatefulSetStartOrdinal=true|false (BETA - default=true)<br/>
StorageNamespaceIndex=true|false (BETA - default=true)<br/>
StorageVersionAPI=true|false (ALPHA - default=false)<br/>
StorageVersionHash=true|false (BETA - default=true)<br/>
StorageVersionMigrator=true|false (ALPHA - default=false)<br/>
StructuredAuthenticationConfiguration=true|false (BETA - default=true)<br/>
StructuredAuthorizationConfiguration=true|false (BETA - default=true)<br/>
TopologyAwareHints=true|false (BETA - default=true)<br/>
TopologyManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>
TopologyManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>
TopologyManagerPolicyOptions=true|false (BETA - default=true)<br/>
TranslateStreamCloseWebsocketRequests=true|false (BETA - default=true)<br/>
UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=true)<br/>
UnknownVersionInteroperabilityProxy=true|false (ALPHA - default=false)<br/>
UserNamespacesPodSecurityStandards=true|false (ALPHA - default=false)<br/>
UserNamespacesSupport=true|false (BETA - default=false)<br/>
VolumeAttributesClass=true|false (ALPHA - default=false)<br/>
VolumeCapacityPriority=true|false (ALPHA - default=false)<br/>
WatchFromStorageWithoutResourceVersion=true|false (BETA - default=false)<br/>
WatchList=true|false (ALPHA - default=false)<br/>
WatchListClient=true|false (BETA - default=false)<br/>
WinDSR=true|false (ALPHA - default=false)<br/>
WinOverlay=true|false (BETA - default=true)<br/>
WindowsHostNetwork=true|false (ALPHA - default=true)<br/>
(DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--file-check-frequency duration Default: <code>20s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Duration between checking config files for new data. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--hairpin-mode string Default: <code>promiscuous-bridge</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 "<code>promiscuous-bridge</code>", "<code>hairpin-veth</code>" and "<code>none</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--healthz-bind-address string Default: <code>127.0.0.1</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The IP address for the healthz server to serve on (set to "<code>0.0.0.0</code>" or "<code>::</code>" for listening in all interfaces and IP families). (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--healthz-port int32 Default: 10248</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The port of the localhost healthz endpoint (set to <code>0</code> to disable). (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for kubelet</td>
</tr>
<tr>
<td colspan="2">--hostname-override string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If non-empty, will use this string as identification instead of the actual hostname. If <code>--cloud-provider</code> is set, the cloud provider determines the name of the node (consult cloud provider documentation to determine if and how the hostname is used).</td>
</tr>
<tr>
<td colspan="2">--http-check-frequency duration Default: <code>20s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Duration between checking HTTP for new data. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--image-credential-provider-bin-dir string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The path to the directory where credential provider plugin binaries are located.</td>
</tr>
<tr>
<td colspan="2">--image-credential-provider-config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The path to the credential provider plugin config file.</td>
</tr>
<tr>
<td colspan="2">--image-gc-high-threshold int32 Default: 85</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--image-gc-low-threshold int32 Default: 80</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--image-gc-high-threshold</code>. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--image-service-endpoint string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The endpoint of remote image service. If not specified, it will be the same with <code>--container-runtime-endpoint</code> by default. UNIX domain socket are supported on Linux, while `npipe` and `tcp` endpoints are supported on Windows. Examples: <code>unix:///path/to/runtime.sock</code>, <code>npipe:////./pipe/runtime</code>. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--keep-terminated-pod-volumes</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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)</td>
</tr>
<tr>
<td colspan="2">--kernel-memcg-notification</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--kube-api-burst int32 Default: 100</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Burst to use while talking with kubernetes API server. The number must be >= 0. If 0 will use default burst (100). Doesn't cover events and node heartbeat apis which rate limiting is controlled by a different set of flags. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--kube-api-content-type string Default: <code>application/vnd.kubernetes.protobuf</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Content type of requests sent to apiserver. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--kube-api-qps int32 Default: 50</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">QPS to use while talking with kubernetes API server. The number must be >= 0. If 0 will use default QPS (50). Doesn't cover events and node heartbeat apis which rate limiting is controlled by a different set of flags. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--kube-reserved strings Default: <None></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of <code><resource name>=<resource quantity></code> (e.g. "<code>cpu=200m,memory=500Mi,ephemeral-storage=1Gi,pid='100'</code>") pairs that describe resources reserved for kubernetes system components. Currently <code>cpu</code>, <code>memory</code> and local <code>ephemeral-storage</code> for root file system are supported. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#kube-reserved">here</a> for more detail. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--kube-reserved-cgroup string Default: <code>''</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Absolute name of the top level cgroup that is used to manage kubernetes components for which compute resources were reserved via <code>--kube-reserved</code> flag. Ex. "<code>/kube-reserved</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to a kubeconfig file, specifying how to connect to the API server. Providing <code>--kubeconfig</code> enables API server mode, omitting <code>--kubeconfig</code> enables standalone mode. </td>
</tr>
<tr>
<td colspan="2">--kubelet-cgroups string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--local-storage-capacity-isolation> Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If true, local ephemeral storage isolation is enabled. Otherwise, local storage isolation feature will be disabled. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--lock-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><Warning: Alpha feature> The path to file for kubelet to use as a lock file.</td>
</tr>
<tr>
<td colspan="2">--log-flush-frequency duration Default: <code>5s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Maximum number of seconds between log flushes.</td>
</tr>
<tr>
<td colspan="2">--log-json-info-buffer-size string Default: <code>'0'</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[Alpha] In JSON format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the <code>LoggingAlphaOptions</code> feature gate to use this. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--log-json-split-stream</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[Alpha] In JSON format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the <code>LoggingAlphaOptions</code> feature gate to use this. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--log-text-info-buffer-size string Default: <code>'0'</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the <code>LoggingAlphaOptions</code> feature gate to use this. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's <code>--config</code> flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)</td>
</tr>
<tr>
<td colspan="2">--log-text-split-stream</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[Alpha] In text format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the <code>LoggingAlphaOptions</code> feature gate to use this. (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's <code>--config</code> flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)
</td>
</tr>
<tr>
<td colspan="2">--logging-format string Default: <code>text</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Sets the log format. Permitted formats: "<code>json</code>" (gated by <code>LoggingBetaOptions</code>, "<code>text</code>"). (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--make-iptables-util-chains Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If true, kubelet will ensure <code>iptables</code> utility rules are present on host. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--manifest-url string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">URL for accessing additional Pod specifications to run. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--manifest-url-header strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Comma-separated list of HTTP headers to use when accessing the URL provided to <code>--manifest-url</code>. Multiple headers with the same name will be added in the same order provided. This flag can be repeatedly invoked. For example: <code>--manifest-url-header 'a:hello,b:again,c:world' --manifest-url-header 'b:beautiful'</code> (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--max-open-files int Default: 1000000</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--max-pods int32 Default: 110</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Number of Pods that can run on this kubelet. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--maximum-dead-containers int32 Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--eviction-hard</code> or <code>--eviction-soft</code> instead. Will be removed in a future version.)</td>
</tr>
<tr>
<td colspan="2">--maximum-dead-containers-per-container int32 Default: 1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Maximum number of old instances to retain per container. Each container takes up some disk space. (DEPRECATED: Use <code>--eviction-hard</code> or <code>--eviction-soft</code> instead. Will be removed in a future version.)</td>
</tr>
<tr>
<td colspan="2">--memory-manager-policy string Default: <code>None</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Memory Manager policy to use. Possible values: "<code>None</code>", "<code>Static</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--minimum-container-ttl-duration duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Minimum age for a finished container before it is garbage collected. Examples: "<code>300ms</code>", "<code>10s</code>" or "<code>2h45m</code>". (DEPRECATED: Use <code>--eviction-hard</code> or <code>--eviction-soft</code> instead. Will be removed in a future version.)</td>
</tr>
<tr>
<td colspan="2">--minimum-image-ttl-duration duration Default: <code>2m0s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Minimum age for an unused image before it is garbage collected. Examples: "<code>300ms</code>", "<code>10s</code>" or "<code>2h45m</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--node-ip string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 "<code>::</code>" to make it prefer the default IPv6 address rather than the default IPv4 address.</td>
</tr>
<tr>
<td colspan="2">--node-labels <key=value pairs></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><Warning: Alpha feature>Labels to add when registering the node in the cluster. Labels must be <code>key=value</code> pairs separated by <code>','</code>. Labels in the <code>'kubernetes.io'</code> namespace must begin with an allowed prefix (<code>'kubelet.kubernetes.io'</code>, <code>'node.kubernetes.io'</code>) or be in the specifically allowed set (<code>'beta.kubernetes.io/arch'</code>, <code>'beta.kubernetes.io/instance-type'</code>, <code>'beta.kubernetes.io/os'</code>, <code>'failure-domain.beta.kubernetes.io/region'</code>, <code>'failure-domain.beta.kubernetes.io/zone'</code>, <code>'kubernetes.io/arch'</code>, <code>'kubernetes.io/hostname'</code>, <code>'kubernetes.io/os'</code>, <code>'node.kubernetes.io/instance-type'</code>, <code>'topology.kubernetes.io/region'</code>, <code>'topology.kubernetes.io/zone'</code>)</td>
</tr>
<tr>
<td colspan="2">--node-status-max-images int32 Default: 50</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The maximum number of images to report in <code>node.status.images</code>. If <code>-1</code> is specified, no cap will be applied. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--node-status-update-frequency duration Default: <code>10s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Specifies how often kubelet posts node status to master. <B>Note</B>: be cautious when changing the constant, it must work with <code>nodeMonitorGracePeriod</code> in Node controller. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--oom-score-adj int32 Default: -999</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The <code>oom-score-adj</code> 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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--pod-cidr string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--pod-infra-container-image string Default: <code>registry.k8s.io/pause:3.9</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Specified image will not be pruned by the image garbage collector. CRI implementations have their own configuration to set this image. (DEPRECATED: will be removed in 1.27. Image garbage collector will get sandbox image information from CRI.)</td>
</tr>
<tr>
<td colspan="2">--pod-manifest-path string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--pod-max-pids int Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Set the maximum number of processes per pod. If <code>-1</code>, the kubelet defaults to the node allocatable PID capacity. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--pods-per-core int32</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Number of Pods per core that can run on this kubelet. The total number of pods on this kubelet cannot exceed <code>--max-pods</code>, so <code>--max-pods</code> will be used if this calculation results in a larger number of pods allowed on the kubelet. A value of <code>0</code> disables this limit. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--port int32 Default: 10250</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The port for the kubelet to serve on. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--protect-kernel-defaults</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--provider-id string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Unique identifier for identifying the node in a machine database, i.e cloud provider.</td>
</tr>
<tr>
<td colspan="2">--qos-reserved string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><Warning: Alpha feature> A set of <code><resource name>=<percentage></code> (e.g. "<code>memory=50%</code>") pairs that describe how pod resource requests are reserved at the QoS level. Currently only <code>memory</code> is supported. Requires the <code>QOSReserved</code> feature gate to be enabled. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--read-only-port int32 Default: 10255</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The read-only port for the kubelet to serve on with no authentication/authorization (set to <code>0</code> to disable). (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--register-node Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Register the node with the API server. If <code>--kubeconfig</code> is not provided, this flag is irrelevant, as the kubelet won't have an API server to register with. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--register-schedulable Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Register the node as schedulable. Won't have any effect if <code>--register-node</code> is <code>false</code>. (DEPRECATED: will be removed in a future version)</td>
</tr>
<tr>
<td colspan="2">--register-with-taints string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Register the node with the given list of taints (comma separated <code><key>=<value>:<effect></code>). No-op if <code>--register-node</code> is <code>false</code>. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--registry-burst int32 Default: 10</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding <code>--registry-qps</code>. Only used if <code>--registry-qps</code> is greater than 0. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--registry-qps int32 Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If > 0, limit registry pull QPS to this value. If <code>0</code>, unlimited. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--reserved-cpus string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--system-reserved</code> and <code>--kube-reserved</code>. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--reserved-memory string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A comma-separated list of memory reservations for NUMA nodes. (e.g. "<code>--reserved-memory 0:memory=1Gi,hugepages-1M=2Gi --reserved-memory 1:memory=2Gi</code>"). The total sum for each memory type should be equal to the sum of <code>--kube-reserved</code>, <code>--system-reserved</code> and <code>--eviction-threshold</code>. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#reserved-memory-flag">here</a> for more details. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--resolv-conf string Default: <code>/etc/resolv.conf</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--root-dir string Default: <code>/var/lib/kubelet</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Directory path for managing kubelet files (volume mounts, etc).</td>
</tr>
<tr>
<td colspan="2">--rotate-certificates</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Auto rotate the kubelet client certificates by requesting new certificates from the <code>kube-apiserver</code> when the certificate expiration approaches. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--rotate-server-certificates</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Auto-request and rotate the kubelet serving certificates by requesting new certificates from the <code>kube-apiserver</code> when the certificate expiration approaches. Requires the <code>RotateKubeletServerCertificate</code> feature gate to be enabled, and approval of the submitted <code>CertificateSigningRequest</code> objects. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--runonce</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If <code>true</code>, exit after spawning pods from local manifests or remote urls. Exclusive with <code>--enable-server</code> (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--runtime-cgroups string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Optional absolute name of cgroups to create and run the runtime in.</td>
</tr>
<tr>
<td colspan="2">--runtime-request-timeout duration Default: <code>2m0s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Timeout of all runtime requests except long running request - <code>pull</code>, <code>logs</code>, <code>exec</code> and <code>attach</code>. 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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--seccomp-default</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Enable the use of <code>RuntimeDefault</code> as the default seccomp profile for all workloads.</td>
</tr>
<tr>
<td colspan="2">--serialize-image-pulls Default: <code>true</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>aufs</code> storage backend. Issue #10959 has more details. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--streaming-connection-idle-timeout duration Default: <code>4h0m0s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Maximum time a streaming connection can be idle before the connection is automatically closed. <code>0</code> indicates no timeout. Example: <code>5m</code>. Note: All connections to the kubelet server have a maximum duration of 4 hours. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--sync-frequency duration Default: <code>1m0s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Max period between synchronizing running containers and config. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--system-cgroups string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Optional absolute name of cgroups in which to place all non-kernel processes that are not already inside a cgroup under <code>'/'</code>. 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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--system-reserved string Default: <none></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of <code><resource name>=<resource quantity></code> (e.g. "<code>cpu=200m,memory=500Mi,ephemeral-storage=1Gi,pid='100'</code>") pairs that describe resources reserved for non-kubernetes components. Currently only <code>cpu</code> and <code>memory</code> and local ephemeral storage for root file system are supported. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#system-reserved">here</a> for more detail. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--system-reserved-cgroup string Default: <code>''</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Absolute name of the top level cgroup that is used to manage non-kubernetes components for which compute resources were reserved via <code>--system-reserved</code> flag. Ex. <code>/system-reserved</code>. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--tls-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">File containing x509 certificate used for serving HTTPS (with intermediate certs, if any, concatenated after server cert). If <code>--tls-cert-file</code> and <code>--tls-private-key-file</code> are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to <code>--cert-dir</code>. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--tls-cipher-suites string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used.<br/>
Preferred values:
<code>TLS_AES_128_GCM_SHA256</code>, <code>TLS_AES_256_GCM_SHA384</code>, <code>TLS_CHACHA20_POLY1305_SHA256</code>, <code>TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA</code>, <code>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</code>, <code>TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA</code>, <code>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</code>, <code>TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305</code>, <code>TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256</code>, <code>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA</code>, <code>TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</code>, <code>TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA</code>, <code>TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</code>, <code>TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305</code>, <code>TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256</code>, <code>TLS_RSA_WITH_AES_128_CBC_SHA</code>, <code>TLS_RSA_WITH_AES_128_GCM_SHA256</code>, <code>TLS_RSA_WITH_AES_256_CBC_SHA</code>, <code>TLS_RSA_WITH_AES_256_GCM_SHA384</code><br/>
Insecure values:
<code>TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256</code>, <code>TLS_ECDHE_ECDSA_WITH_RC4_128_SHA</code>, <code>TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA</code>, <code>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256</code>, <code>TLS_ECDHE_RSA_WITH_RC4_128_SHA</code>, <code>TLS_RSA_WITH_3DES_EDE_CBC_SHA</code>, <code>TLS_RSA_WITH_AES_128_CBC_SHA256</code>, <code>TLS_RSA_WITH_RC4_128_SHA</code>.<br/>
(DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)
</tr>
<tr>
<td colspan="2">--tls-min-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Minimum TLS version supported. Possible values: "<code>VersionTLS10</code>", "<code>VersionTLS11</code>", "<code>VersionTLS12</code>", "<code>VersionTLS13</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--tls-private-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">File containing x509 private key matching <code>--tls-cert-file</code>. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--topology-manager-policy string Default: <code>'none'</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Topology Manager policy to use. Possible values: "<code>none</code>", "<code>best-effort</code>", "<code>restricted</code>", "<code>single-numa-node</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--topology-manager-policy-options string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A set of <key>=<value> topology manager policy options to use, to fine tune their behaviour. If not supplied, keep the default behaviour. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--topology-manager-scope string Default: <code>container</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Scope to which topology hints are applied. Topology manager collects hints from hint providers and applies them to the defined scope to ensure the pod admission. Possible values: "<code>container</code>", "<code>pod</code>". (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">-v, --v Level</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Number for the log level verbosity</td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Print version information and quit; <code>--version=vX.Y.Z...</code> sets the reported version.</td>
</tr>
<tr>
<td colspan="2">--vmodule <A list of 'pattern=N' strings></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Comma-separated list of <code>pattern=N</code> settings for file-filtered logging (only works for text log format).</td>
</tr>
<tr>
<td colspan="2">--volume-plugin-dir string Default: <code>/usr/libexec/kubernetes/kubelet-plugins/volume/exec/</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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 <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
<tr>
<td colspan="2">--volume-stats-agg-period duration Default: <code>1m0s</code></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to a negative number. (DEPRECATED: This parameter should be set via the config file specified by the kubelet's <code>--config</code> flag. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/">kubelet-config-file</a> for more information.)</td>
</tr>
</tbody>
</table> | kubernetes reference | title kubelet content type tool reference weight 20 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 two 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 kubelet flags table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 address string nbsp nbsp nbsp nbsp nbsp Default 0 0 0 0 td tr tr td td td style line height 130 word wrap break word The IP address for the kubelet to serve on set to code 0 0 0 0 code or code code for listening on all interfaces and IP address families DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 allowed unsafe sysctls strings td tr tr td td td style line height 130 word wrap break word Comma separated whitelist of unsafe sysctls or unsafe sysctl patterns ending in code ast code Use these at your own risk DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 anonymous auth nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word 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 code system anonymous code and a group name of code system unauthenticated code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 authentication token webhook td tr tr td td td style line height 130 word wrap break word Use the code TokenReview code API to determine authentication for bearer tokens DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 authentication token webhook cache ttl duration nbsp nbsp nbsp nbsp nbsp Default code 2m0s code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 authorization mode string nbsp nbsp nbsp nbsp nbsp Default code AlwaysAllow code td tr tr td td td style line height 130 word wrap break word Authorization mode for kubelet server Valid options are quot code AlwaysAllow code quot or quot code Webhook code quot Webhook mode uses the code SubjectAccessReview code API to determine authorization DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 authorization webhook cache authorized ttl duration nbsp nbsp nbsp nbsp nbsp Default code 5m0s code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 authorization webhook cache unauthorized ttl duration nbsp nbsp nbsp nbsp nbsp Default code 30s code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 bootstrap kubeconfig string td tr tr td td td style line height 130 word wrap break word Path to a kubeconfig file that will be used to get client certificate for kubelet If the file specified by code kubeconfig code 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 code kubeconfig code The client certificate and key file will be stored in the directory pointed by code cert dir code td tr tr td colspan 2 cert dir string nbsp nbsp nbsp nbsp nbsp Default code var lib kubelet pki code td tr tr td td td style line height 130 word wrap break word The directory where the TLS certs are located If code tls cert file code and code tls private key file code are provided this flag will be ignored td tr tr td colspan 2 cgroup driver string nbsp nbsp nbsp nbsp nbsp Default code cgroupfs code td tr tr td td td style line height 130 word wrap break word Driver that the kubelet uses to manipulate cgroups on the host Possible values quot code cgroupfs code quot quot code systemd code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 cgroup root string nbsp nbsp nbsp nbsp nbsp Default code code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 cgroups per qos nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 client ca file string td tr tr td td td style line height 130 word wrap break word 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 code CommonName code of the client certificate DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 cloud config string td tr tr td td td style line height 130 word wrap break word The path to the cloud provider configuration file Empty string for no configuration file DEPRECATED will be removed in 1 25 or later in favor of removing cloud providers code from kubelet td tr tr td colspan 2 cloud provider string td tr tr td td td style line height 130 word wrap break word The provider for cloud services Set to empty string for running with no cloud provider Set to external for running with an external 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 td tr tr td colspan 2 cluster dns strings td tr tr td td td style line height 130 word wrap break word Comma separated list of DNS server IP address This value is used for containers DNS server in case of Pods with code dnsPolicy ClusterFirst code br B Note B 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 cluster domain string td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 config string td tr tr td td td style line height 130 word wrap break word 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 td tr tr td colspan 2 config dir string nbsp nbsp nbsp nbsp nbsp Default td tr tr td td td style line height 130 word wrap break word Path to a directory to specify drop ins allows the user to optionally specify additional configs to overwrite what is provided by default and in the config flag br B Note B Set the code KUBELET CONFIG DROPIN DIR ALPHA code environment variable to specify the directory td tr tr td colspan 2 container log max files int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word lt Warning Beta feature gt Set the maximum number of container log files that can be present for a container The number must be gt 2 DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 container log max size string nbsp nbsp nbsp nbsp nbsp Default code 10Mi code td tr tr td td td style line height 130 word wrap break word lt Warning Beta feature gt Set the maximum size e g code 10Mi code of container log file before it is rotated DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 container runtime endpoint string nbsp nbsp nbsp nbsp nbsp Default code unix run containerd containerd sock code td tr tr td td td style line height 130 word wrap break word The endpoint of remote runtime service UNIX domain sockets are supported on Linux while npipe and tcp endpoints are supported on windows Examples code unix path to runtime sock code code npipe pipe runtime code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 contention profiling td tr tr td td td style line height 130 word wrap break word Enable block profiling if profiling is enabled DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 cpu cfs quota nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 cpu cfs quota period duration nbsp nbsp nbsp nbsp nbsp Default code 100ms code td tr tr td td td style line height 130 word wrap break word Sets CPU CFS quota period value code cpu cfs period us code defaults to Linux Kernel default DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 cpu manager policy string nbsp nbsp nbsp nbsp nbsp Default code none code td tr tr td td td style line height 130 word wrap break word The CPU manager policy to use Possible values quot code none code quot quot code static code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 cpu manager policy options string td tr tr td td td style line height 130 word wrap break word A set of key value CPU manager policy options to use to fine tune their behaviour If not supplied keep the default behaviour DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 cpu manager reconcile period duration nbsp nbsp nbsp nbsp nbsp Default code 10s code td tr tr td td td style line height 130 word wrap break word lt Warning Alpha feature gt CPU manager reconciliation period Examples quot code 10s code quot or quot code 1m code quot If not supplied defaults to node status update frequency DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 enable controller attach detach nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 enable debugging handlers nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 enable server nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word Enable the kubelet s server DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 enforce node allocatable strings nbsp nbsp nbsp nbsp nbsp Default code pods code td tr tr td td td style line height 130 word wrap break word A comma separated list of levels of node allocatable enforcement to be enforced by kubelet Acceptable options are quot code none code quot quot code pods code quot quot code system reserved code quot and quot code kube reserved code quot If the latter two options are specified code system reserved cgroup code and code kube reserved cgroup code must also be set respectively If quot code none code quot is specified no additional options should be set See a href https kubernetes io docs tasks administer cluster reserve compute resources official documentation a for more details DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 event burst int32 nbsp nbsp nbsp nbsp nbsp Default 100 td tr tr td td td style line height 130 word wrap break word Maximum size of a bursty event records temporarily allows event records to burst to this number while still not exceeding code event qps code The number must be gt 0 If 0 will use default burst 100 DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 event qps int32 nbsp nbsp nbsp nbsp nbsp Default 50 td tr tr td td td style line height 130 word wrap break word QPS to limit event creations The number must be gt 0 If 0 will use default QPS 50 DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 eviction hard strings nbsp nbsp nbsp nbsp nbsp Default code imagefs available 15 memory available 100Mi nodefs available 10 code td tr tr td td td style line height 130 word wrap break word A set of eviction thresholds e g quot code memory available 1Gi code quot that if met would trigger a pod eviction On a Linux node the default value also includes quot code nodefs inodesFree 5 code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 eviction max pod grace period int32 td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 eviction minimum reclaim strings td tr tr td td td style line height 130 word wrap break word A set of minimum reclaims e g quot code imagefs available 2Gi code quot 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 eviction pressure transition period duration nbsp nbsp nbsp nbsp nbsp Default code 5m0s code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 eviction soft strings td tr tr td td td style line height 130 word wrap break word A set of eviction thresholds e g quot code memory available 1 5Gi code quot 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 eviction soft grace period strings td tr tr td td td style line height 130 word wrap break word A set of eviction grace periods e g quot code memory available 1m30s code quot 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 exit on lock contention td tr tr td td td style line height 130 word wrap break word Whether kubelet should exit upon lock file contention td tr tr td colspan 2 experimental allocatable ignore eviction nbsp nbsp nbsp nbsp nbsp Default code false code td tr tr td td td style line height 130 word wrap break word When set to code true code hard eviction thresholds will be ignored while calculating node allocatable See a href https kubernetes io docs tasks administer cluster reserve compute resources here a for more details DEPRECATED will be removed in 1 25 or later td tr tr td colspan 2 experimental mounter path string nbsp nbsp nbsp nbsp nbsp Default code mount code td tr tr td td td style line height 130 word wrap break word Experimental Path of mounter binary Leave empty to use the default code mount code DEPRECATED will be removed in 1 24 or later in favor of using CSI td tr tr td colspan 2 fail swap on nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 feature gates lt A list of key true false pairs gt td tr tr td td td style line height 130 word wrap break word A set of code key value code pairs that describe feature gates for alpha experimental features Options are br APIResponseCompression true false BETA default true br APIServerIdentity true false BETA default true br APIServerTracing true false BETA default true br APIServingWithRoutine true false BETA default true br AllAlpha true false ALPHA default false br AllBeta true false BETA default false br AnyVolumeDataSource true false BETA default true br AppArmor true false BETA default true br AppArmorFields true false BETA default true br CPUManagerPolicyAlphaOptions true false ALPHA default false br CPUManagerPolicyBetaOptions true false BETA default true br CPUManagerPolicyOptions true false BETA default true br CRDValidationRatcheting true false BETA default true br CSIMigrationPortworx true false BETA default false br CSIVolumeHealth true false ALPHA default false br CloudControllerManagerWebhook true false ALPHA default false br ClusterTrustBundle true false ALPHA default false br ClusterTrustBundleProjection true false ALPHA default false br ComponentSLIs true false BETA default true br ConsistentListFromCache true false ALPHA default false br ContainerCheckpoint true false BETA default true br ContextualLogging true false BETA default true br CronJobsScheduledAnnotation true false BETA default true br CrossNamespaceVolumeDataSource true false ALPHA default false br CustomCPUCFSQuotaPeriod true false ALPHA default false br CustomResourceFieldSelectors true false ALPHA default false br DevicePluginCDIDevices true false BETA default true br DisableCloudProviders true false BETA default true br DisableKubeletCloudCredentialProviders true false BETA default true br DisableNodeKubeProxyVersion true false ALPHA default false br DynamicResourceAllocation true false ALPHA default false br ElasticIndexedJob true false BETA default true br EventedPLEG true false ALPHA default false br GracefulNodeShutdown true false BETA default true br GracefulNodeShutdownBasedOnPodPriority true false BETA default true br HPAScaleToZero true false ALPHA default false br HonorPVReclaimPolicy true false ALPHA default false br ImageMaximumGCAge true false BETA default true br InPlacePodVerticalScaling true false ALPHA default false br InTreePluginAWSUnregister true false ALPHA default false br InTreePluginAzureDiskUnregister true false ALPHA default false br InTreePluginAzureFileUnregister true false ALPHA default false br InTreePluginGCEUnregister true false ALPHA default false br InTreePluginOpenStackUnregister true false ALPHA default false br InTreePluginPortworxUnregister true false ALPHA default false br InTreePluginvSphereUnregister true false ALPHA default false br InformerResourceVersion true false ALPHA default false br JobBackoffLimitPerIndex true false BETA default true br JobManagedBy true false ALPHA default false br JobPodFailurePolicy true false BETA default true br JobPodReplacementPolicy true false BETA default true br JobSuccessPolicy true false ALPHA default false br KubeProxyDrainingTerminatingNodes true false BETA default true br KubeletCgroupDriverFromCRI true false ALPHA default false br KubeletInUserNamespace true false ALPHA default false br KubeletPodResourcesDynamicResources true false ALPHA default false br KubeletPodResourcesGet true false ALPHA default false br KubeletSeparateDiskGC true false ALPHA default false br KubeletTracing true false BETA default true br LoadBalancerIPMode true false BETA default true br LocalStorageCapacityIsolationFSQuotaMonitoring true false ALPHA default false br LogarithmicScaleDown true false BETA default true br LoggingAlphaOptions true false ALPHA default false br LoggingBetaOptions true false BETA default true br MatchLabelKeysInPodAffinity true false ALPHA default false br MatchLabelKeysInPodTopologySpread true false BETA default true br MaxUnavailableStatefulSet true false ALPHA default false br MemoryManager true false BETA default true br MemoryQoS true false ALPHA default false br MultiCIDRServiceAllocator true false ALPHA default false br MutatingAdmissionPolicy true false ALPHA default false br NFTablesProxyMode true false ALPHA default false br NodeInclusionPolicyInPodTopologySpread true false BETA default true br NodeLogQuery true false BETA default false br NodeSwap true false BETA default true br OpenAPIEnums true false BETA default true br PDBUnhealthyPodEvictionPolicy true false BETA default true br PersistentVolumeLastPhaseTransitionTime true false BETA default true br PodAndContainerStatsFromCRI true false ALPHA default false br PodDeletionCost true false BETA default true br PodDisruptionConditions true false BETA default true br PodIndexLabel true false BETA default true br PodLifecycleSleepAction true false BETA default true br PodReadyToStartContainersCondition true false BETA default true br PortForwardWebsockets true false ALPHA default false br ProcMountType true false ALPHA default false br QOSReserved true false ALPHA default false br RecoverVolumeExpansionFailure true false ALPHA default false br RecursiveReadOnlyMounts true false ALPHA default false br RelaxedEnvironmentVariableValidation true false ALPHA default false br RetryGenerateName true false ALPHA default false br RotateKubeletServerCertificate true false BETA default true br RuntimeClassInImageCriApi true false ALPHA default false br SELinuxMount true false ALPHA default false br SELinuxMountReadWriteOncePod true false BETA default true br SchedulerQueueingHints true false BETA default false br SeparateCacheWatchRPC true false BETA default true br SeparateTaintEvictionController true false BETA default true br ServiceAccountTokenJTI true false BETA default true br ServiceAccountTokenNodeBinding true false ALPHA default false br ServiceAccountTokenNodeBindingValidation true false BETA default true br ServiceAccountTokenPodNodeInfo true false BETA default true br ServiceTrafficDistribution true false ALPHA default false br SidecarContainers true false BETA default true br SizeMemoryBackedVolumes true false BETA default true br StatefulSetAutoDeletePVC true false BETA default true br StatefulSetStartOrdinal true false BETA default true br StorageNamespaceIndex true false BETA default true br StorageVersionAPI true false ALPHA default false br StorageVersionHash true false BETA default true br StorageVersionMigrator true false ALPHA default false br StructuredAuthenticationConfiguration true false BETA default true br StructuredAuthorizationConfiguration true false BETA default true br TopologyAwareHints true false BETA default true br TopologyManagerPolicyAlphaOptions true false ALPHA default false br TopologyManagerPolicyBetaOptions true false BETA default true br TopologyManagerPolicyOptions true false BETA default true br TranslateStreamCloseWebsocketRequests true false BETA default true br UnauthenticatedHTTP2DOSMitigation true false BETA default true br UnknownVersionInteroperabilityProxy true false ALPHA default false br UserNamespacesPodSecurityStandards true false ALPHA default false br UserNamespacesSupport true false BETA default false br VolumeAttributesClass true false ALPHA default false br VolumeCapacityPriority true false ALPHA default false br WatchFromStorageWithoutResourceVersion true false BETA default false br WatchList true false ALPHA default false br WatchListClient true false BETA default false br WinDSR true false ALPHA default false br WinOverlay true false BETA default true br WindowsHostNetwork true false ALPHA default true br DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 file check frequency duration nbsp nbsp nbsp nbsp nbsp Default code 20s code td tr tr td td td style line height 130 word wrap break word Duration between checking config files for new data DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 hairpin mode string nbsp nbsp nbsp nbsp nbsp Default code promiscuous bridge code td tr tr td td td style line height 130 word wrap break word 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 quot code promiscuous bridge code quot quot code hairpin veth code quot and quot code none code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 healthz bind address string nbsp nbsp nbsp nbsp nbsp Default code 127 0 0 1 code td tr tr td td td style line height 130 word wrap break word The IP address for the healthz server to serve on set to quot code 0 0 0 0 code quot or quot code code quot for listening in all interfaces and IP families DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 healthz port int32 nbsp nbsp nbsp nbsp nbsp Default 10248 td tr tr td td td style line height 130 word wrap break word The port of the localhost healthz endpoint set to code 0 code to disable DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word help for kubelet td tr tr td colspan 2 hostname override string td tr tr td td td style line height 130 word wrap break word If non empty will use this string as identification instead of the actual hostname If code cloud provider code is set the cloud provider determines the name of the node consult cloud provider documentation to determine if and how the hostname is used td tr tr td colspan 2 http check frequency duration nbsp nbsp nbsp nbsp nbsp Default code 20s code td tr tr td td td style line height 130 word wrap break word Duration between checking HTTP for new data DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 image credential provider bin dir string td tr tr td td td style line height 130 word wrap break word The path to the directory where credential provider plugin binaries are located td tr tr td colspan 2 image credential provider config string td tr tr td td td style line height 130 word wrap break word The path to the credential provider plugin config file td tr tr td colspan 2 image gc high threshold int32 nbsp nbsp nbsp nbsp nbsp Default 85 td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 image gc low threshold int32 nbsp nbsp nbsp nbsp nbsp Default 80 td tr tr td td td style line height 130 word wrap break word 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 code image gc high threshold code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 image service endpoint string td tr tr td td td style line height 130 word wrap break word The endpoint of remote image service If not specified it will be the same with code container runtime endpoint code by default UNIX domain socket are supported on Linux while npipe and tcp endpoints are supported on Windows Examples code unix path to runtime sock code code npipe pipe runtime code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 keep terminated pod volumes td tr tr td td td style line height 130 word wrap break word 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 td tr tr td colspan 2 kernel memcg notification td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 kube api burst int32 nbsp nbsp nbsp nbsp nbsp Default 100 td tr tr td td td style line height 130 word wrap break word Burst to use while talking with kubernetes API server The number must be 0 If 0 will use default burst 100 Doesn t cover events and node heartbeat apis which rate limiting is controlled by a different set of flags DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 kube api content type string nbsp nbsp nbsp nbsp nbsp Default code application vnd kubernetes protobuf code td tr tr td td td style line height 130 word wrap break word Content type of requests sent to apiserver DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 kube api qps int32 nbsp nbsp nbsp nbsp nbsp Default 50 td tr tr td td td style line height 130 word wrap break word QPS to use while talking with kubernetes API server The number must be gt 0 If 0 will use default QPS 50 Doesn t cover events and node heartbeat apis which rate limiting is controlled by a different set of flags DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 kube reserved strings nbsp nbsp nbsp nbsp nbsp Default lt None gt td tr tr td td td style line height 130 word wrap break word A set of code lt resource name gt lt resource quantity gt code e g quot code cpu 200m memory 500Mi ephemeral storage 1Gi pid 100 code quot pairs that describe resources reserved for kubernetes system components Currently code cpu code code memory code and local code ephemeral storage code for root file system are supported See a href https kubernetes io docs tasks administer cluster reserve compute resources kube reserved here a for more detail DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 kube reserved cgroup string nbsp nbsp nbsp nbsp nbsp Default code code td tr tr td td td style line height 130 word wrap break word Absolute name of the top level cgroup that is used to manage kubernetes components for which compute resources were reserved via code kube reserved code flag Ex quot code kube reserved code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word Path to a kubeconfig file specifying how to connect to the API server Providing code kubeconfig code enables API server mode omitting code kubeconfig code enables standalone mode td tr tr td colspan 2 kubelet cgroups string td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 local storage capacity isolation gt nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word If true local ephemeral storage isolation is enabled Otherwise local storage isolation feature will be disabled DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 lock file string td tr tr td td td style line height 130 word wrap break word lt Warning Alpha feature gt The path to file for kubelet to use as a lock file td tr tr td colspan 2 log flush frequency duration nbsp nbsp nbsp nbsp nbsp Default code 5s code td tr tr td td td style line height 130 word wrap break word Maximum number of seconds between log flushes td tr tr td colspan 2 log json info buffer size string nbsp nbsp nbsp nbsp nbsp Default code 0 code td tr tr td td td style line height 130 word wrap break word Alpha In JSON format with split output streams the info messages can be buffered for a while to increase performance The default value of zero bytes disables buffering The size can be specified as number of bytes 512 multiples of 1000 1K multiples of 1024 2Ki or powers of those 3M 4G 5Mi 6Gi Enable the code LoggingAlphaOptions code feature gate to use this DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 log json split stream td tr tr td td td style line height 130 word wrap break word Alpha In JSON format write error messages to stderr and info messages to stdout The default is to write a single stream to stdout Enable the code LoggingAlphaOptions code feature gate to use this DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 log text info buffer size string nbsp nbsp nbsp nbsp nbsp Default code 0 code td tr tr td td td style line height 130 word wrap break word Alpha In text format with split output streams the info messages can be buffered for a while to increase performance The default value of zero bytes disables buffering The size can be specified as number of bytes 512 multiples of 1000 1K multiples of 1024 2Ki or powers of those 3M 4G 5Mi 6Gi Enable the code LoggingAlphaOptions code feature gate to use this DEPRECATED This parameter should be set via the config file specified by the Kubelet s code config code flag See https kubernetes io docs tasks administer cluster kubelet config file for more information td tr tr td colspan 2 log text split stream td tr tr td td td style line height 130 word wrap break word Alpha In text format write error messages to stderr and info messages to stdout The default is to write a single stream to stdout Enable the code LoggingAlphaOptions code feature gate to use this DEPRECATED This parameter should be set via the config file specified by the Kubelet s code config code flag See https kubernetes io docs tasks administer cluster kubelet config file for more information td tr tr td colspan 2 logging format string nbsp nbsp nbsp nbsp nbsp Default code text code td tr tr td td td style line height 130 word wrap break word Sets the log format Permitted formats quot code json code quot gated by code LoggingBetaOptions code quot code text code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 make iptables util chains nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word If true kubelet will ensure code iptables code utility rules are present on host DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 manifest url string td tr tr td td td style line height 130 word wrap break word URL for accessing additional Pod specifications to run DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 manifest url header strings td tr tr td td td style line height 130 word wrap break word Comma separated list of HTTP headers to use when accessing the URL provided to code manifest url code Multiple headers with the same name will be added in the same order provided This flag can be repeatedly invoked For example code manifest url header a hello b again c world manifest url header b beautiful code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 max open files int nbsp nbsp nbsp nbsp nbsp Default 1000000 td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 max pods int32 nbsp nbsp nbsp nbsp nbsp Default 110 td tr tr td td td style line height 130 word wrap break word Number of Pods that can run on this kubelet DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 maximum dead containers int32 nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word 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 code eviction hard code or code eviction soft code instead Will be removed in a future version td tr tr td colspan 2 maximum dead containers per container int32 nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word Maximum number of old instances to retain per container Each container takes up some disk space DEPRECATED Use code eviction hard code or code eviction soft code instead Will be removed in a future version td tr tr td colspan 2 memory manager policy string nbsp nbsp nbsp nbsp nbsp Default code None code td tr tr td td td style line height 130 word wrap break word Memory Manager policy to use Possible values quot code None code quot quot code Static code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 minimum container ttl duration duration td tr tr td td td style line height 130 word wrap break word Minimum age for a finished container before it is garbage collected Examples quot code 300ms code quot quot code 10s code quot or quot code 2h45m code quot DEPRECATED Use code eviction hard code or code eviction soft code instead Will be removed in a future version td tr tr td colspan 2 minimum image ttl duration duration nbsp nbsp nbsp nbsp nbsp Default code 2m0s code td tr tr td td td style line height 130 word wrap break word Minimum age for an unused image before it is garbage collected Examples quot code 300ms code quot quot code 10s code quot or quot code 2h45m code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 node ip string td tr tr td td td style line height 130 word wrap break word 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 quot code code quot to make it prefer the default IPv6 address rather than the default IPv4 address td tr tr td colspan 2 node labels lt key value pairs gt td tr tr td td td style line height 130 word wrap break word lt Warning Alpha feature gt Labels to add when registering the node in the cluster Labels must be code key value code pairs separated by code code Labels in the code kubernetes io code namespace must begin with an allowed prefix code kubelet kubernetes io code code node kubernetes io code or be in the specifically allowed set code beta kubernetes io arch code code beta kubernetes io instance type code code beta kubernetes io os code code failure domain beta kubernetes io region code code failure domain beta kubernetes io zone code code kubernetes io arch code code kubernetes io hostname code code kubernetes io os code code node kubernetes io instance type code code topology kubernetes io region code code topology kubernetes io zone code td tr tr td colspan 2 node status max images int32 nbsp nbsp nbsp nbsp nbsp Default 50 td tr tr td td td style line height 130 word wrap break word The maximum number of images to report in code node status images code If code 1 code is specified no cap will be applied DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 node status update frequency duration nbsp nbsp nbsp nbsp nbsp Default code 10s code td tr tr td td td style line height 130 word wrap break word Specifies how often kubelet posts node status to master B Note B be cautious when changing the constant it must work with code nodeMonitorGracePeriod code in Node controller DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 oom score adj int32 nbsp nbsp nbsp nbsp nbsp Default 999 td tr tr td td td style line height 130 word wrap break word The code oom score adj code 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 pod cidr string td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 pod infra container image string nbsp nbsp nbsp nbsp nbsp Default code registry k8s io pause 3 9 code td tr tr td td td style line height 130 word wrap break word Specified image will not be pruned by the image garbage collector CRI implementations have their own configuration to set this image DEPRECATED will be removed in 1 27 Image garbage collector will get sandbox image information from CRI td tr tr td colspan 2 pod manifest path string td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 pod max pids int nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word Set the maximum number of processes per pod If code 1 code the kubelet defaults to the node allocatable PID capacity DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 pods per core int32 td tr tr td td td style line height 130 word wrap break word Number of Pods per core that can run on this kubelet The total number of pods on this kubelet cannot exceed code max pods code so code max pods code will be used if this calculation results in a larger number of pods allowed on the kubelet A value of code 0 code disables this limit DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 port int32 nbsp nbsp nbsp nbsp nbsp Default 10250 td tr tr td td td style line height 130 word wrap break word The port for the kubelet to serve on DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 protect kernel defaults td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 provider id string td tr tr td td td style line height 130 word wrap break word Unique identifier for identifying the node in a machine database i e cloud provider td tr tr td colspan 2 qos reserved string td tr tr td td td style line height 130 word wrap break word lt Warning Alpha feature gt A set of code lt resource name gt lt percentage gt code e g quot code memory 50 code quot pairs that describe how pod resource requests are reserved at the QoS level Currently only code memory code is supported Requires the code QOSReserved code feature gate to be enabled DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 read only port int32 nbsp nbsp nbsp nbsp nbsp Default 10255 td tr tr td td td style line height 130 word wrap break word The read only port for the kubelet to serve on with no authentication authorization set to code 0 code to disable DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 register node nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word Register the node with the API server If code kubeconfig code is not provided this flag is irrelevant as the kubelet won t have an API server to register with DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 register schedulable nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word Register the node as schedulable Won t have any effect if code register node code is code false code DEPRECATED will be removed in a future version td tr tr td colspan 2 register with taints string td tr tr td td td style line height 130 word wrap break word Register the node with the given list of taints comma separated code lt key gt lt value gt lt effect gt code No op if code register node code is code false code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 registry burst int32 nbsp nbsp nbsp nbsp nbsp Default 10 td tr tr td td td style line height 130 word wrap break word Maximum size of a bursty pulls temporarily allows pulls to burst to this number while still not exceeding code registry qps code Only used if code registry qps code is greater than 0 DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 registry qps int32 nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word If gt 0 limit registry pull QPS to this value If code 0 code unlimited DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 reserved cpus string td tr tr td td td style line height 130 word wrap break word 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 code system reserved code and code kube reserved code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 reserved memory string td tr tr td td td style line height 130 word wrap break word A comma separated list of memory reservations for NUMA nodes e g quot code reserved memory 0 memory 1Gi hugepages 1M 2Gi reserved memory 1 memory 2Gi code quot The total sum for each memory type should be equal to the sum of code kube reserved code code system reserved code and code eviction threshold code See a href https kubernetes io docs tasks administer cluster memory manager reserved memory flag here a for more details DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 resolv conf string nbsp nbsp nbsp nbsp nbsp Default code etc resolv conf code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 root dir string nbsp nbsp nbsp nbsp nbsp Default code var lib kubelet code td tr tr td td td style line height 130 word wrap break word Directory path for managing kubelet files volume mounts etc td tr tr td colspan 2 rotate certificates td tr tr td td td style line height 130 word wrap break word Auto rotate the kubelet client certificates by requesting new certificates from the code kube apiserver code when the certificate expiration approaches DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 rotate server certificates td tr tr td td td style line height 130 word wrap break word Auto request and rotate the kubelet serving certificates by requesting new certificates from the code kube apiserver code when the certificate expiration approaches Requires the code RotateKubeletServerCertificate code feature gate to be enabled and approval of the submitted code CertificateSigningRequest code objects DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 runonce td tr tr td td td style line height 130 word wrap break word If code true code exit after spawning pods from local manifests or remote urls Exclusive with code enable server code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 runtime cgroups string td tr tr td td td style line height 130 word wrap break word Optional absolute name of cgroups to create and run the runtime in td tr tr td colspan 2 runtime request timeout duration nbsp nbsp nbsp nbsp nbsp Default code 2m0s code td tr tr td td td style line height 130 word wrap break word Timeout of all runtime requests except long running request code pull code code logs code code exec code and code attach code 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 seccomp default td tr tr td td td style line height 130 word wrap break word Enable the use of code RuntimeDefault code as the default seccomp profile for all workloads td tr tr td colspan 2 serialize image pulls nbsp nbsp nbsp nbsp nbsp Default code true code td tr tr td td td style line height 130 word wrap break word Pull images one at a time We recommend not changing the default value on nodes that run docker daemon with version lt 1 9 or an code aufs code storage backend Issue 10959 has more details DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 streaming connection idle timeout duration nbsp nbsp nbsp nbsp nbsp Default code 4h0m0s code td tr tr td td td style line height 130 word wrap break word Maximum time a streaming connection can be idle before the connection is automatically closed code 0 code indicates no timeout Example code 5m code Note All connections to the kubelet server have a maximum duration of 4 hours DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 sync frequency duration nbsp nbsp nbsp nbsp nbsp Default code 1m0s code td tr tr td td td style line height 130 word wrap break word Max period between synchronizing running containers and config DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 system cgroups string td tr tr td td td style line height 130 word wrap break word Optional absolute name of cgroups in which to place all non kernel processes that are not already inside a cgroup under code code 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 system reserved string nbsp nbsp nbsp nbsp nbsp Default lt none gt td tr tr td td td style line height 130 word wrap break word A set of code lt resource name gt lt resource quantity gt code e g quot code cpu 200m memory 500Mi ephemeral storage 1Gi pid 100 code quot pairs that describe resources reserved for non kubernetes components Currently only code cpu code and code memory code and local ephemeral storage for root file system are supported See a href https kubernetes io docs tasks administer cluster reserve compute resources system reserved here a for more detail DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 system reserved cgroup string nbsp nbsp nbsp nbsp nbsp Default code code td tr tr td td td style line height 130 word wrap break word Absolute name of the top level cgroup that is used to manage non kubernetes components for which compute resources were reserved via code system reserved code flag Ex code system reserved code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 tls cert file string td tr tr td td td style line height 130 word wrap break word File containing x509 certificate used for serving HTTPS with intermediate certs if any concatenated after server cert If code tls cert file code and code tls private key file code are not provided a self signed certificate and key are generated for the public address and saved to the directory passed to code cert dir code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 tls cipher suites string td tr tr td td td style line height 130 word wrap break word Comma separated list of cipher suites for the server If omitted the default Go cipher suites will be used br Preferred values code TLS AES 128 GCM SHA256 code code TLS AES 256 GCM SHA384 code code TLS CHACHA20 POLY1305 SHA256 code code TLS ECDHE ECDSA WITH AES 128 CBC SHA code code TLS ECDHE ECDSA WITH AES 128 GCM SHA256 code code TLS ECDHE ECDSA WITH AES 256 CBC SHA code code TLS ECDHE ECDSA WITH AES 256 GCM SHA384 code code TLS ECDHE ECDSA WITH CHACHA20 POLY1305 code code TLS ECDHE ECDSA WITH CHACHA20 POLY1305 SHA256 code code TLS ECDHE RSA WITH AES 128 CBC SHA code code TLS ECDHE RSA WITH AES 128 GCM SHA256 code code TLS ECDHE RSA WITH AES 256 CBC SHA code code TLS ECDHE RSA WITH AES 256 GCM SHA384 code code TLS ECDHE RSA WITH CHACHA20 POLY1305 code code TLS ECDHE RSA WITH CHACHA20 POLY1305 SHA256 code code TLS RSA WITH AES 128 CBC SHA code code TLS RSA WITH AES 128 GCM SHA256 code code TLS RSA WITH AES 256 CBC SHA code code TLS RSA WITH AES 256 GCM SHA384 code br Insecure values code TLS ECDHE ECDSA WITH AES 128 CBC SHA256 code code TLS ECDHE ECDSA WITH RC4 128 SHA code code TLS ECDHE RSA WITH 3DES EDE CBC SHA code code TLS ECDHE RSA WITH AES 128 CBC SHA256 code code TLS ECDHE RSA WITH RC4 128 SHA code code TLS RSA WITH 3DES EDE CBC SHA code code TLS RSA WITH AES 128 CBC SHA256 code code TLS RSA WITH RC4 128 SHA code br DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information tr tr td colspan 2 tls min version string td tr tr td td td style line height 130 word wrap break word Minimum TLS version supported Possible values quot code VersionTLS10 code quot quot code VersionTLS11 code quot quot code VersionTLS12 code quot quot code VersionTLS13 code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 tls private key file string td tr tr td td td style line height 130 word wrap break word File containing x509 private key matching code tls cert file code DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 topology manager policy string nbsp nbsp nbsp nbsp nbsp Default code none code td tr tr td td td style line height 130 word wrap break word Topology Manager policy to use Possible values quot code none code quot quot code best effort code quot quot code restricted code quot quot code single numa node code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 topology manager policy options string td tr tr td td td style line height 130 word wrap break word A set of lt key gt lt value gt topology manager policy options to use to fine tune their behaviour If not supplied keep the default behaviour DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 topology manager scope string nbsp nbsp nbsp nbsp nbsp Default code container code td tr tr td td td style line height 130 word wrap break word Scope to which topology hints are applied Topology manager collects hints from hint providers and applies them to the defined scope to ensure the pod admission Possible values quot code container code quot quot code pod code quot DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 v v Level td tr tr td td td style line height 130 word wrap break word Number for the log level verbosity td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word Print version information and quit code version vX Y Z code sets the reported version td tr tr td colspan 2 vmodule lt A list of pattern N strings gt td tr tr td td td style line height 130 word wrap break word Comma separated list of code pattern N code settings for file filtered logging only works for text log format td tr tr td colspan 2 volume plugin dir string nbsp nbsp nbsp nbsp nbsp Default code usr libexec kubernetes kubelet plugins volume exec code td tr tr td td td style line height 130 word wrap break word 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 code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tr td colspan 2 volume stats agg period duration nbsp nbsp nbsp nbsp nbsp Default code 1m0s code td tr tr td td td style line height 130 word wrap break word Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes To disable volume calculations set to a negative number DEPRECATED This parameter should be set via the config file specified by the kubelet s code config code flag See a href https kubernetes io docs tasks administer cluster kubelet config file kubelet config file a for more information td tr tbody table |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kube scheduler | ---
title: kube-scheduler
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
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](https://kubernetes.io/docs/concepts/scheduling-eviction/)
for more information about scheduling and the kube-scheduler component.
```
kube-scheduler [flags]
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-metric-labels stringToString Default: []</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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'.</p></td>
</tr>
<tr>
<td colspan="2">--allow-metric-labels-manifest string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path to the manifest file that contains the allow-list mapping. The format of the file is the same as the flag --allow-metric-labels. Note that the flag --allow-metric-labels will override the manifest file.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-skip-lookup</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If false, the authentication-kubeconfig will be used to lookup missing authentication configuration from the cluster.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-token-webhook-cache-ttl duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration to cache responses from the webhook token authenticator.</p></td>
</tr>
<tr>
<td colspan="2">--authentication-tolerate-lookup-failure Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-always-allow-paths strings Default: "/healthz,/readyz,/livez"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A list of HTTP paths to skip during authorization, i.e. these are authorized without contacting the 'core' kubernetes server.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-cache-authorized-ttl duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration to cache 'authorized' responses from the webhook authorizer.</p></td>
</tr>
<tr>
<td colspan="2">--authorization-webhook-cache-unauthorized-ttl duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration to cache 'unauthorized' responses from the webhook authorizer.</p></td>
</tr>
<tr>
<td colspan="2">--bind-address string Default: 0.0.0.0</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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 and IP address families will be used.</p></td>
</tr>
<tr>
<td colspan="2">--cert-dir string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.</p></td>
</tr>
<tr>
<td colspan="2">--client-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The path to the configuration file.</p></td>
</tr>
<tr>
<td colspan="2">--contention-profiling Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>DEPRECATED: enable block profiling, if profiling is enabled. This parameter is ignored if a config file is specified in --config.</p></td>
</tr>
<tr>
<td colspan="2">--disable-http2-serving</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, HTTP2 serving will be disabled [default=false]</p></td>
</tr>
<tr>
<td colspan="2">--disabled-metrics strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--emulated-version strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The versions different components emulate their capabilities (APIs, features, ...) of.<br/>If set, the component will emulate the behavior of this version instead of the underlying binary version.<br/>Version format could only be major.minor, for example: '--emulated-version=wardle=1.2,kube=1.31'. Options are:<br/>kube=1.31..1.31 (default=1.31)If the component is not specified, defaults to "kube"</p></td>
</tr>
<tr>
<td colspan="2">--feature-gates colonSeparatedMultimapStringString</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Comma-separated list of component:key=value pairs that describe feature gates for alpha/experimental features of different components.<br/>If the component is not specified, defaults to "kube". This flag can be repeatedly invoked. For example: --feature-gates 'wardle:featureA=true,wardle:featureB=false' --feature-gates 'kube:featureC=true'Options are:<br/>kube:APIResponseCompression=true|false (BETA - default=true)<br/>kube:APIServerIdentity=true|false (BETA - default=true)<br/>kube:APIServerTracing=true|false (BETA - default=true)<br/>kube:APIServingWithRoutine=true|false (ALPHA - default=false)<br/>kube:AllAlpha=true|false (ALPHA - default=false)<br/>kube:AllBeta=true|false (BETA - default=false)<br/>kube:AnonymousAuthConfigurableEndpoints=true|false (ALPHA - default=false)<br/>kube:AnyVolumeDataSource=true|false (BETA - default=true)<br/>kube:AuthorizeNodeWithSelectors=true|false (ALPHA - default=false)<br/>kube:AuthorizeWithSelectors=true|false (ALPHA - default=false)<br/>kube:CPUManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>kube:CPUManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>kube:CPUManagerPolicyOptions=true|false (BETA - default=true)<br/>kube:CRDValidationRatcheting=true|false (BETA - default=true)<br/>kube:CSIMigrationPortworx=true|false (BETA - default=true)<br/>kube:CSIVolumeHealth=true|false (ALPHA - default=false)<br/>kube:CloudControllerManagerWebhook=true|false (ALPHA - default=false)<br/>kube:ClusterTrustBundle=true|false (ALPHA - default=false)<br/>kube:ClusterTrustBundleProjection=true|false (ALPHA - default=false)<br/>kube:ComponentSLIs=true|false (BETA - default=true)<br/>kube:ConcurrentWatchObjectDecode=true|false (BETA - default=false)<br/>kube:ConsistentListFromCache=true|false (BETA - default=true)<br/>kube:ContainerCheckpoint=true|false (BETA - default=true)<br/>kube:ContextualLogging=true|false (BETA - default=true)<br/>kube:CoordinatedLeaderElection=true|false (ALPHA - default=false)<br/>kube:CronJobsScheduledAnnotation=true|false (BETA - default=true)<br/>kube:CrossNamespaceVolumeDataSource=true|false (ALPHA - default=false)<br/>kube:CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)<br/>kube:CustomResourceFieldSelectors=true|false (BETA - default=true)<br/>kube:DRAControlPlaneController=true|false (ALPHA - default=false)<br/>kube:DisableAllocatorDualWrite=true|false (ALPHA - default=false)<br/>kube:DisableNodeKubeProxyVersion=true|false (BETA - default=true)<br/>kube:DynamicResourceAllocation=true|false (ALPHA - default=false)<br/>kube:EventedPLEG=true|false (ALPHA - default=false)<br/>kube:GracefulNodeShutdown=true|false (BETA - default=true)<br/>kube:GracefulNodeShutdownBasedOnPodPriority=true|false (BETA - default=true)<br/>kube:HPAScaleToZero=true|false (ALPHA - default=false)<br/>kube:HonorPVReclaimPolicy=true|false (BETA - default=true)<br/>kube:ImageMaximumGCAge=true|false (BETA - default=true)<br/>kube:ImageVolume=true|false (ALPHA - default=false)<br/>kube:InPlacePodVerticalScaling=true|false (ALPHA - default=false)<br/>kube:InTreePluginPortworxUnregister=true|false (ALPHA - default=false)<br/>kube:InformerResourceVersion=true|false (ALPHA - default=false)<br/>kube:JobBackoffLimitPerIndex=true|false (BETA - default=true)<br/>kube:JobManagedBy=true|false (ALPHA - default=false)<br/>kube:JobPodReplacementPolicy=true|false (BETA - default=true)<br/>kube:JobSuccessPolicy=true|false (BETA - default=true)<br/>kube:KubeletCgroupDriverFromCRI=true|false (BETA - default=true)<br/>kube:KubeletInUserNamespace=true|false (ALPHA - default=false)<br/>kube:KubeletPodResourcesDynamicResources=true|false (ALPHA - default=false)<br/>kube:KubeletPodResourcesGet=true|false (ALPHA - default=false)<br/>kube:KubeletSeparateDiskGC=true|false (BETA - default=true)<br/>kube:KubeletTracing=true|false (BETA - default=true)<br/>kube:LoadBalancerIPMode=true|false (BETA - default=true)<br/>kube:LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (BETA - default=false)<br/>kube:LoggingAlphaOptions=true|false (ALPHA - default=false)<br/>kube:LoggingBetaOptions=true|false (BETA - default=true)<br/>kube:MatchLabelKeysInPodAffinity=true|false (BETA - default=true)<br/>kube:MatchLabelKeysInPodTopologySpread=true|false (BETA - default=true)<br/>kube:MaxUnavailableStatefulSet=true|false (ALPHA - default=false)<br/>kube:MemoryManager=true|false (BETA - default=true)<br/>kube:MemoryQoS=true|false (ALPHA - default=false)<br/>kube:MultiCIDRServiceAllocator=true|false (BETA - default=false)<br/>kube:MutatingAdmissionPolicy=true|false (ALPHA - default=false)<br/>kube:NFTablesProxyMode=true|false (BETA - default=true)<br/>kube:NodeInclusionPolicyInPodTopologySpread=true|false (BETA - default=true)<br/>kube:NodeLogQuery=true|false (BETA - default=false)<br/>kube:NodeSwap=true|false (BETA - default=true)<br/>kube:OpenAPIEnums=true|false (BETA - default=true)<br/>kube:PodAndContainerStatsFromCRI=true|false (ALPHA - default=false)<br/>kube:PodDeletionCost=true|false (BETA - default=true)<br/>kube:PodIndexLabel=true|false (BETA - default=true)<br/>kube:PodLifecycleSleepAction=true|false (BETA - default=true)<br/>kube:PodReadyToStartContainersCondition=true|false (BETA - default=true)<br/>kube:PortForwardWebsockets=true|false (BETA - default=true)<br/>kube:ProcMountType=true|false (BETA - default=false)<br/>kube:QOSReserved=true|false (ALPHA - default=false)<br/>kube:RecoverVolumeExpansionFailure=true|false (ALPHA - default=false)<br/>kube:RecursiveReadOnlyMounts=true|false (BETA - default=true)<br/>kube:RelaxedEnvironmentVariableValidation=true|false (ALPHA - default=false)<br/>kube:ReloadKubeletServerCertificateFile=true|false (BETA - default=true)<br/>kube:ResilientWatchCacheInitialization=true|false (BETA - default=true)<br/>kube:ResourceHealthStatus=true|false (ALPHA - default=false)<br/>kube:RetryGenerateName=true|false (BETA - default=true)<br/>kube:RotateKubeletServerCertificate=true|false (BETA - default=true)<br/>kube:RuntimeClassInImageCriApi=true|false (ALPHA - default=false)<br/>kube:SELinuxMount=true|false (ALPHA - default=false)<br/>kube:SELinuxMountReadWriteOncePod=true|false (BETA - default=true)<br/>kube:SchedulerQueueingHints=true|false (BETA - default=false)<br/>kube:SeparateCacheWatchRPC=true|false (BETA - default=true)<br/>kube:SeparateTaintEvictionController=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenJTI=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenNodeBinding=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenNodeBindingValidation=true|false (BETA - default=true)<br/>kube:ServiceAccountTokenPodNodeInfo=true|false (BETA - default=true)<br/>kube:ServiceTrafficDistribution=true|false (BETA - default=true)<br/>kube:SidecarContainers=true|false (BETA - default=true)<br/>kube:SizeMemoryBackedVolumes=true|false (BETA - default=true)<br/>kube:StatefulSetAutoDeletePVC=true|false (BETA - default=true)<br/>kube:StorageNamespaceIndex=true|false (BETA - default=true)<br/>kube:StorageVersionAPI=true|false (ALPHA - default=false)<br/>kube:StorageVersionHash=true|false (BETA - default=true)<br/>kube:StorageVersionMigrator=true|false (ALPHA - default=false)<br/>kube:StrictCostEnforcementForVAP=true|false (BETA - default=false)<br/>kube:StrictCostEnforcementForWebhooks=true|false (BETA - default=false)<br/>kube:StructuredAuthenticationConfiguration=true|false (BETA - default=true)<br/>kube:StructuredAuthorizationConfiguration=true|false (BETA - default=true)<br/>kube:SupplementalGroupsPolicy=true|false (ALPHA - default=false)<br/>kube:TopologyAwareHints=true|false (BETA - default=true)<br/>kube:TopologyManagerPolicyAlphaOptions=true|false (ALPHA - default=false)<br/>kube:TopologyManagerPolicyBetaOptions=true|false (BETA - default=true)<br/>kube:TopologyManagerPolicyOptions=true|false (BETA - default=true)<br/>kube:TranslateStreamCloseWebsocketRequests=true|false (BETA - default=true)<br/>kube:UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=true)<br/>kube:UnknownVersionInteroperabilityProxy=true|false (ALPHA - default=false)<br/>kube:UserNamespacesPodSecurityStandards=true|false (ALPHA - default=false)<br/>kube:UserNamespacesSupport=true|false (BETA - default=false)<br/>kube:VolumeAttributesClass=true|false (BETA - default=false)<br/>kube:VolumeCapacityPriority=true|false (ALPHA - default=false)<br/>kube:WatchCacheInitializationPostStartHook=true|false (BETA - default=false)<br/>kube:WatchFromStorageWithoutResourceVersion=true|false (BETA - default=false)<br/>kube:WatchList=true|false (ALPHA - default=false)<br/>kube:WatchListClient=true|false (BETA - default=false)<br/>kube:WinDSR=true|false (ALPHA - default=false)<br/>kube:WinOverlay=true|false (BETA - default=true)<br/>kube:WindowsHostNetwork=true|false (ALPHA - default=true)</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for kube-scheduler</p></td>
</tr>
<tr>
<td colspan="2">--http2-max-streams-per-connection int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--kube-api-burst int32 Default: 100</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>DEPRECATED: burst to use while talking with kubernetes apiserver. This parameter is ignored if a config file is specified in --config.</p></td>
</tr>
<tr>
<td colspan="2">--kube-api-content-type string Default: "application/vnd.kubernetes.protobuf"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>DEPRECATED: content type of requests sent to apiserver. This parameter is ignored if a config file is specified in --config.</p></td>
</tr>
<tr>
<td colspan="2">--kube-api-qps float Default: 50</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>DEPRECATED: QPS to use while talking with kubernetes apiserver. This parameter is ignored if a config file is specified in --config.</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>DEPRECATED: path to kubeconfig file with authorization and master location information. This parameter is ignored if a config file is specified in --config.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-lease-duration duration Default: 15s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-renew-deadline duration Default: 10s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than the lease duration. This is only applicable if leader election is enabled.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-resource-lock string Default: "leases"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The type of resource object that is used for locking during leader election. Supported options are 'leases', 'endpointsleases' and 'configmapsleases'.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-resource-name string Default: "kube-scheduler"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of resource object that is used for locking during leader election.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-resource-namespace string Default: "kube-system"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The namespace of resource object that is used for locking during leader election.</p></td>
</tr>
<tr>
<td colspan="2">--leader-elect-retry-period duration Default: 2s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.</p></td>
</tr>
<tr>
<td colspan="2">--log-flush-frequency duration Default: 5s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum number of seconds between log flushes</p></td>
</tr>
<tr>
<td colspan="2">--log-text-info-buffer-size quantity</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this.</p></td>
</tr>
<tr>
<td colspan="2">--log-text-split-stream</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>[Alpha] In text format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this.</p></td>
</tr>
<tr>
<td colspan="2">--logging-format string Default: "text"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Sets the log format. Permitted formats: "text".</p></td>
</tr>
<tr>
<td colspan="2">--master string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address of the Kubernetes API server (overrides any value in kubeconfig)</p></td>
</tr>
<tr>
<td colspan="2">--permit-address-sharing</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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]</p></td>
</tr>
<tr>
<td colspan="2">--permit-port-sharing</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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]</p></td>
</tr>
<tr>
<td colspan="2">--pod-max-in-unschedulable-pods-duration duration Default: 5m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>DEPRECATED: the maximum time a pod can stay in unschedulablePods. If a pod stays in unschedulablePods for longer than this value, the pod will be moved from unschedulablePods to backoffQ or activeQ. This flag is deprecated and will be removed in a future version.</p></td>
</tr>
<tr>
<td colspan="2">--profiling Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>DEPRECATED: enable profiling via web interface host:port/debug/pprof/. This parameter is ignored if a config file is specified in --config.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-allowed-names strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-client-ca-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-extra-headers-prefix strings Default: "x-remote-extra-"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of request header prefixes to inspect. X-Remote-Extra- is suggested.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-group-headers strings Default: "x-remote-group"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of request headers to inspect for groups. X-Remote-Group is suggested.</p></td>
</tr>
<tr>
<td colspan="2">--requestheader-username-headers strings Default: "x-remote-user"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>List of request headers to inspect for usernames. X-Remote-User is common.</p></td>
</tr>
<tr>
<td colspan="2">--secure-port int Default: 10259</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.</p></td>
</tr>
<tr>
<td colspan="2">--show-hidden-metrics-for-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--tls-cert-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--tls-cipher-suites strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Comma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be used.<br/>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_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.<br/>Insecure values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_RC4_128_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_RC4_128_SHA.</p></td>
</tr>
<tr>
<td colspan="2">--tls-min-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13</p></td>
</tr>
<tr>
<td colspan="2">--tls-private-key-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>File containing the default x509 private key matching --tls-cert-file.</p></td>
</tr>
<tr>
<td colspan="2">--tls-sni-cert-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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".</p></td>
</tr>
<tr>
<td colspan="2">-v, --v int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>number for the log level verbosity</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--vmodule pattern=N,...</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)</p></td>
</tr>
<tr>
<td colspan="2">--write-config-to string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If set, write the configuration values to this file and exit.</p></td>
</tr>
</tbody>
</table>
| kubernetes reference | title kube scheduler content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project 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 https kubernetes io docs concepts scheduling eviction for more information about scheduling and the kube scheduler component kube scheduler flags table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow metric labels stringToString nbsp nbsp nbsp nbsp nbsp Default td tr tr td td td style line height 130 word wrap break word p The map from metric label to value allow list of this label The key s format is lt MetricName gt lt LabelName gt The value s format is lt allowed value gt lt allowed value gt e g metric1 label1 v1 v2 v3 metric1 label2 v1 v2 v3 metric2 label1 v1 v2 v3 p td tr tr td colspan 2 allow metric labels manifest string td tr tr td td td style line height 130 word wrap break word p The path to the manifest file that contains the allow list mapping The format of the file is the same as the flag allow metric labels Note that the flag allow metric labels will override the manifest file p td tr tr td colspan 2 authentication kubeconfig string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 authentication skip lookup td tr tr td td td style line height 130 word wrap break word p If false the authentication kubeconfig will be used to lookup missing authentication configuration from the cluster p td tr tr td colspan 2 authentication token webhook cache ttl duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The duration to cache responses from the webhook token authenticator p td tr tr td colspan 2 authentication tolerate lookup failure nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 authorization always allow paths strings nbsp nbsp nbsp nbsp nbsp Default healthz readyz livez td tr tr td td td style line height 130 word wrap break word p A list of HTTP paths to skip during authorization i e these are authorized without contacting the core kubernetes server p td tr tr td colspan 2 authorization kubeconfig string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 authorization webhook cache authorized ttl duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The duration to cache authorized responses from the webhook authorizer p td tr tr td colspan 2 authorization webhook cache unauthorized ttl duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The duration to cache unauthorized responses from the webhook authorizer p td tr tr td colspan 2 bind address string nbsp nbsp nbsp nbsp nbsp Default 0 0 0 0 td tr tr td td td style line height 130 word wrap break word p 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 and IP address families will be used p td tr tr td colspan 2 cert dir string td tr tr td td td style line height 130 word wrap break word p The directory where the TLS certs are located If tls cert file and tls private key file are provided this flag will be ignored p td tr tr td colspan 2 client ca file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 config string td tr tr td td td style line height 130 word wrap break word p The path to the configuration file p td tr tr td colspan 2 contention profiling nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p DEPRECATED enable block profiling if profiling is enabled This parameter is ignored if a config file is specified in config p td tr tr td colspan 2 disable http2 serving td tr tr td td td style line height 130 word wrap break word p If true HTTP2 serving will be disabled default false p td tr tr td colspan 2 disabled metrics strings td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 emulated version strings td tr tr td td td style line height 130 word wrap break word p The versions different components emulate their capabilities APIs features of br If set the component will emulate the behavior of this version instead of the underlying binary version br Version format could only be major minor for example emulated version wardle 1 2 kube 1 31 Options are br kube 1 31 1 31 default 1 31 If the component is not specified defaults to quot kube quot p td tr tr td colspan 2 feature gates colonSeparatedMultimapStringString td tr tr td td td style line height 130 word wrap break word p Comma separated list of component key value pairs that describe feature gates for alpha experimental features of different components br If the component is not specified defaults to quot kube quot This flag can be repeatedly invoked For example feature gates wardle featureA true wardle featureB false feature gates kube featureC true Options are br kube APIResponseCompression true false BETA default true br kube APIServerIdentity true false BETA default true br kube APIServerTracing true false BETA default true br kube APIServingWithRoutine true false ALPHA default false br kube AllAlpha true false ALPHA default false br kube AllBeta true false BETA default false br kube AnonymousAuthConfigurableEndpoints true false ALPHA default false br kube AnyVolumeDataSource true false BETA default true br kube AuthorizeNodeWithSelectors true false ALPHA default false br kube AuthorizeWithSelectors true false ALPHA default false br kube CPUManagerPolicyAlphaOptions true false ALPHA default false br kube CPUManagerPolicyBetaOptions true false BETA default true br kube CPUManagerPolicyOptions true false BETA default true br kube CRDValidationRatcheting true false BETA default true br kube CSIMigrationPortworx true false BETA default true br kube CSIVolumeHealth true false ALPHA default false br kube CloudControllerManagerWebhook true false ALPHA default false br kube ClusterTrustBundle true false ALPHA default false br kube ClusterTrustBundleProjection true false ALPHA default false br kube ComponentSLIs true false BETA default true br kube ConcurrentWatchObjectDecode true false BETA default false br kube ConsistentListFromCache true false BETA default true br kube ContainerCheckpoint true false BETA default true br kube ContextualLogging true false BETA default true br kube CoordinatedLeaderElection true false ALPHA default false br kube CronJobsScheduledAnnotation true false BETA default true br kube CrossNamespaceVolumeDataSource true false ALPHA default false br kube CustomCPUCFSQuotaPeriod true false ALPHA default false br kube CustomResourceFieldSelectors true false BETA default true br kube DRAControlPlaneController true false ALPHA default false br kube DisableAllocatorDualWrite true false ALPHA default false br kube DisableNodeKubeProxyVersion true false BETA default true br kube DynamicResourceAllocation true false ALPHA default false br kube EventedPLEG true false ALPHA default false br kube GracefulNodeShutdown true false BETA default true br kube GracefulNodeShutdownBasedOnPodPriority true false BETA default true br kube HPAScaleToZero true false ALPHA default false br kube HonorPVReclaimPolicy true false BETA default true br kube ImageMaximumGCAge true false BETA default true br kube ImageVolume true false ALPHA default false br kube InPlacePodVerticalScaling true false ALPHA default false br kube InTreePluginPortworxUnregister true false ALPHA default false br kube InformerResourceVersion true false ALPHA default false br kube JobBackoffLimitPerIndex true false BETA default true br kube JobManagedBy true false ALPHA default false br kube JobPodReplacementPolicy true false BETA default true br kube JobSuccessPolicy true false BETA default true br kube KubeletCgroupDriverFromCRI true false BETA default true br kube KubeletInUserNamespace true false ALPHA default false br kube KubeletPodResourcesDynamicResources true false ALPHA default false br kube KubeletPodResourcesGet true false ALPHA default false br kube KubeletSeparateDiskGC true false BETA default true br kube KubeletTracing true false BETA default true br kube LoadBalancerIPMode true false BETA default true br kube LocalStorageCapacityIsolationFSQuotaMonitoring true false BETA default false br kube LoggingAlphaOptions true false ALPHA default false br kube LoggingBetaOptions true false BETA default true br kube MatchLabelKeysInPodAffinity true false BETA default true br kube MatchLabelKeysInPodTopologySpread true false BETA default true br kube MaxUnavailableStatefulSet true false ALPHA default false br kube MemoryManager true false BETA default true br kube MemoryQoS true false ALPHA default false br kube MultiCIDRServiceAllocator true false BETA default false br kube MutatingAdmissionPolicy true false ALPHA default false br kube NFTablesProxyMode true false BETA default true br kube NodeInclusionPolicyInPodTopologySpread true false BETA default true br kube NodeLogQuery true false BETA default false br kube NodeSwap true false BETA default true br kube OpenAPIEnums true false BETA default true br kube PodAndContainerStatsFromCRI true false ALPHA default false br kube PodDeletionCost true false BETA default true br kube PodIndexLabel true false BETA default true br kube PodLifecycleSleepAction true false BETA default true br kube PodReadyToStartContainersCondition true false BETA default true br kube PortForwardWebsockets true false BETA default true br kube ProcMountType true false BETA default false br kube QOSReserved true false ALPHA default false br kube RecoverVolumeExpansionFailure true false ALPHA default false br kube RecursiveReadOnlyMounts true false BETA default true br kube RelaxedEnvironmentVariableValidation true false ALPHA default false br kube ReloadKubeletServerCertificateFile true false BETA default true br kube ResilientWatchCacheInitialization true false BETA default true br kube ResourceHealthStatus true false ALPHA default false br kube RetryGenerateName true false BETA default true br kube RotateKubeletServerCertificate true false BETA default true br kube RuntimeClassInImageCriApi true false ALPHA default false br kube SELinuxMount true false ALPHA default false br kube SELinuxMountReadWriteOncePod true false BETA default true br kube SchedulerQueueingHints true false BETA default false br kube SeparateCacheWatchRPC true false BETA default true br kube SeparateTaintEvictionController true false BETA default true br kube ServiceAccountTokenJTI true false BETA default true br kube ServiceAccountTokenNodeBinding true false BETA default true br kube ServiceAccountTokenNodeBindingValidation true false BETA default true br kube ServiceAccountTokenPodNodeInfo true false BETA default true br kube ServiceTrafficDistribution true false BETA default true br kube SidecarContainers true false BETA default true br kube SizeMemoryBackedVolumes true false BETA default true br kube StatefulSetAutoDeletePVC true false BETA default true br kube StorageNamespaceIndex true false BETA default true br kube StorageVersionAPI true false ALPHA default false br kube StorageVersionHash true false BETA default true br kube StorageVersionMigrator true false ALPHA default false br kube StrictCostEnforcementForVAP true false BETA default false br kube StrictCostEnforcementForWebhooks true false BETA default false br kube StructuredAuthenticationConfiguration true false BETA default true br kube StructuredAuthorizationConfiguration true false BETA default true br kube SupplementalGroupsPolicy true false ALPHA default false br kube TopologyAwareHints true false BETA default true br kube TopologyManagerPolicyAlphaOptions true false ALPHA default false br kube TopologyManagerPolicyBetaOptions true false BETA default true br kube TopologyManagerPolicyOptions true false BETA default true br kube TranslateStreamCloseWebsocketRequests true false BETA default true br kube UnauthenticatedHTTP2DOSMitigation true false BETA default true br kube UnknownVersionInteroperabilityProxy true false ALPHA default false br kube UserNamespacesPodSecurityStandards true false ALPHA default false br kube UserNamespacesSupport true false BETA default false br kube VolumeAttributesClass true false BETA default false br kube VolumeCapacityPriority true false ALPHA default false br kube WatchCacheInitializationPostStartHook true false BETA default false br kube WatchFromStorageWithoutResourceVersion true false BETA default false br kube WatchList true false ALPHA default false br kube WatchListClient true false BETA default false br kube WinDSR true false ALPHA default false br kube WinOverlay true false BETA default true br kube WindowsHostNetwork true false ALPHA default true p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for kube scheduler p td tr tr td colspan 2 http2 max streams per connection int td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 kube api burst int32 nbsp nbsp nbsp nbsp nbsp Default 100 td tr tr td td td style line height 130 word wrap break word p DEPRECATED burst to use while talking with kubernetes apiserver This parameter is ignored if a config file is specified in config p td tr tr td colspan 2 kube api content type string nbsp nbsp nbsp nbsp nbsp Default application vnd kubernetes protobuf td tr tr td td td style line height 130 word wrap break word p DEPRECATED content type of requests sent to apiserver This parameter is ignored if a config file is specified in config p td tr tr td colspan 2 kube api qps float nbsp nbsp nbsp nbsp nbsp Default 50 td tr tr td td td style line height 130 word wrap break word p DEPRECATED QPS to use while talking with kubernetes apiserver This parameter is ignored if a config file is specified in config p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p DEPRECATED path to kubeconfig file with authorization and master location information This parameter is ignored if a config file is specified in config p td tr tr td colspan 2 leader elect nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Start a leader election client and gain leadership before executing the main loop Enable this when running replicated components for high availability p td tr tr td colspan 2 leader elect lease duration duration nbsp nbsp nbsp nbsp nbsp Default 15s td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 leader elect renew deadline duration nbsp nbsp nbsp nbsp nbsp Default 10s td tr tr td td td style line height 130 word wrap break word p The interval between attempts by the acting master to renew a leadership slot before it stops leading This must be less than the lease duration This is only applicable if leader election is enabled p td tr tr td colspan 2 leader elect resource lock string nbsp nbsp nbsp nbsp nbsp Default leases td tr tr td td td style line height 130 word wrap break word p The type of resource object that is used for locking during leader election Supported options are leases endpointsleases and configmapsleases p td tr tr td colspan 2 leader elect resource name string nbsp nbsp nbsp nbsp nbsp Default kube scheduler td tr tr td td td style line height 130 word wrap break word p The name of resource object that is used for locking during leader election p td tr tr td colspan 2 leader elect resource namespace string nbsp nbsp nbsp nbsp nbsp Default kube system td tr tr td td td style line height 130 word wrap break word p The namespace of resource object that is used for locking during leader election p td tr tr td colspan 2 leader elect retry period duration nbsp nbsp nbsp nbsp nbsp Default 2s td tr tr td td td style line height 130 word wrap break word p The duration the clients should wait between attempting acquisition and renewal of a leadership This is only applicable if leader election is enabled p td tr tr td colspan 2 log flush frequency duration nbsp nbsp nbsp nbsp nbsp Default 5s td tr tr td td td style line height 130 word wrap break word p Maximum number of seconds between log flushes p td tr tr td colspan 2 log text info buffer size quantity td tr tr td td td style line height 130 word wrap break word p Alpha In text format with split output streams the info messages can be buffered for a while to increase performance The default value of zero bytes disables buffering The size can be specified as number of bytes 512 multiples of 1000 1K multiples of 1024 2Ki or powers of those 3M 4G 5Mi 6Gi Enable the LoggingAlphaOptions feature gate to use this p td tr tr td colspan 2 log text split stream td tr tr td td td style line height 130 word wrap break word p Alpha In text format write error messages to stderr and info messages to stdout The default is to write a single stream to stdout Enable the LoggingAlphaOptions feature gate to use this p td tr tr td colspan 2 logging format string nbsp nbsp nbsp nbsp nbsp Default text td tr tr td td td style line height 130 word wrap break word p Sets the log format Permitted formats quot text quot p td tr tr td colspan 2 master string td tr tr td td td style line height 130 word wrap break word p The address of the Kubernetes API server overrides any value in kubeconfig p td tr tr td colspan 2 permit address sharing td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 permit port sharing td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 pod max in unschedulable pods duration duration nbsp nbsp nbsp nbsp nbsp Default 5m0s td tr tr td td td style line height 130 word wrap break word p DEPRECATED the maximum time a pod can stay in unschedulablePods If a pod stays in unschedulablePods for longer than this value the pod will be moved from unschedulablePods to backoffQ or activeQ This flag is deprecated and will be removed in a future version p td tr tr td colspan 2 profiling nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p DEPRECATED enable profiling via web interface host port debug pprof This parameter is ignored if a config file is specified in config p td tr tr td colspan 2 requestheader allowed names strings td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 requestheader client ca file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 requestheader extra headers prefix strings nbsp nbsp nbsp nbsp nbsp Default x remote extra td tr tr td td td style line height 130 word wrap break word p List of request header prefixes to inspect X Remote Extra is suggested p td tr tr td colspan 2 requestheader group headers strings nbsp nbsp nbsp nbsp nbsp Default x remote group td tr tr td td td style line height 130 word wrap break word p List of request headers to inspect for groups X Remote Group is suggested p td tr tr td colspan 2 requestheader username headers strings nbsp nbsp nbsp nbsp nbsp Default x remote user td tr tr td td td style line height 130 word wrap break word p List of request headers to inspect for usernames X Remote User is common p td tr tr td colspan 2 secure port int nbsp nbsp nbsp nbsp nbsp Default 10259 td tr tr td td td style line height 130 word wrap break word p The port on which to serve HTTPS with authentication and authorization If 0 don t serve HTTPS at all p td tr tr td colspan 2 show hidden metrics for version string td tr tr td td td style line height 130 word wrap break word p 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 lt major gt lt minor gt 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 p td tr tr td colspan 2 tls cert file string td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 tls cipher suites strings td tr tr td td td style line height 130 word wrap break word p Comma separated list of cipher suites for the server If omitted the default Go cipher suites will be used br 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 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 br Insecure values TLS ECDHE ECDSA WITH AES 128 CBC SHA256 TLS ECDHE ECDSA WITH RC4 128 SHA TLS ECDHE RSA WITH 3DES EDE CBC SHA TLS ECDHE RSA WITH AES 128 CBC SHA256 TLS ECDHE RSA WITH RC4 128 SHA TLS RSA WITH 3DES EDE CBC SHA TLS RSA WITH AES 128 CBC SHA TLS RSA WITH AES 128 CBC SHA256 TLS RSA WITH AES 128 GCM SHA256 TLS RSA WITH AES 256 CBC SHA TLS RSA WITH AES 256 GCM SHA384 TLS RSA WITH RC4 128 SHA p td tr tr td colspan 2 tls min version string td tr tr td td td style line height 130 word wrap break word p Minimum TLS version supported Possible values VersionTLS10 VersionTLS11 VersionTLS12 VersionTLS13 p td tr tr td colspan 2 tls private key file string td tr tr td td td style line height 130 word wrap break word p File containing the default x509 private key matching tls cert file p td tr tr td colspan 2 tls sni cert key string td tr tr td td td style line height 130 word wrap break word p 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 quot example crt example key quot or quot foo crt foo key foo com foo com quot p td tr tr td colspan 2 v v int td tr tr td td td style line height 130 word wrap break word p number for the log level verbosity p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 vmodule pattern N td tr tr td td td style line height 130 word wrap break word p comma separated list of pattern N settings for file filtered logging only works for text log format p td tr tr td colspan 2 write config to string td tr tr td td td style line height 130 word wrap break word p If set write the configuration values to this file and exit p td tr tbody table |
kubernetes reference name reference contenttype concept card weight 10 title Feature Gates overview weight 60 | ---
title: Feature Gates
weight: 10
content_type: concept
card:
name: reference
weight: 60
---
<!-- overview -->
This page contains an overview of the various feature gates an administrator
can specify on different Kubernetes components.
See [feature stages](#feature-stages) for an explanation of the stages for a feature.
<!-- body -->
## 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:
```shell
--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](#feature-gates-for-alpha-or-beta-features).
- If a feature is stable you can find all stages for that feature listed in the
[Graduated/Deprecated feature gate table](#feature-gates-for-graduated-or-deprecated-features).
- The [Graduated/Deprecated feature gate table](#feature-gates-for-graduated-or-deprecated-features)
also lists deprecated and withdrawn features.
For a reference to old feature gates that are removed, please refer to
[feature gates removed](/docs/reference/command-line-tools-reference/feature-gates-removed/).
<!-- Want to edit this table? See https://k8s.io/docs/contribute/new-content/new-features/#ready-for-review-feature-gates -->
### Feature gates for Alpha or Beta features
<!-- Want to edit this table? See https://k8s.io/docs/contribute/new-content/new-features/#ready-for-review-feature-gates -->
### Feature gates for graduated or deprecated features
## 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:
* Usually enabled by default. Beta API groups are
[disabled by default](https://github.com/kubernetes/enhancements/tree/master/keps/sig-architecture/3136-beta-apis-off-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.
Please do try *Beta* features and give feedback on them!
After they exit beta, it may not be practical for us to make more changes.
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 {#feature-gates}
Each feature gate is designed for enabling/disabling a specific feature.
<!-- Want to edit this list? See https://k8s.io/docs/contribute/new-content/new-features/#ready-for-review-feature-gates -->
##
* The [deprecation policy](/docs/reference/using-api/deprecation-policy/) for Kubernetes explains
the project's approach to removing features and components.
* Since Kubernetes 1.24, new beta APIs are not enabled by default. When enabling a beta
feature, you will also need to enable any associated API resources.
For example, to enable a particular resource like
`storage.k8s.io/v1beta1/csistoragecapacities`, set `--runtime-config=storage.k8s.io/v1beta1/csistoragecapacities`.
See [API Versioning](/docs/reference/using-api/#api-versioning) for more details on the command line flags. | kubernetes reference | title Feature Gates weight 10 content type concept card name reference weight 60 overview This page contains an overview of the various feature gates an administrator can specify on different Kubernetes components See feature stages feature stages for an explanation of the stages for a feature body 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 shell 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 feature gates for alpha or beta features If a feature is stable you can find all stages for that feature listed in the Graduated Deprecated feature gate table feature gates for graduated or deprecated features The Graduated Deprecated feature gate table feature gates for graduated or deprecated features also lists deprecated and withdrawn features For a reference to old feature gates that are removed please refer to feature gates removed docs reference command line tools reference feature gates removed Want to edit this table See https k8s io docs contribute new content new features ready for review feature gates Feature gates for Alpha or Beta features Want to edit this table See https k8s io docs contribute new content new features ready for review feature gates Feature gates for graduated or deprecated features 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 Usually enabled by default Beta API groups are disabled by default https github com kubernetes enhancements tree master keps sig architecture 3136 beta apis off 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 Please do try Beta features and give feedback on them After they exit beta it may not be practical for us to make more changes 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 feature gates Each feature gate is designed for enabling disabling a specific feature Want to edit this list See https k8s io docs contribute new content new features ready for review feature gates The deprecation policy docs reference using api deprecation policy for Kubernetes explains the project s approach to removing features and components Since Kubernetes 1 24 new beta APIs are not enabled by default When enabling a beta feature you will also need to enable any associated API resources For example to enable a particular resource like storage k8s io v1beta1 csistoragecapacities set runtime config storage k8s io v1beta1 csistoragecapacities See API Versioning docs reference using api api versioning for more details on the command line flags |
kubernetes reference title Flow control API Priority and Fairness controls the behavior of the Kubernetes API server in an overload situation You can find more information about it in the weight 130 overview | ---
title: Flow control
weight: 130
---
<!-- overview -->
API Priority and Fairness controls the behavior of the Kubernetes API server in
an overload situation. You can find more information about it in the
[API Priority and Fairness](/docs/concepts/cluster-administration/flow-control/)
documentation.
<!-- body -->
## Diagnostics
Every HTTP response from an API server with the priority and fairness feature
enabled has two extra headers: `X-Kubernetes-PF-FlowSchema-UID` and
`X-Kubernetes-PF-PriorityLevel-UID`, noting the flow schema that matched the request
and the priority level to which it was assigned, respectively. The API objects'
names are not included in these headers (to avoid revealing details in case the
requesting user does not have permission to view them). When debugging, you
can use a command such as:
```shell
kubectl get flowschemas -o custom-columns="uid:{metadata.uid},name:{metadata.name}"
kubectl get prioritylevelconfigurations -o custom-columns="uid:{metadata.uid},name:{metadata.name}"
```
to get a mapping of UIDs to names for both FlowSchemas and
PriorityLevelConfigurations.
## Debug endpoints
With the `APIPriorityAndFairness` feature enabled, the `kube-apiserver`
serves the following additional paths at its HTTP(S) ports.
You need to ensure you have permissions to access these endpoints.
You don't have to do anything if you are using admin.
Permissions can be granted if needed following the [RBAC](/docs/reference/access-authn-authz/rbac/) doc
to access `/debug/api_priority_and_fairness/` by specifying `nonResourceURLs`.
- `/debug/api_priority_and_fairness/dump_priority_levels` - a listing of
all the priority levels and the current state of each. You can fetch like this:
```shell
kubectl get --raw /debug/api_priority_and_fairness/dump_priority_levels
```
The output will be in CSV and similar to this:
```none
PriorityLevelName, ActiveQueues, IsIdle, IsQuiescing, WaitingRequests, ExecutingRequests, DispatchedRequests, RejectedRequests, TimedoutRequests, CancelledRequests
catch-all, 0, true, false, 0, 0, 1, 0, 0, 0
exempt, 0, true, false, 0, 0, 0, 0, 0, 0
global-default, 0, true, false, 0, 0, 46, 0, 0, 0
leader-election, 0, true, false, 0, 0, 4, 0, 0, 0
node-high, 0, true, false, 0, 0, 34, 0, 0, 0
system, 0, true, false, 0, 0, 48, 0, 0, 0
workload-high, 0, true, false, 0, 0, 500, 0, 0, 0
workload-low, 0, true, false, 0, 0, 0, 0, 0, 0
```
Explanation for selected column names:
- `IsQuiescing` indicates if this priority level will be removed when its queues have been drained.
- `/debug/api_priority_and_fairness/dump_queues` - a listing of all the
queues and their current state. You can fetch like this:
```shell
kubectl get --raw /debug/api_priority_and_fairness/dump_queues
```
The output will be in CSV and similar to this:
```none
PriorityLevelName, Index, PendingRequests, ExecutingRequests, SeatsInUse, NextDispatchR, InitialSeatsSum, MaxSeatsSum, TotalWorkSum
workload-low, 14, 27, 0, 0, 77.64342019ss, 270, 270, 0.81000000ss
workload-low, 74, 26, 0, 0, 76.95387841ss, 260, 260, 0.78000000ss
...
leader-election, 0, 0, 0, 0, 5088.87053833ss, 0, 0, 0.00000000ss
leader-election, 1, 0, 0, 0, 0.00000000ss, 0, 0, 0.00000000ss
...
workload-high, 0, 0, 0, 0, 0.00000000ss, 0, 0, 0.00000000ss
workload-high, 1, 0, 0, 0, 1119.44936475ss, 0, 0, 0.00000000ss
```
Explanation for selected column names:
- `NextDispatchR`: The R progress meter reading, in units of seat-seconds, at
which the next request will be dispatched.
- `InitialSeatsSum`: The sum of InitialSeats associated with all requests in
a given queue.
- `MaxSeatsSum`: The sum of MaxSeats associated with all requests in a given
queue.
- `TotalWorkSum`: The sum of total work, in units of seat-seconds, of all
waiting requests in a given queue.
Note: `seat-second` (abbreviate as `ss`) is a measure of work, in units of
seat-seconds, in the APF world.
- `/debug/api_priority_and_fairness/dump_requests` - a listing of all the requests
including requests waiting in a queue and requests being executing.
You can fetch like this:
```shell
kubectl get --raw /debug/api_priority_and_fairness/dump_requests
```
The output will be in CSV and similar to this:
```none
PriorityLevelName, FlowSchemaName, QueueIndex, RequestIndexInQueue, FlowDistingsher, ArriveTime, InitialSeats, FinalSeats, AdditionalLatency, StartTime
exempt, exempt, -1, -1, , 2023-07-15T04:51:25.596404345Z, 1, 0, 0s, 2023-07-15T04:51:25.596404345Z
workload-low, service-accounts, 14, 0, system:serviceaccount:default:loadtest, 2023-07-18T00:12:51.386556253Z, 10, 0, 0s, 0001-01-01T00:00:00Z
workload-low, service-accounts, 14, 1, system:serviceaccount:default:loadtest, 2023-07-18T00:12:51.487092539Z, 10, 0, 0s, 0001-01-01T00:00:00Z
```
You can get a more detailed listing with a command like this:
```shell
kubectl get --raw '/debug/api_priority_and_fairness/dump_requests?includeRequestDetails=1'
```
The output will be in CSV and similar to this:
```none
PriorityLevelName, FlowSchemaName, QueueIndex, RequestIndexInQueue, FlowDistingsher, ArriveTime, InitialSeats, FinalSeats, AdditionalLatency, StartTime, UserName, Verb, APIPath, Namespace, Name, APIVersion, Resource, SubResource
exempt, exempt, -1, -1, , 2023-07-15T04:51:25.596404345Z, 1, 0, 0s, 2023-07-15T04:51:25.596404345Z, system:serviceaccount:system:admin, list, /api/v1/namespaces/kube-stress/configmaps, kube-stress, , v1, configmaps,
workload-low, service-accounts, 14, 0, system:serviceaccount:default:loadtest, 2023-07-18T00:13:08.986534842Z, 10, 0, 0s, 0001-01-01T00:00:00Z, system:serviceaccount:default:loadtest, list, /api/v1/namespaces/kube-stress/configmaps, kube-stress, , v1, configmaps,
workload-low, service-accounts, 14, 1, system:serviceaccount:default:loadtest, 2023-07-18T00:13:09.086476021Z, 10, 0, 0s, 0001-01-01T00:00:00Z, system:serviceaccount:default:loadtest, list, /api/v1/namespaces/kube-stress/configmaps, kube-stress, , v1, configmaps,
```
Explanation for selected column names:
- `QueueIndex`: The index of the queue. It will be -1 for priority levels
without queues.
- `RequestIndexInQueue`: The index in the queue for a given request. It will
be -1 for executing requests.
- `InitialSeats`: The number of seats will be occupied during the initial
(normal) stage of execution of the request.
- `FinalSeats`: The number of seats will be occupied during the final stage
of request execution, accounting for the associated WATCH notifications.
- `AdditionalLatency`: The extra time taken during the final stage of request
execution. FinalSeats will be occupied during this time period. It does not
mean any latency that a user will observe.
- `StartTime`: The time a request starts to execute. It will be
0001-01-01T00:00:00Z for queued requests.
## Debug logging
At `-v=3` or more verbosity, the API server outputs an httplog line for every
request in the API server log, and it includes the following attributes.
- `apf_fs`: the name of the flow schema to which the request was classified.
- `apf_pl`: the name of the priority level for that flow schema.
- `apf_iseats`: the number of seats determined for the initial
(normal) stage of execution of the request.
- `apf_fseats`: the number of seats determined for the final stage of
execution (accounting for the associated `watch` notifications) of the
request.
- `apf_additionalLatency`: the duration of the final stage of
execution of the request.
At higher levels of verbosity there will be log lines exposing details
of how APF handled the request, primarily for debugging purposes.
## Response headers
APF adds the following two headers to each HTTP response message.
They won't appear in the audit log. They can be viewed from the client side.
For client using `klog`, use verbosity `-v=8` or higher to view these headers.
- `X-Kubernetes-PF-FlowSchema-UID` holds the UID of the FlowSchema
object to which the corresponding request was classified.
- `X-Kubernetes-PF-PriorityLevel-UID` holds the UID of the
PriorityLevelConfiguration object associated with that FlowSchema.
##
For background information on design details for API priority and fairness, see
the [enhancement proposal](https://github.com/kubernetes/enhancements/tree/master/keps/sig-api-machinery/1040-priority-and-fairness). | kubernetes reference | title Flow control weight 130 overview API Priority and Fairness controls the behavior of the Kubernetes API server in an overload situation You can find more information about it in the API Priority and Fairness docs concepts cluster administration flow control documentation body Diagnostics Every HTTP response from an API server with the priority and fairness feature enabled has two extra headers X Kubernetes PF FlowSchema UID and X Kubernetes PF PriorityLevel UID noting the flow schema that matched the request and the priority level to which it was assigned respectively The API objects names are not included in these headers to avoid revealing details in case the requesting user does not have permission to view them When debugging you can use a command such as shell kubectl get flowschemas o custom columns uid metadata uid name metadata name kubectl get prioritylevelconfigurations o custom columns uid metadata uid name metadata name to get a mapping of UIDs to names for both FlowSchemas and PriorityLevelConfigurations Debug endpoints With the APIPriorityAndFairness feature enabled the kube apiserver serves the following additional paths at its HTTP S ports You need to ensure you have permissions to access these endpoints You don t have to do anything if you are using admin Permissions can be granted if needed following the RBAC docs reference access authn authz rbac doc to access debug api priority and fairness by specifying nonResourceURLs debug api priority and fairness dump priority levels a listing of all the priority levels and the current state of each You can fetch like this shell kubectl get raw debug api priority and fairness dump priority levels The output will be in CSV and similar to this none PriorityLevelName ActiveQueues IsIdle IsQuiescing WaitingRequests ExecutingRequests DispatchedRequests RejectedRequests TimedoutRequests CancelledRequests catch all 0 true false 0 0 1 0 0 0 exempt 0 true false 0 0 0 0 0 0 global default 0 true false 0 0 46 0 0 0 leader election 0 true false 0 0 4 0 0 0 node high 0 true false 0 0 34 0 0 0 system 0 true false 0 0 48 0 0 0 workload high 0 true false 0 0 500 0 0 0 workload low 0 true false 0 0 0 0 0 0 Explanation for selected column names IsQuiescing indicates if this priority level will be removed when its queues have been drained debug api priority and fairness dump queues a listing of all the queues and their current state You can fetch like this shell kubectl get raw debug api priority and fairness dump queues The output will be in CSV and similar to this none PriorityLevelName Index PendingRequests ExecutingRequests SeatsInUse NextDispatchR InitialSeatsSum MaxSeatsSum TotalWorkSum workload low 14 27 0 0 77 64342019ss 270 270 0 81000000ss workload low 74 26 0 0 76 95387841ss 260 260 0 78000000ss leader election 0 0 0 0 5088 87053833ss 0 0 0 00000000ss leader election 1 0 0 0 0 00000000ss 0 0 0 00000000ss workload high 0 0 0 0 0 00000000ss 0 0 0 00000000ss workload high 1 0 0 0 1119 44936475ss 0 0 0 00000000ss Explanation for selected column names NextDispatchR The R progress meter reading in units of seat seconds at which the next request will be dispatched InitialSeatsSum The sum of InitialSeats associated with all requests in a given queue MaxSeatsSum The sum of MaxSeats associated with all requests in a given queue TotalWorkSum The sum of total work in units of seat seconds of all waiting requests in a given queue Note seat second abbreviate as ss is a measure of work in units of seat seconds in the APF world debug api priority and fairness dump requests a listing of all the requests including requests waiting in a queue and requests being executing You can fetch like this shell kubectl get raw debug api priority and fairness dump requests The output will be in CSV and similar to this none PriorityLevelName FlowSchemaName QueueIndex RequestIndexInQueue FlowDistingsher ArriveTime InitialSeats FinalSeats AdditionalLatency StartTime exempt exempt 1 1 2023 07 15T04 51 25 596404345Z 1 0 0s 2023 07 15T04 51 25 596404345Z workload low service accounts 14 0 system serviceaccount default loadtest 2023 07 18T00 12 51 386556253Z 10 0 0s 0001 01 01T00 00 00Z workload low service accounts 14 1 system serviceaccount default loadtest 2023 07 18T00 12 51 487092539Z 10 0 0s 0001 01 01T00 00 00Z You can get a more detailed listing with a command like this shell kubectl get raw debug api priority and fairness dump requests includeRequestDetails 1 The output will be in CSV and similar to this none PriorityLevelName FlowSchemaName QueueIndex RequestIndexInQueue FlowDistingsher ArriveTime InitialSeats FinalSeats AdditionalLatency StartTime UserName Verb APIPath Namespace Name APIVersion Resource SubResource exempt exempt 1 1 2023 07 15T04 51 25 596404345Z 1 0 0s 2023 07 15T04 51 25 596404345Z system serviceaccount system admin list api v1 namespaces kube stress configmaps kube stress v1 configmaps workload low service accounts 14 0 system serviceaccount default loadtest 2023 07 18T00 13 08 986534842Z 10 0 0s 0001 01 01T00 00 00Z system serviceaccount default loadtest list api v1 namespaces kube stress configmaps kube stress v1 configmaps workload low service accounts 14 1 system serviceaccount default loadtest 2023 07 18T00 13 09 086476021Z 10 0 0s 0001 01 01T00 00 00Z system serviceaccount default loadtest list api v1 namespaces kube stress configmaps kube stress v1 configmaps Explanation for selected column names QueueIndex The index of the queue It will be 1 for priority levels without queues RequestIndexInQueue The index in the queue for a given request It will be 1 for executing requests InitialSeats The number of seats will be occupied during the initial normal stage of execution of the request FinalSeats The number of seats will be occupied during the final stage of request execution accounting for the associated WATCH notifications AdditionalLatency The extra time taken during the final stage of request execution FinalSeats will be occupied during this time period It does not mean any latency that a user will observe StartTime The time a request starts to execute It will be 0001 01 01T00 00 00Z for queued requests Debug logging At v 3 or more verbosity the API server outputs an httplog line for every request in the API server log and it includes the following attributes apf fs the name of the flow schema to which the request was classified apf pl the name of the priority level for that flow schema apf iseats the number of seats determined for the initial normal stage of execution of the request apf fseats the number of seats determined for the final stage of execution accounting for the associated watch notifications of the request apf additionalLatency the duration of the final stage of execution of the request At higher levels of verbosity there will be log lines exposing details of how APF handled the request primarily for debugging purposes Response headers APF adds the following two headers to each HTTP response message They won t appear in the audit log They can be viewed from the client side For client using klog use verbosity v 8 or higher to view these headers X Kubernetes PF FlowSchema UID holds the UID of the FlowSchema object to which the corresponding request was classified X Kubernetes PF PriorityLevel UID holds the UID of the PriorityLevelConfiguration object associated with that FlowSchema For background information on design details for API priority and fairness see the enhancement proposal https github com kubernetes enhancements tree master keps sig api machinery 1040 priority and fairness |
kubernetes reference weight 80 monitoring and maintaining node status to ensure a healthy and stable cluster aspect of managing a Kubernetes cluster In this article we ll cover the basics of contenttype reference title Node Status overview The status of a in Kubernetes is a critical | ---
content_type: reference
title: Node Status
weight: 80
---
<!-- overview -->
The status of a [node](/docs/concepts/architecture/nodes/) in Kubernetes is a critical
aspect of managing a Kubernetes cluster. In this article, we'll cover the basics of
monitoring and maintaining node status to ensure a healthy and stable cluster.
## Node status fields
A Node's status contains the following information:
* [Addresses](#addresses)
* [Conditions](#condition)
* [Capacity and Allocatable](#capacity)
* [Info](#info)
You can use `kubectl` to view a Node's status and other details:
```shell
kubectl describe node <insert-node-name-here>
```
Each section of the output is described below.
## Addresses
The usage of these fields varies depending on your cloud provider or bare metal configuration.
* HostName: The hostname as reported by the node's kernel. Can be overridden via the kubelet
`--hostname-override` parameter.
* ExternalIP: Typically the IP address of the node that is externally routable (available from
outside the cluster).
* InternalIP: Typically the IP address of the node that is routable only within the cluster.
## Conditions {#condition}
The `conditions` field describes the status of all `Running` nodes. Examples of conditions include:
| Node Condition | Description |
|----------------------|-------------|
| `Ready` | `True` if the node is healthy and ready to accept pods, `False` if the node is not healthy and is not accepting pods, and `Unknown` if the node controller has not heard from the node in the last `node-monitor-grace-period` (default is 40 seconds) |
| `DiskPressure` | `True` if pressure exists on the disk size—that is, if the disk capacity is low; otherwise `False` |
| `MemoryPressure` | `True` if pressure exists on the node memory—that is, if the node memory is low; otherwise `False` |
| `PIDPressure` | `True` if pressure exists on the processes—that is, if there are too many processes on the node; otherwise `False` |
| `NetworkUnavailable` | `True` if the network for the node is not correctly configured, otherwise `False` |
If you use command-line tools to print details of a cordoned Node, the Condition includes
`SchedulingDisabled`. `SchedulingDisabled` is not a Condition in the Kubernetes API; instead,
cordoned nodes are marked Unschedulable in their spec.
In the Kubernetes API, a node's condition is represented as part of the `.status`
of the Node resource. For example, the following JSON structure describes a healthy node:
```json
"conditions": [
{
"type": "Ready",
"status": "True",
"reason": "KubeletReady",
"message": "kubelet is posting ready status",
"lastHeartbeatTime": "2019-06-05T18:38:35Z",
"lastTransitionTime": "2019-06-05T11:41:27Z"
}
]
```
When problems occur on nodes, the Kubernetes control plane automatically creates
[taints](/docs/concepts/scheduling-eviction/taint-and-toleration/) that match the conditions
affecting the node. An example of this is when the `status` of the Ready condition
remains `Unknown` or `False` for longer than the kube-controller-manager's `NodeMonitorGracePeriod`,
which defaults to 40 seconds. This will cause either an `node.kubernetes.io/unreachable` taint, for an `Unknown` status,
or a `node.kubernetes.io/not-ready` taint, for a `False` status, to be added to the Node.
These taints affect pending pods as the scheduler takes the Node's taints into consideration when
assigning a pod to a Node. Existing pods scheduled to the node may be evicted due to the application
of `NoExecute` taints. Pods may also have that let
them schedule to and continue running on a Node even though it has a specific taint.
See [Taint Based Evictions](/docs/concepts/scheduling-eviction/taint-and-toleration/#taint-based-evictions) and
[Taint Nodes by Condition](/docs/concepts/scheduling-eviction/taint-and-toleration/#taint-nodes-by-condition)
for more details.
## Capacity and Allocatable {#capacity}
Describes the resources available on the node: CPU, memory, and the maximum
number of pods that can be scheduled onto the node.
The fields in the capacity block indicate the total amount of resources that a
Node has. The allocatable block indicates the amount of resources on a
Node that is available to be consumed by normal Pods.
You may read more about capacity and allocatable resources while learning how
to [reserve compute resources](/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable)
on a Node.
## Info
Describes general information about the node, such as kernel version, Kubernetes
version (kubelet and kube-proxy version), container runtime details, and which
operating system the node uses.
The kubelet gathers this information from the node and publishes it into
the Kubernetes API.
## Heartbeats
Heartbeats, sent by Kubernetes nodes, help your cluster determine the
availability of each node, and to take action when failures are detected.
For nodes there are two forms of heartbeats:
* updates to the `.status` of a Node
* [Lease](/docs/concepts/architecture/leases/) objects
within the `kube-node-lease`
.
Each Node has an associated Lease object.
Compared to updates to `.status` of a Node, a Lease is a lightweight resource.
Using Leases for heartbeats reduces the performance impact of these updates
for large clusters.
The kubelet is responsible for creating and updating the `.status` of Nodes,
and for updating their related Leases.
- The kubelet updates the node's `.status` either when there is change in status
or if there has been no update for a configured interval. The default interval
for `.status` updates to Nodes is 5 minutes, which is much longer than the 40
second default timeout for unreachable nodes.
- The kubelet creates and then updates its Lease object every 10 seconds
(the default update interval). Lease updates occur independently from
updates to the Node's `.status`. If the Lease update fails, the kubelet retries,
using exponential backoff that starts at 200 milliseconds and capped at 7 seconds. | kubernetes reference | content type reference title Node Status weight 80 overview The status of a node docs concepts architecture nodes in Kubernetes is a critical aspect of managing a Kubernetes cluster In this article we ll cover the basics of monitoring and maintaining node status to ensure a healthy and stable cluster Node status fields A Node s status contains the following information Addresses addresses Conditions condition Capacity and Allocatable capacity Info info You can use kubectl to view a Node s status and other details shell kubectl describe node insert node name here Each section of the output is described below Addresses The usage of these fields varies depending on your cloud provider or bare metal configuration HostName The hostname as reported by the node s kernel Can be overridden via the kubelet hostname override parameter ExternalIP Typically the IP address of the node that is externally routable available from outside the cluster InternalIP Typically the IP address of the node that is routable only within the cluster Conditions condition The conditions field describes the status of all Running nodes Examples of conditions include Node Condition Description Ready True if the node is healthy and ready to accept pods False if the node is not healthy and is not accepting pods and Unknown if the node controller has not heard from the node in the last node monitor grace period default is 40 seconds DiskPressure True if pressure exists on the disk size that is if the disk capacity is low otherwise False MemoryPressure True if pressure exists on the node memory that is if the node memory is low otherwise False PIDPressure True if pressure exists on the processes that is if there are too many processes on the node otherwise False NetworkUnavailable True if the network for the node is not correctly configured otherwise False If you use command line tools to print details of a cordoned Node the Condition includes SchedulingDisabled SchedulingDisabled is not a Condition in the Kubernetes API instead cordoned nodes are marked Unschedulable in their spec In the Kubernetes API a node s condition is represented as part of the status of the Node resource For example the following JSON structure describes a healthy node json conditions type Ready status True reason KubeletReady message kubelet is posting ready status lastHeartbeatTime 2019 06 05T18 38 35Z lastTransitionTime 2019 06 05T11 41 27Z When problems occur on nodes the Kubernetes control plane automatically creates taints docs concepts scheduling eviction taint and toleration that match the conditions affecting the node An example of this is when the status of the Ready condition remains Unknown or False for longer than the kube controller manager s NodeMonitorGracePeriod which defaults to 40 seconds This will cause either an node kubernetes io unreachable taint for an Unknown status or a node kubernetes io not ready taint for a False status to be added to the Node These taints affect pending pods as the scheduler takes the Node s taints into consideration when assigning a pod to a Node Existing pods scheduled to the node may be evicted due to the application of NoExecute taints Pods may also have that let them schedule to and continue running on a Node even though it has a specific taint See Taint Based Evictions docs concepts scheduling eviction taint and toleration taint based evictions and Taint Nodes by Condition docs concepts scheduling eviction taint and toleration taint nodes by condition for more details Capacity and Allocatable capacity Describes the resources available on the node CPU memory and the maximum number of pods that can be scheduled onto the node The fields in the capacity block indicate the total amount of resources that a Node has The allocatable block indicates the amount of resources on a Node that is available to be consumed by normal Pods You may read more about capacity and allocatable resources while learning how to reserve compute resources docs tasks administer cluster reserve compute resources node allocatable on a Node Info Describes general information about the node such as kernel version Kubernetes version kubelet and kube proxy version container runtime details and which operating system the node uses The kubelet gathers this information from the node and publishes it into the Kubernetes API Heartbeats Heartbeats sent by Kubernetes nodes help your cluster determine the availability of each node and to take action when failures are detected For nodes there are two forms of heartbeats updates to the status of a Node Lease docs concepts architecture leases objects within the kube node lease Each Node has an associated Lease object Compared to updates to status of a Node a Lease is a lightweight resource Using Leases for heartbeats reduces the performance impact of these updates for large clusters The kubelet is responsible for creating and updating the status of Nodes and for updating their related Leases The kubelet updates the node s status either when there is change in status or if there has been no update for a configured interval The default interval for status updates to Nodes is 5 minutes which is much longer than the 40 second default timeout for unreachable nodes The kubelet creates and then updates its Lease object every 10 seconds the default update interval Lease updates occur independently from updates to the Node s status If the Lease update fails the kubelet retries using exponential backoff that starts at 200 milliseconds and capped at 7 seconds |
kubernetes reference merged configuration there is some specific behavior on how different types are title Kubelet Configuration Directory Merging contenttype reference When using the kubelet s flag to specify a drop in directory for weight 50 | ---
content_type: "reference"
title: Kubelet Configuration Directory Merging
weight: 50
---
When using the kubelet's `--config-dir` flag to specify a drop-in directory for
configuration, there is some specific behavior on how different types are
merged.
Here are some examples of how different data types behave during configuration merging:
### Structure Fields
There are two types of structure fields in a YAML structure: singular (or a
scalar type) and embedded (structures that contain scalar types).
The configuration merging process handles the overriding of singular and embedded struct fields to create a resulting kubelet configuration.
For instance, you may want a baseline kubelet configuration for all nodes, but you may want to customize the `address` and `authorization` fields.
This can be done as follows:
Main kubelet configuration file contents:
```yaml
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
port: 20250
authorization:
mode: Webhook
webhook:
cacheAuthorizedTTL: "5m"
cacheUnauthorizedTTL: "30s"
serializeImagePulls: false
address: "192.168.0.1"
```
Contents of a file in `--config-dir` directory:
```yaml
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
authorization:
mode: AlwaysAllow
webhook:
cacheAuthorizedTTL: "8m"
cacheUnauthorizedTTL: "45s"
address: "192.168.0.8"
```
The resulting configuration will be as follows:
```yaml
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
port: 20250
serializeImagePulls: false
authorization:
mode: AlwaysAllow
webhook:
cacheAuthorizedTTL: "8m"
cacheUnauthorizedTTL: "45s"
address: "192.168.0.8"
```
### Lists
You can overide the slices/lists values of the kubelet configuration.
However, the entire list gets overridden during the merging process.
For example, you can override the `clusterDNS` list as follows:
Main kubelet configuration file contents:
```yaml
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
port: 20250
serializeImagePulls: false
clusterDNS:
- "192.168.0.9"
- "192.168.0.8"
```
Contents of a file in `--config-dir` directory:
```yaml
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
clusterDNS:
- "192.168.0.2"
- "192.168.0.3"
- "192.168.0.5"
```
The resulting configuration will be as follows:
```yaml
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
port: 20250
serializeImagePulls: false
clusterDNS:
- "192.168.0.2"
- "192.168.0.3"
- "192.168.0.5"
```
### Maps, including Nested Structures
Individual fields in maps, regardless of their value types (boolean, string, etc.), can be selectively overridden.
However, for `map[string][]string`, the entire list associated with a specific field gets overridden.
Let's understand this better with an example, particularly on fields like `featureGates` and `staticPodURLHeader`:
Main kubelet configuration file contents:
```yaml
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
port: 20250
serializeImagePulls: false
featureGates:
AllAlpha: false
MemoryQoS: true
staticPodURLHeader:
kubelet-api-support:
- "Authorization: 234APSDFA"
- "X-Custom-Header: 123"
custom-static-pod:
- "Authorization: 223EWRWER"
- "X-Custom-Header: 456"
```
Contents of a file in `--config-dir` directory:
```yaml
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
featureGates:
MemoryQoS: false
KubeletTracing: true
DynamicResourceAllocation: true
staticPodURLHeader:
custom-static-pod:
- "Authorization: 223EWRWER"
- "X-Custom-Header: 345"
```
The resulting configuration will be as follows:
```yaml
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
port: 20250
serializeImagePulls: false
featureGates:
AllAlpha: false
MemoryQoS: false
KubeletTracing: true
DynamicResourceAllocation: true
staticPodURLHeader:
kubelet-api-support:
- "Authorization: 234APSDFA"
- "X-Custom-Header: 123"
custom-static-pod:
- "Authorization: 223EWRWER"
- "X-Custom-Header: 345"
``` | kubernetes reference | content type reference title Kubelet Configuration Directory Merging weight 50 When using the kubelet s config dir flag to specify a drop in directory for configuration there is some specific behavior on how different types are merged Here are some examples of how different data types behave during configuration merging Structure Fields There are two types of structure fields in a YAML structure singular or a scalar type and embedded structures that contain scalar types The configuration merging process handles the overriding of singular and embedded struct fields to create a resulting kubelet configuration For instance you may want a baseline kubelet configuration for all nodes but you may want to customize the address and authorization fields This can be done as follows Main kubelet configuration file contents yaml apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration port 20250 authorization mode Webhook webhook cacheAuthorizedTTL 5m cacheUnauthorizedTTL 30s serializeImagePulls false address 192 168 0 1 Contents of a file in config dir directory yaml apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration authorization mode AlwaysAllow webhook cacheAuthorizedTTL 8m cacheUnauthorizedTTL 45s address 192 168 0 8 The resulting configuration will be as follows yaml apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration port 20250 serializeImagePulls false authorization mode AlwaysAllow webhook cacheAuthorizedTTL 8m cacheUnauthorizedTTL 45s address 192 168 0 8 Lists You can overide the slices lists values of the kubelet configuration However the entire list gets overridden during the merging process For example you can override the clusterDNS list as follows Main kubelet configuration file contents yaml apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration port 20250 serializeImagePulls false clusterDNS 192 168 0 9 192 168 0 8 Contents of a file in config dir directory yaml apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration clusterDNS 192 168 0 2 192 168 0 3 192 168 0 5 The resulting configuration will be as follows yaml apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration port 20250 serializeImagePulls false clusterDNS 192 168 0 2 192 168 0 3 192 168 0 5 Maps including Nested Structures Individual fields in maps regardless of their value types boolean string etc can be selectively overridden However for map string string the entire list associated with a specific field gets overridden Let s understand this better with an example particularly on fields like featureGates and staticPodURLHeader Main kubelet configuration file contents yaml apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration port 20250 serializeImagePulls false featureGates AllAlpha false MemoryQoS true staticPodURLHeader kubelet api support Authorization 234APSDFA X Custom Header 123 custom static pod Authorization 223EWRWER X Custom Header 456 Contents of a file in config dir directory yaml apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration featureGates MemoryQoS false KubeletTracing true DynamicResourceAllocation true staticPodURLHeader custom static pod Authorization 223EWRWER X Custom Header 345 The resulting configuration will be as follows yaml apiVersion kubelet config k8s io v1beta1 kind KubeletConfiguration port 20250 serializeImagePulls false featureGates AllAlpha false MemoryQoS false KubeletTracing true DynamicResourceAllocation true staticPodURLHeader kubelet api support Authorization 234APSDFA X Custom Header 123 custom static pod Authorization 223EWRWER X Custom Header 345 |
kubernetes reference weight 80 Seccomp stands for secure computing mode and has been a feature of the Linux contenttype reference title Seccomp and Kubernetes overview kernel since version 2 6 12 It can be used to sandbox the privileges of a | ---
content_type: reference
title: Seccomp and Kubernetes
weight: 80
---
<!-- overview -->
Seccomp stands for secure computing mode and has been a feature of the Linux
kernel since version 2.6.12. It can be used to sandbox the privileges of a
process, restricting the calls it is able to make from userspace into the
kernel. Kubernetes lets you automatically apply seccomp profiles loaded onto a
to your Pods and containers.
## Seccomp fields
There are four ways to specify a seccomp profile for a
:
- for the whole Pod using [`spec.securityContext.seccompProfile`](/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context)
- for a single container using [`spec.containers[*].securityContext.seccompProfile`](/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-1)
- for an (restartable / sidecar) init container using [`spec.initContainers[*].securityContext.seccompProfile`](/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-1)
- for an [ephermal container](/docs/concepts/workloads/pods/ephemeral-containers) using [`spec.ephemeralContainers[*].securityContext.seccompProfile`](/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2)
The Pod in the example above runs as `Unconfined`, while the
`ephemeral-container` and `init-container` specifically defines
`RuntimeDefault`. If the ephemeral or init container would not have set the
`securityContext.seccompProfile` field explicitly, then the value would be
inherited from the Pod. The same applies to the container, which runs a
`Localhost` profile `my-profile.json`.
Generally speaking, fields from (ephemeral) containers have a higher priority
than the Pod level value, while containers which do not set the seccomp field
inherit the profile from the Pod.
It is not possible to apply a seccomp profile to a Pod or container running with
`privileged: true` set in the container's `securityContext`. Privileged
containers always run as `Unconfined`.
The following values are possible for the `seccompProfile.type`:
`Unconfined`
: The workload runs without any seccomp restrictions.
`RuntimeDefault`
: A default seccomp profile defined by the
is applied. The default profiles aim to provide a strong set of security
defaults while preserving the functionality of the workload. It is possible that
the default profiles differ between container runtimes and their release
versions, for example when comparing those from
and
.
`Localhost`
: The `localhostProfile` will be applied, which has to be available on the node
disk (on Linux it's `/var/lib/kubelet/seccomp`). The availability of the seccomp
profile is verified by the
on container creation. If the profile does not exist, then the container
creation will fail with a `CreateContainerError`.
### `Localhost` profiles
Seccomp profiles are JSON files following the scheme defined by the
[OCI runtime specification](https://github.com/opencontainers/runtime-spec/blob/f329913/config-linux.md#seccomp).
A profile basically defines actions based on matched syscalls, but also allows
to pass specific values as arguments to syscalls. For example:
```json
{
"defaultAction": "SCMP_ACT_ERRNO",
"defaultErrnoRet": 38,
"syscalls": [
{
"names": [
"adjtimex",
"alarm",
"bind",
"waitid",
"waitpid",
"write",
"writev"
],
"action": "SCMP_ACT_ALLOW"
}
]
}
```
The `defaultAction` in the profile above is defined as `SCMP_ACT_ERRNO` and
will return as fallback to the actions defined in `syscalls`. The error is
defined as code `38` via the `defaultErrnoRet` field.
The following actions are generally possible:
`SCMP_ACT_ERRNO`
: Return the specified error code.
`SCMP_ACT_ALLOW`
: Allow the syscall to be executed.
`SCMP_ACT_KILL_PROCESS`
: Kill the process.
`SCMP_ACT_KILL_THREAD` and `SCMP_ACT_KILL`
: Kill only the thread.
`SCMP_ACT_TRAP`
: Throw a `SIGSYS` signal.
`SCMP_ACT_NOTIFY` and `SECCOMP_RET_USER_NOTIF`.
: Notify the user space.
`SCMP_ACT_TRACE`
: Notify a tracing process with the specified value.
`SCMP_ACT_LOG`
: Allow the syscall to be executed after the action has been logged to syslog or
auditd.
Some actions like `SCMP_ACT_NOTIFY` or `SECCOMP_RET_USER_NOTIF` may be not
supported depending on the container runtime, OCI runtime or Linux kernel
version being used. There may be also further limitations, for example that
`SCMP_ACT_NOTIFY` cannot be used as `defaultAction` or for certain syscalls like
`write`. All those limitations are defined by either the OCI runtime
([runc](https://github.com/opencontainers/runc),
[crun](https://github.com/containers/crun)) or
[libseccomp](https://github.com/seccomp/libseccomp).
The `syscalls` JSON array contains a list of objects referencing syscalls by
their respective `names`. For example, the action `SCMP_ACT_ALLOW` can be used
to create a whitelist of allowed syscalls as outlined in the example above. It
would also be possible to define another list using the action `SCMP_ACT_ERRNO`
but a different return (`errnoRet`) value.
It is also possible to specify the arguments (`args`) passed to certain
syscalls. More information about those advanced use cases can be found in the
[OCI runtime spec](https://github.com/opencontainers/runtime-spec/blob/f329913/config-linux.md#seccomp)
and the [Seccomp Linux kernel documentation](https://www.kernel.org/doc/Documentation/prctl/seccomp_filter.txt).
## Further reading
- [Restrict a Container's Syscalls with seccomp](/docs/tutorials/security/seccomp/)
- [Pod Security Standards](/docs/concepts/security/pod-security-standards/) | kubernetes reference | content type reference title Seccomp and Kubernetes weight 80 overview Seccomp stands for secure computing mode and has been a feature of the Linux kernel since version 2 6 12 It can be used to sandbox the privileges of a process restricting the calls it is able to make from userspace into the kernel Kubernetes lets you automatically apply seccomp profiles loaded onto a to your Pods and containers Seccomp fields There are four ways to specify a seccomp profile for a for the whole Pod using spec securityContext seccompProfile docs reference kubernetes api workload resources pod v1 security context for a single container using spec containers securityContext seccompProfile docs reference kubernetes api workload resources pod v1 security context 1 for an restartable sidecar init container using spec initContainers securityContext seccompProfile docs reference kubernetes api workload resources pod v1 security context 1 for an ephermal container docs concepts workloads pods ephemeral containers using spec ephemeralContainers securityContext seccompProfile docs reference kubernetes api workload resources pod v1 security context 2 The Pod in the example above runs as Unconfined while the ephemeral container and init container specifically defines RuntimeDefault If the ephemeral or init container would not have set the securityContext seccompProfile field explicitly then the value would be inherited from the Pod The same applies to the container which runs a Localhost profile my profile json Generally speaking fields from ephemeral containers have a higher priority than the Pod level value while containers which do not set the seccomp field inherit the profile from the Pod It is not possible to apply a seccomp profile to a Pod or container running with privileged true set in the container s securityContext Privileged containers always run as Unconfined The following values are possible for the seccompProfile type Unconfined The workload runs without any seccomp restrictions RuntimeDefault A default seccomp profile defined by the is applied The default profiles aim to provide a strong set of security defaults while preserving the functionality of the workload It is possible that the default profiles differ between container runtimes and their release versions for example when comparing those from and Localhost The localhostProfile will be applied which has to be available on the node disk on Linux it s var lib kubelet seccomp The availability of the seccomp profile is verified by the on container creation If the profile does not exist then the container creation will fail with a CreateContainerError Localhost profiles Seccomp profiles are JSON files following the scheme defined by the OCI runtime specification https github com opencontainers runtime spec blob f329913 config linux md seccomp A profile basically defines actions based on matched syscalls but also allows to pass specific values as arguments to syscalls For example json defaultAction SCMP ACT ERRNO defaultErrnoRet 38 syscalls names adjtimex alarm bind waitid waitpid write writev action SCMP ACT ALLOW The defaultAction in the profile above is defined as SCMP ACT ERRNO and will return as fallback to the actions defined in syscalls The error is defined as code 38 via the defaultErrnoRet field The following actions are generally possible SCMP ACT ERRNO Return the specified error code SCMP ACT ALLOW Allow the syscall to be executed SCMP ACT KILL PROCESS Kill the process SCMP ACT KILL THREAD and SCMP ACT KILL Kill only the thread SCMP ACT TRAP Throw a SIGSYS signal SCMP ACT NOTIFY and SECCOMP RET USER NOTIF Notify the user space SCMP ACT TRACE Notify a tracing process with the specified value SCMP ACT LOG Allow the syscall to be executed after the action has been logged to syslog or auditd Some actions like SCMP ACT NOTIFY or SECCOMP RET USER NOTIF may be not supported depending on the container runtime OCI runtime or Linux kernel version being used There may be also further limitations for example that SCMP ACT NOTIFY cannot be used as defaultAction or for certain syscalls like write All those limitations are defined by either the OCI runtime runc https github com opencontainers runc crun https github com containers crun or libseccomp https github com seccomp libseccomp The syscalls JSON array contains a list of objects referencing syscalls by their respective names For example the action SCMP ACT ALLOW can be used to create a whitelist of allowed syscalls as outlined in the example above It would also be possible to define another list using the action SCMP ACT ERRNO but a different return errnoRet value It is also possible to specify the arguments args passed to certain syscalls More information about those advanced use cases can be found in the OCI runtime spec https github com opencontainers runtime spec blob f329913 config linux md seccomp and the Seccomp Linux kernel documentation https www kernel org doc Documentation prctl seccomp filter txt Further reading Restrict a Container s Syscalls with seccomp docs tutorials security seccomp Pod Security Standards docs concepts security pod security standards |
kubernetes reference This document outlines files that kubelet reads and writes title Local Files And Paths Used By The Kubelet contenttype reference The glossarytooltip text kubelet termid kubelet is mostly a stateless process running on a Kubernetes glossarytooltip text node termid node weight 42 | ---
content_type: "reference"
title: Local Files And Paths Used By The Kubelet
weight: 42
---
The is mostly a stateless
process running on a Kubernetes .
This document outlines files that kubelet reads and writes.
This document is for informational purpose and not describing any guaranteed behaviors or APIs.
It lists resources used by the kubelet, which is an implementation detail and a subject to change at any release.
The kubelet typically uses the as
the source of truth on what needs to run on the Node, and the
to retrieve
the current state of containers. So long as you provide a _kubeconfig_ (API client configuration)
to the kubelet, the kubelet does connect to your control plane; otherwise the node operates in
_standalone mode_.
On Linux nodes, the kubelet also relies on reading cgroups and various system files to collect metrics.
On Windows nodes, the kubelet collects metrics via a different mechanism that does not rely on
paths.
There are also a few other files that are used by the kubelet as well as kubelet communicates using local Unix-domain sockets. Some are sockets that the
kubelet listens on, and for other sockets the kubelet discovers them and then connects
as a client.
This page lists paths as Linux paths, which map to the Windows paths by adding a root disk
`C:\` in place of `/` (unless specified otherwise). For example, `/var/lib/kubelet/device-plugins` maps to `C:\var\lib\kubelet\device-plugins`.
## Configuration
### Kubelet configuration files
The path to the kubelet configuration file can be configured
using the command line argument `--config`. The kubelet also supports
[drop-in configuration files](/docs/tasks/administer-cluster/kubelet-config-file/#kubelet-conf-d)
to enhance configuration.
### Certificates
Certificates and private keys are typically located at `/var/lib/kubelet/pki`,
but can be configured using the `--cert-dir` kubelet command line argument.
Names of certificate files are also configurable.
### Manifests
Manifests for static pods are typically located in `/etc/kubernetes/manifests`.
Location can be configured using the `staticPodPath` kubelet configuration option.
### Systemd unit settings
When kubelet is running as a systemd unit, some kubelet configuration may be declared
in systemd unit settings file. Typically it includes:
- command line arguments to [run kubelet](/docs/reference/command-line-tools-reference/kubelet/)
- environment variables, used by kubelet or [configuring golang runtime](https://pkg.go.dev/runtime#hdr-Environment_Variables)
## State
### Checkpoint files for resource managers {#resource-managers-state}
All resource managers keep the mapping of Pods to allocated resources in state files.
State files are located in the kubelet's base directory, also termed the _root directory_
(but not the same as `/`, the node root directory). You can configure the base directory
for the kubelet
using the kubelet command line argument `--root-dir`.
Names of files:
- `memory_manager_state` for the [Memory Manager](/docs/tasks/administer-cluster/memory-manager/)
- `cpu_manager_state` for the [CPU Manager](/docs/tasks/administer-cluster/cpu-management-policies/)
- `dra_manager_state` for [DRA](/docs/concepts/scheduling-eviction/dynamic-resource-allocation/)
### Checkpoint file for device manager {#device-manager-state}
Device manager creates checkpoints in the same directory with socket files: `/var/lib/kubelet/device-plugins/`.
The name of a checkpoint file is `kubelet_internal_checkpoint` for [Device Manager](/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#device-plugin-integration-with-the-topology-manager)
### Pod status checkpoint storage {#pod-status-manager-state}
If your cluster has
[in-place Pod vertical scaling](/docs/concepts/workloads/autoscaling/#in-place-resizing)
enabled ([feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
name `InPlacePodVerticalScaling`), then the kubelet stores a local record of Pod status.
The file name is `pod_status_manager_state` within the kubelet base directory
(`/var/lib/kubelet` by default on Linux; configurable using `--root-dir`).
### Container runtime
Kubelet communicates with the container runtime using socket configured via the
configuration parameters:
- `containerRuntimeEndpoint` for runtime operations
- `imageServiceEndpoint` for image management operations
The actual values of those endpoints depend on the container runtime being used.
### Device plugins
The kubelet exposes a socket at the path `/var/lib/kubelet/device-plugins/kubelet.sock` for
various [Device Plugins to register](/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#device-plugin-implementation).
When a device plugin registers itself, it provides its socket path for the kubelet to connect.
The device plugin socket should be in the directory `device-plugins` within the kubelet base
directory. On a typical Linux node, this means `/var/lib/kubelet/device-plugins`.
### Pod resources API
[Pod Resources API](/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/#monitoring-device-plugin-resources)
will be exposed at the path `/var/lib/kubelet/pod-resources`.
### DRA, CSI, and Device plugins
The kubelet looks for socket files created by device plugins managed via [DRA](/docs/concepts/scheduling-eviction/dynamic-resource-allocation/),
device manager, or storage plugins, and then attempts to connect
to these sockets. The directory that the kubelet looks in is `plugins_registry` within the kubelet base
directory, so on a typical Linux node this means `/var/lib/kubelet/plugins_registry`.
Note, for the device plugins there are two alternative registration mechanisms. Only one should be used for a given plugin.
The types of plugins that can place socket files into that directory are:
- CSI plugins
- DRA plugins
- Device Manager plugins
(typically `/var/lib/kubelet/plugins_registry`).
## Security profiles & configuration
### Seccomp
Seccomp profile files referenced from Pods should be placed in `/var/lib/kubelet/seccomp`.
See the [seccomp reference](/docs/reference/node/seccomp/) for details.
### AppArmor
The kubelet does not load or refer to AppArmor profiles by a Kubernetes-specific path.
AppArmor profiles are loaded via the node operating system rather then referenced by their path.
## Locking
A lock file for the kubelet; typically `/var/run/kubelet.lock`. The kubelet uses this to ensure
that two different kubelets don't try to run in conflict with each other.
You can configure the path to the lock file using the the `--lock-file` kubelet command line argument.
If two kubelets on the same node use a different value for the lock file path, they will not be able to
detect a conflict when both are running.
##
- Learn about the kubelet [command line arguments](/docs/reference/command-line-tools-reference/kubelet/).
- Review the [Kubelet Configuration (v1beta1) reference](/docs/reference/config-api/kubelet-config.v1beta1/) | kubernetes reference | content type reference title Local Files And Paths Used By The Kubelet weight 42 The is mostly a stateless process running on a Kubernetes This document outlines files that kubelet reads and writes This document is for informational purpose and not describing any guaranteed behaviors or APIs It lists resources used by the kubelet which is an implementation detail and a subject to change at any release The kubelet typically uses the as the source of truth on what needs to run on the Node and the to retrieve the current state of containers So long as you provide a kubeconfig API client configuration to the kubelet the kubelet does connect to your control plane otherwise the node operates in standalone mode On Linux nodes the kubelet also relies on reading cgroups and various system files to collect metrics On Windows nodes the kubelet collects metrics via a different mechanism that does not rely on paths There are also a few other files that are used by the kubelet as well as kubelet communicates using local Unix domain sockets Some are sockets that the kubelet listens on and for other sockets the kubelet discovers them and then connects as a client This page lists paths as Linux paths which map to the Windows paths by adding a root disk C in place of unless specified otherwise For example var lib kubelet device plugins maps to C var lib kubelet device plugins Configuration Kubelet configuration files The path to the kubelet configuration file can be configured using the command line argument config The kubelet also supports drop in configuration files docs tasks administer cluster kubelet config file kubelet conf d to enhance configuration Certificates Certificates and private keys are typically located at var lib kubelet pki but can be configured using the cert dir kubelet command line argument Names of certificate files are also configurable Manifests Manifests for static pods are typically located in etc kubernetes manifests Location can be configured using the staticPodPath kubelet configuration option Systemd unit settings When kubelet is running as a systemd unit some kubelet configuration may be declared in systemd unit settings file Typically it includes command line arguments to run kubelet docs reference command line tools reference kubelet environment variables used by kubelet or configuring golang runtime https pkg go dev runtime hdr Environment Variables State Checkpoint files for resource managers resource managers state All resource managers keep the mapping of Pods to allocated resources in state files State files are located in the kubelet s base directory also termed the root directory but not the same as the node root directory You can configure the base directory for the kubelet using the kubelet command line argument root dir Names of files memory manager state for the Memory Manager docs tasks administer cluster memory manager cpu manager state for the CPU Manager docs tasks administer cluster cpu management policies dra manager state for DRA docs concepts scheduling eviction dynamic resource allocation Checkpoint file for device manager device manager state Device manager creates checkpoints in the same directory with socket files var lib kubelet device plugins The name of a checkpoint file is kubelet internal checkpoint for Device Manager docs concepts extend kubernetes compute storage net device plugins device plugin integration with the topology manager Pod status checkpoint storage pod status manager state If your cluster has in place Pod vertical scaling docs concepts workloads autoscaling in place resizing enabled feature gate docs reference command line tools reference feature gates name InPlacePodVerticalScaling then the kubelet stores a local record of Pod status The file name is pod status manager state within the kubelet base directory var lib kubelet by default on Linux configurable using root dir Container runtime Kubelet communicates with the container runtime using socket configured via the configuration parameters containerRuntimeEndpoint for runtime operations imageServiceEndpoint for image management operations The actual values of those endpoints depend on the container runtime being used Device plugins The kubelet exposes a socket at the path var lib kubelet device plugins kubelet sock for various Device Plugins to register docs concepts extend kubernetes compute storage net device plugins device plugin implementation When a device plugin registers itself it provides its socket path for the kubelet to connect The device plugin socket should be in the directory device plugins within the kubelet base directory On a typical Linux node this means var lib kubelet device plugins Pod resources API Pod Resources API docs concepts extend kubernetes compute storage net device plugins monitoring device plugin resources will be exposed at the path var lib kubelet pod resources DRA CSI and Device plugins The kubelet looks for socket files created by device plugins managed via DRA docs concepts scheduling eviction dynamic resource allocation device manager or storage plugins and then attempts to connect to these sockets The directory that the kubelet looks in is plugins registry within the kubelet base directory so on a typical Linux node this means var lib kubelet plugins registry Note for the device plugins there are two alternative registration mechanisms Only one should be used for a given plugin The types of plugins that can place socket files into that directory are CSI plugins DRA plugins Device Manager plugins typically var lib kubelet plugins registry Security profiles configuration Seccomp Seccomp profile files referenced from Pods should be placed in var lib kubelet seccomp See the seccomp reference docs reference node seccomp for details AppArmor The kubelet does not load or refer to AppArmor profiles by a Kubernetes specific path AppArmor profiles are loaded via the node operating system rather then referenced by their path Locking A lock file for the kubelet typically var run kubelet lock The kubelet uses this to ensure that two different kubelets don t try to run in conflict with each other You can configure the path to the lock file using the the lock file kubelet command line argument If two kubelets on the same node use a different value for the lock file path they will not be able to detect a conflict when both are running Learn about the kubelet command line arguments docs reference command line tools reference kubelet Review the Kubelet Configuration v1beta1 reference docs reference config api kubelet config v1beta1 |
kubernetes reference name tasks erictune title kubectl Quick Reference krousey contenttype concept card reviewers clove weight 10 highlight it | ---
title: kubectl Quick Reference
reviewers:
- erictune
- krousey
- clove
content_type: concept
weight: 10 # highlight it
card:
name: tasks
weight: 10
---
<!-- overview -->
This page contains a list of commonly used `kubectl` commands and flags.
These instructions are for Kubernetes v. To check the version, use the `kubectl version` command.
<!-- body -->
## Kubectl autocomplete
### BASH
```bash
source <(kubectl completion bash) # set up autocomplete in bash into the current shell, bash-completion package should be installed first.
echo "source <(kubectl completion bash)" >> ~/.bashrc # add autocomplete permanently to your bash shell.
```
You can also use a shorthand alias for `kubectl` that also works with completion:
```bash
alias k=kubectl
complete -o default -F __start_kubectl k
```
### ZSH
```bash
source <(kubectl completion zsh) # set up autocomplete in zsh into the current shell
echo '[[ $commands[kubectl] ]] && source <(kubectl completion zsh)' >> ~/.zshrc # add autocomplete permanently to your zsh shell
```
### FISH
Requires kubectl version 1.23 or above.
```bash
echo 'kubectl completion fish | source' > ~/.config/fish/completions/kubectl.fish && source ~/.config/fish/completions/kubectl.fish
```
### A note on `--all-namespaces`
Appending `--all-namespaces` happens frequently enough that you should be aware of the shorthand for `--all-namespaces`:
```kubectl -A```
## Kubectl context and configuration
Set which Kubernetes cluster `kubectl` communicates with and modifies configuration
information. See [Authenticating Across Clusters with kubeconfig](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) documentation for
detailed config file information.
```bash
kubectl config view # Show Merged kubeconfig settings.
# use multiple kubeconfig files at the same time and view merged config
KUBECONFIG=~/.kube/config:~/.kube/kubconfig2
kubectl config view
# Show merged kubeconfig settings and raw certificate data and exposed secrets
kubectl config view --raw
# get the password for the e2e user
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
# get the certificate for the e2e user
kubectl config view --raw -o jsonpath='{.users[?(.name == "e2e")].user.client-certificate-data}' | base64 -d
kubectl config view -o jsonpath='{.users[].name}' # display the first user
kubectl config view -o jsonpath='{.users[*].name}' # get a list of users
kubectl config get-contexts # display list of contexts
kubectl config get-contexts -o name # get all context names
kubectl config current-context # display the current-context
kubectl config use-context my-cluster-name # set the default context to my-cluster-name
kubectl config set-cluster my-cluster-name # set a cluster entry in the kubeconfig
# configure the URL to a proxy server to use for requests made by this client in the kubeconfig
kubectl config set-cluster my-cluster-name --proxy-url=my-proxy-url
# add a new user to your kubeconf that supports basic auth
kubectl config set-credentials kubeuser/foo.kubernetes.com --username=kubeuser --password=kubepassword
# permanently save the namespace for all subsequent kubectl commands in that context.
kubectl config set-context --current --namespace=ggckad-s2
# set a context utilizing a specific username and namespace.
kubectl config set-context gce --user=cluster-admin --namespace=foo \
&& kubectl config use-context gce
kubectl config unset users.foo # delete user foo
# short alias to set/show context/namespace (only works for bash and bash-compatible shells, current context to be set before using kn to set namespace)
alias kx='f() { [ "$1" ] && kubectl config use-context $1 || kubectl config current-context ; } ; f'
alias kn='f() { [ "$1" ] && kubectl config set-context --current --namespace $1 || kubectl config view --minify | grep namespace | cut -d" " -f6 ; } ; f'
```
## Kubectl apply
`apply` manages applications through files defining Kubernetes resources. It creates and updates resources in a cluster through running `kubectl apply`. This is the recommended way of managing Kubernetes applications on production. See [Kubectl Book](https://kubectl.docs.kubernetes.io).
## Creating objects
Kubernetes manifests can be defined in YAML or JSON. The file extension `.yaml`,
`.yml`, and `.json` can be used.
```bash
kubectl apply -f ./my-manifest.yaml # create resource(s)
kubectl apply -f ./my1.yaml -f ./my2.yaml # create from multiple files
kubectl apply -f ./dir # create resource(s) in all manifest files in dir
kubectl apply -f https://example.com/manifest.yaml # create resource(s) from url (Note: this is an example domain and does not contain a valid manifest)
kubectl create deployment nginx --image=nginx # start a single instance of nginx
# create a Job which prints "Hello World"
kubectl create job hello --image=busybox:1.28 -- echo "Hello World"
# create a CronJob that prints "Hello World" every minute
kubectl create cronjob hello --image=busybox:1.28 --schedule="*/1 * * * *" -- echo "Hello World"
kubectl explain pods # get the documentation for pod manifests
# Create multiple YAML objects from stdin
kubectl apply -f - <<EOF
apiVersion: v1
kind: Pod
metadata:
name: busybox-sleep
spec:
containers:
- name: busybox
image: busybox:1.28
args:
- sleep
- "1000000"
---
apiVersion: v1
kind: Pod
metadata:
name: busybox-sleep-less
spec:
containers:
- name: busybox
image: busybox:1.28
args:
- sleep
- "1000"
EOF
# Create a secret with several keys
kubectl apply -f - <<EOF
apiVersion: v1
kind: Secret
metadata:
name: mysecret
type: Opaque
data:
password: $(echo -n "s33msi4" | base64 -w0)
username: $(echo -n "jane" | base64 -w0)
EOF
```
## Viewing and finding resources
```bash
# Get commands with basic output
kubectl get services # List all services in the namespace
kubectl get pods --all-namespaces # List all pods in all namespaces
kubectl get pods -o wide # List all pods in the current namespace, with more details
kubectl get deployment my-dep # List a particular deployment
kubectl get pods # List all pods in the namespace
kubectl get pod my-pod -o yaml # Get a pod's YAML
# Describe commands with verbose output
kubectl describe nodes my-node
kubectl describe pods my-pod
# List Services Sorted by Name
kubectl get services --sort-by=.metadata.name
# List pods Sorted by Restart Count
kubectl get pods --sort-by='.status.containerStatuses[0].restartCount'
# List PersistentVolumes sorted by capacity
kubectl get pv --sort-by=.spec.capacity.storage
# Get the version label of all pods with label app=cassandra
kubectl get pods --selector=app=cassandra -o \
jsonpath='{.items[*].metadata.labels.version}'
# Retrieve the value of a key with dots, e.g. 'ca.crt'
kubectl get configmap myconfig \
-o jsonpath='{.data.ca\.crt}'
# Retrieve a base64 encoded value with dashes instead of underscores.
kubectl get secret my-secret --template=''
# Get all worker nodes (use a selector to exclude results that have a label
# named 'node-role.kubernetes.io/control-plane')
kubectl get node --selector='!node-role.kubernetes.io/control-plane'
# Get all running pods in the namespace
kubectl get pods --field-selector=status.phase=Running
# Get ExternalIPs of all nodes
kubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type=="ExternalIP")].address}'
# List Names of Pods that belong to Particular RC
# "jq" command useful for transformations that are too complex for jsonpath, it can be found at https://jqlang.github.io/jq/
sel=${$(kubectl get rc my-rc --output=json | jq -j '.spec.selector | to_entries | .[] | "\(.key)=\(.value),"')%?}
echo $(kubectl get pods --selector=$sel --output=jsonpath={.items..metadata.name})
# Show labels for all pods (or any other Kubernetes object that supports labelling)
kubectl get pods --show-labels
# Check which nodes are ready
JSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}' \
&& kubectl get nodes -o jsonpath="$JSONPATH" | grep "Ready=True"
# Check which nodes are ready with custom-columns
kubectl get node -o custom-columns='NODE_NAME:.metadata.name,STATUS:.status.conditions[?(@.type=="Ready")].status'
# Output decoded secrets without external tools
kubectl get secret my-secret -o go-template=''
# List all Secrets currently in use by a pod
kubectl get pods -o json | jq '.items[].spec.containers[].env[]?.valueFrom.secretKeyRef.name' | grep -v null | sort | uniq
# List all containerIDs of initContainer of all pods
# Helpful when cleaning up stopped containers, while avoiding removal of initContainers.
kubectl get pods --all-namespaces -o jsonpath='{range .items[*].status.initContainerStatuses[*]}{.containerID}{"\n"}{end}' | cut -d/ -f3
# List Events sorted by timestamp
kubectl get events --sort-by=.metadata.creationTimestamp
# List all warning events
kubectl events --types=Warning
# Compares the current state of the cluster against the state that the cluster would be in if the manifest was applied.
kubectl diff -f ./my-manifest.yaml
# Produce a period-delimited tree of all keys returned for nodes
# Helpful when locating a key within a complex nested JSON structure
kubectl get nodes -o json | jq -c 'paths|join(".")'
# Produce a period-delimited tree of all keys returned for pods, etc
kubectl get pods -o json | jq -c 'paths|join(".")'
# Produce ENV for all pods, assuming you have a default container for the pods, default namespace and the `env` command is supported.
# Helpful when running any supported command across all pods, not just `env`
for pod in $(kubectl get po --output=jsonpath={.items..metadata.name}); do echo $pod && kubectl exec -it $pod -- env; done
# Get a deployment's status subresource
kubectl get deployment nginx-deployment --subresource=status
```
## Updating resources
```bash
kubectl set image deployment/frontend www=image:v2 # Rolling update "www" containers of "frontend" deployment, updating the image
kubectl rollout history deployment/frontend # Check the history of deployments including the revision
kubectl rollout undo deployment/frontend # Rollback to the previous deployment
kubectl rollout undo deployment/frontend --to-revision=2 # Rollback to a specific revision
kubectl rollout status -w deployment/frontend # Watch rolling update status of "frontend" deployment until completion
kubectl rollout restart deployment/frontend # Rolling restart of the "frontend" deployment
cat pod.json | kubectl replace -f - # Replace a pod based on the JSON passed into stdin
# Force replace, delete and then re-create the resource. Will cause a service outage.
kubectl replace --force -f ./pod.json
# Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000
kubectl expose rc nginx --port=80 --target-port=8000
# Update a single-container pod's image version (tag) to v4
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
kubectl label pods my-pod new-label=awesome # Add a Label
kubectl label pods my-pod new-label- # Remove a label
kubectl label pods my-pod new-label=new-value --overwrite # Overwrite an existing value
kubectl annotate pods my-pod icon-url=http://goo.gl/XXBTWq # Add an annotation
kubectl annotate pods my-pod icon-url- # Remove annotation
kubectl autoscale deployment foo --min=2 --max=10 # Auto scale a deployment "foo"
```
## Patching resources
```bash
# Partially update a node
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
# Update a container's image; spec.containers[*].name is required because it's a merge key
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
# Update a container's image using a json patch with positional arrays
kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
# Disable a deployment livenessProbe using a json patch with positional arrays
kubectl patch deployment valid-deployment --type json -p='[{"op": "remove", "path": "/spec/template/spec/containers/0/livenessProbe"}]'
# Add a new element to a positional array
kubectl patch sa default --type='json' -p='[{"op": "add", "path": "/secrets/1", "value": {"name": "whatever" } }]'
# Update a deployment's replica count by patching its scale subresource
kubectl patch deployment nginx-deployment --subresource='scale' --type='merge' -p '{"spec":{"replicas":2}}'
```
## Editing resources
Edit any API resource in your preferred editor.
```bash
kubectl edit svc/docker-registry # Edit the service named docker-registry
KUBE_EDITOR="nano" kubectl edit svc/docker-registry # Use an alternative editor
```
## Scaling resources
```bash
kubectl scale --replicas=3 rs/foo # Scale a replicaset named 'foo' to 3
kubectl scale --replicas=3 -f foo.yaml # Scale a resource specified in "foo.yaml" to 3
kubectl scale --current-replicas=2 --replicas=3 deployment/mysql # If the deployment named mysql's current size is 2, scale mysql to 3
kubectl scale --replicas=5 rc/foo rc/bar rc/baz # Scale multiple replication controllers
```
## Deleting resources
```bash
kubectl delete -f ./pod.json # Delete a pod using the type and name specified in pod.json
kubectl delete pod unwanted --now # Delete a pod with no grace period
kubectl delete pod,service baz foo # Delete pods and services with same names "baz" and "foo"
kubectl delete pods,services -l name=myLabel # Delete pods and services with label name=myLabel
kubectl -n my-ns delete pod,svc --all # Delete all pods and services in namespace my-ns,
# Delete all pods matching the awk pattern1 or pattern2
kubectl get pods -n mynamespace --no-headers=true | awk '/pattern1|pattern2/{print $1}' | xargs kubectl delete -n mynamespace pod
```
## Interacting with running Pods
```bash
kubectl logs my-pod # dump pod logs (stdout)
kubectl logs -l name=myLabel # dump pod logs, with label name=myLabel (stdout)
kubectl logs my-pod --previous # dump pod logs (stdout) for a previous instantiation of a container
kubectl logs my-pod -c my-container # dump pod container logs (stdout, multi-container case)
kubectl logs -l name=myLabel -c my-container # dump pod container logs, with label name=myLabel (stdout)
kubectl logs my-pod -c my-container --previous # dump pod container logs (stdout, multi-container case) for a previous instantiation of a container
kubectl logs -f my-pod # stream pod logs (stdout)
kubectl logs -f my-pod -c my-container # stream pod container logs (stdout, multi-container case)
kubectl logs -f -l name=myLabel --all-containers # stream all pods logs with label name=myLabel (stdout)
kubectl run -i --tty busybox --image=busybox:1.28 -- sh # Run pod as interactive shell
kubectl run nginx --image=nginx -n mynamespace # Start a single instance of nginx pod in the namespace of mynamespace
kubectl run nginx --image=nginx --dry-run=client -o yaml > pod.yaml
# Generate spec for running pod nginx and write it into a file called pod.yaml
kubectl attach my-pod -i # Attach to Running Container
kubectl port-forward my-pod 5000:6000 # Listen on port 5000 on the local machine and forward to port 6000 on my-pod
kubectl exec my-pod -- ls / # Run command in existing pod (1 container case)
kubectl exec --stdin --tty my-pod -- /bin/sh # Interactive shell access to a running pod (1 container case)
kubectl exec my-pod -c my-container -- ls / # Run command in existing pod (multi-container case)
kubectl debug my-pod -it --image=busybox:1.28 # Create an interactive debugging session within existing pod and immediately attach to it
kubectl debug node/my-node -it --image=busybox:1.28 # Create an interactive debugging session on a node and immediately attach to it
kubectl top pod # Show metrics for all pods in the default namespace
kubectl top pod POD_NAME --containers # Show metrics for a given pod and its containers
kubectl top pod POD_NAME --sort-by=cpu # Show metrics for a given pod and sort it by 'cpu' or 'memory'
```
## Copying files and directories to and from containers
```bash
kubectl cp /tmp/foo_dir my-pod:/tmp/bar_dir # Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the current namespace
kubectl cp /tmp/foo my-pod:/tmp/bar -c my-container # Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container
kubectl cp /tmp/foo my-namespace/my-pod:/tmp/bar # Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace my-namespace
kubectl cp my-namespace/my-pod:/tmp/foo /tmp/bar # Copy /tmp/foo from a remote pod to /tmp/bar locally
```
`kubectl cp` requires that the 'tar' binary is present in your container image. If 'tar' is not present, `kubectl cp` will fail.
For advanced use cases, such as symlinks, wildcard expansion or file mode preservation consider using `kubectl exec`.
```bash
tar cf - /tmp/foo | kubectl exec -i -n my-namespace my-pod -- tar xf - -C /tmp/bar # Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace my-namespace
kubectl exec -n my-namespace my-pod -- tar cf - /tmp/foo | tar xf - -C /tmp/bar # Copy /tmp/foo from a remote pod to /tmp/bar locally
```
## Interacting with Deployments and Services
```bash
kubectl logs deploy/my-deployment # dump Pod logs for a Deployment (single-container case)
kubectl logs deploy/my-deployment -c my-container # dump Pod logs for a Deployment (multi-container case)
kubectl port-forward svc/my-service 5000 # listen on local port 5000 and forward to port 5000 on Service backend
kubectl port-forward svc/my-service 5000:my-service-port # listen on local port 5000 and forward to Service target port with name <my-service-port>
kubectl port-forward deploy/my-deployment 5000:6000 # listen on local port 5000 and forward to port 6000 on a Pod created by <my-deployment>
kubectl exec deploy/my-deployment -- ls # run command in first Pod and first container in Deployment (single- or multi-container cases)
```
## Interacting with Nodes and cluster
```bash
kubectl cordon my-node # Mark my-node as unschedulable
kubectl drain my-node # Drain my-node in preparation for maintenance
kubectl uncordon my-node # Mark my-node as schedulable
kubectl top node # Show metrics for all nodes
kubectl top node my-node # Show metrics for a given node
kubectl cluster-info # Display addresses of the master and services
kubectl cluster-info dump # Dump current cluster state to stdout
kubectl cluster-info dump --output-directory=/path/to/cluster-state # Dump current cluster state to /path/to/cluster-state
# View existing taints on which exist on current nodes.
kubectl get nodes -o='custom-columns=NodeName:.metadata.name,TaintKey:.spec.taints[*].key,TaintValue:.spec.taints[*].value,TaintEffect:.spec.taints[*].effect'
# If a taint with that key and effect already exists, its value is replaced as specified.
kubectl taint nodes foo dedicated=special-user:NoSchedule
```
### Resource types
List all supported resource types along with their shortnames, [API group](/docs/concepts/overview/kubernetes-api/#api-groups-and-versioning), whether they are [namespaced](/docs/concepts/overview/working-with-objects/namespaces), and [kind](/docs/concepts/overview/working-with-objects/):
```bash
kubectl api-resources
```
Other operations for exploring API resources:
```bash
kubectl api-resources --namespaced=true # All namespaced resources
kubectl api-resources --namespaced=false # All non-namespaced resources
kubectl api-resources -o name # All resources with simple output (only the resource name)
kubectl api-resources -o wide # All resources with expanded (aka "wide") output
kubectl api-resources --verbs=list,get # All resources that support the "list" and "get" request verbs
kubectl api-resources --api-group=extensions # All resources in the "extensions" API group
```
### Formatting output
To output details to your terminal window in a specific format, add the `-o` (or `--output`) flag to a supported `kubectl` command.
Output format | Description
--------------| -----------
`-o=custom-columns=<spec>` | Print a table using a comma separated list of custom columns
`-o=custom-columns-file=<filename>` | Print a table using the custom columns template in the `<filename>` file
`-o=go-template=<template>` | Print the fields defined in a [golang template](https://pkg.go.dev/text/template)
`-o=go-template-file=<filename>` | Print the fields defined by the [golang template](https://pkg.go.dev/text/template) in the `<filename>` file
`-o=json` | Output a JSON formatted API object
`-o=jsonpath=<template>` | Print the fields defined in a [jsonpath](/docs/reference/kubectl/jsonpath) expression
`-o=jsonpath-file=<filename>` | Print the fields defined by the [jsonpath](/docs/reference/kubectl/jsonpath) expression in the `<filename>` file
`-o=name` | Print only the resource name and nothing else
`-o=wide` | Output in the plain-text format with any additional information, and for pods, the node name is included
`-o=yaml` | Output a YAML formatted API object
Examples using `-o=custom-columns`:
```bash
# All images running in a cluster
kubectl get pods -A -o=custom-columns='DATA:spec.containers[*].image'
# All images running in namespace: default, grouped by Pod
kubectl get pods --namespace default --output=custom-columns="NAME:.metadata.name,IMAGE:.spec.containers[*].image"
# All images excluding "registry.k8s.io/coredns:1.6.2"
kubectl get pods -A -o=custom-columns='DATA:spec.containers[?(@.image!="registry.k8s.io/coredns:1.6.2")].image'
# All fields under metadata regardless of name
kubectl get pods -A -o=custom-columns='DATA:metadata.*'
```
More examples in the kubectl [reference documentation](/docs/reference/kubectl/#custom-columns).
### Kubectl output verbosity and debugging
Kubectl verbosity is controlled with the `-v` or `--v` flags followed by an integer representing the log level. General Kubernetes logging conventions and the associated log levels are described [here](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md).
Verbosity | Description
--------------| -----------
`--v=0` | Generally useful for this to *always* be visible to a cluster operator.
`--v=1` | A reasonable default log level if you don't want verbosity.
`--v=2` | Useful steady state information about the service and important log messages that may correlate to significant changes in the system. This is the recommended default log level for most systems.
`--v=3` | Extended information about changes.
`--v=4` | Debug level verbosity.
`--v=5` | Trace level verbosity.
`--v=6` | Display requested resources.
`--v=7` | Display HTTP request headers.
`--v=8` | Display HTTP request contents.
`--v=9` | Display HTTP request contents without truncation of contents.
##
* Read the [kubectl overview](/docs/reference/kubectl/) and learn about [JsonPath](/docs/reference/kubectl/jsonpath).
* See [kubectl](/docs/reference/kubectl/kubectl/) options.
* Also read [kubectl Usage Conventions](/docs/reference/kubectl/conventions/) to understand how to use kubectl in reusable scripts.
* See more community [kubectl cheatsheets](https://github.com/dennyzhang/cheatsheet-kubernetes-A4). | kubernetes reference | title kubectl Quick Reference reviewers erictune krousey clove content type concept weight 10 highlight it card name tasks weight 10 overview This page contains a list of commonly used kubectl commands and flags These instructions are for Kubernetes v To check the version use the kubectl version command body Kubectl autocomplete BASH bash source kubectl completion bash set up autocomplete in bash into the current shell bash completion package should be installed first echo source kubectl completion bash bashrc add autocomplete permanently to your bash shell You can also use a shorthand alias for kubectl that also works with completion bash alias k kubectl complete o default F start kubectl k ZSH bash source kubectl completion zsh set up autocomplete in zsh into the current shell echo commands kubectl source kubectl completion zsh zshrc add autocomplete permanently to your zsh shell FISH Requires kubectl version 1 23 or above bash echo kubectl completion fish source config fish completions kubectl fish source config fish completions kubectl fish A note on all namespaces Appending all namespaces happens frequently enough that you should be aware of the shorthand for all namespaces kubectl A Kubectl context and configuration Set which Kubernetes cluster kubectl communicates with and modifies configuration information See Authenticating Across Clusters with kubeconfig docs tasks access application cluster configure access multiple clusters documentation for detailed config file information bash kubectl config view Show Merged kubeconfig settings use multiple kubeconfig files at the same time and view merged config KUBECONFIG kube config kube kubconfig2 kubectl config view Show merged kubeconfig settings and raw certificate data and exposed secrets kubectl config view raw get the password for the e2e user kubectl config view o jsonpath users name e2e user password get the certificate for the e2e user kubectl config view raw o jsonpath users name e2e user client certificate data base64 d kubectl config view o jsonpath users name display the first user kubectl config view o jsonpath users name get a list of users kubectl config get contexts display list of contexts kubectl config get contexts o name get all context names kubectl config current context display the current context kubectl config use context my cluster name set the default context to my cluster name kubectl config set cluster my cluster name set a cluster entry in the kubeconfig configure the URL to a proxy server to use for requests made by this client in the kubeconfig kubectl config set cluster my cluster name proxy url my proxy url add a new user to your kubeconf that supports basic auth kubectl config set credentials kubeuser foo kubernetes com username kubeuser password kubepassword permanently save the namespace for all subsequent kubectl commands in that context kubectl config set context current namespace ggckad s2 set a context utilizing a specific username and namespace kubectl config set context gce user cluster admin namespace foo kubectl config use context gce kubectl config unset users foo delete user foo short alias to set show context namespace only works for bash and bash compatible shells current context to be set before using kn to set namespace alias kx f 1 kubectl config use context 1 kubectl config current context f alias kn f 1 kubectl config set context current namespace 1 kubectl config view minify grep namespace cut d f6 f Kubectl apply apply manages applications through files defining Kubernetes resources It creates and updates resources in a cluster through running kubectl apply This is the recommended way of managing Kubernetes applications on production See Kubectl Book https kubectl docs kubernetes io Creating objects Kubernetes manifests can be defined in YAML or JSON The file extension yaml yml and json can be used bash kubectl apply f my manifest yaml create resource s kubectl apply f my1 yaml f my2 yaml create from multiple files kubectl apply f dir create resource s in all manifest files in dir kubectl apply f https example com manifest yaml create resource s from url Note this is an example domain and does not contain a valid manifest kubectl create deployment nginx image nginx start a single instance of nginx create a Job which prints Hello World kubectl create job hello image busybox 1 28 echo Hello World create a CronJob that prints Hello World every minute kubectl create cronjob hello image busybox 1 28 schedule 1 echo Hello World kubectl explain pods get the documentation for pod manifests Create multiple YAML objects from stdin kubectl apply f EOF apiVersion v1 kind Pod metadata name busybox sleep spec containers name busybox image busybox 1 28 args sleep 1000000 apiVersion v1 kind Pod metadata name busybox sleep less spec containers name busybox image busybox 1 28 args sleep 1000 EOF Create a secret with several keys kubectl apply f EOF apiVersion v1 kind Secret metadata name mysecret type Opaque data password echo n s33msi4 base64 w0 username echo n jane base64 w0 EOF Viewing and finding resources bash Get commands with basic output kubectl get services List all services in the namespace kubectl get pods all namespaces List all pods in all namespaces kubectl get pods o wide List all pods in the current namespace with more details kubectl get deployment my dep List a particular deployment kubectl get pods List all pods in the namespace kubectl get pod my pod o yaml Get a pod s YAML Describe commands with verbose output kubectl describe nodes my node kubectl describe pods my pod List Services Sorted by Name kubectl get services sort by metadata name List pods Sorted by Restart Count kubectl get pods sort by status containerStatuses 0 restartCount List PersistentVolumes sorted by capacity kubectl get pv sort by spec capacity storage Get the version label of all pods with label app cassandra kubectl get pods selector app cassandra o jsonpath items metadata labels version Retrieve the value of a key with dots e g ca crt kubectl get configmap myconfig o jsonpath data ca crt Retrieve a base64 encoded value with dashes instead of underscores kubectl get secret my secret template Get all worker nodes use a selector to exclude results that have a label named node role kubernetes io control plane kubectl get node selector node role kubernetes io control plane Get all running pods in the namespace kubectl get pods field selector status phase Running Get ExternalIPs of all nodes kubectl get nodes o jsonpath items status addresses type ExternalIP address List Names of Pods that belong to Particular RC jq command useful for transformations that are too complex for jsonpath it can be found at https jqlang github io jq sel kubectl get rc my rc output json jq j spec selector to entries key value echo kubectl get pods selector sel output jsonpath items metadata name Show labels for all pods or any other Kubernetes object that supports labelling kubectl get pods show labels Check which nodes are ready JSONPATH range items metadata name range status conditions type status end end kubectl get nodes o jsonpath JSONPATH grep Ready True Check which nodes are ready with custom columns kubectl get node o custom columns NODE NAME metadata name STATUS status conditions type Ready status Output decoded secrets without external tools kubectl get secret my secret o go template List all Secrets currently in use by a pod kubectl get pods o json jq items spec containers env valueFrom secretKeyRef name grep v null sort uniq List all containerIDs of initContainer of all pods Helpful when cleaning up stopped containers while avoiding removal of initContainers kubectl get pods all namespaces o jsonpath range items status initContainerStatuses containerID n end cut d f3 List Events sorted by timestamp kubectl get events sort by metadata creationTimestamp List all warning events kubectl events types Warning Compares the current state of the cluster against the state that the cluster would be in if the manifest was applied kubectl diff f my manifest yaml Produce a period delimited tree of all keys returned for nodes Helpful when locating a key within a complex nested JSON structure kubectl get nodes o json jq c paths join Produce a period delimited tree of all keys returned for pods etc kubectl get pods o json jq c paths join Produce ENV for all pods assuming you have a default container for the pods default namespace and the env command is supported Helpful when running any supported command across all pods not just env for pod in kubectl get po output jsonpath items metadata name do echo pod kubectl exec it pod env done Get a deployment s status subresource kubectl get deployment nginx deployment subresource status Updating resources bash kubectl set image deployment frontend www image v2 Rolling update www containers of frontend deployment updating the image kubectl rollout history deployment frontend Check the history of deployments including the revision kubectl rollout undo deployment frontend Rollback to the previous deployment kubectl rollout undo deployment frontend to revision 2 Rollback to a specific revision kubectl rollout status w deployment frontend Watch rolling update status of frontend deployment until completion kubectl rollout restart deployment frontend Rolling restart of the frontend deployment cat pod json kubectl replace f Replace a pod based on the JSON passed into stdin Force replace delete and then re create the resource Will cause a service outage kubectl replace force f pod json Create a service for a replicated nginx which serves on port 80 and connects to the containers on port 8000 kubectl expose rc nginx port 80 target port 8000 Update a single container pod s image version tag to v4 kubectl get pod mypod o yaml sed s image myimage 1 v4 kubectl replace f kubectl label pods my pod new label awesome Add a Label kubectl label pods my pod new label Remove a label kubectl label pods my pod new label new value overwrite Overwrite an existing value kubectl annotate pods my pod icon url http goo gl XXBTWq Add an annotation kubectl annotate pods my pod icon url Remove annotation kubectl autoscale deployment foo min 2 max 10 Auto scale a deployment foo Patching resources bash Partially update a node kubectl patch node k8s node 1 p spec unschedulable true Update a container s image spec containers name is required because it s a merge key kubectl patch pod valid pod p spec containers name kubernetes serve hostname image new image Update a container s image using a json patch with positional arrays kubectl patch pod valid pod type json p op replace path spec containers 0 image value new image Disable a deployment livenessProbe using a json patch with positional arrays kubectl patch deployment valid deployment type json p op remove path spec template spec containers 0 livenessProbe Add a new element to a positional array kubectl patch sa default type json p op add path secrets 1 value name whatever Update a deployment s replica count by patching its scale subresource kubectl patch deployment nginx deployment subresource scale type merge p spec replicas 2 Editing resources Edit any API resource in your preferred editor bash kubectl edit svc docker registry Edit the service named docker registry KUBE EDITOR nano kubectl edit svc docker registry Use an alternative editor Scaling resources bash kubectl scale replicas 3 rs foo Scale a replicaset named foo to 3 kubectl scale replicas 3 f foo yaml Scale a resource specified in foo yaml to 3 kubectl scale current replicas 2 replicas 3 deployment mysql If the deployment named mysql s current size is 2 scale mysql to 3 kubectl scale replicas 5 rc foo rc bar rc baz Scale multiple replication controllers Deleting resources bash kubectl delete f pod json Delete a pod using the type and name specified in pod json kubectl delete pod unwanted now Delete a pod with no grace period kubectl delete pod service baz foo Delete pods and services with same names baz and foo kubectl delete pods services l name myLabel Delete pods and services with label name myLabel kubectl n my ns delete pod svc all Delete all pods and services in namespace my ns Delete all pods matching the awk pattern1 or pattern2 kubectl get pods n mynamespace no headers true awk pattern1 pattern2 print 1 xargs kubectl delete n mynamespace pod Interacting with running Pods bash kubectl logs my pod dump pod logs stdout kubectl logs l name myLabel dump pod logs with label name myLabel stdout kubectl logs my pod previous dump pod logs stdout for a previous instantiation of a container kubectl logs my pod c my container dump pod container logs stdout multi container case kubectl logs l name myLabel c my container dump pod container logs with label name myLabel stdout kubectl logs my pod c my container previous dump pod container logs stdout multi container case for a previous instantiation of a container kubectl logs f my pod stream pod logs stdout kubectl logs f my pod c my container stream pod container logs stdout multi container case kubectl logs f l name myLabel all containers stream all pods logs with label name myLabel stdout kubectl run i tty busybox image busybox 1 28 sh Run pod as interactive shell kubectl run nginx image nginx n mynamespace Start a single instance of nginx pod in the namespace of mynamespace kubectl run nginx image nginx dry run client o yaml pod yaml Generate spec for running pod nginx and write it into a file called pod yaml kubectl attach my pod i Attach to Running Container kubectl port forward my pod 5000 6000 Listen on port 5000 on the local machine and forward to port 6000 on my pod kubectl exec my pod ls Run command in existing pod 1 container case kubectl exec stdin tty my pod bin sh Interactive shell access to a running pod 1 container case kubectl exec my pod c my container ls Run command in existing pod multi container case kubectl debug my pod it image busybox 1 28 Create an interactive debugging session within existing pod and immediately attach to it kubectl debug node my node it image busybox 1 28 Create an interactive debugging session on a node and immediately attach to it kubectl top pod Show metrics for all pods in the default namespace kubectl top pod POD NAME containers Show metrics for a given pod and its containers kubectl top pod POD NAME sort by cpu Show metrics for a given pod and sort it by cpu or memory Copying files and directories to and from containers bash kubectl cp tmp foo dir my pod tmp bar dir Copy tmp foo dir local directory to tmp bar dir in a remote pod in the current namespace kubectl cp tmp foo my pod tmp bar c my container Copy tmp foo local file to tmp bar in a remote pod in a specific container kubectl cp tmp foo my namespace my pod tmp bar Copy tmp foo local file to tmp bar in a remote pod in namespace my namespace kubectl cp my namespace my pod tmp foo tmp bar Copy tmp foo from a remote pod to tmp bar locally kubectl cp requires that the tar binary is present in your container image If tar is not present kubectl cp will fail For advanced use cases such as symlinks wildcard expansion or file mode preservation consider using kubectl exec bash tar cf tmp foo kubectl exec i n my namespace my pod tar xf C tmp bar Copy tmp foo local file to tmp bar in a remote pod in namespace my namespace kubectl exec n my namespace my pod tar cf tmp foo tar xf C tmp bar Copy tmp foo from a remote pod to tmp bar locally Interacting with Deployments and Services bash kubectl logs deploy my deployment dump Pod logs for a Deployment single container case kubectl logs deploy my deployment c my container dump Pod logs for a Deployment multi container case kubectl port forward svc my service 5000 listen on local port 5000 and forward to port 5000 on Service backend kubectl port forward svc my service 5000 my service port listen on local port 5000 and forward to Service target port with name my service port kubectl port forward deploy my deployment 5000 6000 listen on local port 5000 and forward to port 6000 on a Pod created by my deployment kubectl exec deploy my deployment ls run command in first Pod and first container in Deployment single or multi container cases Interacting with Nodes and cluster bash kubectl cordon my node Mark my node as unschedulable kubectl drain my node Drain my node in preparation for maintenance kubectl uncordon my node Mark my node as schedulable kubectl top node Show metrics for all nodes kubectl top node my node Show metrics for a given node kubectl cluster info Display addresses of the master and services kubectl cluster info dump Dump current cluster state to stdout kubectl cluster info dump output directory path to cluster state Dump current cluster state to path to cluster state View existing taints on which exist on current nodes kubectl get nodes o custom columns NodeName metadata name TaintKey spec taints key TaintValue spec taints value TaintEffect spec taints effect If a taint with that key and effect already exists its value is replaced as specified kubectl taint nodes foo dedicated special user NoSchedule Resource types List all supported resource types along with their shortnames API group docs concepts overview kubernetes api api groups and versioning whether they are namespaced docs concepts overview working with objects namespaces and kind docs concepts overview working with objects bash kubectl api resources Other operations for exploring API resources bash kubectl api resources namespaced true All namespaced resources kubectl api resources namespaced false All non namespaced resources kubectl api resources o name All resources with simple output only the resource name kubectl api resources o wide All resources with expanded aka wide output kubectl api resources verbs list get All resources that support the list and get request verbs kubectl api resources api group extensions All resources in the extensions API group Formatting output To output details to your terminal window in a specific format add the o or output flag to a supported kubectl command Output format Description o custom columns spec Print a table using a comma separated list of custom columns o custom columns file filename Print a table using the custom columns template in the filename file o go template template Print the fields defined in a golang template https pkg go dev text template o go template file filename Print the fields defined by the golang template https pkg go dev text template in the filename file o json Output a JSON formatted API object o jsonpath template Print the fields defined in a jsonpath docs reference kubectl jsonpath expression o jsonpath file filename Print the fields defined by the jsonpath docs reference kubectl jsonpath expression in the filename file o name Print only the resource name and nothing else o wide Output in the plain text format with any additional information and for pods the node name is included o yaml Output a YAML formatted API object Examples using o custom columns bash All images running in a cluster kubectl get pods A o custom columns DATA spec containers image All images running in namespace default grouped by Pod kubectl get pods namespace default output custom columns NAME metadata name IMAGE spec containers image All images excluding registry k8s io coredns 1 6 2 kubectl get pods A o custom columns DATA spec containers image registry k8s io coredns 1 6 2 image All fields under metadata regardless of name kubectl get pods A o custom columns DATA metadata More examples in the kubectl reference documentation docs reference kubectl custom columns Kubectl output verbosity and debugging Kubectl verbosity is controlled with the v or v flags followed by an integer representing the log level General Kubernetes logging conventions and the associated log levels are described here https github com kubernetes community blob master contributors devel sig instrumentation logging md Verbosity Description v 0 Generally useful for this to always be visible to a cluster operator v 1 A reasonable default log level if you don t want verbosity v 2 Useful steady state information about the service and important log messages that may correlate to significant changes in the system This is the recommended default log level for most systems v 3 Extended information about changes v 4 Debug level verbosity v 5 Trace level verbosity v 6 Display requested resources v 7 Display HTTP request headers v 8 Display HTTP request contents v 9 Display HTTP request contents without truncation of contents Read the kubectl overview docs reference kubectl and learn about JsonPath docs reference kubectl jsonpath See kubectl docs reference kubectl kubectl options Also read kubectl Usage Conventions docs reference kubectl conventions to understand how to use kubectl in reusable scripts See more community kubectl cheatsheets https github com dennyzhang cheatsheet kubernetes A4 |
kubernetes reference title JSONPath Support Kubectl supports JSONPath template contenttype concept weight 40 overview | ---
title: JSONPath Support
content_type: concept
weight: 40
---
<!-- overview -->
Kubectl supports JSONPath template.
<!-- body -->
JSONPath template is composed of JSONPath expressions enclosed by curly braces {}.
Kubectl uses JSONPath expressions to filter on specific fields in the JSON object and format the output.
In addition to the original JSONPath template syntax, the following functions and syntax are valid:
1. Use double quotes to quote text inside JSONPath expressions.
2. Use the `range`, `end` operators to iterate lists.
3. Use negative slice indices to step backwards through a list. Negative indices do not "wrap around" a list and are valid as long as `-index + listLength >= 0`.
- The `$` operator is optional since the expression always starts from the root object by default.
- The result object is printed as its String() function.
Given the JSON input:
```json
{
"kind": "List",
"items":[
{
"kind":"None",
"metadata":{
"name":"127.0.0.1",
"labels":{
"kubernetes.io/hostname":"127.0.0.1"
}
},
"status":{
"capacity":{"cpu":"4"},
"addresses":[{"type": "LegacyHostIP", "address":"127.0.0.1"}]
}
},
{
"kind":"None",
"metadata":{"name":"127.0.0.2"},
"status":{
"capacity":{"cpu":"8"},
"addresses":[
{"type": "LegacyHostIP", "address":"127.0.0.2"},
{"type": "another", "address":"127.0.0.3"}
]
}
}
],
"users":[
{
"name": "myself",
"user": {}
},
{
"name": "e2e",
"user": {"username": "admin", "password": "secret"}
}
]
}
```
Function | Description | Example | Result
--------------------|------------------------------|-----------------------------------------------------------------|------------------
`text` | the plain text | `kind is {.kind}` | `kind is List`
`@` | the current object | `{@}` | the same as input
`.` or `[]` | child operator | `{.kind}`, `{['kind']}` or `{['name\.type']}` | `List`
`..` | recursive descent | `{..name}` | `127.0.0.1 127.0.0.2 myself e2e`
`*` | wildcard. Get all objects | `{.items[*].metadata.name}` | `[127.0.0.1 127.0.0.2]`
`[start:end:step]` | subscript operator | `{.users[0].name}` | `myself`
`[,]` | union operator | `{.items[*]['metadata.name', 'status.capacity']}` | `127.0.0.1 127.0.0.2 map[cpu:4] map[cpu:8]`
`?()` | filter | `{.users[?(@.name=="e2e")].user.password}` | `secret`
`range`, `end` | iterate list | `{range .items[*]}[{.metadata.name}, {.status.capacity}] {end}` | `[127.0.0.1, map[cpu:4]] [127.0.0.2, map[cpu:8]]`
`''` | quote interpreted string | `{range .items[*]}{.metadata.name}{'\t'}{end}` | `127.0.0.1 127.0.0.2`
`\` | escape termination character | `{.items[0].metadata.labels.kubernetes\.io/hostname}` | `127.0.0.1`
Examples using `kubectl` and JSONPath expressions:
```shell
kubectl get pods -o json
kubectl get pods -o=jsonpath='{@}'
kubectl get pods -o=jsonpath='{.items[0]}'
kubectl get pods -o=jsonpath='{.items[0].metadata.name}'
kubectl get pods -o=jsonpath="{.items[*]['metadata.name', 'status.capacity']}"
kubectl get pods -o=jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.startTime}{"\n"}{end}'
kubectl get pods -o=jsonpath='{.items[0].metadata.labels.kubernetes\.io/hostname}'
```
On Windows, you must _double_ quote any JSONPath template that contains spaces (not single quote as shown above for bash). This in turn means that you must use a single quote or escaped double quote around any literals in the template. For example:
```cmd
kubectl get pods -o=jsonpath="{range .items[*]}{.metadata.name}{'\t'}{.status.startTime}{'\n'}{end}"
kubectl get pods -o=jsonpath="{range .items[*]}{.metadata.name}{\"\t\"}{.status.startTime}{\"\n\"}{end}"
```
JSONPath regular expressions are not supported. If you want to match using regular expressions, you can use a tool such as `jq`.
```shell
# kubectl does not support regular expressions for JSONpath output
# The following command does not work
kubectl get pods -o jsonpath='{.items[?(@.metadata.name=~/^test$/)].metadata.name}'
# The following command achieves the desired result
kubectl get pods -o json | jq -r '.items[] | select(.metadata.name | test("test-")).metadata.name'
```
| kubernetes reference | title JSONPath Support content type concept weight 40 overview Kubectl supports JSONPath template body JSONPath template is composed of JSONPath expressions enclosed by curly braces Kubectl uses JSONPath expressions to filter on specific fields in the JSON object and format the output In addition to the original JSONPath template syntax the following functions and syntax are valid 1 Use double quotes to quote text inside JSONPath expressions 2 Use the range end operators to iterate lists 3 Use negative slice indices to step backwards through a list Negative indices do not wrap around a list and are valid as long as index listLength 0 The operator is optional since the expression always starts from the root object by default The result object is printed as its String function Given the JSON input json kind List items kind None metadata name 127 0 0 1 labels kubernetes io hostname 127 0 0 1 status capacity cpu 4 addresses type LegacyHostIP address 127 0 0 1 kind None metadata name 127 0 0 2 status capacity cpu 8 addresses type LegacyHostIP address 127 0 0 2 type another address 127 0 0 3 users name myself user name e2e user username admin password secret Function Description Example Result text the plain text kind is kind kind is List the current object the same as input or child operator kind kind or name type List recursive descent name 127 0 0 1 127 0 0 2 myself e2e wildcard Get all objects items metadata name 127 0 0 1 127 0 0 2 start end step subscript operator users 0 name myself union operator items metadata name status capacity 127 0 0 1 127 0 0 2 map cpu 4 map cpu 8 filter users name e2e user password secret range end iterate list range items metadata name status capacity end 127 0 0 1 map cpu 4 127 0 0 2 map cpu 8 quote interpreted string range items metadata name t end 127 0 0 1 127 0 0 2 escape termination character items 0 metadata labels kubernetes io hostname 127 0 0 1 Examples using kubectl and JSONPath expressions shell kubectl get pods o json kubectl get pods o jsonpath kubectl get pods o jsonpath items 0 kubectl get pods o jsonpath items 0 metadata name kubectl get pods o jsonpath items metadata name status capacity kubectl get pods o jsonpath range items metadata name t status startTime n end kubectl get pods o jsonpath items 0 metadata labels kubernetes io hostname On Windows you must double quote any JSONPath template that contains spaces not single quote as shown above for bash This in turn means that you must use a single quote or escaped double quote around any literals in the template For example cmd kubectl get pods o jsonpath range items metadata name t status startTime n end kubectl get pods o jsonpath range items metadata name t status startTime n end JSONPath regular expressions are not supported If you want to match using regular expressions you can use a tool such as jq shell kubectl does not support regular expressions for JSONpath output The following command does not work kubectl get pods o jsonpath items metadata name test metadata name The following command achieves the desired result kubectl get pods o json jq r items select metadata name test test metadata name |
kubernetes reference contenttype tool reference heading synopsis weight 30 kubectl controls the Kubernetes cluster manager title kubectl | ---
title: kubectl
content_type: tool-reference
weight: 30
---
##
kubectl controls the Kubernetes cluster manager.
Find more information in [Command line tool](/docs/reference/kubectl/) (`kubectl`).
```shell
kubectl [flags]
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--add-dir-header</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If true, adds the file directory to the header of the log messages</td>
</tr>
<tr>
<td colspan="2">--alsologtostderr</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">log to standard error as well as files</td>
</tr>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Username to impersonate for the operation</td>
</tr>
<tr>
<td colspan="2">--as-group stringArray</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</td>
</tr>
<tr>
<td colspan="2">--azure-container-registry-config string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to the file containing Azure container registry configuration information.</td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Default cache directory</td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to a cert file for the certificate authority</td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to a client certificate file for TLS</td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to a client key file for TLS</td>
</tr>
<tr>
<td colspan="2">--cloud-provider-gce-l7lb-src-cidrs cidrs Default: 130.211.0.0/22,35.191.0.0/16</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">CIDRs opened in GCE firewall for L7 LB traffic proxy & health checks</td>
</tr>
<tr>
<td colspan="2">--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</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">CIDRs opened in GCE firewall for L4 LB traffic proxy & health checks</td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The name of the kubeconfig cluster to use</td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The name of the kubeconfig context to use</td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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.</td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">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.</td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">help for kubectl</td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to the kubeconfig file to use for CLI requests.</td>
</tr>
<tr>
<td colspan="2">--log-backtrace-at traceLocation Default: :0</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">when logging hits line file:N, emit a stack trace</td>
</tr>
<tr>
<td colspan="2">--log-dir string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If non-empty, write log files in this directory</td>
</tr>
<tr>
<td colspan="2">--log-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If non-empty, use this log file</td>
</tr>
<tr>
<td colspan="2">--log-file-max-size uint Default: 1800</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited.</td>
</tr>
<tr>
<td colspan="2">--log-flush-frequency duration Default: 5s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Maximum number of seconds between log flushes</td>
</tr>
<tr>
<td colspan="2">--logtostderr Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">log to standard error instead of files</td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Require server version to match client version</td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If present, the namespace scope for this CLI request</td>
</tr>
<tr>
<td colspan="2">--one-output</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If true, only write logs to their native severity level (vs also writing to each lower severity level)</td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Password for basic authentication to the API server</td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Name of the file to write the profile to</td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The address and port of the Kubernetes API server</td>
</tr>
<tr>
<td colspan="2">--skip-headers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If true, avoid header prefixes in the log messages</td>
</tr>
<tr>
<td colspan="2">--skip-log-headers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">If true, avoid headers when opening log files</td>
</tr>
<tr>
<td colspan="2">--stderrthreshold severity Default: 2</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">logs at or above this threshold go to stderr</td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Bearer token for authentication to the API server</td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">The name of the kubeconfig user to use</td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Username for basic authentication to the API server</td>
</tr>
<tr>
<td colspan="2">-v, --v Level</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">number for the log level verbosity</td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Print version information and quit</td>
</tr>
<tr>
<td colspan="2">--vmodule moduleSpec</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">comma-separated list of pattern=N settings for file-filtered logging</td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Treat warnings received from the server as errors and exit with a non-zero exit code</td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">KUBECONFIG</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Path to the kubectl configuration ("kubeconfig") file. Default: "$HOME/.kube/config"</td>
</tr>
<tr>
<td colspan="2">KUBECTL_COMMAND_HEADERS</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">When set to false, turns off extra HTTP headers detailing invoked kubectl command (Kubernetes version v1.22 or later)</td>
</tr>
<tr>
<td colspan="2">KUBECTL_DEBUG_CUSTOM_PROFILE</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">When set to true, custom flag will be enabled in kubectl debug. This flag is used to customize the pre-defined profiles.
</td>
</tr>
<tr>
<td colspan="2">KUBECTL_EXPLAIN_OPENAPIV3</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Toggles whether calls to `kubectl explain` use the new OpenAPIv3 data source available. OpenAPIV3 is enabled by default since Kubernetes 1.24.
</td>
</tr>
<tr>
<td colspan="2">KUBECTL_ENABLE_CMD_SHADOW</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">When set to true, external plugins can be used as subcommands for builtin commands if subcommand does not exist. In alpha stage, this feature can only be used for create command(e.g. kubectl create networkpolicy).
</td>
</tr>
<tr>
<td colspan="2">KUBECTL_PORT_FORWARD_WEBSOCKETS</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">When set to true, the kubectl port-forward command will attempt to stream using the websockets protocol. If the upgrade to websockets fails, the commands will fallback to use the current SPDY protocol.
</td>
</tr>
<tr>
<td colspan="2">KUBECTL_REMOTE_COMMAND_WEBSOCKETS</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">When set to true, the kubectl exec, cp, and attach commands will attempt to stream using the websockets protocol. If the upgrade to websockets fails, the commands will fallback to use the current SPDY protocol.
</td>
</tr>
</tbody>
</table>
##
* [kubectl annotate](/docs/reference/kubectl/generated/kubectl_annotate/) - Update the annotations on a resource
* [kubectl api-resources](/docs/reference/kubectl/generated/kubectl_api-resources/) - Print the supported API resources on the server
* [kubectl api-versions](/docs/reference/kubectl/generated/kubectl_api-versions/) - Print the supported API versions on the server,
in the form of "group/version"
* [kubectl apply](/docs/reference/kubectl/generated/kubectl_apply/) - Apply a configuration to a resource by filename or stdin
* [kubectl attach](/docs/reference/kubectl/generated/kubectl_attach/) - Attach to a running container
* [kubectl auth](/docs/reference/kubectl/generated/kubectl_auth/) - Inspect authorization
* [kubectl autoscale](/docs/reference/kubectl/generated/kubectl_autoscale/) - Auto-scale a Deployment, ReplicaSet, or ReplicationController
* [kubectl certificate](/docs/reference/kubectl/generated/kubectl_certificate/) - Modify certificate resources.
* [kubectl cluster-info](/docs/reference/kubectl/generated/kubectl_cluster-info/) - Display cluster info
* [kubectl completion](/docs/reference/kubectl/generated/kubectl_completion/) - Output shell completion code for the specified shell (bash or zsh)
* [kubectl config](/docs/reference/kubectl/generated/kubectl_config/) - Modify kubeconfig files
* [kubectl cordon](/docs/reference/kubectl/generated/kubectl_cordon/) - Mark node as unschedulable
* [kubectl cp](/docs/reference/kubectl/generated/kubectl_cp/) - Copy files and directories to and from containers.
* [kubectl create](/docs/reference/kubectl/generated/kubectl_create/) - Create a resource from a file or from stdin.
* [kubectl debug](/docs/reference/kubectl/generated/kubectl_debug/) - Create debugging sessions for troubleshooting workloads and nodes
* [kubectl delete](/docs/reference/kubectl/generated/kubectl_delete/) - Delete resources by filenames,
stdin, resources and names, or by resources and label selector
* [kubectl describe](/docs/reference/kubectl/generated/kubectl_describe/) - Show details of a specific resource or group of resources
* [kubectl diff](/docs/reference/kubectl/generated/kubectl_diff/) - Diff live version against would-be applied version
* [kubectl drain](/docs/reference/kubectl/generated/kubectl_drain/) - Drain node in preparation for maintenance
* [kubectl edit](/docs/reference/kubectl/generated/kubectl_edit/) - Edit a resource on the server
* [kubectl events](/docs/reference/kubectl/generated/kubectl_events/) - List events
* [kubectl exec](/docs/reference/kubectl/generated/kubectl_exec/) - Execute a command in a container
* [kubectl explain](/docs/reference/kubectl/generated/kubectl_explain/) - Documentation of resources
* [kubectl expose](/docs/reference/kubectl/generated/kubectl_expose/) - Take a replication controller,
service, deployment or pod and expose it as a new Kubernetes Service
* [kubectl get](/docs/reference/kubectl/generated/kubectl_get/) - Display one or many resources
* [kubectl kustomize](/docs/reference/kubectl/generated/kubectl_kustomize/) - Build a kustomization
target from a directory or a remote url.
* [kubectl label](/docs/reference/kubectl/generated/kubectl_label/) - Update the labels on a resource
* [kubectl logs](/docs/reference/kubectl/generated/kubectl_logs/) - Print the logs for a container in a pod
* [kubectl options](/docs/reference/kubectl/generated/kubectl_options/) - Print the list of flags inherited by all commands
* [kubectl patch](/docs/reference/kubectl/generated/kubectl_patch/) - Update field(s) of a resource
* [kubectl plugin](/docs/reference/kubectl/generated/kubectl_plugin/) - Provides utilities for interacting with plugins.
* [kubectl port-forward](/docs/reference/kubectl/generated/kubectl_port-forward/) - Forward one or more local ports to a pod
* [kubectl proxy](/docs/reference/kubectl/generated/kubectl_proxy/) - Run a proxy to the Kubernetes API server
* [kubectl replace](/docs/reference/kubectl/generated/kubectl_replace/) - Replace a resource by filename or stdin
* [kubectl rollout](/docs/reference/kubectl/generated/kubectl_rollout/) - Manage the rollout of a resource
* [kubectl run](/docs/reference/kubectl/generated/kubectl_run/) - Run a particular image on the cluster
* [kubectl scale](/docs/reference/kubectl/generated/kubectl_scale/) - Set a new size for a Deployment, ReplicaSet or Replication Controller
* [kubectl set](/docs/reference/kubectl/generated/kubectl_set/) - Set specific features on objects
* [kubectl taint](/docs/reference/kubectl/generated/kubectl_taint/) - Update the taints on one or more nodes
* [kubectl top](/docs/reference/kubectl/generated/kubectl_top/) - Display Resource (CPU/Memory/Storage) usage.
* [kubectl uncordon](/docs/reference/kubectl/generated/kubectl_uncordon/) - Mark node as schedulable
* [kubectl version](/docs/reference/kubectl/generated/kubectl_version/) - Print the client and server version information
* [kubectl wait](/docs/reference/kubectl/generated/kubectl_wait/) - Experimental: Wait for a specific condition on one or many resources. | kubernetes reference | title kubectl content type tool reference weight 30 kubectl controls the Kubernetes cluster manager Find more information in Command line tool docs reference kubectl kubectl shell kubectl flags table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 add dir header td tr tr td td td style line height 130 word wrap break word If true adds the file directory to the header of the log messages td tr tr td colspan 2 alsologtostderr td tr tr td td td style line height 130 word wrap break word log to standard error as well as files td tr tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word Username to impersonate for the operation td tr tr td colspan 2 as group stringArray td tr tr td td td style line height 130 word wrap break word Group to impersonate for the operation this flag can be repeated to specify multiple groups td tr tr td colspan 2 azure container registry config string td tr tr td td td style line height 130 word wrap break word Path to the file containing Azure container registry configuration information td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word Default cache directory td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word Path to a cert file for the certificate authority td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word Path to a client certificate file for TLS td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word Path to a client key file for TLS td tr tr td colspan 2 cloud provider gce l7lb src cidrs cidrs nbsp nbsp nbsp nbsp nbsp Default 130 211 0 0 22 35 191 0 0 16 td tr tr td td td style line height 130 word wrap break word CIDRs opened in GCE firewall for L7 LB traffic proxy health checks td tr tr td colspan 2 cloud provider gce lb src cidrs cidrs nbsp nbsp nbsp nbsp nbsp Default 130 211 0 0 22 209 85 152 0 22 209 85 204 0 22 35 191 0 0 16 td tr tr td td td style line height 130 word wrap break word CIDRs opened in GCE firewall for L4 LB traffic proxy health checks td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word The name of the kubeconfig cluster to use td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word The name of the kubeconfig context to use td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word 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 td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word 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 td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word help for kubectl td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word Path to the kubeconfig file to use for CLI requests td tr tr td colspan 2 log backtrace at traceLocation nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word when logging hits line file N emit a stack trace td tr tr td colspan 2 log dir string td tr tr td td td style line height 130 word wrap break word If non empty write log files in this directory td tr tr td colspan 2 log file string td tr tr td td td style line height 130 word wrap break word If non empty use this log file td tr tr td colspan 2 log file max size uint nbsp nbsp nbsp nbsp nbsp Default 1800 td tr tr td td td style line height 130 word wrap break word Defines the maximum size a log file can grow to Unit is megabytes If the value is 0 the maximum file size is unlimited td tr tr td colspan 2 log flush frequency duration nbsp nbsp nbsp nbsp nbsp Default 5s td tr tr td td td style line height 130 word wrap break word Maximum number of seconds between log flushes td tr tr td colspan 2 logtostderr nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word log to standard error instead of files td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word Require server version to match client version td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word If present the namespace scope for this CLI request td tr tr td colspan 2 one output td tr tr td td td style line height 130 word wrap break word If true only write logs to their native severity level vs also writing to each lower severity level td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word Password for basic authentication to the API server td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word Name of profile to capture One of none cpu heap goroutine threadcreate block mutex td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word Name of the file to write the profile to td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word The address and port of the Kubernetes API server td tr tr td colspan 2 skip headers td tr tr td td td style line height 130 word wrap break word If true avoid header prefixes in the log messages td tr tr td colspan 2 skip log headers td tr tr td td td style line height 130 word wrap break word If true avoid headers when opening log files td tr tr td colspan 2 stderrthreshold severity nbsp nbsp nbsp nbsp nbsp Default 2 td tr tr td td td style line height 130 word wrap break word logs at or above this threshold go to stderr td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word Bearer token for authentication to the API server td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word The name of the kubeconfig user to use td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word Username for basic authentication to the API server td tr tr td colspan 2 v v Level td tr tr td td td style line height 130 word wrap break word number for the log level verbosity td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word Print version information and quit td tr tr td colspan 2 vmodule moduleSpec td tr tr td td td style line height 130 word wrap break word comma separated list of pattern N settings for file filtered logging td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word Treat warnings received from the server as errors and exit with a non zero exit code td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 KUBECONFIG td tr tr td td td style line height 130 word wrap break word Path to the kubectl configuration kubeconfig file Default HOME kube config td tr tr td colspan 2 KUBECTL COMMAND HEADERS td tr tr td td td style line height 130 word wrap break word When set to false turns off extra HTTP headers detailing invoked kubectl command Kubernetes version v1 22 or later td tr tr td colspan 2 KUBECTL DEBUG CUSTOM PROFILE td tr tr td td td style line height 130 word wrap break word When set to true custom flag will be enabled in kubectl debug This flag is used to customize the pre defined profiles td tr tr td colspan 2 KUBECTL EXPLAIN OPENAPIV3 td tr tr td td td style line height 130 word wrap break word Toggles whether calls to kubectl explain use the new OpenAPIv3 data source available OpenAPIV3 is enabled by default since Kubernetes 1 24 td tr tr td colspan 2 KUBECTL ENABLE CMD SHADOW td tr tr td td td style line height 130 word wrap break word When set to true external plugins can be used as subcommands for builtin commands if subcommand does not exist In alpha stage this feature can only be used for create command e g kubectl create networkpolicy td tr tr td colspan 2 KUBECTL PORT FORWARD WEBSOCKETS td tr tr td td td style line height 130 word wrap break word When set to true the kubectl port forward command will attempt to stream using the websockets protocol If the upgrade to websockets fails the commands will fallback to use the current SPDY protocol td tr tr td colspan 2 KUBECTL REMOTE COMMAND WEBSOCKETS td tr tr td td td style line height 130 word wrap break word When set to true the kubectl exec cp and attach commands will attempt to stream using the websockets protocol If the upgrade to websockets fails the commands will fallback to use the current SPDY protocol td tr tbody table kubectl annotate docs reference kubectl generated kubectl annotate Update the annotations on a resource kubectl api resources docs reference kubectl generated kubectl api resources Print the supported API resources on the server kubectl api versions docs reference kubectl generated kubectl api versions Print the supported API versions on the server in the form of group version kubectl apply docs reference kubectl generated kubectl apply Apply a configuration to a resource by filename or stdin kubectl attach docs reference kubectl generated kubectl attach Attach to a running container kubectl auth docs reference kubectl generated kubectl auth Inspect authorization kubectl autoscale docs reference kubectl generated kubectl autoscale Auto scale a Deployment ReplicaSet or ReplicationController kubectl certificate docs reference kubectl generated kubectl certificate Modify certificate resources kubectl cluster info docs reference kubectl generated kubectl cluster info Display cluster info kubectl completion docs reference kubectl generated kubectl completion Output shell completion code for the specified shell bash or zsh kubectl config docs reference kubectl generated kubectl config Modify kubeconfig files kubectl cordon docs reference kubectl generated kubectl cordon Mark node as unschedulable kubectl cp docs reference kubectl generated kubectl cp Copy files and directories to and from containers kubectl create docs reference kubectl generated kubectl create Create a resource from a file or from stdin kubectl debug docs reference kubectl generated kubectl debug Create debugging sessions for troubleshooting workloads and nodes kubectl delete docs reference kubectl generated kubectl delete Delete resources by filenames stdin resources and names or by resources and label selector kubectl describe docs reference kubectl generated kubectl describe Show details of a specific resource or group of resources kubectl diff docs reference kubectl generated kubectl diff Diff live version against would be applied version kubectl drain docs reference kubectl generated kubectl drain Drain node in preparation for maintenance kubectl edit docs reference kubectl generated kubectl edit Edit a resource on the server kubectl events docs reference kubectl generated kubectl events List events kubectl exec docs reference kubectl generated kubectl exec Execute a command in a container kubectl explain docs reference kubectl generated kubectl explain Documentation of resources kubectl expose docs reference kubectl generated kubectl expose Take a replication controller service deployment or pod and expose it as a new Kubernetes Service kubectl get docs reference kubectl generated kubectl get Display one or many resources kubectl kustomize docs reference kubectl generated kubectl kustomize Build a kustomization target from a directory or a remote url kubectl label docs reference kubectl generated kubectl label Update the labels on a resource kubectl logs docs reference kubectl generated kubectl logs Print the logs for a container in a pod kubectl options docs reference kubectl generated kubectl options Print the list of flags inherited by all commands kubectl patch docs reference kubectl generated kubectl patch Update field s of a resource kubectl plugin docs reference kubectl generated kubectl plugin Provides utilities for interacting with plugins kubectl port forward docs reference kubectl generated kubectl port forward Forward one or more local ports to a pod kubectl proxy docs reference kubectl generated kubectl proxy Run a proxy to the Kubernetes API server kubectl replace docs reference kubectl generated kubectl replace Replace a resource by filename or stdin kubectl rollout docs reference kubectl generated kubectl rollout Manage the rollout of a resource kubectl run docs reference kubectl generated kubectl run Run a particular image on the cluster kubectl scale docs reference kubectl generated kubectl scale Set a new size for a Deployment ReplicaSet or Replication Controller kubectl set docs reference kubectl generated kubectl set Set specific features on objects kubectl taint docs reference kubectl generated kubectl taint Update the taints on one or more nodes kubectl top docs reference kubectl generated kubectl top Display Resource CPU Memory Storage usage kubectl uncordon docs reference kubectl generated kubectl uncordon Mark node as schedulable kubectl version docs reference kubectl generated kubectl version Print the client and server version information kubectl wait docs reference kubectl generated kubectl wait Experimental Wait for a specific condition on one or many resources |
kubernetes reference brendandburns contenttype concept reviewers title kubectl for Docker Users thockin overview weight 50 | ---
title: kubectl for Docker Users
content_type: concept
reviewers:
- brendandburns
- thockin
weight: 50
---
<!-- overview -->
You can use the Kubernetes command line tool `kubectl` to interact with the API Server. Using kubectl is straightforward if you are familiar with the Docker command line tool. However, there are a few differences between the Docker commands and the kubectl commands. The following sections show a Docker sub-command and describe the equivalent `kubectl` command.
<!-- body -->
## docker run
To run an nginx Deployment and expose the Deployment, see [kubectl create deployment](/docs/reference/generated/kubectl/kubectl-commands#-em-deployment-em-).
docker:
```shell
docker run -d --restart=always -e DOMAIN=cluster --name nginx-app -p 80:80 nginx
```
```
55c103fa129692154a7652490236fee9be47d70a8dd562281ae7d2f9a339a6db
```
```shell
docker ps
```
```
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
55c103fa1296 nginx "nginx -g 'daemon of…" 9 seconds ago Up 9 seconds 0.0.0.0:80->80/tcp nginx-app
```
kubectl:
```shell
# start the pod running nginx
kubectl create deployment --image=nginx nginx-app
```
```
deployment.apps/nginx-app created
```
```shell
# add env to nginx-app
kubectl set env deployment/nginx-app DOMAIN=cluster
```
```
deployment.apps/nginx-app env updated
```
`kubectl` commands print the type and name of the resource created or mutated, which can then be used in subsequent commands. You can expose a new Service after a Deployment is created.
```shell
# expose a port through with a service
kubectl expose deployment nginx-app --port=80 --name=nginx-http
```
```
service "nginx-http" exposed
```
By using kubectl, you can create a [Deployment](/docs/concepts/workloads/controllers/deployment/) to ensure that N pods are running nginx, where N is the number of replicas stated in the spec and defaults to 1. You can also create a [service](/docs/concepts/services-networking/service/) with a selector that matches the pod labels. For more information, see [Use a Service to Access an Application in a Cluster](/docs/tasks/access-application-cluster/service-access-application-cluster).
By default images run in the background, similar to `docker run -d ...`. To run things in the foreground, use [`kubectl run`](/docs/reference/generated/kubectl/kubectl-commands/#run) to create pod:
```shell
kubectl run [-i] [--tty] --attach <name> --image=<image>
```
Unlike `docker run ...`, if you specify `--attach`, then you attach `stdin`, `stdout` and `stderr`. You cannot control which streams are attached (`docker -a ...`).
To detach from the container, you can type the escape sequence Ctrl+P followed by Ctrl+Q.
## docker ps
To list what is currently running, see [kubectl get](/docs/reference/generated/kubectl/kubectl-commands/#get).
docker:
```shell
docker ps -a
```
```
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
14636241935f ubuntu:16.04 "echo test" 5 seconds ago Exited (0) 5 seconds ago cocky_fermi
55c103fa1296 nginx "nginx -g 'daemon of…" About a minute ago Up About a minute 0.0.0.0:80->80/tcp nginx-app
```
kubectl:
```shell
kubectl get po
```
```
NAME READY STATUS RESTARTS AGE
nginx-app-8df569cb7-4gd89 1/1 Running 0 3m
ubuntu 0/1 Completed 0 20s
```
## docker attach
To attach a process that is already running in a container, see [kubectl attach](/docs/reference/generated/kubectl/kubectl-commands/#attach).
docker:
```shell
docker ps
```
```
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
55c103fa1296 nginx "nginx -g 'daemon of…" 5 minutes ago Up 5 minutes 0.0.0.0:80->80/tcp nginx-app
```
```shell
docker attach 55c103fa1296
...
```
kubectl:
```shell
kubectl get pods
```
```
NAME READY STATUS RESTARTS AGE
nginx-app-5jyvm 1/1 Running 0 10m
```
```shell
kubectl attach -it nginx-app-5jyvm
...
```
To detach from the container, you can type the escape sequence Ctrl+P followed by Ctrl+Q.
## docker exec
To execute a command in a container, see [kubectl exec](/docs/reference/generated/kubectl/kubectl-commands/#exec).
docker:
```shell
docker ps
```
```
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
55c103fa1296 nginx "nginx -g 'daemon of…" 6 minutes ago Up 6 minutes 0.0.0.0:80->80/tcp nginx-app
```
```shell
docker exec 55c103fa1296 cat /etc/hostname
```
```
55c103fa1296
```
kubectl:
```shell
kubectl get po
```
```
NAME READY STATUS RESTARTS AGE
nginx-app-5jyvm 1/1 Running 0 10m
```
```shell
kubectl exec nginx-app-5jyvm -- cat /etc/hostname
```
```
nginx-app-5jyvm
```
To use interactive commands.
docker:
```shell
docker exec -ti 55c103fa1296 /bin/sh
# exit
```
kubectl:
```shell
kubectl exec -ti nginx-app-5jyvm -- /bin/sh
# exit
```
For more information, see [Get a Shell to a Running Container](/docs/tasks/debug/debug-application/get-shell-running-container/).
## docker logs
To follow stdout/stderr of a process that is running, see [kubectl logs](/docs/reference/generated/kubectl/kubectl-commands/#logs).
docker:
```shell
docker logs -f a9e
```
```
192.168.9.1 - - [14/Jul/2015:01:04:02 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.35.0" "-"
192.168.9.1 - - [14/Jul/2015:01:04:03 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.35.0" "-"
```
kubectl:
```shell
kubectl logs -f nginx-app-zibvs
```
```
10.240.63.110 - - [14/Jul/2015:01:09:01 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.26.0" "-"
10.240.63.110 - - [14/Jul/2015:01:09:02 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.26.0" "-"
```
There is a slight difference between pods and containers; by default pods do not terminate if their processes exit. Instead the pods restart the process. This is similar to the docker run option `--restart=always` with one major difference. In docker, the output for each invocation of the process is concatenated, but for Kubernetes, each invocation is separate. To see the output from a previous run in Kubernetes, do this:
```shell
kubectl logs --previous nginx-app-zibvs
```
```
10.240.63.110 - - [14/Jul/2015:01:09:01 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.26.0" "-"
10.240.63.110 - - [14/Jul/2015:01:09:02 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.26.0" "-"
```
For more information, see [Logging Architecture](/docs/concepts/cluster-administration/logging/).
## docker stop and docker rm
To stop and delete a running process, see [kubectl delete](/docs/reference/generated/kubectl/kubectl-commands/#delete).
docker:
```shell
docker ps
```
```
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
a9ec34d98787 nginx "nginx -g 'daemon of" 22 hours ago Up 22 hours 0.0.0.0:80->80/tcp, 443/tcp nginx-app
```
```shell
docker stop a9ec34d98787
```
```
a9ec34d98787
```
```shell
docker rm a9ec34d98787
```
```
a9ec34d98787
```
kubectl:
```shell
kubectl get deployment nginx-app
```
```
NAME READY UP-TO-DATE AVAILABLE AGE
nginx-app 1/1 1 1 2m
```
```shell
kubectl get po -l app=nginx-app
```
```
NAME READY STATUS RESTARTS AGE
nginx-app-2883164633-aklf7 1/1 Running 0 2m
```
```shell
kubectl delete deployment nginx-app
```
```
deployment "nginx-app" deleted
```
```shell
kubectl get po -l app=nginx-app
# Return nothing
```
When you use kubectl, you don't delete the pod directly. You have to first delete the Deployment that owns the pod. If you delete the pod directly, the Deployment recreates the pod.
## docker login
There is no direct analog of `docker login` in kubectl. If you are interested in using Kubernetes with a private registry, see [Using a Private Registry](/docs/concepts/containers/images/#using-a-private-registry).
## docker version
To get the version of client and server, see [kubectl version](/docs/reference/generated/kubectl/kubectl-commands/#version).
docker:
```shell
docker version
```
```
Client version: 1.7.0
Client API version: 1.19
Go version (client): go1.4.2
Git commit (client): 0baf609
OS/Arch (client): linux/amd64
Server version: 1.7.0
Server API version: 1.19
Go version (server): go1.4.2
Git commit (server): 0baf609
OS/Arch (server): linux/amd64
```
kubectl:
```shell
kubectl version
```
```
Client Version: version.Info{Major:"1", Minor:"6", GitVersion:"v1.6.9+a3d1dfa6f4335", GitCommit:"9b77fed11a9843ce3780f70dd251e92901c43072", GitTreeState:"dirty", BuildDate:"2017-08-29T20:32:58Z", OpenPaasKubernetesVersion:"v1.03.02", GoVersion:"go1.7.5", Compiler:"gc", Platform:"linux/amd64"}
Server Version: version.Info{Major:"1", Minor:"6", GitVersion:"v1.6.9+a3d1dfa6f4335", GitCommit:"9b77fed11a9843ce3780f70dd251e92901c43072", GitTreeState:"dirty", BuildDate:"2017-08-29T20:32:58Z", OpenPaasKubernetesVersion:"v1.03.02", GoVersion:"go1.7.5", Compiler:"gc", Platform:"linux/amd64"}
```
## docker info
To get miscellaneous information about the environment and configuration, see [kubectl cluster-info](/docs/reference/generated/kubectl/kubectl-commands/#cluster-info).
docker:
```shell
docker info
```
```
Containers: 40
Images: 168
Storage Driver: aufs
Root Dir: /usr/local/google/docker/aufs
Backing Filesystem: extfs
Dirs: 248
Dirperm1 Supported: false
Execution Driver: native-0.2
Logging Driver: json-file
Kernel Version: 3.13.0-53-generic
Operating System: Ubuntu 14.04.2 LTS
CPUs: 12
Total Memory: 31.32 GiB
Name: k8s-is-fun.mtv.corp.google.com
ID: ADUV:GCYR:B3VJ:HMPO:LNPQ:KD5S:YKFQ:76VN:IANZ:7TFV:ZBF4:BYJO
WARNING: No swap limit support
```
kubectl:
```shell
kubectl cluster-info
```
```
Kubernetes master is running at https://203.0.113.141
KubeDNS is running at https://203.0.113.141/api/v1/namespaces/kube-system/services/kube-dns/proxy
kubernetes-dashboard is running at https://203.0.113.141/api/v1/namespaces/kube-system/services/kubernetes-dashboard/proxy
Grafana is running at https://203.0.113.141/api/v1/namespaces/kube-system/services/monitoring-grafana/proxy
Heapster is running at https://203.0.113.141/api/v1/namespaces/kube-system/services/monitoring-heapster/proxy
InfluxDB is running at https://203.0.113.141/api/v1/namespaces/kube-system/services/monitoring-influxdb/proxy
```
| kubernetes reference | title kubectl for Docker Users content type concept reviewers brendandburns thockin weight 50 overview You can use the Kubernetes command line tool kubectl to interact with the API Server Using kubectl is straightforward if you are familiar with the Docker command line tool However there are a few differences between the Docker commands and the kubectl commands The following sections show a Docker sub command and describe the equivalent kubectl command body docker run To run an nginx Deployment and expose the Deployment see kubectl create deployment docs reference generated kubectl kubectl commands em deployment em docker shell docker run d restart always e DOMAIN cluster name nginx app p 80 80 nginx 55c103fa129692154a7652490236fee9be47d70a8dd562281ae7d2f9a339a6db shell docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 55c103fa1296 nginx nginx g daemon of 9 seconds ago Up 9 seconds 0 0 0 0 80 80 tcp nginx app kubectl shell start the pod running nginx kubectl create deployment image nginx nginx app deployment apps nginx app created shell add env to nginx app kubectl set env deployment nginx app DOMAIN cluster deployment apps nginx app env updated kubectl commands print the type and name of the resource created or mutated which can then be used in subsequent commands You can expose a new Service after a Deployment is created shell expose a port through with a service kubectl expose deployment nginx app port 80 name nginx http service nginx http exposed By using kubectl you can create a Deployment docs concepts workloads controllers deployment to ensure that N pods are running nginx where N is the number of replicas stated in the spec and defaults to 1 You can also create a service docs concepts services networking service with a selector that matches the pod labels For more information see Use a Service to Access an Application in a Cluster docs tasks access application cluster service access application cluster By default images run in the background similar to docker run d To run things in the foreground use kubectl run docs reference generated kubectl kubectl commands run to create pod shell kubectl run i tty attach name image image Unlike docker run if you specify attach then you attach stdin stdout and stderr You cannot control which streams are attached docker a To detach from the container you can type the escape sequence Ctrl P followed by Ctrl Q docker ps To list what is currently running see kubectl get docs reference generated kubectl kubectl commands get docker shell docker ps a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 14636241935f ubuntu 16 04 echo test 5 seconds ago Exited 0 5 seconds ago cocky fermi 55c103fa1296 nginx nginx g daemon of About a minute ago Up About a minute 0 0 0 0 80 80 tcp nginx app kubectl shell kubectl get po NAME READY STATUS RESTARTS AGE nginx app 8df569cb7 4gd89 1 1 Running 0 3m ubuntu 0 1 Completed 0 20s docker attach To attach a process that is already running in a container see kubectl attach docs reference generated kubectl kubectl commands attach docker shell docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 55c103fa1296 nginx nginx g daemon of 5 minutes ago Up 5 minutes 0 0 0 0 80 80 tcp nginx app shell docker attach 55c103fa1296 kubectl shell kubectl get pods NAME READY STATUS RESTARTS AGE nginx app 5jyvm 1 1 Running 0 10m shell kubectl attach it nginx app 5jyvm To detach from the container you can type the escape sequence Ctrl P followed by Ctrl Q docker exec To execute a command in a container see kubectl exec docs reference generated kubectl kubectl commands exec docker shell docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 55c103fa1296 nginx nginx g daemon of 6 minutes ago Up 6 minutes 0 0 0 0 80 80 tcp nginx app shell docker exec 55c103fa1296 cat etc hostname 55c103fa1296 kubectl shell kubectl get po NAME READY STATUS RESTARTS AGE nginx app 5jyvm 1 1 Running 0 10m shell kubectl exec nginx app 5jyvm cat etc hostname nginx app 5jyvm To use interactive commands docker shell docker exec ti 55c103fa1296 bin sh exit kubectl shell kubectl exec ti nginx app 5jyvm bin sh exit For more information see Get a Shell to a Running Container docs tasks debug debug application get shell running container docker logs To follow stdout stderr of a process that is running see kubectl logs docs reference generated kubectl kubectl commands logs docker shell docker logs f a9e 192 168 9 1 14 Jul 2015 01 04 02 0000 GET HTTP 1 1 200 612 curl 7 35 0 192 168 9 1 14 Jul 2015 01 04 03 0000 GET HTTP 1 1 200 612 curl 7 35 0 kubectl shell kubectl logs f nginx app zibvs 10 240 63 110 14 Jul 2015 01 09 01 0000 GET HTTP 1 1 200 612 curl 7 26 0 10 240 63 110 14 Jul 2015 01 09 02 0000 GET HTTP 1 1 200 612 curl 7 26 0 There is a slight difference between pods and containers by default pods do not terminate if their processes exit Instead the pods restart the process This is similar to the docker run option restart always with one major difference In docker the output for each invocation of the process is concatenated but for Kubernetes each invocation is separate To see the output from a previous run in Kubernetes do this shell kubectl logs previous nginx app zibvs 10 240 63 110 14 Jul 2015 01 09 01 0000 GET HTTP 1 1 200 612 curl 7 26 0 10 240 63 110 14 Jul 2015 01 09 02 0000 GET HTTP 1 1 200 612 curl 7 26 0 For more information see Logging Architecture docs concepts cluster administration logging docker stop and docker rm To stop and delete a running process see kubectl delete docs reference generated kubectl kubectl commands delete docker shell docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES a9ec34d98787 nginx nginx g daemon of 22 hours ago Up 22 hours 0 0 0 0 80 80 tcp 443 tcp nginx app shell docker stop a9ec34d98787 a9ec34d98787 shell docker rm a9ec34d98787 a9ec34d98787 kubectl shell kubectl get deployment nginx app NAME READY UP TO DATE AVAILABLE AGE nginx app 1 1 1 1 2m shell kubectl get po l app nginx app NAME READY STATUS RESTARTS AGE nginx app 2883164633 aklf7 1 1 Running 0 2m shell kubectl delete deployment nginx app deployment nginx app deleted shell kubectl get po l app nginx app Return nothing When you use kubectl you don t delete the pod directly You have to first delete the Deployment that owns the pod If you delete the pod directly the Deployment recreates the pod docker login There is no direct analog of docker login in kubectl If you are interested in using Kubernetes with a private registry see Using a Private Registry docs concepts containers images using a private registry docker version To get the version of client and server see kubectl version docs reference generated kubectl kubectl commands version docker shell docker version Client version 1 7 0 Client API version 1 19 Go version client go1 4 2 Git commit client 0baf609 OS Arch client linux amd64 Server version 1 7 0 Server API version 1 19 Go version server go1 4 2 Git commit server 0baf609 OS Arch server linux amd64 kubectl shell kubectl version Client Version version Info Major 1 Minor 6 GitVersion v1 6 9 a3d1dfa6f4335 GitCommit 9b77fed11a9843ce3780f70dd251e92901c43072 GitTreeState dirty BuildDate 2017 08 29T20 32 58Z OpenPaasKubernetesVersion v1 03 02 GoVersion go1 7 5 Compiler gc Platform linux amd64 Server Version version Info Major 1 Minor 6 GitVersion v1 6 9 a3d1dfa6f4335 GitCommit 9b77fed11a9843ce3780f70dd251e92901c43072 GitTreeState dirty BuildDate 2017 08 29T20 32 58Z OpenPaasKubernetesVersion v1 03 02 GoVersion go1 7 5 Compiler gc Platform linux amd64 docker info To get miscellaneous information about the environment and configuration see kubectl cluster info docs reference generated kubectl kubectl commands cluster info docker shell docker info Containers 40 Images 168 Storage Driver aufs Root Dir usr local google docker aufs Backing Filesystem extfs Dirs 248 Dirperm1 Supported false Execution Driver native 0 2 Logging Driver json file Kernel Version 3 13 0 53 generic Operating System Ubuntu 14 04 2 LTS CPUs 12 Total Memory 31 32 GiB Name k8s is fun mtv corp google com ID ADUV GCYR B3VJ HMPO LNPQ KD5S YKFQ 76VN IANZ 7TFV ZBF4 BYJO WARNING No swap limit support kubectl shell kubectl cluster info Kubernetes master is running at https 203 0 113 141 KubeDNS is running at https 203 0 113 141 api v1 namespaces kube system services kube dns proxy kubernetes dashboard is running at https 203 0 113 141 api v1 namespaces kube system services kubernetes dashboard proxy Grafana is running at https 203 0 113 141 api v1 namespaces kube system services monitoring grafana proxy Heapster is running at https 203 0 113 141 api v1 namespaces kube system services monitoring heapster proxy InfluxDB is running at https 203 0 113 141 api v1 namespaces kube system services monitoring influxdb proxy |
kubernetes reference name reference weight 20 title Command line tool kubectl card contenttype reference title kubectl command line tool nolist true weight 110 | ---
title: Command line tool (kubectl)
content_type: reference
weight: 110
no_list: true
card:
name: reference
title: kubectl command line tool
weight: 20
---
<!-- overview -->
This tool is named `kubectl`.
For configuration, `kubectl` looks for a file named `config` in the `$HOME/.kube` directory.
You can specify other [kubeconfig](/docs/concepts/configuration/organize-cluster-access-kubeconfig/)
files by setting the `KUBECONFIG` environment variable or by setting the
[`--kubeconfig`](/docs/concepts/configuration/organize-cluster-access-kubeconfig/) flag.
This overview covers `kubectl` syntax, describes the command operations, and provides common examples.
For details about each command, including all the supported flags and subcommands, see the
[kubectl](/docs/reference/kubectl/generated/kubectl/) reference documentation.
For installation instructions, see [Installing kubectl](/docs/tasks/tools/#kubectl);
for a quick guide, see the [cheat sheet](/docs/reference/kubectl/quick-reference/).
If you're used to using the `docker` command-line tool,
[`kubectl` for Docker Users](/docs/reference/kubectl/docker-cli-to-kubectl/) explains some equivalent commands for Kubernetes.
<!-- body -->
## Syntax
Use the following syntax to run `kubectl` commands from your terminal window:
```shell
kubectl [command] [TYPE] [NAME] [flags]
```
where `command`, `TYPE`, `NAME`, and `flags` are:
* `command`: Specifies the operation that you want to perform on one or more resources,
for example `create`, `get`, `describe`, `delete`.
* `TYPE`: Specifies the [resource type](#resource-types). Resource types are case-insensitive and
you can specify the singular, plural, or abbreviated forms.
For example, the following commands produce the same output:
```shell
kubectl get pod pod1
kubectl get pods pod1
kubectl get po pod1
```
* `NAME`: Specifies the name of the resource. Names are case-sensitive. If the name is omitted,
details for all resources are displayed, for example `kubectl get pods`.
When performing an operation on multiple resources, you can specify each resource by
type and name or specify one or more files:
* To specify resources by type and name:
* To group resources if they are all the same type: `TYPE1 name1 name2 name<#>`.<br/>
Example: `kubectl get pod example-pod1 example-pod2`
* To specify multiple resource types individually: `TYPE1/name1 TYPE1/name2 TYPE2/name3 TYPE<#>/name<#>`.<br/>
Example: `kubectl get pod/example-pod1 replicationcontroller/example-rc1`
* To specify resources with one or more files: `-f file1 -f file2 -f file<#>`
* [Use YAML rather than JSON](/docs/concepts/configuration/overview/#general-configuration-tips)
since YAML tends to be more user-friendly, especially for configuration files.<br/>
Example: `kubectl get -f ./pod.yaml`
* `flags`: Specifies optional flags. For example, you can use the `-s` or `--server` flags
to specify the address and port of the Kubernetes API server.<br/>
Flags that you specify from the command line override default values and any corresponding environment variables.
If you need help, run `kubectl help` from the terminal window.
## In-cluster authentication and namespace overrides
By default `kubectl` will first determine if it is running within a pod, and thus in a cluster.
It starts by checking for the `KUBERNETES_SERVICE_HOST` and `KUBERNETES_SERVICE_PORT` environment
variables and the existence of a service account token file at `/var/run/secrets/kubernetes.io/serviceaccount/token`.
If all three are found in-cluster authentication is assumed.
To maintain backwards compatibility, if the `POD_NAMESPACE` environment variable is set
during in-cluster authentication it will override the default namespace from the
service account token. Any manifests or tools relying on namespace defaulting will be affected by this.
**`POD_NAMESPACE` environment variable**
If the `POD_NAMESPACE` environment variable is set, cli operations on namespaced resources
will default to the variable value. For example, if the variable is set to `seattle`,
`kubectl get pods` would return pods in the `seattle` namespace. This is because pods are
a namespaced resource, and no namespace was provided in the command. Review the output
of `kubectl api-resources` to determine if a resource is namespaced.
Explicit use of `--namespace <value>` overrides this behavior.
**How kubectl handles ServiceAccount tokens**
If:
* there is Kubernetes service account token file mounted at
`/var/run/secrets/kubernetes.io/serviceaccount/token`, and
* the `KUBERNETES_SERVICE_HOST` environment variable is set, and
* the `KUBERNETES_SERVICE_PORT` environment variable is set, and
* you don't explicitly specify a namespace on the kubectl command line
then kubectl assumes it is running in your cluster. The kubectl tool looks up the
namespace of that ServiceAccount (this is the same as the namespace of the Pod)
and acts against that namespace. This is different from what happens outside of a
cluster; when kubectl runs outside a cluster and you don't specify a namespace,
the kubectl command acts against the namespace set for the current context in your
client configuration. To change the default namespace for your kubectl you can use the
following command:
```shell
kubectl config set-context --current --namespace=<namespace-name>
```
## Operations
The following table includes short descriptions and the general syntax for all of the `kubectl` operations:
Operation | Syntax | Description
-------------------- | -------------------- | --------------------
`alpha` | `kubectl alpha SUBCOMMAND [flags]` | List the available commands that correspond to alpha features, which are not enabled in Kubernetes clusters by default.
`annotate` | <code>kubectl annotate (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]</code> | Add or update the annotations of one or more resources.
`api-resources` | `kubectl api-resources [flags]` | List the API resources that are available.
`api-versions` | `kubectl api-versions [flags]` | List the API versions that are available.
`apply` | `kubectl apply -f FILENAME [flags]`| Apply a configuration change to a resource from a file or stdin.
`attach` | `kubectl attach POD -c CONTAINER [-i] [-t] [flags]` | Attach to a running container either to view the output stream or interact with the container (stdin).
`auth` | `kubectl auth [flags] [options]` | Inspect authorization.
`autoscale` | <code>kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]</code> | Automatically scale the set of pods that are managed by a replication controller.
`certificate` | `kubectl certificate SUBCOMMAND [options]` | Modify certificate resources.
`cluster-info` | `kubectl cluster-info [flags]` | Display endpoint information about the master and services in the cluster.
`completion` | `kubectl completion SHELL [options]` | Output shell completion code for the specified shell (bash or zsh).
`config` | `kubectl config SUBCOMMAND [flags]` | Modifies kubeconfig files. See the individual subcommands for details.
`convert` | `kubectl convert -f FILENAME [options]` | Convert config files between different API versions. Both YAML and JSON formats are accepted. Note - requires `kubectl-convert` plugin to be installed.
`cordon` | `kubectl cordon NODE [options]` | Mark node as unschedulable.
`cp` | `kubectl cp <file-spec-src> <file-spec-dest> [options]` | Copy files and directories to and from containers.
`create` | `kubectl create -f FILENAME [flags]` | Create one or more resources from a file or stdin.
`delete` | <code>kubectl delete (-f FILENAME | TYPE [NAME | /NAME | -l label | --all]) [flags]</code> | Delete resources either from a file, stdin, or specifying label selectors, names, resource selectors, or resources.
`describe` | <code>kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | /NAME | -l label]) [flags]</code> | Display the detailed state of one or more resources.
`diff` | `kubectl diff -f FILENAME [flags]`| Diff file or stdin against live configuration.
`drain` | `kubectl drain NODE [options]` | Drain node in preparation for maintenance.
`edit` | <code>kubectl edit (-f FILENAME | TYPE NAME | TYPE/NAME) [flags]</code> | Edit and update the definition of one or more resources on the server by using the default editor.
`events` | `kubectl events` | List events
`exec` | `kubectl exec POD [-c CONTAINER] [-i] [-t] [flags] [-- COMMAND [args...]]` | Execute a command against a container in a pod.
`explain` | `kubectl explain TYPE [--recursive=false] [flags]` | Get documentation of various resources. For instance pods, nodes, services, etc.
`expose` | <code>kubectl expose (-f FILENAME | TYPE NAME | TYPE/NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type] [flags]</code> | Expose a replication controller, service, or pod as a new Kubernetes service.
`get` | <code>kubectl get (-f FILENAME | TYPE [NAME | /NAME | -l label]) [--watch] [--sort-by=FIELD] [[-o | --output]=OUTPUT_FORMAT] [flags]</code> | List one or more resources.
`kustomize` | `kubectl kustomize <dir> [flags] [options]` | List a set of API resources generated from instructions in a kustomization.yaml file. The argument must be the path to the directory containing the file, or a git repository URL with a path suffix specifying same with respect to the repository root.
`label` | <code>kubectl label (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]</code> | Add or update the labels of one or more resources.
`logs` | `kubectl logs POD [-c CONTAINER] [--follow] [flags]` | Print the logs for a container in a pod.
`options` | `kubectl options` | List of global command-line options, which apply to all commands.
`patch` | <code>kubectl patch (-f FILENAME | TYPE NAME | TYPE/NAME) --patch PATCH [flags]</code> | Update one or more fields of a resource by using the strategic merge patch process.
`plugin` | `kubectl plugin [flags] [options]` | Provides utilities for interacting with plugins.
`port-forward` | `kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] [flags]` | Forward one or more local ports to a pod.
`proxy` | `kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix] [flags]` | Run a proxy to the Kubernetes API server.
`replace` | `kubectl replace -f FILENAME` | Replace a resource from a file or stdin.
`rollout` | `kubectl rollout SUBCOMMAND [options]` | Manage the rollout of a resource. Valid resource types include: deployments, daemonsets and statefulsets.
`run` | <code>kubectl run NAME --image=image [--env="key=value"] [--port=port] [--dry-run=server|client|none] [--overrides=inline-json] [flags]</code> | Run a specified image on the cluster.
`scale` | <code>kubectl scale (-f FILENAME | TYPE NAME | TYPE/NAME) --replicas=COUNT [--resource-version=version] [--current-replicas=count] [flags]</code> | Update the size of the specified replication controller.
`set` | `kubectl set SUBCOMMAND [options]` | Configure application resources.
`taint` | `kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N [options]` | Update the taints on one or more nodes.
`top` | <code>kubectl top (POD | NODE) [flags] [options]</code> | Display Resource (CPU/Memory/Storage) usage of pod or node.
`uncordon` | `kubectl uncordon NODE [options]` | Mark node as schedulable.
`version` | `kubectl version [--client] [flags]` | Display the Kubernetes version running on the client and server.
`wait` | <code>kubectl wait ([-f FILENAME] | resource.group/resource.name | resource.group [(-l label | --all)]) [--for=delete|--for condition=available] [options]</code> | Experimental: Wait for a specific condition on one or many resources.
To learn more about command operations, see the [kubectl](/docs/reference/kubectl/kubectl/) reference documentation.
## Resource types
The following table includes a list of all the supported resource types and their abbreviated aliases.
(This output can be retrieved from `kubectl api-resources`, and was accurate as of Kubernetes 1.25.0)
| NAME | SHORTNAMES | APIVERSION | NAMESPACED | KIND |
|---|---|---|---|---|
| `bindings` | | v1 | true | Binding |
| `componentstatuses` | `cs` | v1 | false | ComponentStatus |
| `configmaps` | `cm` | v1 | true | ConfigMap |
| `endpoints` | `ep` | v1 | true | Endpoints |
| `events` | `ev` | v1 | true | Event |
| `limitranges` | `limits` | v1 | true | LimitRange |
| `namespaces` | `ns` | v1 | false | Namespace |
| `nodes` | `no` | v1 | false | Node |
| `persistentvolumeclaims` | `pvc` | v1 | true | PersistentVolumeClaim |
| `persistentvolumes` | `pv` | v1 | false | PersistentVolume |
| `pods` | `po` | v1 | true | Pod |
| `podtemplates` | | v1 | true | PodTemplate |
| `replicationcontrollers` | `rc` | v1 | true | ReplicationController |
| `resourcequotas` | `quota` | v1 | true | ResourceQuota |
| `secrets` | | v1 | true | Secret |
| `serviceaccounts` | `sa` | v1 | true | ServiceAccount |
| `services` | `svc` | v1 | true | Service |
| `mutatingwebhookconfigurations` | | admissionregistration.k8s.io/v1 | false | MutatingWebhookConfiguration |
| `validatingwebhookconfigurations` | | admissionregistration.k8s.io/v1 | false | ValidatingWebhookConfiguration |
| `customresourcedefinitions` | `crd,crds` | apiextensions.k8s.io/v1 | false | CustomResourceDefinition |
| `apiservices` | | apiregistration.k8s.io/v1 | false | APIService |
| `controllerrevisions` | | apps/v1 | true | ControllerRevision |
| `daemonsets` | `ds` | apps/v1 | true | DaemonSet |
| `deployments` | `deploy` | apps/v1 | true | Deployment |
| `replicasets` | `rs` | apps/v1 | true | ReplicaSet |
| `statefulsets` | `sts` | apps/v1 | true | StatefulSet |
| `tokenreviews` | | authentication.k8s.io/v1 | false | TokenReview |
| `localsubjectaccessreviews` | | authorization.k8s.io/v1 | true | LocalSubjectAccessReview |
| `selfsubjectaccessreviews` | | authorization.k8s.io/v1 | false | SelfSubjectAccessReview |
| `selfsubjectrulesreviews` | | authorization.k8s.io/v1 | false | SelfSubjectRulesReview |
| `subjectaccessreviews` | | authorization.k8s.io/v1 | false | SubjectAccessReview |
| `horizontalpodautoscalers` | `hpa` | autoscaling/v2 | true | HorizontalPodAutoscaler |
| `cronjobs` | `cj` | batch/v1 | true | CronJob |
| `jobs` | | batch/v1 | true | Job |
| `certificatesigningrequests` | `csr` | certificates.k8s.io/v1 | false | CertificateSigningRequest |
| `leases` | | coordination.k8s.io/v1 | true | Lease |
| `endpointslices` | | discovery.k8s.io/v1 | true | EndpointSlice |
| `events` | `ev` | events.k8s.io/v1 | true | Event |
| `flowschemas` | | flowcontrol.apiserver.k8s.io/v1beta2 | false | FlowSchema |
| `prioritylevelconfigurations` | | flowcontrol.apiserver.k8s.io/v1beta2 | false | PriorityLevelConfiguration |
| `ingressclasses` | | networking.k8s.io/v1 | false | IngressClass |
| `ingresses` | `ing` | networking.k8s.io/v1 | true | Ingress |
| `networkpolicies` | `netpol` | networking.k8s.io/v1 | true | NetworkPolicy |
| `runtimeclasses` | | node.k8s.io/v1 | false | RuntimeClass |
| `poddisruptionbudgets` | `pdb` | policy/v1 | true | PodDisruptionBudget |
| `podsecuritypolicies` | `psp` | policy/v1beta1 | false | PodSecurityPolicy |
| `clusterrolebindings` | | rbac.authorization.k8s.io/v1 | false | ClusterRoleBinding |
| `clusterroles` | | rbac.authorization.k8s.io/v1 | false | ClusterRole |
| `rolebindings` | | rbac.authorization.k8s.io/v1 | true | RoleBinding |
| `roles` | | rbac.authorization.k8s.io/v1 | true | Role |
| `priorityclasses` | `pc` | scheduling.k8s.io/v1 | false | PriorityClass |
| `csidrivers` | | storage.k8s.io/v1 | false | CSIDriver |
| `csinodes` | | storage.k8s.io/v1 | false | CSINode |
| `csistoragecapacities` | | storage.k8s.io/v1 | true | CSIStorageCapacity |
| `storageclasses` | `sc` | storage.k8s.io/v1 | false | StorageClass |
| `volumeattachments` | | storage.k8s.io/v1 | false | VolumeAttachment |
## Output options
Use the following sections for information about how you can format or sort the output
of certain commands. For details about which commands support the various output options,
see the [kubectl](/docs/reference/kubectl/kubectl/) reference documentation.
### Formatting output
The default output format for all `kubectl` commands is the human readable plain-text format.
To output details to your terminal window in a specific format, you can add either the `-o`
or `--output` flags to a supported `kubectl` command.
#### Syntax
```shell
kubectl [command] [TYPE] [NAME] -o <output_format>
```
Depending on the `kubectl` operation, the following output formats are supported:
Output format | Description
--------------| -----------
`-o custom-columns=<spec>` | Print a table using a comma separated list of [custom columns](#custom-columns).
`-o custom-columns-file=<filename>` | Print a table using the [custom columns](#custom-columns) template in the `<filename>` file.
`-o json` | Output a JSON formatted API object.
`-o jsonpath=<template>` | Print the fields defined in a [jsonpath](/docs/reference/kubectl/jsonpath/) expression.
`-o jsonpath-file=<filename>` | Print the fields defined by the [jsonpath](/docs/reference/kubectl/jsonpath/) expression in the `<filename>` file.
`-o name` | Print only the resource name and nothing else.
`-o wide` | Output in the plain-text format with any additional information. For pods, the node name is included.
`-o yaml` | Output a YAML formatted API object.
##### Example
In this example, the following command outputs the details for a single pod as a YAML formatted object:
```shell
kubectl get pod web-pod-13je7 -o yaml
```
Remember: See the [kubectl](/docs/reference/kubectl/kubectl/) reference documentation
for details about which output format is supported by each command.
#### Custom columns
To define custom columns and output only the details that you want into a table, you can use the `custom-columns` option.
You can choose to define the custom columns inline or use a template file: `-o custom-columns=<spec>` or `-o custom-columns-file=<filename>`.
##### Examples
Inline:
```shell
kubectl get pods <pod-name> -o custom-columns=NAME:.metadata.name,RSRC:.metadata.resourceVersion
```
Template file:
```shell
kubectl get pods <pod-name> -o custom-columns-file=template.txt
```
where the `template.txt` file contains:
```
NAME RSRC
metadata.name metadata.resourceVersion
```
The result of running either command is similar to:
```
NAME RSRC
submit-queue 610995
```
#### Server-side columns
`kubectl` supports receiving specific column information from the server about objects.
This means that for any given resource, the server will return columns and rows relevant to that resource, for the client to print.
This allows for consistent human-readable output across clients used against the same cluster, by having the server encapsulate the details of printing.
This feature is enabled by default. To disable it, add the
`--server-print=false` flag to the `kubectl get` command.
##### Examples
To print information about the status of a pod, use a command like the following:
```shell
kubectl get pods <pod-name> --server-print=false
```
The output is similar to:
```
NAME AGE
pod-name 1m
```
### Sorting list objects
To output objects to a sorted list in your terminal window, you can add the `--sort-by` flag
to a supported `kubectl` command. Sort your objects by specifying any numeric or string field
with the `--sort-by` flag. To specify a field, use a [jsonpath](/docs/reference/kubectl/jsonpath/) expression.
#### Syntax
```shell
kubectl [command] [TYPE] [NAME] --sort-by=<jsonpath_exp>
```
##### Example
To print a list of pods sorted by name, you run:
```shell
kubectl get pods --sort-by=.metadata.name
```
## Examples: Common operations
Use the following set of examples to help you familiarize yourself with running the commonly used `kubectl` operations:
`kubectl apply` - Apply or Update a resource from a file or stdin.
```shell
# Create a service using the definition in example-service.yaml.
kubectl apply -f example-service.yaml
# Create a replication controller using the definition in example-controller.yaml.
kubectl apply -f example-controller.yaml
# Create the objects that are defined in any .yaml, .yml, or .json file within the <directory> directory.
kubectl apply -f <directory>
```
`kubectl get` - List one or more resources.
```shell
# List all pods in plain-text output format.
kubectl get pods
# List all pods in plain-text output format and include additional information (such as node name).
kubectl get pods -o wide
# List the replication controller with the specified name in plain-text output format. Tip: You can shorten and replace the 'replicationcontroller' resource type with the alias 'rc'.
kubectl get replicationcontroller <rc-name>
# List all replication controllers and services together in plain-text output format.
kubectl get rc,services
# List all daemon sets in plain-text output format.
kubectl get ds
# List all pods running on node server01
kubectl get pods --field-selector=spec.nodeName=server01
```
`kubectl describe` - Display detailed state of one or more resources, including the uninitialized ones by default.
```shell
# Display the details of the node with name <node-name>.
kubectl describe nodes <node-name>
# Display the details of the pod with name <pod-name>.
kubectl describe pods/<pod-name>
# Display the details of all the pods that are managed by the replication controller named <rc-name>.
# Remember: Any pods that are created by the replication controller get prefixed with the name of the replication controller.
kubectl describe pods <rc-name>
# Describe all pods
kubectl describe pods
```
The `kubectl get` command is usually used for retrieving one or more
resources of the same resource type. It features a rich set of flags that allows
you to customize the output format using the `-o` or `--output` flag, for example.
You can specify the `-w` or `--watch` flag to start watching updates to a particular
object. The `kubectl describe` command is more focused on describing the many
related aspects of a specified resource. It may invoke several API calls to the
API server to build a view for the user. For example, the `kubectl describe node`
command retrieves not only the information about the node, but also a summary of
the pods running on it, the events generated for the node etc.
`kubectl delete` - Delete resources either from a file, stdin, or specifying label selectors, names, resource selectors, or resources.
```shell
# Delete a pod using the type and name specified in the pod.yaml file.
kubectl delete -f pod.yaml
# Delete all the pods and services that have the label '<label-key>=<label-value>'.
kubectl delete pods,services -l <label-key>=<label-value>
# Delete all pods, including uninitialized ones.
kubectl delete pods --all
```
`kubectl exec` - Execute a command against a container in a pod.
```shell
# Get output from running 'date' from pod <pod-name>. By default, output is from the first container.
kubectl exec <pod-name> -- date
# Get output from running 'date' in container <container-name> of pod <pod-name>.
kubectl exec <pod-name> -c <container-name> -- date
# Get an interactive TTY and run /bin/bash from pod <pod-name>. By default, output is from the first container.
kubectl exec -ti <pod-name> -- /bin/bash
```
`kubectl logs` - Print the logs for a container in a pod.
```shell
# Return a snapshot of the logs from pod <pod-name>.
kubectl logs <pod-name>
# Start streaming the logs from pod <pod-name>. This is similar to the 'tail -f' Linux command.
kubectl logs -f <pod-name>
```
`kubectl diff` - View a diff of the proposed updates to a cluster.
```shell
# Diff resources included in "pod.json".
kubectl diff -f pod.json
# Diff file read from stdin.
cat service.yaml | kubectl diff -f -
```
## Examples: Creating and using plugins
Use the following set of examples to help you familiarize yourself with writing and using `kubectl` plugins:
```shell
# create a simple plugin in any language and name the resulting executable file
# so that it begins with the prefix "kubectl-"
cat ./kubectl-hello
```
```shell
#!/bin/sh
# this plugin prints the words "hello world"
echo "hello world"
```
With a plugin written, let's make it executable:
```bash
chmod a+x ./kubectl-hello
# and move it to a location in our PATH
sudo mv ./kubectl-hello /usr/local/bin
sudo chown root:root /usr/local/bin
# You have now created and "installed" a kubectl plugin.
# You can begin using this plugin by invoking it from kubectl as if it were a regular command
kubectl hello
```
```
hello world
```
```shell
# You can "uninstall" a plugin, by removing it from the folder in your
# $PATH where you placed it
sudo rm /usr/local/bin/kubectl-hello
```
In order to view all of the plugins that are available to `kubectl`, use
the `kubectl plugin list` subcommand:
```shell
kubectl plugin list
```
The output is similar to:
```
The following kubectl-compatible plugins are available:
/usr/local/bin/kubectl-hello
/usr/local/bin/kubectl-foo
/usr/local/bin/kubectl-bar
```
`kubectl plugin list` also warns you about plugins that are not
executable, or that are shadowed by other plugins; for example:
```shell
sudo chmod -x /usr/local/bin/kubectl-foo # remove execute permission
kubectl plugin list
```
```
The following kubectl-compatible plugins are available:
/usr/local/bin/kubectl-hello
/usr/local/bin/kubectl-foo
- warning: /usr/local/bin/kubectl-foo identified as a plugin, but it is not executable
/usr/local/bin/kubectl-bar
error: one plugin warning was found
```
You can think of plugins as a means to build more complex functionality on top
of the existing kubectl commands:
```shell
cat ./kubectl-whoami
```
The next few examples assume that you already made `kubectl-whoami` have
the following contents:
```shell
#!/bin/bash
# this plugin makes use of the `kubectl config` command in order to output
# information about the current user, based on the currently selected context
kubectl config view --template='Current user: '
```
Running the above command gives you an output containing the user for the
current context in your KUBECONFIG file:
```shell
# make the file executable
sudo chmod +x ./kubectl-whoami
# and move it into your PATH
sudo mv ./kubectl-whoami /usr/local/bin
kubectl whoami
Current user: plugins-user
```
##
* Read the `kubectl` reference documentation:
* the kubectl [command reference](/docs/reference/kubectl/kubectl/)
* the [command line arguments](/docs/reference/kubectl/generated/kubectl/) reference
* Learn about [`kubectl` usage conventions](/docs/reference/kubectl/conventions/)
* Read about [JSONPath support](/docs/reference/kubectl/jsonpath/) in kubectl
* Read about how to [extend kubectl with plugins](/docs/tasks/extend-kubectl/kubectl-plugins)
* To find out more about plugins, take a look at the [example CLI plugin](https://github.com/kubernetes/sample-cli-plugin). | kubernetes reference | title Command line tool kubectl content type reference weight 110 no list true card name reference title kubectl command line tool weight 20 overview This tool is named kubectl For configuration kubectl looks for a file named config in the HOME kube directory You can specify other kubeconfig docs concepts configuration organize cluster access kubeconfig files by setting the KUBECONFIG environment variable or by setting the kubeconfig docs concepts configuration organize cluster access kubeconfig flag This overview covers kubectl syntax describes the command operations and provides common examples For details about each command including all the supported flags and subcommands see the kubectl docs reference kubectl generated kubectl reference documentation For installation instructions see Installing kubectl docs tasks tools kubectl for a quick guide see the cheat sheet docs reference kubectl quick reference If you re used to using the docker command line tool kubectl for Docker Users docs reference kubectl docker cli to kubectl explains some equivalent commands for Kubernetes body Syntax Use the following syntax to run kubectl commands from your terminal window shell kubectl command TYPE NAME flags where command TYPE NAME and flags are command Specifies the operation that you want to perform on one or more resources for example create get describe delete TYPE Specifies the resource type resource types Resource types are case insensitive and you can specify the singular plural or abbreviated forms For example the following commands produce the same output shell kubectl get pod pod1 kubectl get pods pod1 kubectl get po pod1 NAME Specifies the name of the resource Names are case sensitive If the name is omitted details for all resources are displayed for example kubectl get pods When performing an operation on multiple resources you can specify each resource by type and name or specify one or more files To specify resources by type and name To group resources if they are all the same type TYPE1 name1 name2 name br Example kubectl get pod example pod1 example pod2 To specify multiple resource types individually TYPE1 name1 TYPE1 name2 TYPE2 name3 TYPE name br Example kubectl get pod example pod1 replicationcontroller example rc1 To specify resources with one or more files f file1 f file2 f file Use YAML rather than JSON docs concepts configuration overview general configuration tips since YAML tends to be more user friendly especially for configuration files br Example kubectl get f pod yaml flags Specifies optional flags For example you can use the s or server flags to specify the address and port of the Kubernetes API server br Flags that you specify from the command line override default values and any corresponding environment variables If you need help run kubectl help from the terminal window In cluster authentication and namespace overrides By default kubectl will first determine if it is running within a pod and thus in a cluster It starts by checking for the KUBERNETES SERVICE HOST and KUBERNETES SERVICE PORT environment variables and the existence of a service account token file at var run secrets kubernetes io serviceaccount token If all three are found in cluster authentication is assumed To maintain backwards compatibility if the POD NAMESPACE environment variable is set during in cluster authentication it will override the default namespace from the service account token Any manifests or tools relying on namespace defaulting will be affected by this POD NAMESPACE environment variable If the POD NAMESPACE environment variable is set cli operations on namespaced resources will default to the variable value For example if the variable is set to seattle kubectl get pods would return pods in the seattle namespace This is because pods are a namespaced resource and no namespace was provided in the command Review the output of kubectl api resources to determine if a resource is namespaced Explicit use of namespace value overrides this behavior How kubectl handles ServiceAccount tokens If there is Kubernetes service account token file mounted at var run secrets kubernetes io serviceaccount token and the KUBERNETES SERVICE HOST environment variable is set and the KUBERNETES SERVICE PORT environment variable is set and you don t explicitly specify a namespace on the kubectl command line then kubectl assumes it is running in your cluster The kubectl tool looks up the namespace of that ServiceAccount this is the same as the namespace of the Pod and acts against that namespace This is different from what happens outside of a cluster when kubectl runs outside a cluster and you don t specify a namespace the kubectl command acts against the namespace set for the current context in your client configuration To change the default namespace for your kubectl you can use the following command shell kubectl config set context current namespace namespace name Operations The following table includes short descriptions and the general syntax for all of the kubectl operations Operation Syntax Description alpha kubectl alpha SUBCOMMAND flags List the available commands that correspond to alpha features which are not enabled in Kubernetes clusters by default annotate code kubectl annotate f FILENAME 124 TYPE NAME 124 TYPE NAME KEY 1 VAL 1 KEY N VAL N overwrite all resource version version flags code Add or update the annotations of one or more resources api resources kubectl api resources flags List the API resources that are available api versions kubectl api versions flags List the API versions that are available apply kubectl apply f FILENAME flags Apply a configuration change to a resource from a file or stdin attach kubectl attach POD c CONTAINER i t flags Attach to a running container either to view the output stream or interact with the container stdin auth kubectl auth flags options Inspect authorization autoscale code kubectl autoscale f FILENAME 124 TYPE NAME 124 TYPE NAME min MINPODS max MAXPODS cpu percent CPU flags code Automatically scale the set of pods that are managed by a replication controller certificate kubectl certificate SUBCOMMAND options Modify certificate resources cluster info kubectl cluster info flags Display endpoint information about the master and services in the cluster completion kubectl completion SHELL options Output shell completion code for the specified shell bash or zsh config kubectl config SUBCOMMAND flags Modifies kubeconfig files See the individual subcommands for details convert kubectl convert f FILENAME options Convert config files between different API versions Both YAML and JSON formats are accepted Note requires kubectl convert plugin to be installed cordon kubectl cordon NODE options Mark node as unschedulable cp kubectl cp file spec src file spec dest options Copy files and directories to and from containers create kubectl create f FILENAME flags Create one or more resources from a file or stdin delete code kubectl delete f FILENAME 124 TYPE NAME 124 NAME 124 l label 124 all flags code Delete resources either from a file stdin or specifying label selectors names resource selectors or resources describe code kubectl describe f FILENAME 124 TYPE NAME PREFIX 124 NAME 124 l label flags code Display the detailed state of one or more resources diff kubectl diff f FILENAME flags Diff file or stdin against live configuration drain kubectl drain NODE options Drain node in preparation for maintenance edit code kubectl edit f FILENAME 124 TYPE NAME 124 TYPE NAME flags code Edit and update the definition of one or more resources on the server by using the default editor events kubectl events List events exec kubectl exec POD c CONTAINER i t flags COMMAND args Execute a command against a container in a pod explain kubectl explain TYPE recursive false flags Get documentation of various resources For instance pods nodes services etc expose code kubectl expose f FILENAME 124 TYPE NAME 124 TYPE NAME port port protocol TCP 124 UDP target port number or name name name external ip external ip of service type type flags code Expose a replication controller service or pod as a new Kubernetes service get code kubectl get f FILENAME 124 TYPE NAME 124 NAME 124 l label watch sort by FIELD o 124 output OUTPUT FORMAT flags code List one or more resources kustomize kubectl kustomize dir flags options List a set of API resources generated from instructions in a kustomization yaml file The argument must be the path to the directory containing the file or a git repository URL with a path suffix specifying same with respect to the repository root label code kubectl label f FILENAME 124 TYPE NAME 124 TYPE NAME KEY 1 VAL 1 KEY N VAL N overwrite all resource version version flags code Add or update the labels of one or more resources logs kubectl logs POD c CONTAINER follow flags Print the logs for a container in a pod options kubectl options List of global command line options which apply to all commands patch code kubectl patch f FILENAME 124 TYPE NAME 124 TYPE NAME patch PATCH flags code Update one or more fields of a resource by using the strategic merge patch process plugin kubectl plugin flags options Provides utilities for interacting with plugins port forward kubectl port forward POD LOCAL PORT REMOTE PORT LOCAL PORT N REMOTE PORT N flags Forward one or more local ports to a pod proxy kubectl proxy port PORT www static dir www prefix prefix api prefix prefix flags Run a proxy to the Kubernetes API server replace kubectl replace f FILENAME Replace a resource from a file or stdin rollout kubectl rollout SUBCOMMAND options Manage the rollout of a resource Valid resource types include deployments daemonsets and statefulsets run code kubectl run NAME image image env key value port port dry run server 124 client 124 none overrides inline json flags code Run a specified image on the cluster scale code kubectl scale f FILENAME 124 TYPE NAME 124 TYPE NAME replicas COUNT resource version version current replicas count flags code Update the size of the specified replication controller set kubectl set SUBCOMMAND options Configure application resources taint kubectl taint NODE NAME KEY 1 VAL 1 TAINT EFFECT 1 KEY N VAL N TAINT EFFECT N options Update the taints on one or more nodes top code kubectl top POD 124 NODE flags options code Display Resource CPU Memory Storage usage of pod or node uncordon kubectl uncordon NODE options Mark node as schedulable version kubectl version client flags Display the Kubernetes version running on the client and server wait code kubectl wait f FILENAME 124 resource group resource name 124 resource group l label 124 all for delete 124 for condition available options code Experimental Wait for a specific condition on one or many resources To learn more about command operations see the kubectl docs reference kubectl kubectl reference documentation Resource types The following table includes a list of all the supported resource types and their abbreviated aliases This output can be retrieved from kubectl api resources and was accurate as of Kubernetes 1 25 0 NAME SHORTNAMES APIVERSION NAMESPACED KIND bindings v1 true Binding componentstatuses cs v1 false ComponentStatus configmaps cm v1 true ConfigMap endpoints ep v1 true Endpoints events ev v1 true Event limitranges limits v1 true LimitRange namespaces ns v1 false Namespace nodes no v1 false Node persistentvolumeclaims pvc v1 true PersistentVolumeClaim persistentvolumes pv v1 false PersistentVolume pods po v1 true Pod podtemplates v1 true PodTemplate replicationcontrollers rc v1 true ReplicationController resourcequotas quota v1 true ResourceQuota secrets v1 true Secret serviceaccounts sa v1 true ServiceAccount services svc v1 true Service mutatingwebhookconfigurations admissionregistration k8s io v1 false MutatingWebhookConfiguration validatingwebhookconfigurations admissionregistration k8s io v1 false ValidatingWebhookConfiguration customresourcedefinitions crd crds apiextensions k8s io v1 false CustomResourceDefinition apiservices apiregistration k8s io v1 false APIService controllerrevisions apps v1 true ControllerRevision daemonsets ds apps v1 true DaemonSet deployments deploy apps v1 true Deployment replicasets rs apps v1 true ReplicaSet statefulsets sts apps v1 true StatefulSet tokenreviews authentication k8s io v1 false TokenReview localsubjectaccessreviews authorization k8s io v1 true LocalSubjectAccessReview selfsubjectaccessreviews authorization k8s io v1 false SelfSubjectAccessReview selfsubjectrulesreviews authorization k8s io v1 false SelfSubjectRulesReview subjectaccessreviews authorization k8s io v1 false SubjectAccessReview horizontalpodautoscalers hpa autoscaling v2 true HorizontalPodAutoscaler cronjobs cj batch v1 true CronJob jobs batch v1 true Job certificatesigningrequests csr certificates k8s io v1 false CertificateSigningRequest leases coordination k8s io v1 true Lease endpointslices discovery k8s io v1 true EndpointSlice events ev events k8s io v1 true Event flowschemas flowcontrol apiserver k8s io v1beta2 false FlowSchema prioritylevelconfigurations flowcontrol apiserver k8s io v1beta2 false PriorityLevelConfiguration ingressclasses networking k8s io v1 false IngressClass ingresses ing networking k8s io v1 true Ingress networkpolicies netpol networking k8s io v1 true NetworkPolicy runtimeclasses node k8s io v1 false RuntimeClass poddisruptionbudgets pdb policy v1 true PodDisruptionBudget podsecuritypolicies psp policy v1beta1 false PodSecurityPolicy clusterrolebindings rbac authorization k8s io v1 false ClusterRoleBinding clusterroles rbac authorization k8s io v1 false ClusterRole rolebindings rbac authorization k8s io v1 true RoleBinding roles rbac authorization k8s io v1 true Role priorityclasses pc scheduling k8s io v1 false PriorityClass csidrivers storage k8s io v1 false CSIDriver csinodes storage k8s io v1 false CSINode csistoragecapacities storage k8s io v1 true CSIStorageCapacity storageclasses sc storage k8s io v1 false StorageClass volumeattachments storage k8s io v1 false VolumeAttachment Output options Use the following sections for information about how you can format or sort the output of certain commands For details about which commands support the various output options see the kubectl docs reference kubectl kubectl reference documentation Formatting output The default output format for all kubectl commands is the human readable plain text format To output details to your terminal window in a specific format you can add either the o or output flags to a supported kubectl command Syntax shell kubectl command TYPE NAME o output format Depending on the kubectl operation the following output formats are supported Output format Description o custom columns spec Print a table using a comma separated list of custom columns custom columns o custom columns file filename Print a table using the custom columns custom columns template in the filename file o json Output a JSON formatted API object o jsonpath template Print the fields defined in a jsonpath docs reference kubectl jsonpath expression o jsonpath file filename Print the fields defined by the jsonpath docs reference kubectl jsonpath expression in the filename file o name Print only the resource name and nothing else o wide Output in the plain text format with any additional information For pods the node name is included o yaml Output a YAML formatted API object Example In this example the following command outputs the details for a single pod as a YAML formatted object shell kubectl get pod web pod 13je7 o yaml Remember See the kubectl docs reference kubectl kubectl reference documentation for details about which output format is supported by each command Custom columns To define custom columns and output only the details that you want into a table you can use the custom columns option You can choose to define the custom columns inline or use a template file o custom columns spec or o custom columns file filename Examples Inline shell kubectl get pods pod name o custom columns NAME metadata name RSRC metadata resourceVersion Template file shell kubectl get pods pod name o custom columns file template txt where the template txt file contains NAME RSRC metadata name metadata resourceVersion The result of running either command is similar to NAME RSRC submit queue 610995 Server side columns kubectl supports receiving specific column information from the server about objects This means that for any given resource the server will return columns and rows relevant to that resource for the client to print This allows for consistent human readable output across clients used against the same cluster by having the server encapsulate the details of printing This feature is enabled by default To disable it add the server print false flag to the kubectl get command Examples To print information about the status of a pod use a command like the following shell kubectl get pods pod name server print false The output is similar to NAME AGE pod name 1m Sorting list objects To output objects to a sorted list in your terminal window you can add the sort by flag to a supported kubectl command Sort your objects by specifying any numeric or string field with the sort by flag To specify a field use a jsonpath docs reference kubectl jsonpath expression Syntax shell kubectl command TYPE NAME sort by jsonpath exp Example To print a list of pods sorted by name you run shell kubectl get pods sort by metadata name Examples Common operations Use the following set of examples to help you familiarize yourself with running the commonly used kubectl operations kubectl apply Apply or Update a resource from a file or stdin shell Create a service using the definition in example service yaml kubectl apply f example service yaml Create a replication controller using the definition in example controller yaml kubectl apply f example controller yaml Create the objects that are defined in any yaml yml or json file within the directory directory kubectl apply f directory kubectl get List one or more resources shell List all pods in plain text output format kubectl get pods List all pods in plain text output format and include additional information such as node name kubectl get pods o wide List the replication controller with the specified name in plain text output format Tip You can shorten and replace the replicationcontroller resource type with the alias rc kubectl get replicationcontroller rc name List all replication controllers and services together in plain text output format kubectl get rc services List all daemon sets in plain text output format kubectl get ds List all pods running on node server01 kubectl get pods field selector spec nodeName server01 kubectl describe Display detailed state of one or more resources including the uninitialized ones by default shell Display the details of the node with name node name kubectl describe nodes node name Display the details of the pod with name pod name kubectl describe pods pod name Display the details of all the pods that are managed by the replication controller named rc name Remember Any pods that are created by the replication controller get prefixed with the name of the replication controller kubectl describe pods rc name Describe all pods kubectl describe pods The kubectl get command is usually used for retrieving one or more resources of the same resource type It features a rich set of flags that allows you to customize the output format using the o or output flag for example You can specify the w or watch flag to start watching updates to a particular object The kubectl describe command is more focused on describing the many related aspects of a specified resource It may invoke several API calls to the API server to build a view for the user For example the kubectl describe node command retrieves not only the information about the node but also a summary of the pods running on it the events generated for the node etc kubectl delete Delete resources either from a file stdin or specifying label selectors names resource selectors or resources shell Delete a pod using the type and name specified in the pod yaml file kubectl delete f pod yaml Delete all the pods and services that have the label label key label value kubectl delete pods services l label key label value Delete all pods including uninitialized ones kubectl delete pods all kubectl exec Execute a command against a container in a pod shell Get output from running date from pod pod name By default output is from the first container kubectl exec pod name date Get output from running date in container container name of pod pod name kubectl exec pod name c container name date Get an interactive TTY and run bin bash from pod pod name By default output is from the first container kubectl exec ti pod name bin bash kubectl logs Print the logs for a container in a pod shell Return a snapshot of the logs from pod pod name kubectl logs pod name Start streaming the logs from pod pod name This is similar to the tail f Linux command kubectl logs f pod name kubectl diff View a diff of the proposed updates to a cluster shell Diff resources included in pod json kubectl diff f pod json Diff file read from stdin cat service yaml kubectl diff f Examples Creating and using plugins Use the following set of examples to help you familiarize yourself with writing and using kubectl plugins shell create a simple plugin in any language and name the resulting executable file so that it begins with the prefix kubectl cat kubectl hello shell bin sh this plugin prints the words hello world echo hello world With a plugin written let s make it executable bash chmod a x kubectl hello and move it to a location in our PATH sudo mv kubectl hello usr local bin sudo chown root root usr local bin You have now created and installed a kubectl plugin You can begin using this plugin by invoking it from kubectl as if it were a regular command kubectl hello hello world shell You can uninstall a plugin by removing it from the folder in your PATH where you placed it sudo rm usr local bin kubectl hello In order to view all of the plugins that are available to kubectl use the kubectl plugin list subcommand shell kubectl plugin list The output is similar to The following kubectl compatible plugins are available usr local bin kubectl hello usr local bin kubectl foo usr local bin kubectl bar kubectl plugin list also warns you about plugins that are not executable or that are shadowed by other plugins for example shell sudo chmod x usr local bin kubectl foo remove execute permission kubectl plugin list The following kubectl compatible plugins are available usr local bin kubectl hello usr local bin kubectl foo warning usr local bin kubectl foo identified as a plugin but it is not executable usr local bin kubectl bar error one plugin warning was found You can think of plugins as a means to build more complex functionality on top of the existing kubectl commands shell cat kubectl whoami The next few examples assume that you already made kubectl whoami have the following contents shell bin bash this plugin makes use of the kubectl config command in order to output information about the current user based on the currently selected context kubectl config view template Current user Running the above command gives you an output containing the user for the current context in your KUBECONFIG file shell make the file executable sudo chmod x kubectl whoami and move it into your PATH sudo mv kubectl whoami usr local bin kubectl whoami Current user plugins user Read the kubectl reference documentation the kubectl command reference docs reference kubectl kubectl the command line arguments docs reference kubectl generated kubectl reference Learn about kubectl usage conventions docs reference kubectl conventions Read about JSONPath support docs reference kubectl jsonpath in kubectl Read about how to extend kubectl with plugins docs tasks extend kubectl kubectl plugins To find out more about plugins take a look at the example CLI plugin https github com kubernetes sample cli plugin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl | ---
title: kubectl
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
kubectl controls the Kubernetes cluster manager.
Find more information at: https://kubernetes.io/docs/reference/kubectl/
```
kubectl [flags]
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for kubectl</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl annotate](../kubectl_annotate/) - Update the annotations on a resource
* [kubectl api-resources](../kubectl_api-resources/) - Print the supported API resources on the server
* [kubectl api-versions](../kubectl_api-versions/) - Print the supported API versions on the server, in the form of "group/version"
* [kubectl apply](../kubectl_apply/) - Apply a configuration to a resource by file name or stdin
* [kubectl attach](../kubectl_attach/) - Attach to a running container
* [kubectl auth](../kubectl_auth/) - Inspect authorization
* [kubectl autoscale](../kubectl_autoscale/) - Auto-scale a deployment, replica set, stateful set, or replication controller
* [kubectl certificate](../kubectl_certificate/) - Modify certificate resources
* [kubectl cluster-info](../kubectl_cluster-info/) - Display cluster information
* [kubectl completion](../kubectl_completion/) - Output shell completion code for the specified shell (bash, zsh, fish, or powershell)
* [kubectl config](../kubectl_config/) - Modify kubeconfig files
* [kubectl cordon](../kubectl_cordon/) - Mark node as unschedulable
* [kubectl cp](../kubectl_cp/) - Copy files and directories to and from containers
* [kubectl create](../kubectl_create/) - Create a resource from a file or from stdin
* [kubectl debug](../kubectl_debug/) - Create debugging sessions for troubleshooting workloads and nodes
* [kubectl delete](../kubectl_delete/) - Delete resources by file names, stdin, resources and names, or by resources and label selector
* [kubectl describe](../kubectl_describe/) - Show details of a specific resource or group of resources
* [kubectl diff](../kubectl_diff/) - Diff the live version against a would-be applied version
* [kubectl drain](../kubectl_drain/) - Drain node in preparation for maintenance
* [kubectl edit](../kubectl_edit/) - Edit a resource on the server
* [kubectl events](../kubectl_events/) - List events
* [kubectl exec](../kubectl_exec/) - Execute a command in a container
* [kubectl explain](../kubectl_explain/) - Get documentation for a resource
* [kubectl expose](../kubectl_expose/) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes service
* [kubectl get](../kubectl_get/) - Display one or many resources
* [kubectl kustomize](../kubectl_kustomize/) - Build a kustomization target from a directory or URL
* [kubectl label](../kubectl_label/) - Update the labels on a resource
* [kubectl logs](../kubectl_logs/) - Print the logs for a container in a pod
* [kubectl options](../kubectl_options/) - Print the list of flags inherited by all commands
* [kubectl patch](../kubectl_patch/) - Update fields of a resource
* [kubectl plugin](../kubectl_plugin/) - Provides utilities for interacting with plugins
* [kubectl port-forward](../kubectl_port-forward/) - Forward one or more local ports to a pod
* [kubectl proxy](../kubectl_proxy/) - Run a proxy to the Kubernetes API server
* [kubectl replace](../kubectl_replace/) - Replace a resource by file name or stdin
* [kubectl rollout](../kubectl_rollout/) - Manage the rollout of a resource
* [kubectl run](../kubectl_run/) - Run a particular image on the cluster
* [kubectl scale](../kubectl_scale/) - Set a new size for a deployment, replica set, or replication controller
* [kubectl set](../kubectl_set/) - Set specific features on objects
* [kubectl taint](../kubectl_taint/) - Update the taints on one or more nodes
* [kubectl top](../kubectl_top/) - Display resource (CPU/memory) usage
* [kubectl uncordon](../kubectl_uncordon/) - Mark node as schedulable
* [kubectl version](../kubectl_version/) - Print the client and server version information
* [kubectl wait](../kubectl_wait/) - Experimental: Wait for a specific condition on one or many resources
| kubernetes reference | title kubectl content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project kubectl controls the Kubernetes cluster manager Find more information at https kubernetes io docs reference kubectl kubectl flags table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for kubectl p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl annotate kubectl annotate Update the annotations on a resource kubectl api resources kubectl api resources Print the supported API resources on the server kubectl api versions kubectl api versions Print the supported API versions on the server in the form of group version kubectl apply kubectl apply Apply a configuration to a resource by file name or stdin kubectl attach kubectl attach Attach to a running container kubectl auth kubectl auth Inspect authorization kubectl autoscale kubectl autoscale Auto scale a deployment replica set stateful set or replication controller kubectl certificate kubectl certificate Modify certificate resources kubectl cluster info kubectl cluster info Display cluster information kubectl completion kubectl completion Output shell completion code for the specified shell bash zsh fish or powershell kubectl config kubectl config Modify kubeconfig files kubectl cordon kubectl cordon Mark node as unschedulable kubectl cp kubectl cp Copy files and directories to and from containers kubectl create kubectl create Create a resource from a file or from stdin kubectl debug kubectl debug Create debugging sessions for troubleshooting workloads and nodes kubectl delete kubectl delete Delete resources by file names stdin resources and names or by resources and label selector kubectl describe kubectl describe Show details of a specific resource or group of resources kubectl diff kubectl diff Diff the live version against a would be applied version kubectl drain kubectl drain Drain node in preparation for maintenance kubectl edit kubectl edit Edit a resource on the server kubectl events kubectl events List events kubectl exec kubectl exec Execute a command in a container kubectl explain kubectl explain Get documentation for a resource kubectl expose kubectl expose Take a replication controller service deployment or pod and expose it as a new Kubernetes service kubectl get kubectl get Display one or many resources kubectl kustomize kubectl kustomize Build a kustomization target from a directory or URL kubectl label kubectl label Update the labels on a resource kubectl logs kubectl logs Print the logs for a container in a pod kubectl options kubectl options Print the list of flags inherited by all commands kubectl patch kubectl patch Update fields of a resource kubectl plugin kubectl plugin Provides utilities for interacting with plugins kubectl port forward kubectl port forward Forward one or more local ports to a pod kubectl proxy kubectl proxy Run a proxy to the Kubernetes API server kubectl replace kubectl replace Replace a resource by file name or stdin kubectl rollout kubectl rollout Manage the rollout of a resource kubectl run kubectl run Run a particular image on the cluster kubectl scale kubectl scale Set a new size for a deployment replica set or replication controller kubectl set kubectl set Set specific features on objects kubectl taint kubectl taint Update the taints on one or more nodes kubectl top kubectl top Display resource CPU memory usage kubectl uncordon kubectl uncordon Mark node as schedulable kubectl version kubectl version Print the client and server version information kubectl wait kubectl wait Experimental Wait for a specific condition on one or many resources |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl attach autogenerated true | ---
title: kubectl attach
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Attach to a process that is already running inside an existing container.
```
kubectl attach (POD | TYPE/NAME) -c CONTAINER
```
##
```
# Get output from running pod mypod; use the 'kubectl.kubernetes.io/default-container' annotation
# for selecting the container to be attached or the first container in the pod will be chosen
kubectl attach mypod
# Get output from ruby-container from pod mypod
kubectl attach mypod -c ruby-container
# Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod
# and sends stdout/stderr from 'bash' back to the client
kubectl attach mypod -c ruby-container -i -t
# Get output from the first pod of a replica set named nginx
kubectl attach rs/nginx
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-c, --container string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Container name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for attach</p></td>
</tr>
<tr>
<td colspan="2">--pod-running-timeout duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running</p></td>
</tr>
<tr>
<td colspan="2">-q, --quiet</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Only print output from the remote session</p></td>
</tr>
<tr>
<td colspan="2">-i, --stdin</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Pass stdin to the container</p></td>
</tr>
<tr>
<td colspan="2">-t, --tty</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Stdin is a TTY</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl attach content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Attach to a process that is already running inside an existing container kubectl attach POD TYPE NAME c CONTAINER Get output from running pod mypod use the kubectl kubernetes io default container annotation for selecting the container to be attached or the first container in the pod will be chosen kubectl attach mypod Get output from ruby container from pod mypod kubectl attach mypod c ruby container Switch to raw terminal mode sends stdin to bash in ruby container from pod mypod and sends stdout stderr from bash back to the client kubectl attach mypod c ruby container i t Get output from the first pod of a replica set named nginx kubectl attach rs nginx table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 c container string td tr tr td td td style line height 130 word wrap break word p Container name If omitted use the kubectl kubernetes io default container annotation for selecting the container to be attached or the first container in the pod will be chosen p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for attach p td tr tr td colspan 2 pod running timeout duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p The length of time like 5s 2m or 3h higher than zero to wait until at least one pod is running p td tr tr td colspan 2 q quiet td tr tr td td td style line height 130 word wrap break word p Only print output from the remote session p td tr tr td colspan 2 i stdin td tr tr td td td style line height 130 word wrap break word p Pass stdin to the container p td tr tr td colspan 2 t tty td tr tr td td td style line height 130 word wrap break word p Stdin is a TTY p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl set subject | ---
title: kubectl set subject
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Update the user, group, or service account in a role binding or cluster role binding.
```
kubectl set subject (-f FILENAME | TYPE NAME) [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run=server|client|none]
```
##
```
# Update a cluster role binding for serviceaccount1
kubectl set subject clusterrolebinding admin --serviceaccount=namespace:serviceaccount1
# Update a role binding for user1, user2, and group1
kubectl set subject rolebinding admin --user=user1 --user=user2 --group=group1
# Print the result (in YAML format) of updating rolebinding subjects from a local, without hitting the server
kubectl create rolebinding admin --role=admin --user=admin -o yaml --dry-run=client | kubectl set subject --local -f - --user=foo -o yaml
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Select all resources, in the namespace of the specified resource types</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-set"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files the resource to update the subjects</p></td>
</tr>
<tr>
<td colspan="2">--group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Groups to bind to the role</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for subject</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--local</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, set subject will NOT contact api-server but run locally.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--serviceaccount strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Service accounts to bind to the role</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--user strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Usernames to bind to the role</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl set](../) - Set specific features on objects
| kubernetes reference | title kubectl set subject content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Update the user group or service account in a role binding or cluster role binding kubectl set subject f FILENAME TYPE NAME user username group groupname serviceaccount namespace serviceaccountname dry run server client none Update a cluster role binding for serviceaccount1 kubectl set subject clusterrolebinding admin serviceaccount namespace serviceaccount1 Update a role binding for user1 user2 and group1 kubectl set subject rolebinding admin user user1 user user2 group group1 Print the result in YAML format of updating rolebinding subjects from a local without hitting the server kubectl create rolebinding admin role admin user admin o yaml dry run client kubectl set subject local f user foo o yaml table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all td tr tr td td td style line height 130 word wrap break word p Select all resources in the namespace of the specified resource types p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl set td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files the resource to update the subjects p td tr tr td colspan 2 group strings td tr tr td td td style line height 130 word wrap break word p Groups to bind to the role p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for subject p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 local td tr tr td td td style line height 130 word wrap break word p If true set subject will NOT contact api server but run locally p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 serviceaccount strings td tr tr td td td style line height 130 word wrap break word p Service accounts to bind to the role p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 user strings td tr tr td td td style line height 130 word wrap break word p Usernames to bind to the role p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl set Set specific features on objects |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl set selector autogenerated true | ---
title: kubectl set selector
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Set the selector on a resource. Note that the new selector will overwrite the old selector if the resource had one prior to the invocation of 'set selector'.
A selector must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. Note: currently selectors can only be set on Service objects.
```
kubectl set selector (-f FILENAME | TYPE NAME) EXPRESSIONS [--resource-version=version]
```
##
```
# Set the labels and selector before creating a deployment/service pair
kubectl create service clusterip my-svc --clusterip="None" -o yaml --dry-run=client | kubectl set selector --local -f - 'environment=qa' -o yaml | kubectl create -f -
kubectl create deployment my-dep -o yaml --dry-run=client | kubectl label --local -f - environment=qa -o yaml | kubectl create -f -
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Select all resources in the namespace of the specified resource types</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-set"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>identifying the resource.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for selector</p></td>
</tr>
<tr>
<td colspan="2">--local</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, annotation will NOT contact api-server but run locally.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--resource-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-empty, the selectors update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl set](../) - Set specific features on objects
| kubernetes reference | title kubectl set selector content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Set the selector on a resource Note that the new selector will overwrite the old selector if the resource had one prior to the invocation of set selector A selector must begin with a letter or number and may contain letters numbers hyphens dots and underscores up to 63 characters If resource version is specified then updates will use this resource version otherwise the existing resource version will be used Note currently selectors can only be set on Service objects kubectl set selector f FILENAME TYPE NAME EXPRESSIONS resource version version Set the labels and selector before creating a deployment service pair kubectl create service clusterip my svc clusterip None o yaml dry run client kubectl set selector local f environment qa o yaml kubectl create f kubectl create deployment my dep o yaml dry run client kubectl label local f environment qa o yaml kubectl create f table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all td tr tr td td td style line height 130 word wrap break word p Select all resources in the namespace of the specified resource types p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl set td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p identifying the resource p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for selector p td tr tr td colspan 2 local td tr tr td td td style line height 130 word wrap break word p If true annotation will NOT contact api server but run locally p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 R recursive nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 resource version string td tr tr td td td style line height 130 word wrap break word p If non empty the selectors update will only succeed if this is the current resource version for the object Only valid when specifying a single resource p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl set Set specific features on objects |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl set env | ---
title: kubectl set env
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Update environment variables on a pod template.
List environment variable definitions in one or more pods, pod templates. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations). View or modify the environment variable definitions on all containers in the specified pods or pod templates, or just those that match a wildcard.
If "--env -" is passed, environment variables can be read from STDIN using the standard env syntax.
Possible resources include (case insensitive):
pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), statefulset (sts), cronjob (cj), replicaset (rs)
```
kubectl set env RESOURCE/NAME KEY_1=VAL_1 ... KEY_N=VAL_N
```
##
```
# Update deployment 'registry' with a new environment variable
kubectl set env deployment/registry STORAGE_DIR=/local
# List the environment variables defined on a deployments 'sample-build'
kubectl set env deployment/sample-build --list
# List the environment variables defined on all pods
kubectl set env pods --all --list
# Output modified deployment in YAML, and does not alter the object on the server
kubectl set env deployment/sample-build STORAGE_DIR=/data -o yaml
# Update all containers in all replication controllers in the project to have ENV=prod
kubectl set env rc --all ENV=prod
# Import environment from a secret
kubectl set env --from=secret/mysecret deployment/myapp
# Import environment from a config map with a prefix
kubectl set env --from=configmap/myconfigmap --prefix=MYSQL_ deployment/myapp
# Import specific keys from a config map
kubectl set env --keys=my-example-key --from=configmap/myconfigmap deployment/myapp
# Remove the environment variable ENV from container 'c1' in all deployment configs
kubectl set env deployments --all --containers="c1" ENV-
# Remove the environment variable ENV from a deployment definition on disk and
# update the deployment config on the server
kubectl set env -f deploy.json ENV-
# Set some of the local shell environment into a deployment config on the server
env | grep RAILS_ | kubectl set env -e - deployment/registry
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, select all resources in the namespace of the specified resource types</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">-c, --containers string Default: "*"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The names of containers in the selected pod templates to change - may use wildcards</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">-e, --env strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Specify a key-value pair for an environment variable to set into each container.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-set"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files the resource to update the env</p></td>
</tr>
<tr>
<td colspan="2">--from string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of a resource from which to inject environment variables</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for env</p></td>
</tr>
<tr>
<td colspan="2">--keys strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Comma-separated list of keys to import from specified resource</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--list</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, display the environment and any changes in the standard format. this flag will removed when we have kubectl view env.</p></td>
</tr>
<tr>
<td colspan="2">--local</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, set env will NOT contact api-server but run locally.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--overwrite Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, allow environment to be overwritten, otherwise reject updates that overwrite existing environment.</p></td>
</tr>
<tr>
<td colspan="2">--prefix string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Prefix to append to variable names</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--resolve</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, show secret or configmap references when listing variables</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl set](../) - Set specific features on objects
| kubernetes reference | title kubectl set env content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Update environment variables on a pod template List environment variable definitions in one or more pods pod templates Add update or remove container environment variable definitions in one or more pod templates within replication controllers or deployment configurations View or modify the environment variable definitions on all containers in the specified pods or pod templates or just those that match a wildcard If env is passed environment variables can be read from STDIN using the standard env syntax Possible resources include case insensitive pod po replicationcontroller rc deployment deploy daemonset ds statefulset sts cronjob cj replicaset rs kubectl set env RESOURCE NAME KEY 1 VAL 1 KEY N VAL N Update deployment registry with a new environment variable kubectl set env deployment registry STORAGE DIR local List the environment variables defined on a deployments sample build kubectl set env deployment sample build list List the environment variables defined on all pods kubectl set env pods all list Output modified deployment in YAML and does not alter the object on the server kubectl set env deployment sample build STORAGE DIR data o yaml Update all containers in all replication controllers in the project to have ENV prod kubectl set env rc all ENV prod Import environment from a secret kubectl set env from secret mysecret deployment myapp Import environment from a config map with a prefix kubectl set env from configmap myconfigmap prefix MYSQL deployment myapp Import specific keys from a config map kubectl set env keys my example key from configmap myconfigmap deployment myapp Remove the environment variable ENV from container c1 in all deployment configs kubectl set env deployments all containers c1 ENV Remove the environment variable ENV from a deployment definition on disk and update the deployment config on the server kubectl set env f deploy json ENV Set some of the local shell environment into a deployment config on the server env grep RAILS kubectl set env e deployment registry table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all td tr tr td td td style line height 130 word wrap break word p If true select all resources in the namespace of the specified resource types p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 c containers string nbsp nbsp nbsp nbsp nbsp Default td tr tr td td td style line height 130 word wrap break word p The names of containers in the selected pod templates to change may use wildcards p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 e env strings td tr tr td td td style line height 130 word wrap break word p Specify a key value pair for an environment variable to set into each container p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl set td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files the resource to update the env p td tr tr td colspan 2 from string td tr tr td td td style line height 130 word wrap break word p The name of a resource from which to inject environment variables p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for env p td tr tr td colspan 2 keys strings td tr tr td td td style line height 130 word wrap break word p Comma separated list of keys to import from specified resource p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 list td tr tr td td td style line height 130 word wrap break word p If true display the environment and any changes in the standard format this flag will removed when we have kubectl view env p td tr tr td colspan 2 local td tr tr td td td style line height 130 word wrap break word p If true set env will NOT contact api server but run locally p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 overwrite nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true allow environment to be overwritten otherwise reject updates that overwrite existing environment p td tr tr td colspan 2 prefix string td tr tr td td td style line height 130 word wrap break word p Prefix to append to variable names p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 resolve td tr tr td td td style line height 130 word wrap break word p If true show secret or configmap references when listing variables p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl set Set specific features on objects |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl set serviceaccount autogenerated true | ---
title: kubectl set serviceaccount
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Update the service account of pod template resources.
Possible resources (case insensitive) can be:
replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs), statefulset
```
kubectl set serviceaccount (-f FILENAME | TYPE NAME) SERVICE_ACCOUNT
```
##
```
# Set deployment nginx-deployment's service account to serviceaccount1
kubectl set serviceaccount deployment nginx-deployment serviceaccount1
# Print the result (in YAML format) of updated nginx deployment with the service account from local file, without hitting the API server
kubectl set sa -f nginx-deployment.yaml serviceaccount1 --local --dry-run=client -o yaml
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Select all resources, in the namespace of the specified resource types</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-set"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to get from a server.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for serviceaccount</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--local</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, set serviceaccount will NOT contact api-server but run locally.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl set](../) - Set specific features on objects
| kubernetes reference | title kubectl set serviceaccount content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Update the service account of pod template resources Possible resources case insensitive can be replicationcontroller rc deployment deploy daemonset ds job replicaset rs statefulset kubectl set serviceaccount f FILENAME TYPE NAME SERVICE ACCOUNT Set deployment nginx deployment s service account to serviceaccount1 kubectl set serviceaccount deployment nginx deployment serviceaccount1 Print the result in YAML format of updated nginx deployment with the service account from local file without hitting the API server kubectl set sa f nginx deployment yaml serviceaccount1 local dry run client o yaml table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all td tr tr td td td style line height 130 word wrap break word p Select all resources in the namespace of the specified resource types p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl set td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to get from a server p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for serviceaccount p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 local td tr tr td td td style line height 130 word wrap break word p If true set serviceaccount will NOT contact api server but run locally p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl set Set specific features on objects |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kubectl set resources contenttype tool reference weight 30 autogenerated true | ---
title: kubectl set resources
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Specify compute resource requirements (CPU, memory) for any resource that defines a pod template. If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits.
For each compute resource, if a limit is specified and a request is omitted, the request will default to the limit.
Possible resources include (case insensitive): Use "kubectl api-resources" for a complete list of supported resources..
```
kubectl set resources (-f FILENAME | TYPE NAME) ([--limits=LIMITS & --requests=REQUESTS]
```
##
```
# Set a deployments nginx container cpu limits to "200m" and memory to "512Mi"
kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi
# Set the resource request and limits for all containers in nginx
kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi
# Remove the resource requests for resources on containers in nginx
kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0
# Print the result (in yaml format) of updating nginx container limits from a local, without hitting the server
kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --local -o yaml
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Select all resources, in the namespace of the specified resource types</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">-c, --containers string Default: "*"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The names of containers in the selected pod templates to change, all containers are selected by default - may use wildcards</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-set"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to get from a server.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for resources</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--limits string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.</p></td>
</tr>
<tr>
<td colspan="2">--local</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, set resources will NOT contact api-server but run locally.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--requests string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl set](../) - Set specific features on objects
| kubernetes reference | title kubectl set resources content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Specify compute resource requirements CPU memory for any resource that defines a pod template If a pod is successfully scheduled it is guaranteed the amount of resource requested but may burst up to its specified limits For each compute resource if a limit is specified and a request is omitted the request will default to the limit Possible resources include case insensitive Use kubectl api resources for a complete list of supported resources kubectl set resources f FILENAME TYPE NAME limits LIMITS requests REQUESTS Set a deployments nginx container cpu limits to 200m and memory to 512Mi kubectl set resources deployment nginx c nginx limits cpu 200m memory 512Mi Set the resource request and limits for all containers in nginx kubectl set resources deployment nginx limits cpu 200m memory 512Mi requests cpu 100m memory 256Mi Remove the resource requests for resources on containers in nginx kubectl set resources deployment nginx limits cpu 0 memory 0 requests cpu 0 memory 0 Print the result in yaml format of updating nginx container limits from a local without hitting the server kubectl set resources f path to file yaml limits cpu 200m memory 512Mi local o yaml table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all td tr tr td td td style line height 130 word wrap break word p Select all resources in the namespace of the specified resource types p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 c containers string nbsp nbsp nbsp nbsp nbsp Default td tr tr td td td style line height 130 word wrap break word p The names of containers in the selected pod templates to change all containers are selected by default may use wildcards p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl set td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to get from a server p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for resources p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 limits string td tr tr td td td style line height 130 word wrap break word p The resource requirement requests for this container For example cpu 100m memory 256Mi Note that server side components may assign requests depending on the server configuration such as limit ranges p td tr tr td colspan 2 local td tr tr td td td style line height 130 word wrap break word p If true set resources will NOT contact api server but run locally p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 requests string td tr tr td td td style line height 130 word wrap break word p The resource requirement requests for this container For example cpu 100m memory 256Mi Note that server side components may assign requests depending on the server configuration such as limit ranges p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl set Set specific features on objects |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl set image | ---
title: kubectl set image
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Update existing container image(s) of resources.
Possible resources include (case insensitive):
pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), statefulset (sts), cronjob (cj), replicaset (rs)
```
kubectl set image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N
```
##
```
# Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'
kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1
# Update all deployments' and rc's nginx container's image to 'nginx:1.9.1'
kubectl set image deployments,rc nginx=nginx:1.9.1 --all
# Update image of all containers of daemonset abc to 'nginx:1.9.1'
kubectl set image daemonset abc *=nginx:1.9.1
# Print result (in yaml format) of updating nginx container image from local file, without hitting the server
kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Select all resources, in the namespace of the specified resource types</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-set"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to get from a server.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for image</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--local</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, set image will NOT contact api-server but run locally.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl set](../) - Set specific features on objects
| kubernetes reference | title kubectl set image content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Update existing container image s of resources Possible resources include case insensitive pod po replicationcontroller rc deployment deploy daemonset ds statefulset sts cronjob cj replicaset rs kubectl set image f FILENAME TYPE NAME CONTAINER NAME 1 CONTAINER IMAGE 1 CONTAINER NAME N CONTAINER IMAGE N Set a deployment s nginx container image to nginx 1 9 1 and its busybox container image to busybox kubectl set image deployment nginx busybox busybox nginx nginx 1 9 1 Update all deployments and rc s nginx container s image to nginx 1 9 1 kubectl set image deployments rc nginx nginx 1 9 1 all Update image of all containers of daemonset abc to nginx 1 9 1 kubectl set image daemonset abc nginx 1 9 1 Print result in yaml format of updating nginx container image from local file without hitting the server kubectl set image f path to file yaml nginx nginx 1 9 1 local o yaml table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all td tr tr td td td style line height 130 word wrap break word p Select all resources in the namespace of the specified resource types p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl set td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to get from a server p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for image p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 local td tr tr td td td style line height 130 word wrap break word p If true set image will NOT contact api server but run locally p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl set Set specific features on objects |
kubernetes reference nolist true contenttype tool reference weight 30 autogenerated true title kubectl set | ---
title: kubectl set
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Configure application resources.
These commands help you make changes to existing application resources.
```
kubectl set SUBCOMMAND
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for set</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
* [kubectl set env](kubectl_set_env/) - Update environment variables on a pod template
* [kubectl set image](kubectl_set_image/) - Update the image of a pod template
* [kubectl set resources](kubectl_set_resources/) - Update resource requests/limits on objects with pod templates
* [kubectl set selector](kubectl_set_selector/) - Set the selector on a resource
* [kubectl set serviceaccount](kubectl_set_serviceaccount/) - Update the service account of a resource
* [kubectl set subject](kubectl_set_subject/) - Update the user, group, or service account in a role binding or cluster role binding
| kubernetes reference | title kubectl set content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Configure application resources These commands help you make changes to existing application resources kubectl set SUBCOMMAND table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for set p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager kubectl set env kubectl set env Update environment variables on a pod template kubectl set image kubectl set image Update the image of a pod template kubectl set resources kubectl set resources Update resource requests limits on objects with pod templates kubectl set selector kubectl set selector Set the selector on a resource kubectl set serviceaccount kubectl set serviceaccount Update the service account of a resource kubectl set subject kubectl set subject Update the user group or service account in a role binding or cluster role binding |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl run autogenerated true | ---
title: kubectl run
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create and run a particular image in a pod.
```
kubectl run NAME --image=image [--env="key=value"] [--port=port] [--dry-run=server|client] [--overrides=inline-json] [--command] -- [COMMAND] [args...]
```
##
```
# Start a nginx pod
kubectl run nginx --image=nginx
# Start a hazelcast pod and let the container expose port 5701
kubectl run hazelcast --image=hazelcast/hazelcast --port=5701
# Start a hazelcast pod and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container
kubectl run hazelcast --image=hazelcast/hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
# Start a hazelcast pod and set labels "app=hazelcast" and "env=prod" in the container
kubectl run hazelcast --image=hazelcast/hazelcast --labels="app=hazelcast,env=prod"
# Dry run; print the corresponding API objects without creating them
kubectl run nginx --image=nginx --dry-run=client
# Start a nginx pod, but overload the spec with a partial set of values parsed from JSON
kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
# Start a busybox pod and keep it in the foreground, don't restart it if it exits
kubectl run -i -t busybox --image=busybox --restart=Never
# Start the nginx pod using the default command, but use custom arguments (arg1 .. argN) for that command
kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
# Start the nginx pod using a different command and custom arguments
kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--annotations strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Annotations to apply to the pod.</p></td>
</tr>
<tr>
<td colspan="2">--attach</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned.</p></td>
</tr>
<tr>
<td colspan="2">--cascade string[="background"] Default: "background"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "background", "orphan", or "foreground". Selects the deletion cascading strategy for the dependents (e.g. Pods created by a ReplicationController). Defaults to background.</p></td>
</tr>
<tr>
<td colspan="2">--command</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--env strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Environment variables to set in the container.</p></td>
</tr>
<tr>
<td colspan="2">--expose --port</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, create a ClusterIP service associated with the pod. Requires --port.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-run"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>to use to replace the resource.</p></td>
</tr>
<tr>
<td colspan="2">--force</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.</p></td>
</tr>
<tr>
<td colspan="2">--grace-period int Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion).</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for run</p></td>
</tr>
<tr>
<td colspan="2">--image string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The image for the container to run.</p></td>
</tr>
<tr>
<td colspan="2">--image-pull-policy string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server.</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process a kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-l, --labels string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Comma separated labels to apply to the pod. Will override previous values.</p></td>
</tr>
<tr>
<td colspan="2">--leave-stdin-open</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--override-type string Default: "merge"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The method used to override the generated object: json, merge, or strategic.</p></td>
</tr>
<tr>
<td colspan="2">--overrides string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.</p></td>
</tr>
<tr>
<td colspan="2">--pod-running-timeout duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running</p></td>
</tr>
<tr>
<td colspan="2">--port string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The port that this container exposes.</p></td>
</tr>
<tr>
<td colspan="2">--privileged</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, run the container in privileged mode.</p></td>
</tr>
<tr>
<td colspan="2">-q, --quiet</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, suppress prompt messages.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--restart string Default: "Always"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The restart policy for this Pod. Legal values [Always, OnFailure, Never].</p></td>
</tr>
<tr>
<td colspan="2">--rm</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, delete the pod after it exits. Only valid when attaching to the container, e.g. with '--attach' or with '-i/--stdin'.</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">-i, --stdin</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Keep stdin open on the container in the pod, even if nothing is attached.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--timeout duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object</p></td>
</tr>
<tr>
<td colspan="2">-t, --tty</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Allocate a TTY for the container in the pod.</p></td>
</tr>
<tr>
<td colspan="2">--wait</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, wait for resources to be gone before returning. This waits for finalizers.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl run content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create and run a particular image in a pod kubectl run NAME image image env key value port port dry run server client overrides inline json command COMMAND args Start a nginx pod kubectl run nginx image nginx Start a hazelcast pod and let the container expose port 5701 kubectl run hazelcast image hazelcast hazelcast port 5701 Start a hazelcast pod and set environment variables DNS DOMAIN cluster and POD NAMESPACE default in the container kubectl run hazelcast image hazelcast hazelcast env DNS DOMAIN cluster env POD NAMESPACE default Start a hazelcast pod and set labels app hazelcast and env prod in the container kubectl run hazelcast image hazelcast hazelcast labels app hazelcast env prod Dry run print the corresponding API objects without creating them kubectl run nginx image nginx dry run client Start a nginx pod but overload the spec with a partial set of values parsed from JSON kubectl run nginx image nginx overrides apiVersion v1 spec Start a busybox pod and keep it in the foreground don t restart it if it exits kubectl run i t busybox image busybox restart Never Start the nginx pod using the default command but use custom arguments arg1 argN for that command kubectl run nginx image nginx arg1 arg2 argN Start the nginx pod using a different command and custom arguments kubectl run nginx image nginx command cmd arg1 argN table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 annotations strings td tr tr td td td style line height 130 word wrap break word p Annotations to apply to the pod p td tr tr td colspan 2 attach td tr tr td td td style line height 130 word wrap break word p If true wait for the Pod to start running and then attach to the Pod as if kubectl attach were called Default false unless i stdin is set in which case the default is true With restart Never the exit code of the container process is returned p td tr tr td colspan 2 cascade string background nbsp nbsp nbsp nbsp nbsp Default background td tr tr td td td style line height 130 word wrap break word p Must be quot background quot quot orphan quot or quot foreground quot Selects the deletion cascading strategy for the dependents e g Pods created by a ReplicationController Defaults to background p td tr tr td colspan 2 command td tr tr td td td style line height 130 word wrap break word p If true and extra arguments are present use them as the command field in the container rather than the args field which is the default p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 env strings td tr tr td td td style line height 130 word wrap break word p Environment variables to set in the container p td tr tr td colspan 2 expose port td tr tr td td td style line height 130 word wrap break word p If true create a ClusterIP service associated with the pod Requires port p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl run td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p to use to replace the resource p td tr tr td colspan 2 force td tr tr td td td style line height 130 word wrap break word p If true immediately remove resources from API and bypass graceful deletion Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation p td tr tr td colspan 2 grace period int nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p Period of time in seconds given to the resource to terminate gracefully Ignored if negative Set to 1 for immediate shutdown Can only be set to 0 when force is true force deletion p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for run p td tr tr td colspan 2 image string td tr tr td td td style line height 130 word wrap break word p The image for the container to run p td tr tr td colspan 2 image pull policy string td tr tr td td td style line height 130 word wrap break word p The image pull policy for the container If left empty this value will not be specified by the client and defaulted by the server p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process a kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 l labels string td tr tr td td td style line height 130 word wrap break word p Comma separated labels to apply to the pod Will override previous values p td tr tr td colspan 2 leave stdin open td tr tr td td td style line height 130 word wrap break word p If the pod is started in interactive mode or with stdin leave stdin open after the first attach completes By default stdin will be closed after the first attach completes p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 override type string nbsp nbsp nbsp nbsp nbsp Default merge td tr tr td td td style line height 130 word wrap break word p The method used to override the generated object json merge or strategic p td tr tr td colspan 2 overrides string td tr tr td td td style line height 130 word wrap break word p An inline JSON override for the generated object If this is non empty it is used to override the generated object Requires that the object supply a valid apiVersion field p td tr tr td colspan 2 pod running timeout duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p The length of time like 5s 2m or 3h higher than zero to wait until at least one pod is running p td tr tr td colspan 2 port string td tr tr td td td style line height 130 word wrap break word p The port that this container exposes p td tr tr td colspan 2 privileged td tr tr td td td style line height 130 word wrap break word p If true run the container in privileged mode p td tr tr td colspan 2 q quiet td tr tr td td td style line height 130 word wrap break word p If true suppress prompt messages p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 restart string nbsp nbsp nbsp nbsp nbsp Default Always td tr tr td td td style line height 130 word wrap break word p The restart policy for this Pod Legal values Always OnFailure Never p td tr tr td colspan 2 rm td tr tr td td td style line height 130 word wrap break word p If true delete the pod after it exits Only valid when attaching to the container e g with attach or with i stdin p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 i stdin td tr tr td td td style line height 130 word wrap break word p Keep stdin open on the container in the pod even if nothing is attached p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 timeout duration td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a delete zero means determine a timeout from the size of the object p td tr tr td colspan 2 t tty td tr tr td td td style line height 130 word wrap break word p Allocate a TTY for the container in the pod p td tr tr td colspan 2 wait td tr tr td td td style line height 130 word wrap break word p If true wait for resources to be gone before returning This waits for finalizers p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl debug autogenerated true | ---
title: kubectl debug
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Debug cluster resources using interactive debugging containers.
'debug' provides automation for common debugging tasks for cluster objects identified by resource and name. Pods will be used by default if no resource is specified.
The action taken by 'debug' varies depending on what resource is specified. Supported actions include:
* Workload: Create a copy of an existing pod with certain attributes changed, for example changing the image tag to a new version.
* Workload: Add an ephemeral container to an already running pod, for example to add debugging utilities without restarting the pod.
* Node: Create a new pod that runs in the node's host namespaces and can access the node's filesystem.
```
kubectl debug (POD | TYPE[[.VERSION].GROUP]/NAME) [ -- COMMAND [args...] ]
```
##
```
# Create an interactive debugging session in pod mypod and immediately attach to it.
kubectl debug mypod -it --image=busybox
# Create an interactive debugging session for the pod in the file pod.yaml and immediately attach to it.
# (requires the EphemeralContainers feature to be enabled in the cluster)
kubectl debug -f pod.yaml -it --image=busybox
# Create a debug container named debugger using a custom automated debugging image.
kubectl debug --image=myproj/debug-tools -c debugger mypod
# Create a copy of mypod adding a debug container and attach to it
kubectl debug mypod -it --image=busybox --copy-to=my-debugger
# Create a copy of mypod changing the command of mycontainer
kubectl debug mypod -it --copy-to=my-debugger --container=mycontainer -- sh
# Create a copy of mypod changing all container images to busybox
kubectl debug mypod --copy-to=my-debugger --set-image=*=busybox
# Create a copy of mypod adding a debug container and changing container images
kubectl debug mypod -it --copy-to=my-debugger --image=debian --set-image=app=app:debug,sidecar=sidecar:debug
# Create an interactive debugging session on a node and immediately attach to it.
# The container will run in the host namespaces and the host's filesystem will be mounted at /host
kubectl debug node/mynode -it --image=busybox
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--arguments-only</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If specified, everything after -- will be passed to the new container as Args instead of Command.</p></td>
</tr>
<tr>
<td colspan="2">--attach</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, wait for the container to start running, and then attach as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true.</p></td>
</tr>
<tr>
<td colspan="2">-c, --container string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Container name to use for debug container.</p></td>
</tr>
<tr>
<td colspan="2">--copy-to string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Create a copy of the target Pod with this name.</p></td>
</tr>
<tr>
<td colspan="2">--custom string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a JSON or YAML file containing a partial container spec to customize built-in debug profiles.</p></td>
</tr>
<tr>
<td colspan="2">--env stringToString Default: []</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Environment variables to set in the container.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>identifying the resource to debug</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for debug</p></td>
</tr>
<tr>
<td colspan="2">--image string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Container image to use for debug container.</p></td>
</tr>
<tr>
<td colspan="2">--image-pull-policy string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server.</p></td>
</tr>
<tr>
<td colspan="2">--keep-annotations</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the original pod annotations.(This flag only works when used with '--copy-to')</p></td>
</tr>
<tr>
<td colspan="2">--keep-init-containers Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Run the init containers for the pod. Defaults to true.(This flag only works when used with '--copy-to')</p></td>
</tr>
<tr>
<td colspan="2">--keep-labels</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the original pod labels.(This flag only works when used with '--copy-to')</p></td>
</tr>
<tr>
<td colspan="2">--keep-liveness</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the original pod liveness probes.(This flag only works when used with '--copy-to')</p></td>
</tr>
<tr>
<td colspan="2">--keep-readiness</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the original pod readiness probes.(This flag only works when used with '--copy-to')</p></td>
</tr>
<tr>
<td colspan="2">--keep-startup</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the original startup probes.(This flag only works when used with '--copy-to')</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "legacy"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Options are "legacy", "general", "baseline", "netadmin", "restricted" or "sysadmin".</p></td>
</tr>
<tr>
<td colspan="2">-q, --quiet</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, suppress informational messages.</p></td>
</tr>
<tr>
<td colspan="2">--replace</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When used with '--copy-to', delete the original Pod.</p></td>
</tr>
<tr>
<td colspan="2">--same-node</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When used with '--copy-to', schedule the copy of target Pod on the same node.</p></td>
</tr>
<tr>
<td colspan="2">--set-image stringToString Default: []</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When used with '--copy-to', a list of name=image pairs for changing container images, similar to how 'kubectl set image' works.</p></td>
</tr>
<tr>
<td colspan="2">--share-processes Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When used with '--copy-to', enable process namespace sharing in the copy.</p></td>
</tr>
<tr>
<td colspan="2">-i, --stdin</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Keep stdin open on the container(s) in the pod, even if nothing is attached.</p></td>
</tr>
<tr>
<td colspan="2">--target string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When using an ephemeral container, target processes in this container name.</p></td>
</tr>
<tr>
<td colspan="2">-t, --tty</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Allocate a TTY for the debugging container.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl debug content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Debug cluster resources using interactive debugging containers debug provides automation for common debugging tasks for cluster objects identified by resource and name Pods will be used by default if no resource is specified The action taken by debug varies depending on what resource is specified Supported actions include Workload Create a copy of an existing pod with certain attributes changed for example changing the image tag to a new version Workload Add an ephemeral container to an already running pod for example to add debugging utilities without restarting the pod Node Create a new pod that runs in the node s host namespaces and can access the node s filesystem kubectl debug POD TYPE VERSION GROUP NAME COMMAND args Create an interactive debugging session in pod mypod and immediately attach to it kubectl debug mypod it image busybox Create an interactive debugging session for the pod in the file pod yaml and immediately attach to it requires the EphemeralContainers feature to be enabled in the cluster kubectl debug f pod yaml it image busybox Create a debug container named debugger using a custom automated debugging image kubectl debug image myproj debug tools c debugger mypod Create a copy of mypod adding a debug container and attach to it kubectl debug mypod it image busybox copy to my debugger Create a copy of mypod changing the command of mycontainer kubectl debug mypod it copy to my debugger container mycontainer sh Create a copy of mypod changing all container images to busybox kubectl debug mypod copy to my debugger set image busybox Create a copy of mypod adding a debug container and changing container images kubectl debug mypod it copy to my debugger image debian set image app app debug sidecar sidecar debug Create an interactive debugging session on a node and immediately attach to it The container will run in the host namespaces and the host s filesystem will be mounted at host kubectl debug node mynode it image busybox table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 arguments only td tr tr td td td style line height 130 word wrap break word p If specified everything after will be passed to the new container as Args instead of Command p td tr tr td colspan 2 attach td tr tr td td td style line height 130 word wrap break word p If true wait for the container to start running and then attach as if kubectl attach were called Default false unless i stdin is set in which case the default is true p td tr tr td colspan 2 c container string td tr tr td td td style line height 130 word wrap break word p Container name to use for debug container p td tr tr td colspan 2 copy to string td tr tr td td td style line height 130 word wrap break word p Create a copy of the target Pod with this name p td tr tr td colspan 2 custom string td tr tr td td td style line height 130 word wrap break word p Path to a JSON or YAML file containing a partial container spec to customize built in debug profiles p td tr tr td colspan 2 env stringToString nbsp nbsp nbsp nbsp nbsp Default td tr tr td td td style line height 130 word wrap break word p Environment variables to set in the container p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p identifying the resource to debug p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for debug p td tr tr td colspan 2 image string td tr tr td td td style line height 130 word wrap break word p Container image to use for debug container p td tr tr td colspan 2 image pull policy string td tr tr td td td style line height 130 word wrap break word p The image pull policy for the container If left empty this value will not be specified by the client and defaulted by the server p td tr tr td colspan 2 keep annotations td tr tr td td td style line height 130 word wrap break word p If true keep the original pod annotations This flag only works when used with copy to p td tr tr td colspan 2 keep init containers nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p Run the init containers for the pod Defaults to true This flag only works when used with copy to p td tr tr td colspan 2 keep labels td tr tr td td td style line height 130 word wrap break word p If true keep the original pod labels This flag only works when used with copy to p td tr tr td colspan 2 keep liveness td tr tr td td td style line height 130 word wrap break word p If true keep the original pod liveness probes This flag only works when used with copy to p td tr tr td colspan 2 keep readiness td tr tr td td td style line height 130 word wrap break word p If true keep the original pod readiness probes This flag only works when used with copy to p td tr tr td colspan 2 keep startup td tr tr td td td style line height 130 word wrap break word p If true keep the original startup probes This flag only works when used with copy to p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default legacy td tr tr td td td style line height 130 word wrap break word p Options are quot legacy quot quot general quot quot baseline quot quot netadmin quot quot restricted quot or quot sysadmin quot p td tr tr td colspan 2 q quiet td tr tr td td td style line height 130 word wrap break word p If true suppress informational messages p td tr tr td colspan 2 replace td tr tr td td td style line height 130 word wrap break word p When used with copy to delete the original Pod p td tr tr td colspan 2 same node td tr tr td td td style line height 130 word wrap break word p When used with copy to schedule the copy of target Pod on the same node p td tr tr td colspan 2 set image stringToString nbsp nbsp nbsp nbsp nbsp Default td tr tr td td td style line height 130 word wrap break word p When used with copy to a list of name image pairs for changing container images similar to how kubectl set image works p td tr tr td colspan 2 share processes nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p When used with copy to enable process namespace sharing in the copy p td tr tr td colspan 2 i stdin td tr tr td td td style line height 130 word wrap break word p Keep stdin open on the container s in the pod even if nothing is attached p td tr tr td colspan 2 target string td tr tr td td td style line height 130 word wrap break word p When using an ephemeral container target processes in this container name p td tr tr td colspan 2 t tty td tr tr td td td style line height 130 word wrap break word p Allocate a TTY for the debugging container p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference title kubectl api resources weight 30 autogenerated true | ---
title: kubectl api-resources
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Print the supported API resources on the server.
```
kubectl api-resources [flags]
```
##
```
# Print the supported API resources
kubectl api-resources
# Print the supported API resources with more information
kubectl api-resources -o wide
# Print the supported API resources sorted by a column
kubectl api-resources --sort-by=name
# Print the supported namespaced resources
kubectl api-resources --namespaced=true
# Print the supported non-namespaced resources
kubectl api-resources --namespaced=false
# Print the supported API resources with a specific APIGroup
kubectl api-resources --api-group=rbac.authorization.k8s.io
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--api-group string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Limit to resources in the specified API group.</p></td>
</tr>
<tr>
<td colspan="2">--cached</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Use the cached list of resources if available.</p></td>
</tr>
<tr>
<td colspan="2">--categories strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Limit to resources that belong to the specified categories.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for api-resources</p></td>
</tr>
<tr>
<td colspan="2">--namespaced Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If false, non-namespaced resources will be returned, otherwise returning namespaced resources by default.</p></td>
</tr>
<tr>
<td colspan="2">--no-headers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When using the default or custom-column output format, don't print headers (default print headers).</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (wide, name).</p></td>
</tr>
<tr>
<td colspan="2">--sort-by string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-empty, sort list of resources using specified field. The field can be either 'name' or 'kind'.</p></td>
</tr>
<tr>
<td colspan="2">--verbs strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Limit to resources that support the specified verbs.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl api resources content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Print the supported API resources on the server kubectl api resources flags Print the supported API resources kubectl api resources Print the supported API resources with more information kubectl api resources o wide Print the supported API resources sorted by a column kubectl api resources sort by name Print the supported namespaced resources kubectl api resources namespaced true Print the supported non namespaced resources kubectl api resources namespaced false Print the supported API resources with a specific APIGroup kubectl api resources api group rbac authorization k8s io table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 api group string td tr tr td td td style line height 130 word wrap break word p Limit to resources in the specified API group p td tr tr td colspan 2 cached td tr tr td td td style line height 130 word wrap break word p Use the cached list of resources if available p td tr tr td colspan 2 categories strings td tr tr td td td style line height 130 word wrap break word p Limit to resources that belong to the specified categories p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for api resources p td tr tr td colspan 2 namespaced nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If false non namespaced resources will be returned otherwise returning namespaced resources by default p td tr tr td colspan 2 no headers td tr tr td td td style line height 130 word wrap break word p When using the default or custom column output format don t print headers default print headers p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of wide name p td tr tr td colspan 2 sort by string td tr tr td td td style line height 130 word wrap break word p If non empty sort list of resources using specified field The field can be either name or kind p td tr tr td colspan 2 verbs strings td tr tr td td td style line height 130 word wrap break word p Limit to resources that support the specified verbs p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 autogenerated true title kubectl expose | ---
title: kubectl expose
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Expose a resource as a new Kubernetes service.
Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector for that resource as the selector for a new service on the specified port. A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports, i.e. when the selector contains only the matchLabels component. Note that if no port is specified via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no labels are specified, the new service will re-use the labels from the resource it exposes.
Possible resources include (case insensitive):
pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)
```
kubectl expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP|SCTP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type]
```
##
```
# Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000
kubectl expose rc nginx --port=80 --target-port=8000
# Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000
kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000
# Create a service for a pod valid-pod, which serves on port 444 with the name "frontend"
kubectl expose pod valid-pod --port=444 --name=frontend
# Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https"
kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https
# Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.
kubectl expose rc streamer --port=4100 --protocol=UDP --name=video-stream
# Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000
kubectl expose rs nginx --port=80 --target-port=8000
# Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000
kubectl expose deployment nginx --port=80 --target-port=8000
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--cluster-ip string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>ClusterIP to be assigned to the service. Leave empty to auto-allocate, or set to 'None' to create a headless service.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--external-ip string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-expose"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to expose a service</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for expose</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-l, --labels string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Labels to apply to the service created by this call.</p></td>
</tr>
<tr>
<td colspan="2">--load-balancer-ip string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>IP to assign to the LoadBalancer. If empty, an ephemeral IP will be created and used (cloud-provider specific).</p></td>
</tr>
<tr>
<td colspan="2">--name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name for the newly created object.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--override-type string Default: "merge"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The method used to override the generated object: json, merge, or strategic.</p></td>
</tr>
<tr>
<td colspan="2">--overrides string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.</p></td>
</tr>
<tr>
<td colspan="2">--port string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The port that the service should serve on. Copied from the resource being exposed, if unspecified</p></td>
</tr>
<tr>
<td colspan="2">--protocol string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The network protocol for the service to be created. Default is 'TCP'.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set.)</p></td>
</tr>
<tr>
<td colspan="2">--session-affinity string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP'</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--target-port string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name or number for the port on the container that the service should direct traffic to. Optional.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--type string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Type for this service: ClusterIP, NodePort, LoadBalancer, or ExternalName. Default is 'ClusterIP'.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl expose content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Expose a resource as a new Kubernetes service Looks up a deployment service replica set replication controller or pod by name and uses the selector for that resource as the selector for a new service on the specified port A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports i e when the selector contains only the matchLabels component Note that if no port is specified via port and the exposed resource has multiple ports all will be re used by the new service Also if no labels are specified the new service will re use the labels from the resource it exposes Possible resources include case insensitive pod po service svc replicationcontroller rc deployment deploy replicaset rs kubectl expose f FILENAME TYPE NAME port port protocol TCP UDP SCTP target port number or name name name external ip external ip of service type type Create a service for a replicated nginx which serves on port 80 and connects to the containers on port 8000 kubectl expose rc nginx port 80 target port 8000 Create a service for a replication controller identified by type and name specified in nginx controller yaml which serves on port 80 and connects to the containers on port 8000 kubectl expose f nginx controller yaml port 80 target port 8000 Create a service for a pod valid pod which serves on port 444 with the name frontend kubectl expose pod valid pod port 444 name frontend Create a second service based on the above service exposing the container port 8443 as port 443 with the name nginx https kubectl expose service nginx port 443 target port 8443 name nginx https Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named video stream kubectl expose rc streamer port 4100 protocol UDP name video stream Create a service for a replicated nginx using replica set which serves on port 80 and connects to the containers on port 8000 kubectl expose rs nginx port 80 target port 8000 Create a service for an nginx deployment which serves on port 80 and connects to the containers on port 8000 kubectl expose deployment nginx port 80 target port 8000 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 cluster ip string td tr tr td td td style line height 130 word wrap break word p ClusterIP to be assigned to the service Leave empty to auto allocate or set to None to create a headless service p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 external ip string td tr tr td td td style line height 130 word wrap break word p Additional external IP address not managed by Kubernetes to accept for the service If this IP is routed to a node the service can be accessed by this IP in addition to its generated service IP p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl expose td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to expose a service p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for expose p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 l labels string td tr tr td td td style line height 130 word wrap break word p Labels to apply to the service created by this call p td tr tr td colspan 2 load balancer ip string td tr tr td td td style line height 130 word wrap break word p IP to assign to the LoadBalancer If empty an ephemeral IP will be created and used cloud provider specific p td tr tr td colspan 2 name string td tr tr td td td style line height 130 word wrap break word p The name for the newly created object p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 override type string nbsp nbsp nbsp nbsp nbsp Default merge td tr tr td td td style line height 130 word wrap break word p The method used to override the generated object json merge or strategic p td tr tr td colspan 2 overrides string td tr tr td td td style line height 130 word wrap break word p An inline JSON override for the generated object If this is non empty it is used to override the generated object Requires that the object supply a valid apiVersion field p td tr tr td colspan 2 port string td tr tr td td td style line height 130 word wrap break word p The port that the service should serve on Copied from the resource being exposed if unspecified p td tr tr td colspan 2 protocol string td tr tr td td td style line height 130 word wrap break word p The network protocol for the service to be created Default is TCP p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 selector string td tr tr td td td style line height 130 word wrap break word p A label selector to use for this service Only equality based selector requirements are supported If empty the default infer the selector from the replication controller or replica set p td tr tr td colspan 2 session affinity string td tr tr td td td style line height 130 word wrap break word p If non empty set the session affinity for the service to this legal values None ClientIP p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 target port string td tr tr td td td style line height 130 word wrap break word p Name or number for the port on the container that the service should direct traffic to Optional p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 type string td tr tr td td td style line height 130 word wrap break word p Type for this service ClusterIP NodePort LoadBalancer or ExternalName Default is ClusterIP p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl annotate autogenerated true | ---
title: kubectl annotate
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Update the annotations on one or more resources.
All Kubernetes objects support the ability to store additional data with the object as annotations. Annotations are key/value pairs that can be larger than labels and include arbitrary string values such as structured JSON. Tools and system extensions may use annotations to store their own data.
Attempting to set an annotation that already exists will fail unless --overwrite is set. If --resource-version is specified and does not match the current resource version on the server the command will fail.
Use "kubectl api-resources" for a complete list of supported resources.
```
kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
```
##
```
# Update pod 'foo' with the annotation 'description' and the value 'my frontend'
# If the same annotation is set multiple times, only the last value will be applied
kubectl annotate pods foo description='my frontend'
# Update a pod identified by type and name in "pod.json"
kubectl annotate -f pod.json description='my frontend'
# Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value
kubectl annotate --overwrite pods foo description='my frontend running nginx'
# Update all pods in the namespace
kubectl annotate pods --all description='my frontend running nginx'
# Update pod 'foo' only if the resource is unchanged from version 1
kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
# Update pod 'foo' by removing an annotation named 'description' if it exists
# Does not require the --overwrite flag
kubectl annotate pods foo description-
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Select all resources, in the namespace of the specified resource types.</p></td>
</tr>
<tr>
<td colspan="2">-A, --all-namespaces</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, check the specified action in all namespaces.</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-annotate"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--field-selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to update the annotation</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for annotate</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--list</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, display the annotations for a given resource.</p></td>
</tr>
<tr>
<td colspan="2">--local</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, annotation will NOT contact api-server but run locally.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--overwrite</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--resource-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl annotate content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Update the annotations on one or more resources All Kubernetes objects support the ability to store additional data with the object as annotations Annotations are key value pairs that can be larger than labels and include arbitrary string values such as structured JSON Tools and system extensions may use annotations to store their own data Attempting to set an annotation that already exists will fail unless overwrite is set If resource version is specified and does not match the current resource version on the server the command will fail Use kubectl api resources for a complete list of supported resources kubectl annotate overwrite f FILENAME TYPE NAME KEY 1 VAL 1 KEY N VAL N resource version version Update pod foo with the annotation description and the value my frontend If the same annotation is set multiple times only the last value will be applied kubectl annotate pods foo description my frontend Update a pod identified by type and name in pod json kubectl annotate f pod json description my frontend Update pod foo with the annotation description and the value my frontend running nginx overwriting any existing value kubectl annotate overwrite pods foo description my frontend running nginx Update all pods in the namespace kubectl annotate pods all description my frontend running nginx Update pod foo only if the resource is unchanged from version 1 kubectl annotate pods foo description my frontend running nginx resource version 1 Update pod foo by removing an annotation named description if it exists Does not require the overwrite flag kubectl annotate pods foo description table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all td tr tr td td td style line height 130 word wrap break word p Select all resources in the namespace of the specified resource types p td tr tr td colspan 2 A all namespaces td tr tr td td td style line height 130 word wrap break word p If true check the specified action in all namespaces p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl annotate td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 field selector string td tr tr td td td style line height 130 word wrap break word p Selector field query to filter on supports and e g field selector key1 value1 key2 value2 The server only supports a limited number of field queries per type p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to update the annotation p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for annotate p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 list td tr tr td td td style line height 130 word wrap break word p If true display the annotations for a given resource p td tr tr td colspan 2 local td tr tr td td td style line height 130 word wrap break word p If true annotation will NOT contact api server but run locally p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 overwrite td tr tr td td td style line height 130 word wrap break word p If true allow annotations to be overwritten otherwise reject annotation updates that overwrite existing annotations p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 resource version string td tr tr td td td style line height 130 word wrap break word p If non empty the annotation update will only succeed if this is the current resource version for the object Only valid when specifying a single resource p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl cluster info dump autogenerated true | ---
title: kubectl cluster-info dump
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Dump cluster information out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, Kubernetes will build a set of files in that directory. By default, only dumps things in the current namespace and 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces.
The command also dumps the logs of all of the pods in the cluster; these logs are dumped into different directories based on namespace and pod name.
```
kubectl cluster-info dump [flags]
```
##
```
# Dump current cluster state to stdout
kubectl cluster-info dump
# Dump current cluster state to /path/to/cluster-state
kubectl cluster-info dump --output-directory=/path/to/cluster-state
# Dump all namespaces to stdout
kubectl cluster-info dump --all-namespaces
# Dump a set of namespaces to /path/to/cluster-state
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-A, --all-namespaces</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, dump all namespaces. If true, --namespaces is ignored.</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for dump</p></td>
</tr>
<tr>
<td colspan="2">--namespaces strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A comma separated list of namespaces to dump.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string Default: "json"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--output-directory string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory</p></td>
</tr>
<tr>
<td colspan="2">--pod-running-timeout duration Default: 20s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl cluster-info](../) - Display cluster information
| kubernetes reference | title kubectl cluster info dump content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Dump cluster information out suitable for debugging and diagnosing cluster problems By default dumps everything to stdout You can optionally specify a directory with output directory If you specify a directory Kubernetes will build a set of files in that directory By default only dumps things in the current namespace and kube system namespace but you can switch to a different namespace with the namespaces flag or specify all namespaces to dump all namespaces The command also dumps the logs of all of the pods in the cluster these logs are dumped into different directories based on namespace and pod name kubectl cluster info dump flags Dump current cluster state to stdout kubectl cluster info dump Dump current cluster state to path to cluster state kubectl cluster info dump output directory path to cluster state Dump all namespaces to stdout kubectl cluster info dump all namespaces Dump a set of namespaces to path to cluster state kubectl cluster info dump namespaces default kube system output directory path to cluster state table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 A all namespaces td tr tr td td td style line height 130 word wrap break word p If true dump all namespaces If true namespaces is ignored p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for dump p td tr tr td colspan 2 namespaces strings td tr tr td td td style line height 130 word wrap break word p A comma separated list of namespaces to dump p td tr tr td colspan 2 o output string nbsp nbsp nbsp nbsp nbsp Default json td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 output directory string td tr tr td td td style line height 130 word wrap break word p Where to output the files If empty or uses stdout otherwise creates a directory hierarchy in that directory p td tr tr td colspan 2 pod running timeout duration nbsp nbsp nbsp nbsp nbsp Default 20s td tr tr td td td style line height 130 word wrap break word p The length of time like 5s 2m or 3h higher than zero to wait until at least one pod is running p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl cluster info Display cluster information |
kubernetes reference nolist true contenttype tool reference weight 30 autogenerated true title kubectl cluster info | ---
title: kubectl cluster-info
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Display addresses of the control plane and services with label kubernetes.io/cluster-service=true. To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
```
kubectl cluster-info [flags]
```
##
```
# Print the address of the control plane and cluster services
kubectl cluster-info
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for cluster-info</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
* [kubectl cluster-info dump](kubectl_cluster-info_dump/) - Dump relevant information for debugging and diagnosis
| kubernetes reference | title kubectl cluster info content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Display addresses of the control plane and services with label kubernetes io cluster service true To further debug and diagnose cluster problems use kubectl cluster info dump kubectl cluster info flags Print the address of the control plane and cluster services kubectl cluster info table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for cluster info p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager kubectl cluster info dump kubectl cluster info dump Dump relevant information for debugging and diagnosis |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl explain autogenerated true | ---
title: kubectl explain
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Describe fields and structure of various resources.
This command describes the fields associated with each supported API resource. Fields are identified via a simple JSONPath identifier:
<type>.<fieldName>[.<fieldName>]
Information about each field is retrieved from the server in OpenAPI format.
Use "kubectl api-resources" for a complete list of supported resources.
```
kubectl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-group] [--output=plaintext|plaintext-openapiv2]
```
##
```
# Get the documentation of the resource and its fields
kubectl explain pods
# Get all the fields in the resource
kubectl explain pods --recursive
# Get the explanation for deployment in supported api versions
kubectl explain deployments --api-version=apps/v1
# Get the documentation of a specific field of a resource
kubectl explain pods.spec.containers
# Get the documentation of resources in different format
kubectl explain deployment --output=plaintext-openapiv2
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--api-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Use given api-version (group/version) of the resource.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for explain</p></td>
</tr>
<tr>
<td colspan="2">--output string Default: "plaintext"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Format in which to render the schema. Valid values are: (plaintext, plaintext-openapiv2).</p></td>
</tr>
<tr>
<td colspan="2">--recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When true, print the name of all the fields recursively. Otherwise, print the available fields with their description.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl explain content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Describe fields and structure of various resources This command describes the fields associated with each supported API resource Fields are identified via a simple JSONPath identifier lt type gt lt fieldName gt lt fieldName gt Information about each field is retrieved from the server in OpenAPI format Use kubectl api resources for a complete list of supported resources kubectl explain TYPE recursive FALSE TRUE api version api version group output plaintext plaintext openapiv2 Get the documentation of the resource and its fields kubectl explain pods Get all the fields in the resource kubectl explain pods recursive Get the explanation for deployment in supported api versions kubectl explain deployments api version apps v1 Get the documentation of a specific field of a resource kubectl explain pods spec containers Get the documentation of resources in different format kubectl explain deployment output plaintext openapiv2 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 api version string td tr tr td td td style line height 130 word wrap break word p Use given api version group version of the resource p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for explain p td tr tr td colspan 2 output string nbsp nbsp nbsp nbsp nbsp Default plaintext td tr tr td td td style line height 130 word wrap break word p Format in which to render the schema Valid values are plaintext plaintext openapiv2 p td tr tr td colspan 2 recursive td tr tr td td td style line height 130 word wrap break word p When true print the name of all the fields recursively Otherwise print the available fields with their description p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl describe autogenerated true | ---
title: kubectl describe
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Show details of a specific resource or group of resources.
Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example:
$ kubectl describe TYPE NAME_PREFIX
will first check for an exact match on TYPE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX.
Use "kubectl api-resources" for a complete list of supported resources.
```
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
```
##
```
# Describe a node
kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
# Describe a pod
kubectl describe pods/nginx
# Describe a pod identified by type and name in "pod.json"
kubectl describe -f pod.json
# Describe all pods
kubectl describe pods
# Describe pods by label name=myLabel
kubectl describe pods -l name=myLabel
# Describe all pods managed by the 'frontend' replication controller
# (rc-created pods get the name of the rc as a prefix in the pod name)
kubectl describe pods frontend
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-A, --all-namespaces</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.</p></td>
</tr>
<tr>
<td colspan="2">--chunk-size int Default: 500</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files containing the resource to describe</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for describe</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--show-events Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, display events related to the described object.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl describe content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Show details of a specific resource or group of resources Print a detailed description of the selected resources including related resources such as events or controllers You may select a single object by name all objects of that type provide a name prefix or label selector For example kubectl describe TYPE NAME PREFIX will first check for an exact match on TYPE and NAME PREFIX If no such resource exists it will output details for every resource that has a name prefixed with NAME PREFIX Use kubectl api resources for a complete list of supported resources kubectl describe f FILENAME TYPE NAME PREFIX l label TYPE NAME Describe a node kubectl describe nodes kubernetes node emt8 c myproject internal Describe a pod kubectl describe pods nginx Describe a pod identified by type and name in pod json kubectl describe f pod json Describe all pods kubectl describe pods Describe pods by label name myLabel kubectl describe pods l name myLabel Describe all pods managed by the frontend replication controller rc created pods get the name of the rc as a prefix in the pod name kubectl describe pods frontend table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 A all namespaces td tr tr td td td style line height 130 word wrap break word p If present list the requested object s across all namespaces Namespace in current context is ignored even if specified with namespace p td tr tr td colspan 2 chunk size int nbsp nbsp nbsp nbsp nbsp Default 500 td tr tr td td td style line height 130 word wrap break word p Return large lists in chunks rather than all at once Pass 0 to disable This flag is beta and may change in the future p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files containing the resource to describe p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for describe p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 show events nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true display events related to the described object p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 autogenerated true title kubectl edit | ---
title: kubectl edit
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Edit a resource from the default editor.
The edit command allows you to directly edit any API resource you can retrieve via the command-line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. When attempting to open the editor, it will first attempt to use the shell that has been defined in the 'SHELL' environment variable. If this is not defined, the default shell will be used, which is '/bin/bash' for Linux or 'cmd' for Windows.
You can edit multiple objects, although changes are applied one at a time. The command accepts file names as well as command-line arguments, although the files you point to must be previously saved versions of resources.
Editing is done with the API version used to fetch the resource. To edit using a specific API version, fully-qualify the resource, version, and group.
The default format is YAML. To edit in JSON, specify "-o json".
The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used.
In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.
```
kubectl edit (RESOURCE/NAME | -f FILENAME)
```
##
```
# Edit the service named 'registry'
kubectl edit svc/registry
# Use an alternative editor
KUBE_EDITOR="nano" kubectl edit svc/registry
# Edit the job 'myjob' in JSON using the v1 API format
kubectl edit job.v1.batch/myjob -o json
# Edit the deployment 'mydeployment' in YAML and save the modified config in its annotation
kubectl edit deployment/mydeployment -o yaml --save-config
# Edit the 'status' subresource for the 'mydeployment' deployment
kubectl edit deployment mydeployment --subresource='status'
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-edit"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files to use to edit the resource</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for edit</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--output-patch</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output the patch if the resource is edited.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--subresource string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If specified, edit will operate on the subresource of the requested object. Must be one of [status]. This flag is beta and may change in the future.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
<tr>
<td colspan="2">--windows-line-endings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Defaults to the line ending native to your platform.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl edit content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Edit a resource from the default editor The edit command allows you to directly edit any API resource you can retrieve via the command line tools It will open the editor defined by your KUBE EDITOR or EDITOR environment variables or fall back to vi for Linux or notepad for Windows When attempting to open the editor it will first attempt to use the shell that has been defined in the SHELL environment variable If this is not defined the default shell will be used which is bin bash for Linux or cmd for Windows You can edit multiple objects although changes are applied one at a time The command accepts file names as well as command line arguments although the files you point to must be previously saved versions of resources Editing is done with the API version used to fetch the resource To edit using a specific API version fully qualify the resource version and group The default format is YAML To edit in JSON specify o json The flag windows line endings can be used to force Windows line endings otherwise the default for your operating system will be used In the event an error occurs while updating a temporary file will be created on disk that contains your unapplied changes The most common error when updating a resource is another editor changing the resource on the server When this occurs you will have to apply your changes to the newer version of the resource or update your temporary saved copy to include the latest resource version kubectl edit RESOURCE NAME f FILENAME Edit the service named registry kubectl edit svc registry Use an alternative editor KUBE EDITOR nano kubectl edit svc registry Edit the job myjob in JSON using the v1 API format kubectl edit job v1 batch myjob o json Edit the deployment mydeployment in YAML and save the modified config in its annotation kubectl edit deployment mydeployment o yaml save config Edit the status subresource for the mydeployment deployment kubectl edit deployment mydeployment subresource status table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl edit td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files to use to edit the resource p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for edit p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 output patch td tr tr td td td style line height 130 word wrap break word p Output the patch if the resource is edited p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 subresource string td tr tr td td td style line height 130 word wrap break word p If specified edit will operate on the subresource of the requested object Must be one of status This flag is beta and may change in the future p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tr td colspan 2 windows line endings td tr tr td td td style line height 130 word wrap break word p Defaults to the line ending native to your platform p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl events autogenerated true | ---
title: kubectl events
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Display events.
Prints a table of the most important information about events. You can request events for a namespace, for all namespace, or filtered to only those pertaining to a specified resource.
```
kubectl events [(-o|--output=)json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file] [--for TYPE/NAME] [--watch] [--types=Normal,Warning]
```
##
```
# List recent events in the default namespace
kubectl events
# List recent events in all namespaces
kubectl events --all-namespaces
# List recent events for the specified pod, then wait for more events and list them as they arrive
kubectl events --for pod/web-pod-13je7 --watch
# List recent events in YAML format
kubectl events -oyaml
# List recent only events of type 'Warning' or 'Normal'
kubectl events --types=Warning,Normal
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-A, --all-namespaces</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--chunk-size int Default: 500</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future.</p></td>
</tr>
<tr>
<td colspan="2">--for string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filter events to only those pertaining to the specified resource.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for events</p></td>
</tr>
<tr>
<td colspan="2">--no-headers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When using the default output format, don't print headers.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--types strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output only events of given types.</p></td>
</tr>
<tr>
<td colspan="2">-w, --watch</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>After listing the requested events, watch for more events.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl events content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Display events Prints a table of the most important information about events You can request events for a namespace for all namespace or filtered to only those pertaining to a specified resource kubectl events o output json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file for TYPE NAME watch types Normal Warning List recent events in the default namespace kubectl events List recent events in all namespaces kubectl events all namespaces List recent events for the specified pod then wait for more events and list them as they arrive kubectl events for pod web pod 13je7 watch List recent events in YAML format kubectl events oyaml List recent only events of type Warning or Normal kubectl events types Warning Normal table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 A all namespaces td tr tr td td td style line height 130 word wrap break word p If present list the requested object s across all namespaces Namespace in current context is ignored even if specified with namespace p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 chunk size int nbsp nbsp nbsp nbsp nbsp Default 500 td tr tr td td td style line height 130 word wrap break word p Return large lists in chunks rather than all at once Pass 0 to disable This flag is beta and may change in the future p td tr tr td colspan 2 for string td tr tr td td td style line height 130 word wrap break word p Filter events to only those pertaining to the specified resource p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for events p td tr tr td colspan 2 no headers td tr tr td td td style line height 130 word wrap break word p When using the default output format don t print headers p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 types strings td tr tr td td td style line height 130 word wrap break word p Output only events of given types p td tr tr td colspan 2 w watch td tr tr td td td style line height 130 word wrap break word p After listing the requested events watch for more events p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference title kubectl logs weight 30 autogenerated true | ---
title: kubectl logs
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Print the logs for a container in a pod or specified resource. If the pod has only one container, the container name is optional.
```
kubectl logs [-f] [-p] (POD | TYPE/NAME) [-c CONTAINER]
```
##
```
# Return snapshot logs from pod nginx with only one container
kubectl logs nginx
# Return snapshot logs from pod nginx with multi containers
kubectl logs nginx --all-containers=true
# Return snapshot logs from all containers in pods defined by label app=nginx
kubectl logs -l app=nginx --all-containers=true
# Return snapshot of previous terminated ruby container logs from pod web-1
kubectl logs -p -c ruby web-1
# Begin streaming the logs of the ruby container in pod web-1
kubectl logs -f -c ruby web-1
# Begin streaming the logs from all containers in pods defined by label app=nginx
kubectl logs -f -l app=nginx --all-containers=true
# Display only the most recent 20 lines of output in pod nginx
kubectl logs --tail=20 nginx
# Show all logs from pod nginx written in the last hour
kubectl logs --since=1h nginx
# Show logs from a kubelet with an expired serving certificate
kubectl logs --insecure-skip-tls-verify-backend nginx
# Return snapshot logs from first container of a job named hello
kubectl logs job/hello
# Return snapshot logs from container nginx-1 of a deployment named nginx
kubectl logs deployment/nginx -c nginx-1
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all-containers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Get all containers' logs in the pod(s).</p></td>
</tr>
<tr>
<td colspan="2">--all-pods</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Get logs from all pod(s). Sets prefix to true.</p></td>
</tr>
<tr>
<td colspan="2">-c, --container string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Print the logs of this container</p></td>
</tr>
<tr>
<td colspan="2">-f, --follow</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Specify if the logs should be streamed.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for logs</p></td>
</tr>
<tr>
<td colspan="2">--ignore-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If watching / following pod logs, allow for any errors that occur to be non-fatal</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify-backend</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Skip verifying the identity of the kubelet that logs are requested from. In theory, an attacker could provide invalid log content back. You might want to use this if your kubelet serving certificates have expired.</p></td>
</tr>
<tr>
<td colspan="2">--limit-bytes int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Maximum bytes of logs to return. Defaults to no limit.</p></td>
</tr>
<tr>
<td colspan="2">--max-log-requests int Default: 5</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Specify maximum number of concurrent logs to follow when using by a selector. Defaults to 5.</p></td>
</tr>
<tr>
<td colspan="2">--pod-running-timeout duration Default: 20s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running</p></td>
</tr>
<tr>
<td colspan="2">--prefix</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Prefix each log line with the log source (pod name and container name)</p></td>
</tr>
<tr>
<td colspan="2">-p, --previous</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, print the logs for the previous instance of the container in a pod if it exists.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--since duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used.</p></td>
</tr>
<tr>
<td colspan="2">--since-time string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used.</p></td>
</tr>
<tr>
<td colspan="2">--tail int Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Lines of recent log file to display. Defaults to -1 with no selector, showing all log lines otherwise 10, if a selector is provided.</p></td>
</tr>
<tr>
<td colspan="2">--timestamps</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Include timestamps on each line in the log output</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl logs content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Print the logs for a container in a pod or specified resource If the pod has only one container the container name is optional kubectl logs f p POD TYPE NAME c CONTAINER Return snapshot logs from pod nginx with only one container kubectl logs nginx Return snapshot logs from pod nginx with multi containers kubectl logs nginx all containers true Return snapshot logs from all containers in pods defined by label app nginx kubectl logs l app nginx all containers true Return snapshot of previous terminated ruby container logs from pod web 1 kubectl logs p c ruby web 1 Begin streaming the logs of the ruby container in pod web 1 kubectl logs f c ruby web 1 Begin streaming the logs from all containers in pods defined by label app nginx kubectl logs f l app nginx all containers true Display only the most recent 20 lines of output in pod nginx kubectl logs tail 20 nginx Show all logs from pod nginx written in the last hour kubectl logs since 1h nginx Show logs from a kubelet with an expired serving certificate kubectl logs insecure skip tls verify backend nginx Return snapshot logs from first container of a job named hello kubectl logs job hello Return snapshot logs from container nginx 1 of a deployment named nginx kubectl logs deployment nginx c nginx 1 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all containers td tr tr td td td style line height 130 word wrap break word p Get all containers logs in the pod s p td tr tr td colspan 2 all pods td tr tr td td td style line height 130 word wrap break word p Get logs from all pod s Sets prefix to true p td tr tr td colspan 2 c container string td tr tr td td td style line height 130 word wrap break word p Print the logs of this container p td tr tr td colspan 2 f follow td tr tr td td td style line height 130 word wrap break word p Specify if the logs should be streamed p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for logs p td tr tr td colspan 2 ignore errors td tr tr td td td style line height 130 word wrap break word p If watching following pod logs allow for any errors that occur to be non fatal p td tr tr td colspan 2 insecure skip tls verify backend td tr tr td td td style line height 130 word wrap break word p Skip verifying the identity of the kubelet that logs are requested from In theory an attacker could provide invalid log content back You might want to use this if your kubelet serving certificates have expired p td tr tr td colspan 2 limit bytes int td tr tr td td td style line height 130 word wrap break word p Maximum bytes of logs to return Defaults to no limit p td tr tr td colspan 2 max log requests int nbsp nbsp nbsp nbsp nbsp Default 5 td tr tr td td td style line height 130 word wrap break word p Specify maximum number of concurrent logs to follow when using by a selector Defaults to 5 p td tr tr td colspan 2 pod running timeout duration nbsp nbsp nbsp nbsp nbsp Default 20s td tr tr td td td style line height 130 word wrap break word p The length of time like 5s 2m or 3h higher than zero to wait until at least one pod is running p td tr tr td colspan 2 prefix td tr tr td td td style line height 130 word wrap break word p Prefix each log line with the log source pod name and container name p td tr tr td colspan 2 p previous td tr tr td td td style line height 130 word wrap break word p If true print the logs for the previous instance of the container in a pod if it exists p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 since duration td tr tr td td td style line height 130 word wrap break word p Only return logs newer than a relative duration like 5s 2m or 3h Defaults to all logs Only one of since time since may be used p td tr tr td colspan 2 since time string td tr tr td td td style line height 130 word wrap break word p Only return logs after a specific date RFC3339 Defaults to all logs Only one of since time since may be used p td tr tr td colspan 2 tail int nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p Lines of recent log file to display Defaults to 1 with no selector showing all log lines otherwise 10 if a selector is provided p td tr tr td colspan 2 timestamps td tr tr td td td style line height 130 word wrap break word p Include timestamps on each line in the log output p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference title kubectl autoscale nolist true contenttype tool reference weight 30 autogenerated true | ---
title: kubectl autoscale
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Creates an autoscaler that automatically chooses and sets the number of pods that run in a Kubernetes cluster.
Looks up a deployment, replica set, stateful set, or replication controller by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.
```
kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU]
```
##
```
# Auto scale a deployment "foo", with the number of pods between 2 and 10, no target CPU utilization specified so a default autoscaling policy will be used
kubectl autoscale deployment foo --min=2 --max=10
# Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%
kubectl autoscale rc foo --max=5 --cpu-percent=80
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--cpu-percent int32 Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, a default autoscaling policy will be used.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-autoscale"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to autoscale.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for autoscale</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--max int32 Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The upper limit for the number of pods that can be set by the autoscaler. Required.</p></td>
</tr>
<tr>
<td colspan="2">--min int32 Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value.</p></td>
</tr>
<tr>
<td colspan="2">--name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name for the newly created object. If not specified, the name of the input resource will be used.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl autoscale content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Creates an autoscaler that automatically chooses and sets the number of pods that run in a Kubernetes cluster Looks up a deployment replica set stateful set or replication controller by name and creates an autoscaler that uses the given resource as a reference An autoscaler can automatically increase or decrease number of pods deployed within the system as needed kubectl autoscale f FILENAME TYPE NAME TYPE NAME min MINPODS max MAXPODS cpu percent CPU Auto scale a deployment foo with the number of pods between 2 and 10 no target CPU utilization specified so a default autoscaling policy will be used kubectl autoscale deployment foo min 2 max 10 Auto scale a replication controller foo with the number of pods between 1 and 5 target CPU utilization at 80 kubectl autoscale rc foo max 5 cpu percent 80 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 cpu percent int32 nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p The target average CPU utilization represented as a percent of requested CPU over all the pods If it s not specified or negative a default autoscaling policy will be used p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl autoscale td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to autoscale p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for autoscale p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 max int32 nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p The upper limit for the number of pods that can be set by the autoscaler Required p td tr tr td colspan 2 min int32 nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p The lower limit for the number of pods that can be set by the autoscaler If it s not specified or negative the server will apply a default value p td tr tr td colspan 2 name string td tr tr td td td style line height 130 word wrap break word p The name for the newly created object If not specified the name of the input resource will be used p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 autogenerated true title kubectl options | ---
title: kubectl options
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Print the list of flags inherited by all commands
```
kubectl options [flags]
```
##
```
# Print flags inherited by all commands
kubectl options
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for options</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl options content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Print the list of flags inherited by all commands kubectl options flags Print flags inherited by all commands kubectl options table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for options p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference title kubectl create namespace weight 30 autogenerated true | ---
title: kubectl create namespace
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a namespace with the specified name.
```
kubectl create namespace NAME [--dry-run=server|client|none]
```
##
```
# Create a new namespace named my-namespace
kubectl create namespace my-namespace
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for namespace</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create namespace content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a namespace with the specified name kubectl create namespace NAME dry run server client none Create a new namespace named my namespace kubectl create namespace my namespace table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for namespace p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kubectl create token contenttype tool reference weight 30 autogenerated true | ---
title: kubectl create token
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Request a service account token.
```
kubectl create token SERVICE_ACCOUNT_NAME
```
##
```
# Request a token to authenticate to the kube-apiserver as the service account "myapp" in the current namespace
kubectl create token myapp
# Request a token for a service account in a custom namespace
kubectl create token myapp --namespace myns
# Request a token with a custom expiration
kubectl create token myapp --duration 10m
# Request a token with a custom audience
kubectl create token myapp --audience https://example.com
# Request a token bound to an instance of a Secret object
kubectl create token myapp --bound-object-kind Secret --bound-object-name mysecret
# Request a token bound to an instance of a Secret object with a specific UID
kubectl create token myapp --bound-object-kind Secret --bound-object-name mysecret --bound-object-uid 0d4691ed-659b-4935-a832-355f77ee47cc
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--audience strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Audience of the requested token. If unset, defaults to requesting a token for use with the Kubernetes API server. May be repeated to request a token valid for multiple audiences.</p></td>
</tr>
<tr>
<td colspan="2">--bound-object-kind string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Kind of an object to bind the token to. Supported kinds are Node, Pod, Secret. If set, --bound-object-name must be provided.</p></td>
</tr>
<tr>
<td colspan="2">--bound-object-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of an object to bind the token to. The token will expire when the object is deleted. Requires --bound-object-kind.</p></td>
</tr>
<tr>
<td colspan="2">--bound-object-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID of an object to bind the token to. Requires --bound-object-kind and --bound-object-name. If unset, the UID of the existing object is used.</p></td>
</tr>
<tr>
<td colspan="2">--duration duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Requested lifetime of the issued token. If not set or if set to 0, the lifetime will be determined by the server automatically. The server may return a token with a longer or shorter lifetime.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for token</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create token content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Request a service account token kubectl create token SERVICE ACCOUNT NAME Request a token to authenticate to the kube apiserver as the service account myapp in the current namespace kubectl create token myapp Request a token for a service account in a custom namespace kubectl create token myapp namespace myns Request a token with a custom expiration kubectl create token myapp duration 10m Request a token with a custom audience kubectl create token myapp audience https example com Request a token bound to an instance of a Secret object kubectl create token myapp bound object kind Secret bound object name mysecret Request a token bound to an instance of a Secret object with a specific UID kubectl create token myapp bound object kind Secret bound object name mysecret bound object uid 0d4691ed 659b 4935 a832 355f77ee47cc table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 audience strings td tr tr td td td style line height 130 word wrap break word p Audience of the requested token If unset defaults to requesting a token for use with the Kubernetes API server May be repeated to request a token valid for multiple audiences p td tr tr td colspan 2 bound object kind string td tr tr td td td style line height 130 word wrap break word p Kind of an object to bind the token to Supported kinds are Node Pod Secret If set bound object name must be provided p td tr tr td colspan 2 bound object name string td tr tr td td td style line height 130 word wrap break word p Name of an object to bind the token to The token will expire when the object is deleted Requires bound object kind p td tr tr td colspan 2 bound object uid string td tr tr td td td style line height 130 word wrap break word p UID of an object to bind the token to Requires bound object kind and bound object name If unset the UID of the existing object is used p td tr tr td colspan 2 duration duration td tr tr td td td style line height 130 word wrap break word p Requested lifetime of the issued token If not set or if set to 0 the lifetime will be determined by the server automatically The server may return a token with a longer or shorter lifetime p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for token p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl create ingress | ---
title: kubectl create ingress
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create an ingress with the specified name.
```
kubectl create ingress NAME --rule=host/path=service:port[,tls[=secret]]
```
##
```
# Create a single ingress called 'simple' that directs requests to foo.com/bar to svc
# svc1:8080 with a TLS secret "my-cert"
kubectl create ingress simple --rule="foo.com/bar=svc1:8080,tls=my-cert"
# Create a catch all ingress of "/path" pointing to service svc:port and Ingress Class as "otheringress"
kubectl create ingress catch-all --class=otheringress --rule="/path=svc:port"
# Create an ingress with two annotations: ingress.annotation1 and ingress.annotations2
kubectl create ingress annotated --class=default --rule="foo.com/bar=svc:port" \
--annotation ingress.annotation1=foo \
--annotation ingress.annotation2=bla
# Create an ingress with the same host and multiple paths
kubectl create ingress multipath --class=default \
--rule="foo.com/=svc:port" \
--rule="foo.com/admin/=svcadmin:portadmin"
# Create an ingress with multiple hosts and the pathType as Prefix
kubectl create ingress ingress1 --class=default \
--rule="foo.com/path*=svc:8080" \
--rule="bar.com/admin*=svc2:http"
# Create an ingress with TLS enabled using the default ingress certificate and different path types
kubectl create ingress ingtls --class=default \
--rule="foo.com/=svc:https,tls" \
--rule="foo.com/path/subpath*=othersvc:8080"
# Create an ingress with TLS enabled using a specific secret and pathType as Prefix
kubectl create ingress ingsecret --class=default \
--rule="foo.com/*=svc:8080,tls=secret1"
# Create an ingress with a default backend
kubectl create ingress ingdefault --class=default \
--default-backend=defaultsvc:http \
--rule="foo.com/*=svc:8080,tls=secret1"
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--annotation strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Annotation to insert in the ingress object, in the format annotation=value</p></td>
</tr>
<tr>
<td colspan="2">--class string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Ingress Class to be used</p></td>
</tr>
<tr>
<td colspan="2">--default-backend string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default service for backend, in format of svcname:port</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for ingress</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--rule strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Rule in format host/path=service:port[,tls=secretname]. Paths containing the leading character '*' are considered pathType=Prefix. tls argument is optional.</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create ingress content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create an ingress with the specified name kubectl create ingress NAME rule host path service port tls secret Create a single ingress called simple that directs requests to foo com bar to svc svc1 8080 with a TLS secret my cert kubectl create ingress simple rule foo com bar svc1 8080 tls my cert Create a catch all ingress of path pointing to service svc port and Ingress Class as otheringress kubectl create ingress catch all class otheringress rule path svc port Create an ingress with two annotations ingress annotation1 and ingress annotations2 kubectl create ingress annotated class default rule foo com bar svc port annotation ingress annotation1 foo annotation ingress annotation2 bla Create an ingress with the same host and multiple paths kubectl create ingress multipath class default rule foo com svc port rule foo com admin svcadmin portadmin Create an ingress with multiple hosts and the pathType as Prefix kubectl create ingress ingress1 class default rule foo com path svc 8080 rule bar com admin svc2 http Create an ingress with TLS enabled using the default ingress certificate and different path types kubectl create ingress ingtls class default rule foo com svc https tls rule foo com path subpath othersvc 8080 Create an ingress with TLS enabled using a specific secret and pathType as Prefix kubectl create ingress ingsecret class default rule foo com svc 8080 tls secret1 Create an ingress with a default backend kubectl create ingress ingdefault class default default backend defaultsvc http rule foo com svc 8080 tls secret1 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 annotation strings td tr tr td td td style line height 130 word wrap break word p Annotation to insert in the ingress object in the format annotation value p td tr tr td colspan 2 class string td tr tr td td td style line height 130 word wrap break word p Ingress Class to be used p td tr tr td colspan 2 default backend string td tr tr td td td style line height 130 word wrap break word p Default service for backend in format of svcname port p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for ingress p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 rule strings td tr tr td td td style line height 130 word wrap break word p Rule in format host path service port tls secretname Paths containing the leading character are considered pathType Prefix tls argument is optional p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl create deployment autogenerated true | ---
title: kubectl create deployment
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a deployment with the specified name.
```
kubectl create deployment NAME --image=image -- [COMMAND] [args...]
```
##
```
# Create a deployment named my-dep that runs the busybox image
kubectl create deployment my-dep --image=busybox
# Create a deployment with a command
kubectl create deployment my-dep --image=busybox -- date
# Create a deployment named my-dep that runs the nginx image with 3 replicas
kubectl create deployment my-dep --image=nginx --replicas=3
# Create a deployment named my-dep that runs the busybox image and expose port 5701
kubectl create deployment my-dep --image=busybox --port=5701
# Create a deployment named my-dep that runs multiple containers
kubectl create deployment my-dep --image=busybox:latest --image=ubuntu:latest --image=nginx
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for deployment</p></td>
</tr>
<tr>
<td colspan="2">--image strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Image names to run. A deployment can have multiple images set for multi-container pod.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--port int32 Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The containerPort that this deployment exposes.</p></td>
</tr>
<tr>
<td colspan="2">-r, --replicas int32 Default: 1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Number of replicas to create. Default is 1.</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create deployment content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a deployment with the specified name kubectl create deployment NAME image image COMMAND args Create a deployment named my dep that runs the busybox image kubectl create deployment my dep image busybox Create a deployment with a command kubectl create deployment my dep image busybox date Create a deployment named my dep that runs the nginx image with 3 replicas kubectl create deployment my dep image nginx replicas 3 Create a deployment named my dep that runs the busybox image and expose port 5701 kubectl create deployment my dep image busybox port 5701 Create a deployment named my dep that runs multiple containers kubectl create deployment my dep image busybox latest image ubuntu latest image nginx table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for deployment p td tr tr td colspan 2 image strings td tr tr td td td style line height 130 word wrap break word p Image names to run A deployment can have multiple images set for multi container pod p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 port int32 nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p The containerPort that this deployment exposes p td tr tr td colspan 2 r replicas int32 nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p Number of replicas to create Default is 1 p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl create service loadbalancer | ---
title: kubectl create service loadbalancer
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a LoadBalancer service with the specified name.
```
kubectl create service loadbalancer NAME [--tcp=port:targetPort] [--dry-run=server|client|none]
```
##
```
# Create a new LoadBalancer service named my-lbs
kubectl create service loadbalancer my-lbs --tcp=5678:8080
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for loadbalancer</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--tcp strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Port pairs can be specified as '<port>:<targetPort>'.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create service](../) - Create a service using a specified subcommand
| kubernetes reference | title kubectl create service loadbalancer content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a LoadBalancer service with the specified name kubectl create service loadbalancer NAME tcp port targetPort dry run server client none Create a new LoadBalancer service named my lbs kubectl create service loadbalancer my lbs tcp 5678 8080 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for loadbalancer p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 tcp strings td tr tr td td td style line height 130 word wrap break word p Port pairs can be specified as lt port gt lt targetPort gt p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create service Create a service using a specified subcommand |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kubectl create service externalname contenttype tool reference weight 30 autogenerated true | ---
title: kubectl create service externalname
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create an ExternalName service with the specified name.
ExternalName service references to an external DNS address instead of only pods, which will allow application authors to reference services that exist off platform, on other clusters, or locally.
```
kubectl create service externalname NAME --external-name external.name [--dry-run=server|client|none]
```
##
```
# Create a new ExternalName service named my-ns
kubectl create service externalname my-ns --external-name bar.com
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--external-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>External name of service</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for externalname</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--tcp strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Port pairs can be specified as '<port>:<targetPort>'.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create service](../) - Create a service using a specified subcommand
| kubernetes reference | title kubectl create service externalname content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create an ExternalName service with the specified name ExternalName service references to an external DNS address instead of only pods which will allow application authors to reference services that exist off platform on other clusters or locally kubectl create service externalname NAME external name external name dry run server client none Create a new ExternalName service named my ns kubectl create service externalname my ns external name bar com table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 external name string td tr tr td td td style line height 130 word wrap break word p External name of service p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for externalname p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 tcp strings td tr tr td td td style line height 130 word wrap break word p Port pairs can be specified as lt port gt lt targetPort gt p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create service Create a service using a specified subcommand |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl create secret | ---
title: kubectl create secret
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a secret with specified type.
A docker-registry type secret is for accessing a container registry.
A generic type secret indicate an Opaque secret type.
A tls type secret holds TLS certificate and its associated key.
```
kubectl create secret (docker-registry | generic | tls)
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for secret</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
* [kubectl create secret docker-registry](../kubectl_create_secret_docker-registry/) - Create a secret for use with a Docker registry
* [kubectl create secret generic](../kubectl_create_secret_generic/) - Create a secret from a local file, directory, or literal value
* [kubectl create secret tls](../kubectl_create_secret_tls/) - Create a TLS secret
| kubernetes reference | title kubectl create secret content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a secret with specified type A docker registry type secret is for accessing a container registry A generic type secret indicate an Opaque secret type A tls type secret holds TLS certificate and its associated key kubectl create secret docker registry generic tls table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for secret p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin kubectl create secret docker registry kubectl create secret docker registry Create a secret for use with a Docker registry kubectl create secret generic kubectl create secret generic Create a secret from a local file directory or literal value kubectl create secret tls kubectl create secret tls Create a TLS secret |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kubectl create priorityclass contenttype tool reference weight 30 autogenerated true | ---
title: kubectl create priorityclass
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a priority class with the specified name, value, globalDefault and description.
```
kubectl create priorityclass NAME --value=VALUE --global-default=BOOL [--dry-run=server|client|none]
```
##
```
# Create a priority class named high-priority
kubectl create priorityclass high-priority --value=1000 --description="high priority"
# Create a priority class named default-priority that is considered as the global default priority
kubectl create priorityclass default-priority --value=1000 --global-default=true --description="default priority"
# Create a priority class named high-priority that cannot preempt pods with lower priority
kubectl create priorityclass high-priority --value=1000 --description="high priority" --preemption-policy="Never"
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--description string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>description is an arbitrary string that usually provides guidelines on when this priority class should be used.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--global-default</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>global-default specifies whether this PriorityClass should be considered as the default priority.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for priorityclass</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--preemption-policy string Default: "PreemptLowerPriority"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>preemption-policy is the policy for preempting pods with lower priority.</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
<tr>
<td colspan="2">--value int32</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>the value of this priority class.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create priorityclass content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a priority class with the specified name value globalDefault and description kubectl create priorityclass NAME value VALUE global default BOOL dry run server client none Create a priority class named high priority kubectl create priorityclass high priority value 1000 description high priority Create a priority class named default priority that is considered as the global default priority kubectl create priorityclass default priority value 1000 global default true description default priority Create a priority class named high priority that cannot preempt pods with lower priority kubectl create priorityclass high priority value 1000 description high priority preemption policy Never table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 description string td tr tr td td td style line height 130 word wrap break word p description is an arbitrary string that usually provides guidelines on when this priority class should be used p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 global default td tr tr td td td style line height 130 word wrap break word p global default specifies whether this PriorityClass should be considered as the default priority p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for priorityclass p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 preemption policy string nbsp nbsp nbsp nbsp nbsp Default PreemptLowerPriority td tr tr td td td style line height 130 word wrap break word p preemption policy is the policy for preempting pods with lower priority p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tr td colspan 2 value int32 td tr tr td td td style line height 130 word wrap break word p the value of this priority class p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl create poddisruptionbudget autogenerated true | ---
title: kubectl create poddisruptionbudget
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a pod disruption budget with the specified name, selector, and desired minimum available pods.
```
kubectl create poddisruptionbudget NAME --selector=SELECTOR --min-available=N [--dry-run=server|client|none]
```
##
```
# Create a pod disruption budget named my-pdb that will select all pods with the app=rails label
# and require at least one of them being available at any point in time
kubectl create poddisruptionbudget my-pdb --selector=app=rails --min-available=1
# Create a pod disruption budget named my-pdb that will select all pods with the app=nginx label
# and require at least half of the pods selected to be available at any point in time
kubectl create pdb my-pdb --selector=app=nginx --min-available=50%
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for poddisruptionbudget</p></td>
</tr>
<tr>
<td colspan="2">--max-unavailable string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The maximum number or percentage of unavailable pods this budget requires.</p></td>
</tr>
<tr>
<td colspan="2">--min-available string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The minimum number or percentage of available pods this budget requires.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A label selector to use for this budget. Only equality-based selector requirements are supported.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create poddisruptionbudget content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a pod disruption budget with the specified name selector and desired minimum available pods kubectl create poddisruptionbudget NAME selector SELECTOR min available N dry run server client none Create a pod disruption budget named my pdb that will select all pods with the app rails label and require at least one of them being available at any point in time kubectl create poddisruptionbudget my pdb selector app rails min available 1 Create a pod disruption budget named my pdb that will select all pods with the app nginx label and require at least half of the pods selected to be available at any point in time kubectl create pdb my pdb selector app nginx min available 50 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for poddisruptionbudget p td tr tr td colspan 2 max unavailable string td tr tr td td td style line height 130 word wrap break word p The maximum number or percentage of unavailable pods this budget requires p td tr tr td colspan 2 min available string td tr tr td td td style line height 130 word wrap break word p The minimum number or percentage of available pods this budget requires p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 selector string td tr tr td td td style line height 130 word wrap break word p A label selector to use for this budget Only equality based selector requirements are supported p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl create configmap autogenerated true | ---
title: kubectl create configmap
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a config map based on a file, directory, or specified literal value.
A single config map may package one or more key/value pairs.
When creating a config map based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key.
When creating a config map based on a directory, each file whose basename is a valid key in the directory will be packaged into the config map. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
```
kubectl create configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run=server|client|none]
```
##
```
# Create a new config map named my-config based on folder bar
kubectl create configmap my-config --from-file=path/to/bar
# Create a new config map named my-config with specified keys instead of file basenames on disk
kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt
# Create a new config map named my-config with key1=config1 and key2=config2
kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2
# Create a new config map named my-config from the key=value pairs in the file
kubectl create configmap my-config --from-file=path/to/bar
# Create a new config map named my-config from an env file
kubectl create configmap my-config --from-env-file=path/to/foo.env --from-env-file=path/to/bar.env
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--append-hash</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Append a hash of the configmap to its name.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--from-env-file strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Specify the path to a file to read lines of key=val pairs to create a configmap.</p></td>
</tr>
<tr>
<td colspan="2">--from-file strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Key file can be specified using its file path, in which case file basename will be used as configmap key, or optionally with a key and file path, in which case the given key will be used. Specifying a directory will iterate each named file in the directory whose basename is a valid configmap key.</p></td>
</tr>
<tr>
<td colspan="2">--from-literal strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Specify a key and literal value to insert in configmap (i.e. mykey=somevalue)</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for configmap</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create configmap content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a config map based on a file directory or specified literal value A single config map may package one or more key value pairs When creating a config map based on a file the key will default to the basename of the file and the value will default to the file content If the basename is an invalid key you may specify an alternate key When creating a config map based on a directory each file whose basename is a valid key in the directory will be packaged into the config map Any directory entries except regular files are ignored e g subdirectories symlinks devices pipes etc kubectl create configmap NAME from file key source from literal key1 value1 dry run server client none Create a new config map named my config based on folder bar kubectl create configmap my config from file path to bar Create a new config map named my config with specified keys instead of file basenames on disk kubectl create configmap my config from file key1 path to bar file1 txt from file key2 path to bar file2 txt Create a new config map named my config with key1 config1 and key2 config2 kubectl create configmap my config from literal key1 config1 from literal key2 config2 Create a new config map named my config from the key value pairs in the file kubectl create configmap my config from file path to bar Create a new config map named my config from an env file kubectl create configmap my config from env file path to foo env from env file path to bar env table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 append hash td tr tr td td td style line height 130 word wrap break word p Append a hash of the configmap to its name p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 from env file strings td tr tr td td td style line height 130 word wrap break word p Specify the path to a file to read lines of key val pairs to create a configmap p td tr tr td colspan 2 from file strings td tr tr td td td style line height 130 word wrap break word p Key file can be specified using its file path in which case file basename will be used as configmap key or optionally with a key and file path in which case the given key will be used Specifying a directory will iterate each named file in the directory whose basename is a valid configmap key p td tr tr td colspan 2 from literal strings td tr tr td td td style line height 130 word wrap break word p Specify a key and literal value to insert in configmap i e mykey somevalue p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for configmap p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl create service autogenerated true | ---
title: kubectl create service
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a service using a specified subcommand.
```
kubectl create service [flags]
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for service</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
* [kubectl create service clusterip](../kubectl_create_service_clusterip/) - Create a ClusterIP service
* [kubectl create service externalname](../kubectl_create_service_externalname/) - Create an ExternalName service
* [kubectl create service loadbalancer](../kubectl_create_service_loadbalancer/) - Create a LoadBalancer service
* [kubectl create service nodeport](../kubectl_create_service_nodeport/) - Create a NodePort service
| kubernetes reference | title kubectl create service content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a service using a specified subcommand kubectl create service flags table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for service p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin kubectl create service clusterip kubectl create service clusterip Create a ClusterIP service kubectl create service externalname kubectl create service externalname Create an ExternalName service kubectl create service loadbalancer kubectl create service loadbalancer Create a LoadBalancer service kubectl create service nodeport kubectl create service nodeport Create a NodePort service |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl create clusterrolebinding | ---
title: kubectl create clusterrolebinding
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a cluster role binding for a particular cluster role.
```
kubectl create clusterrolebinding NAME --clusterrole=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run=server|client|none]
```
##
```
# Create a cluster role binding for user1, user2, and group1 using the cluster-admin cluster role
kubectl create clusterrolebinding cluster-admin --clusterrole=cluster-admin --user=user1 --user=user2 --group=group1
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--clusterrole string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>ClusterRole this ClusterRoleBinding should reference</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Groups to bind to the clusterrole. The flag can be repeated to add multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for clusterrolebinding</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--serviceaccount strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Service accounts to bind to the clusterrole, in the format <namespace>:<name>. The flag can be repeated to add multiple service accounts.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--user strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Usernames to bind to the clusterrole. The flag can be repeated to add multiple users.</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create clusterrolebinding content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a cluster role binding for a particular cluster role kubectl create clusterrolebinding NAME clusterrole NAME user username group groupname serviceaccount namespace serviceaccountname dry run server client none Create a cluster role binding for user1 user2 and group1 using the cluster admin cluster role kubectl create clusterrolebinding cluster admin clusterrole cluster admin user user1 user user2 group group1 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 clusterrole string td tr tr td td td style line height 130 word wrap break word p ClusterRole this ClusterRoleBinding should reference p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 group strings td tr tr td td td style line height 130 word wrap break word p Groups to bind to the clusterrole The flag can be repeated to add multiple groups p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for clusterrolebinding p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 serviceaccount strings td tr tr td td td style line height 130 word wrap break word p Service accounts to bind to the clusterrole in the format lt namespace gt lt name gt The flag can be repeated to add multiple service accounts p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 user strings td tr tr td td td style line height 130 word wrap break word p Usernames to bind to the clusterrole The flag can be repeated to add multiple users p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kubectl create secret generic contenttype tool reference weight 30 autogenerated true | ---
title: kubectl create secret generic
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a secret based on a file, directory, or specified literal value.
A single secret may package one or more key/value pairs.
When creating a secret based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key or you wish to chose your own, you may specify an alternate key.
When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
```
kubectl create secret generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run=server|client|none]
```
##
```
# Create a new secret named my-secret with keys for each file in folder bar
kubectl create secret generic my-secret --from-file=path/to/bar
# Create a new secret named my-secret with specified keys instead of names on disk
kubectl create secret generic my-secret --from-file=ssh-privatekey=path/to/id_rsa --from-file=ssh-publickey=path/to/id_rsa.pub
# Create a new secret named my-secret with key1=supersecret and key2=topsecret
kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
# Create a new secret named my-secret using a combination of a file and a literal
kubectl create secret generic my-secret --from-file=ssh-privatekey=path/to/id_rsa --from-literal=passphrase=topsecret
# Create a new secret named my-secret from env files
kubectl create secret generic my-secret --from-env-file=path/to/foo.env --from-env-file=path/to/bar.env
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--append-hash</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Append a hash of the secret to its name.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--from-env-file strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Specify the path to a file to read lines of key=val pairs to create a secret.</p></td>
</tr>
<tr>
<td colspan="2">--from-file strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key.</p></td>
</tr>
<tr>
<td colspan="2">--from-literal strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Specify a key and literal value to insert in secret (i.e. mykey=somevalue)</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for generic</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--type string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The type of secret to create</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create secret](../) - Create a secret using a specified subcommand
| kubernetes reference | title kubectl create secret generic content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a secret based on a file directory or specified literal value A single secret may package one or more key value pairs When creating a secret based on a file the key will default to the basename of the file and the value will default to the file content If the basename is an invalid key or you wish to chose your own you may specify an alternate key When creating a secret based on a directory each file whose basename is a valid key in the directory will be packaged into the secret Any directory entries except regular files are ignored e g subdirectories symlinks devices pipes etc kubectl create secret generic NAME type string from file key source from literal key1 value1 dry run server client none Create a new secret named my secret with keys for each file in folder bar kubectl create secret generic my secret from file path to bar Create a new secret named my secret with specified keys instead of names on disk kubectl create secret generic my secret from file ssh privatekey path to id rsa from file ssh publickey path to id rsa pub Create a new secret named my secret with key1 supersecret and key2 topsecret kubectl create secret generic my secret from literal key1 supersecret from literal key2 topsecret Create a new secret named my secret using a combination of a file and a literal kubectl create secret generic my secret from file ssh privatekey path to id rsa from literal passphrase topsecret Create a new secret named my secret from env files kubectl create secret generic my secret from env file path to foo env from env file path to bar env table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 append hash td tr tr td td td style line height 130 word wrap break word p Append a hash of the secret to its name p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 from env file strings td tr tr td td td style line height 130 word wrap break word p Specify the path to a file to read lines of key val pairs to create a secret p td tr tr td colspan 2 from file strings td tr tr td td td style line height 130 word wrap break word p Key files can be specified using their file path in which case a default name will be given to them or optionally with a name and file path in which case the given name will be used Specifying a directory will iterate each named file in the directory that is a valid secret key p td tr tr td colspan 2 from literal strings td tr tr td td td style line height 130 word wrap break word p Specify a key and literal value to insert in secret i e mykey somevalue p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for generic p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 type string td tr tr td td td style line height 130 word wrap break word p The type of secret to create p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create secret Create a secret using a specified subcommand |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kubectl create quota contenttype tool reference weight 30 autogenerated true | ---
title: kubectl create quota
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a resource quota with the specified name, hard limits, and optional scopes.
```
kubectl create quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scope2] [--dry-run=server|client|none]
```
##
```
# Create a new resource quota named my-quota
kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
# Create a new resource quota named best-effort
kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--hard string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A comma-delimited set of resource=quantity pairs that define a hard limit.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for quota</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--scopes string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A comma-delimited set of quota scopes that must all match each object tracked by the quota.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create quota content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a resource quota with the specified name hard limits and optional scopes kubectl create quota NAME hard key1 value1 key2 value2 scopes Scope1 Scope2 dry run server client none Create a new resource quota named my quota kubectl create quota my quota hard cpu 1 memory 1G pods 2 services 3 replicationcontrollers 2 resourcequotas 1 secrets 5 persistentvolumeclaims 10 Create a new resource quota named best effort kubectl create quota best effort hard pods 100 scopes BestEffort table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 hard string td tr tr td td td style line height 130 word wrap break word p A comma delimited set of resource quantity pairs that define a hard limit p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for quota p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 scopes string td tr tr td td td style line height 130 word wrap break word p A comma delimited set of quota scopes that must all match each object tracked by the quota p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference title kubectl create secret tls The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true | ---
title: kubectl create secret tls
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a TLS secret from the given public/private key pair.
The public/private key pair must exist beforehand. The public key certificate must be .PEM encoded and match the given private key.
```
kubectl create secret tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run=server|client|none]
```
##
```
# Create a new TLS secret named tls-secret with the given key pair
kubectl create secret tls tls-secret --cert=path/to/tls.crt --key=path/to/tls.key
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--append-hash</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Append a hash of the secret to its name.</p></td>
</tr>
<tr>
<td colspan="2">--cert string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to PEM encoded public key certificate.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for tls</p></td>
</tr>
<tr>
<td colspan="2">--key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to private key associated with given certificate.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create secret](../) - Create a secret using a specified subcommand
| kubernetes reference | title kubectl create secret tls content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a TLS secret from the given public private key pair The public private key pair must exist beforehand The public key certificate must be PEM encoded and match the given private key kubectl create secret tls NAME cert path to cert file key path to key file dry run server client none Create a new TLS secret named tls secret with the given key pair kubectl create secret tls tls secret cert path to tls crt key path to tls key table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 append hash td tr tr td td td style line height 130 word wrap break word p Append a hash of the secret to its name p td tr tr td colspan 2 cert string td tr tr td td td style line height 130 word wrap break word p Path to PEM encoded public key certificate p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for tls p td tr tr td colspan 2 key string td tr tr td td td style line height 130 word wrap break word p Path to private key associated with given certificate p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create secret Create a secret using a specified subcommand |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl create cronjob autogenerated true | ---
title: kubectl create cronjob
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a cron job with the specified name.
```
kubectl create cronjob NAME --image=image --schedule='0/5 * * * ?' -- [COMMAND] [args...] [flags]
```
##
```
# Create a cron job
kubectl create cronjob my-job --image=busybox --schedule="*/1 * * * *"
# Create a cron job with a command
kubectl create cronjob my-job --image=busybox --schedule="*/1 * * * *" -- date
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for cronjob</p></td>
</tr>
<tr>
<td colspan="2">--image string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Image name to run.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--restart string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>job's restart policy. supported values: OnFailure, Never</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--schedule string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A schedule in the Cron format the job should be run with.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create cronjob content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a cron job with the specified name kubectl create cronjob NAME image image schedule 0 5 COMMAND args flags Create a cron job kubectl create cronjob my job image busybox schedule 1 Create a cron job with a command kubectl create cronjob my job image busybox schedule 1 date table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for cronjob p td tr tr td colspan 2 image string td tr tr td td td style line height 130 word wrap break word p Image name to run p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 restart string td tr tr td td td style line height 130 word wrap break word p job s restart policy supported values OnFailure Never p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 schedule string td tr tr td td td style line height 130 word wrap break word p A schedule in the Cron format the job should be run with p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kubectl create job contenttype tool reference weight 30 autogenerated true | ---
title: kubectl create job
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a job with the specified name.
```
kubectl create job NAME --image=image [--from=cronjob/name] -- [COMMAND] [args...]
```
##
```
# Create a job
kubectl create job my-job --image=busybox
# Create a job with a command
kubectl create job my-job --image=busybox -- date
# Create a job from a cron job named "a-cronjob"
kubectl create job test-job --from=cronjob/a-cronjob
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--from string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the resource to create a Job from (only cronjob is supported).</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for job</p></td>
</tr>
<tr>
<td colspan="2">--image string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Image name to run.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create job content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a job with the specified name kubectl create job NAME image image from cronjob name COMMAND args Create a job kubectl create job my job image busybox Create a job with a command kubectl create job my job image busybox date Create a job from a cron job named a cronjob kubectl create job test job from cronjob a cronjob table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 from string td tr tr td td td style line height 130 word wrap break word p The name of the resource to create a Job from only cronjob is supported p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for job p td tr tr td colspan 2 image string td tr tr td td td style line height 130 word wrap break word p Image name to run p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl create service clusterip autogenerated true | ---
title: kubectl create service clusterip
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a ClusterIP service with the specified name.
```
kubectl create service clusterip NAME [--tcp=<port>:<targetPort>] [--dry-run=server|client|none]
```
##
```
# Create a new ClusterIP service named my-cs
kubectl create service clusterip my-cs --tcp=5678:8080
# Create a new ClusterIP service named my-cs (in headless mode)
kubectl create service clusterip my-cs --clusterip="None"
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--clusterip string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Assign your own ClusterIP or set to 'None' for a 'headless' service (no loadbalancing).</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for clusterip</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--tcp strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Port pairs can be specified as '<port>:<targetPort>'.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create service](../) - Create a service using a specified subcommand
| kubernetes reference | title kubectl create service clusterip content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a ClusterIP service with the specified name kubectl create service clusterip NAME tcp port targetPort dry run server client none Create a new ClusterIP service named my cs kubectl create service clusterip my cs tcp 5678 8080 Create a new ClusterIP service named my cs in headless mode kubectl create service clusterip my cs clusterip None table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 clusterip string td tr tr td td td style line height 130 word wrap break word p Assign your own ClusterIP or set to None for a headless service no loadbalancing p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for clusterip p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 tcp strings td tr tr td td td style line height 130 word wrap break word p Port pairs can be specified as lt port gt lt targetPort gt p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create service Create a service using a specified subcommand |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl create role | ---
title: kubectl create role
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a role with single rule.
```
kubectl create role NAME --verb=verb --resource=resource.group/subresource [--resource-name=resourcename] [--dry-run=server|client|none]
```
##
```
# Create a role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods
kubectl create role pod-reader --verb=get --verb=list --verb=watch --resource=pods
# Create a role named "pod-reader" with ResourceName specified
kubectl create role pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod
# Create a role named "foo" with API Group specified
kubectl create role foo --verb=get,list,watch --resource=rs.apps
# Create a role named "foo" with SubResource specified
kubectl create role foo --verb=get,list,watch --resource=pods,pods/status
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for role</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--resource strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Resource that the rule applies to</p></td>
</tr>
<tr>
<td colspan="2">--resource-name strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Resource in the white list that the rule applies to, repeat this flag for multiple items</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
<tr>
<td colspan="2">--verb strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Verb that applies to the resources contained in the rule</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create role content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a role with single rule kubectl create role NAME verb verb resource resource group subresource resource name resourcename dry run server client none Create a role named pod reader that allows user to perform get watch and list on pods kubectl create role pod reader verb get verb list verb watch resource pods Create a role named pod reader with ResourceName specified kubectl create role pod reader verb get resource pods resource name readablepod resource name anotherpod Create a role named foo with API Group specified kubectl create role foo verb get list watch resource rs apps Create a role named foo with SubResource specified kubectl create role foo verb get list watch resource pods pods status table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for role p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 resource strings td tr tr td td td style line height 130 word wrap break word p Resource that the rule applies to p td tr tr td colspan 2 resource name strings td tr tr td td td style line height 130 word wrap break word p Resource in the white list that the rule applies to repeat this flag for multiple items p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tr td colspan 2 verb strings td tr tr td td td style line height 130 word wrap break word p Verb that applies to the resources contained in the rule p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl create rolebinding | ---
title: kubectl create rolebinding
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a role binding for a particular role or cluster role.
```
kubectl create rolebinding NAME --clusterrole=NAME|--role=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run=server|client|none]
```
##
```
# Create a role binding for user1, user2, and group1 using the admin cluster role
kubectl create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1
# Create a role binding for service account monitoring:sa-dev using the admin role
kubectl create rolebinding admin-binding --role=admin --serviceaccount=monitoring:sa-dev
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--clusterrole string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>ClusterRole this RoleBinding should reference</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Groups to bind to the role. The flag can be repeated to add multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for rolebinding</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--role string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Role this RoleBinding should reference</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--serviceaccount strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Service accounts to bind to the role, in the format <namespace>:<name>. The flag can be repeated to add multiple service accounts.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--user strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Usernames to bind to the role. The flag can be repeated to add multiple users.</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create rolebinding content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a role binding for a particular role or cluster role kubectl create rolebinding NAME clusterrole NAME role NAME user username group groupname serviceaccount namespace serviceaccountname dry run server client none Create a role binding for user1 user2 and group1 using the admin cluster role kubectl create rolebinding admin clusterrole admin user user1 user user2 group group1 Create a role binding for service account monitoring sa dev using the admin role kubectl create rolebinding admin binding role admin serviceaccount monitoring sa dev table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 clusterrole string td tr tr td td td style line height 130 word wrap break word p ClusterRole this RoleBinding should reference p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 group strings td tr tr td td td style line height 130 word wrap break word p Groups to bind to the role The flag can be repeated to add multiple groups p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for rolebinding p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 role string td tr tr td td td style line height 130 word wrap break word p Role this RoleBinding should reference p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 serviceaccount strings td tr tr td td td style line height 130 word wrap break word p Service accounts to bind to the role in the format lt namespace gt lt name gt The flag can be repeated to add multiple service accounts p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 user strings td tr tr td td td style line height 130 word wrap break word p Usernames to bind to the role The flag can be repeated to add multiple users p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl create secret docker registry autogenerated true | ---
title: kubectl create secret docker-registry
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a new secret for use with Docker registries.
Dockercfg secrets are used to authenticate against Docker registries.
When using the Docker command line to push images, you can authenticate to a given registry by running:
'$ docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'.
That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry. The email address is optional.
When creating applications, you may have a Docker registry that requires authentication. In order for the
nodes to pull images on your behalf, they must have the credentials. You can provide this information
by creating a dockercfg secret and attaching it to your service account.
```
kubectl create secret docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-file=[key=]source] [--dry-run=server|client|none]
```
##
```
# If you do not already have a .dockercfg file, create a dockercfg secret directly
kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
# Create a new secret named my-secret from ~/.docker/config.json
kubectl create secret docker-registry my-secret --from-file=path/to/.docker/config.json
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--append-hash</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Append a hash of the secret to its name.</p></td>
</tr>
<tr>
<td colspan="2">--docker-email string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Email for Docker registry</p></td>
</tr>
<tr>
<td colspan="2">--docker-password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for Docker registry authentication</p></td>
</tr>
<tr>
<td colspan="2">--docker-server string Default: "https://index.docker.io/v1/"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server location for Docker registry</p></td>
</tr>
<tr>
<td colspan="2">--docker-username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for Docker registry authentication</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--from-file strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Key files can be specified using their file path, in which case a default name of .dockerconfigjson will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key. For this command, the key should always be .dockerconfigjson.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for docker-registry</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create secret](../) - Create a secret using a specified subcommand
| kubernetes reference | title kubectl create secret docker registry content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a new secret for use with Docker registries Dockercfg secrets are used to authenticate against Docker registries When using the Docker command line to push images you can authenticate to a given registry by running docker login DOCKER REGISTRY SERVER username DOCKER USER password DOCKER PASSWORD email DOCKER EMAIL That produces a dockercfg file that is used by subsequent docker push and docker pull commands to authenticate to the registry The email address is optional When creating applications you may have a Docker registry that requires authentication In order for the nodes to pull images on your behalf they must have the credentials You can provide this information by creating a dockercfg secret and attaching it to your service account kubectl create secret docker registry NAME docker username user docker password password docker email email docker server string from file key source dry run server client none If you do not already have a dockercfg file create a dockercfg secret directly kubectl create secret docker registry my secret docker server DOCKER REGISTRY SERVER docker username DOCKER USER docker password DOCKER PASSWORD docker email DOCKER EMAIL Create a new secret named my secret from docker config json kubectl create secret docker registry my secret from file path to docker config json table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 append hash td tr tr td td td style line height 130 word wrap break word p Append a hash of the secret to its name p td tr tr td colspan 2 docker email string td tr tr td td td style line height 130 word wrap break word p Email for Docker registry p td tr tr td colspan 2 docker password string td tr tr td td td style line height 130 word wrap break word p Password for Docker registry authentication p td tr tr td colspan 2 docker server string nbsp nbsp nbsp nbsp nbsp Default https index docker io v1 td tr tr td td td style line height 130 word wrap break word p Server location for Docker registry p td tr tr td colspan 2 docker username string td tr tr td td td style line height 130 word wrap break word p Username for Docker registry authentication p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 from file strings td tr tr td td td style line height 130 word wrap break word p Key files can be specified using their file path in which case a default name of dockerconfigjson will be given to them or optionally with a name and file path in which case the given name will be used Specifying a directory will iterate each named file in the directory that is a valid secret key For this command the key should always be dockerconfigjson p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for docker registry p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create secret Create a secret using a specified subcommand |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kubectl create service nodeport contenttype tool reference weight 30 autogenerated true | ---
title: kubectl create service nodeport
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a NodePort service with the specified name.
```
kubectl create service nodeport NAME [--tcp=port:targetPort] [--dry-run=server|client|none]
```
##
```
# Create a new NodePort service named my-ns
kubectl create service nodeport my-ns --tcp=5678:8080
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for nodeport</p></td>
</tr>
<tr>
<td colspan="2">--node-port int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Port used to expose the service on each node in a cluster.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--tcp strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Port pairs can be specified as '<port>:<targetPort>'.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create service](../) - Create a service using a specified subcommand
| kubernetes reference | title kubectl create service nodeport content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a NodePort service with the specified name kubectl create service nodeport NAME tcp port targetPort dry run server client none Create a new NodePort service named my ns kubectl create service nodeport my ns tcp 5678 8080 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for nodeport p td tr tr td colspan 2 node port int td tr tr td td td style line height 130 word wrap break word p Port used to expose the service on each node in a cluster p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 tcp strings td tr tr td td td style line height 130 word wrap break word p Port pairs can be specified as lt port gt lt targetPort gt p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create service Create a service using a specified subcommand |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl create serviceaccount | ---
title: kubectl create serviceaccount
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a service account with the specified name.
```
kubectl create serviceaccount NAME [--dry-run=server|client|none]
```
##
```
# Create a new service account named my-service-account
kubectl create serviceaccount my-service-account
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for serviceaccount</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create serviceaccount content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a service account with the specified name kubectl create serviceaccount NAME dry run server client none Create a new service account named my service account kubectl create serviceaccount my service account table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for serviceaccount p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference title kubectl create clusterrole The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true | ---
title: kubectl create clusterrole
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a cluster role.
```
kubectl create clusterrole NAME --verb=verb --resource=resource.group [--resource-name=resourcename] [--dry-run=server|client|none]
```
##
```
# Create a cluster role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods
kubectl create clusterrole pod-reader --verb=get,list,watch --resource=pods
# Create a cluster role named "pod-reader" with ResourceName specified
kubectl create clusterrole pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod
# Create a cluster role named "foo" with API Group specified
kubectl create clusterrole foo --verb=get,list,watch --resource=rs.apps
# Create a cluster role named "foo" with SubResource specified
kubectl create clusterrole foo --verb=get,list,watch --resource=pods,pods/status
# Create a cluster role name "foo" with NonResourceURL specified
kubectl create clusterrole "foo" --verb=get --non-resource-url=/logs/*
# Create a cluster role name "monitoring" with AggregationRule specified
kubectl create clusterrole monitoring --aggregation-rule="rbac.example.com/aggregate-to-monitoring=true"
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--aggregation-rule <comma-separated 'key=value' pairs></td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>An aggregation label selector for combining ClusterRoles.</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for clusterrole</p></td>
</tr>
<tr>
<td colspan="2">--non-resource-url strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A partial url that user should have access to.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--resource strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Resource that the rule applies to</p></td>
</tr>
<tr>
<td colspan="2">--resource-name strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Resource in the white list that the rule applies to, repeat this flag for multiple items</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
<tr>
<td colspan="2">--verb strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Verb that applies to the resources contained in the rule</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl create](../) - Create a resource from a file or from stdin
| kubernetes reference | title kubectl create clusterrole content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a cluster role kubectl create clusterrole NAME verb verb resource resource group resource name resourcename dry run server client none Create a cluster role named pod reader that allows user to perform get watch and list on pods kubectl create clusterrole pod reader verb get list watch resource pods Create a cluster role named pod reader with ResourceName specified kubectl create clusterrole pod reader verb get resource pods resource name readablepod resource name anotherpod Create a cluster role named foo with API Group specified kubectl create clusterrole foo verb get list watch resource rs apps Create a cluster role named foo with SubResource specified kubectl create clusterrole foo verb get list watch resource pods pods status Create a cluster role name foo with NonResourceURL specified kubectl create clusterrole foo verb get non resource url logs Create a cluster role name monitoring with AggregationRule specified kubectl create clusterrole monitoring aggregation rule rbac example com aggregate to monitoring true table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 aggregation rule lt comma separated key value pairs gt td tr tr td td td style line height 130 word wrap break word p An aggregation label selector for combining ClusterRoles p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for clusterrole p td tr tr td colspan 2 non resource url strings td tr tr td td td style line height 130 word wrap break word p A partial url that user should have access to p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 resource strings td tr tr td td td style line height 130 word wrap break word p Resource that the rule applies to p td tr tr td colspan 2 resource name strings td tr tr td td td style line height 130 word wrap break word p Resource in the white list that the rule applies to repeat this flag for multiple items p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tr td colspan 2 verb strings td tr tr td td td style line height 130 word wrap break word p Verb that applies to the resources contained in the rule p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl create Create a resource from a file or from stdin |
kubernetes reference nolist true contenttype tool reference title kubectl create weight 30 autogenerated true | ---
title: kubectl create
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Create a resource from a file or from stdin.
JSON and YAML formats are accepted.
```
kubectl create -f FILENAME
```
##
```
# Create a pod using the data in pod.json
kubectl create -f ./pod.json
# Create a pod based on the JSON passed into stdin
cat pod.json | kubectl create -f -
# Edit the data in registry.yaml in JSON then create the resource using the edited data
kubectl create -f registry.yaml --edit -o json
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--edit</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Edit the API resource before creating</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-create"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files to use to create the resource</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for create</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--raw string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Raw URI to POST to the server. Uses the transport specified by the kubeconfig file.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
<tr>
<td colspan="2">--windows-line-endings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Only relevant if --edit=true. Defaults to the line ending native to your platform.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
* [kubectl create clusterrole](kubectl_create_clusterrole/) - Create a cluster role
* [kubectl create clusterrolebinding](kubectl_create_clusterrolebinding/) - Create a cluster role binding for a particular cluster role
* [kubectl create configmap](kubectl_create_configmap/) - Create a config map from a local file, directory or literal value
* [kubectl create cronjob](kubectl_create_cronjob/) - Create a cron job with the specified name
* [kubectl create deployment](kubectl_create_deployment/) - Create a deployment with the specified name
* [kubectl create ingress](kubectl_create_ingress/) - Create an ingress with the specified name
* [kubectl create job](kubectl_create_job/) - Create a job with the specified name
* [kubectl create namespace](kubectl_create_namespace/) - Create a namespace with the specified name
* [kubectl create poddisruptionbudget](kubectl_create_poddisruptionbudget/) - Create a pod disruption budget with the specified name
* [kubectl create priorityclass](kubectl_create_priorityclass/) - Create a priority class with the specified name
* [kubectl create quota](kubectl_create_quota/) - Create a quota with the specified name
* [kubectl create role](kubectl_create_role/) - Create a role with single rule
* [kubectl create rolebinding](kubectl_create_rolebinding/) - Create a role binding for a particular role or cluster role
* [kubectl create secret](kubectl_create_secret/) - Create a secret using a specified subcommand
* [kubectl create service](kubectl_create_service/) - Create a service using a specified subcommand
* [kubectl create serviceaccount](kubectl_create_serviceaccount/) - Create a service account with the specified name
* [kubectl create token](kubectl_create_token/) - Request a service account token
| kubernetes reference | title kubectl create content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Create a resource from a file or from stdin JSON and YAML formats are accepted kubectl create f FILENAME Create a pod using the data in pod json kubectl create f pod json Create a pod based on the JSON passed into stdin cat pod json kubectl create f Edit the data in registry yaml in JSON then create the resource using the edited data kubectl create f registry yaml edit o json table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 edit td tr tr td td td style line height 130 word wrap break word p Edit the API resource before creating p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl create td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files to use to create the resource p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for create p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 raw string td tr tr td td td style line height 130 word wrap break word p Raw URI to POST to the server Uses the transport specified by the kubeconfig file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tr td colspan 2 windows line endings td tr tr td td td style line height 130 word wrap break word p Only relevant if edit true Defaults to the line ending native to your platform p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager kubectl create clusterrole kubectl create clusterrole Create a cluster role kubectl create clusterrolebinding kubectl create clusterrolebinding Create a cluster role binding for a particular cluster role kubectl create configmap kubectl create configmap Create a config map from a local file directory or literal value kubectl create cronjob kubectl create cronjob Create a cron job with the specified name kubectl create deployment kubectl create deployment Create a deployment with the specified name kubectl create ingress kubectl create ingress Create an ingress with the specified name kubectl create job kubectl create job Create a job with the specified name kubectl create namespace kubectl create namespace Create a namespace with the specified name kubectl create poddisruptionbudget kubectl create poddisruptionbudget Create a pod disruption budget with the specified name kubectl create priorityclass kubectl create priorityclass Create a priority class with the specified name kubectl create quota kubectl create quota Create a quota with the specified name kubectl create role kubectl create role Create a role with single rule kubectl create rolebinding kubectl create rolebinding Create a role binding for a particular role or cluster role kubectl create secret kubectl create secret Create a secret using a specified subcommand kubectl create service kubectl create service Create a service using a specified subcommand kubectl create serviceaccount kubectl create serviceaccount Create a service account with the specified name kubectl create token kubectl create token Request a service account token |
kubernetes reference nolist true contenttype tool reference weight 30 autogenerated true title kubectl api versions | ---
title: kubectl api-versions
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Print the supported API versions on the server, in the form of "group/version".
```
kubectl api-versions
```
##
```
# Print the supported API versions
kubectl api-versions
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for api-versions</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl api versions content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Print the supported API versions on the server in the form of group version kubectl api versions Print the supported API versions kubectl api versions table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for api versions p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference title kubectl exec weight 30 autogenerated true | ---
title: kubectl exec
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Execute a command in a container.
```
kubectl exec (POD | TYPE/NAME) [-c CONTAINER] [flags] -- COMMAND [args...]
```
##
```
# Get output from running the 'date' command from pod mypod, using the first container by default
kubectl exec mypod -- date
# Get output from running the 'date' command in ruby-container from pod mypod
kubectl exec mypod -c ruby-container -- date
# Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod
# and sends stdout/stderr from 'bash' back to the client
kubectl exec mypod -c ruby-container -i -t -- bash -il
# List contents of /usr from the first container of pod mypod and sort by modification time
# If the command you want to execute in the pod has any flags in common (e.g. -i),
# you must use two dashes (--) to separate your command's flags/arguments
# Also note, do not surround your command and its flags/arguments with quotes
# unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr")
kubectl exec mypod -i -t -- ls -t /usr
# Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default
kubectl exec deploy/mydeployment -- date
# Get output from running 'date' command from the first pod of the service myservice, using the first container by default
kubectl exec svc/myservice -- date
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-c, --container string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Container name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>to use to exec into the resource</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for exec</p></td>
</tr>
<tr>
<td colspan="2">--pod-running-timeout duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running</p></td>
</tr>
<tr>
<td colspan="2">-q, --quiet</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Only print output from the remote session</p></td>
</tr>
<tr>
<td colspan="2">-i, --stdin</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Pass stdin to the container</p></td>
</tr>
<tr>
<td colspan="2">-t, --tty</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Stdin is a TTY</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl exec content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Execute a command in a container kubectl exec POD TYPE NAME c CONTAINER flags COMMAND args Get output from running the date command from pod mypod using the first container by default kubectl exec mypod date Get output from running the date command in ruby container from pod mypod kubectl exec mypod c ruby container date Switch to raw terminal mode sends stdin to bash in ruby container from pod mypod and sends stdout stderr from bash back to the client kubectl exec mypod c ruby container i t bash il List contents of usr from the first container of pod mypod and sort by modification time If the command you want to execute in the pod has any flags in common e g i you must use two dashes to separate your command s flags arguments Also note do not surround your command and its flags arguments with quotes unless that is how you would execute it normally i e do ls t usr not ls t usr kubectl exec mypod i t ls t usr Get output from running date command from the first pod of the deployment mydeployment using the first container by default kubectl exec deploy mydeployment date Get output from running date command from the first pod of the service myservice using the first container by default kubectl exec svc myservice date table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 c container string td tr tr td td td style line height 130 word wrap break word p Container name If omitted use the kubectl kubernetes io default container annotation for selecting the container to be attached or the first container in the pod will be chosen p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p to use to exec into the resource p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for exec p td tr tr td colspan 2 pod running timeout duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p The length of time like 5s 2m or 3h higher than zero to wait until at least one pod is running p td tr tr td colspan 2 q quiet td tr tr td td td style line height 130 word wrap break word p Only print output from the remote session p td tr tr td colspan 2 i stdin td tr tr td td td style line height 130 word wrap break word p Pass stdin to the container p td tr tr td colspan 2 t tty td tr tr td td td style line height 130 word wrap break word p Stdin is a TTY p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl patch autogenerated true | ---
title: kubectl patch
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Update fields of a resource using strategic merge patch, a JSON merge patch, or a JSON patch.
JSON and YAML formats are accepted.
Note: Strategic merge patch is not supported for custom resources.
```
kubectl patch (-f FILENAME | TYPE NAME) [-p PATCH|--patch-file FILE]
```
##
```
# Partially update a node using a strategic merge patch, specifying the patch as JSON
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
# Partially update a node using a strategic merge patch, specifying the patch as YAML
kubectl patch node k8s-node-1 -p $'spec:\n unschedulable: true'
# Partially update a node identified by the type and name specified in "node.json" using strategic merge patch
kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
# Update a container's image; spec.containers[*].name is required because it's a merge key
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
# Update a container's image using a JSON patch with positional arrays
kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
# Update a deployment's replicas through the 'scale' subresource using a merge patch
kubectl patch deployment nginx-deployment --subresource='scale' --type='merge' -p '{"spec":{"replicas":2}}'
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-patch"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to update</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for patch</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--local</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, patch will operate on the content of the file, not the server-side resource.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-p, --patch string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The patch to be applied to the resource JSON file.</p></td>
</tr>
<tr>
<td colspan="2">--patch-file string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>A file containing a patch to be applied to the resource.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--subresource string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If specified, patch will operate on the subresource of the requested object. Must be one of [status scale]. This flag is beta and may change in the future.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--type string Default: "strategic"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The type of patch being provided; one of [json merge strategic]</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl patch content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Update fields of a resource using strategic merge patch a JSON merge patch or a JSON patch JSON and YAML formats are accepted Note Strategic merge patch is not supported for custom resources kubectl patch f FILENAME TYPE NAME p PATCH patch file FILE Partially update a node using a strategic merge patch specifying the patch as JSON kubectl patch node k8s node 1 p spec unschedulable true Partially update a node using a strategic merge patch specifying the patch as YAML kubectl patch node k8s node 1 p spec n unschedulable true Partially update a node identified by the type and name specified in node json using strategic merge patch kubectl patch f node json p spec unschedulable true Update a container s image spec containers name is required because it s a merge key kubectl patch pod valid pod p spec containers name kubernetes serve hostname image new image Update a container s image using a JSON patch with positional arrays kubectl patch pod valid pod type json p op replace path spec containers 0 image value new image Update a deployment s replicas through the scale subresource using a merge patch kubectl patch deployment nginx deployment subresource scale type merge p spec replicas 2 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl patch td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to update p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for patch p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 local td tr tr td td td style line height 130 word wrap break word p If true patch will operate on the content of the file not the server side resource p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 p patch string td tr tr td td td style line height 130 word wrap break word p The patch to be applied to the resource JSON file p td tr tr td colspan 2 patch file string td tr tr td td td style line height 130 word wrap break word p A file containing a patch to be applied to the resource p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 subresource string td tr tr td td td style line height 130 word wrap break word p If specified patch will operate on the subresource of the requested object Must be one of status scale This flag is beta and may change in the future p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 type string nbsp nbsp nbsp nbsp nbsp Default strategic td tr tr td td td style line height 130 word wrap break word p The type of patch being provided one of json merge strategic p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl drain autogenerated true | ---
title: kubectl drain
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Drain node in preparation for maintenance.
The given node will be marked unschedulable to prevent new pods from arriving. 'drain' evicts the pods if the API server supports https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ eviction https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ . Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server). If there are daemon set-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any daemon set-managed pods, because those pods would be immediately replaced by the daemon set controller, which ignores unschedulable markings. If there are any pods that are neither mirror pods nor managed by a replication controller, replica set, daemon set, stateful set, or job, then drain will not delete any pods unless you use --force. --force will also allow deletion to proceed if the managing resource of one or more pods is missing.
'drain' waits for graceful termination. You should not operate on the machine until the command completes.
When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again.
https://kubernetes.io/images/docs/kubectl_drain.svg Workflowhttps://kubernetes.io/images/docs/kubectl_drain.svg
```
kubectl drain NODE
```
##
```
# Drain node "foo", even if there are pods not managed by a replication controller, replica set, job, daemon set, or stateful set on it
kubectl drain foo --force
# As above, but abort if there are pods not managed by a replication controller, replica set, job, daemon set, or stateful set, and use a grace period of 15 minutes
kubectl drain foo --grace-period=900
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--chunk-size int Default: 500</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future.</p></td>
</tr>
<tr>
<td colspan="2">--delete-emptydir-data</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained).</p></td>
</tr>
<tr>
<td colspan="2">--disable-eviction</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Force drain to use delete, even if eviction is supported. This will bypass checking PodDisruptionBudgets, use with caution.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--force</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Continue even if there are pods that do not declare a controller.</p></td>
</tr>
<tr>
<td colspan="2">--grace-period int Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for drain</p></td>
</tr>
<tr>
<td colspan="2">--ignore-daemonsets</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Ignore DaemonSet-managed pods.</p></td>
</tr>
<tr>
<td colspan="2">--pod-selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Label selector to filter pods on the node</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--skip-wait-for-delete-timeout int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If pod DeletionTimestamp older than N seconds, skip waiting for the pod. Seconds must be greater than 0 to skip.</p></td>
</tr>
<tr>
<td colspan="2">--timeout duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up, zero means infinite</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl drain content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Drain node in preparation for maintenance The given node will be marked unschedulable to prevent new pods from arriving drain evicts the pods if the API server supports https kubernetes io docs concepts workloads pods disruptions eviction https kubernetes io docs concepts workloads pods disruptions Otherwise it will use normal DELETE to delete the pods The drain evicts or deletes all pods except mirror pods which cannot be deleted through the API server If there are daemon set managed pods drain will not proceed without ignore daemonsets and regardless it will not delete any daemon set managed pods because those pods would be immediately replaced by the daemon set controller which ignores unschedulable markings If there are any pods that are neither mirror pods nor managed by a replication controller replica set daemon set stateful set or job then drain will not delete any pods unless you use force force will also allow deletion to proceed if the managing resource of one or more pods is missing drain waits for graceful termination You should not operate on the machine until the command completes When you are ready to put the node back into service use kubectl uncordon which will make the node schedulable again https kubernetes io images docs kubectl drain svg Workflowhttps kubernetes io images docs kubectl drain svg kubectl drain NODE Drain node foo even if there are pods not managed by a replication controller replica set job daemon set or stateful set on it kubectl drain foo force As above but abort if there are pods not managed by a replication controller replica set job daemon set or stateful set and use a grace period of 15 minutes kubectl drain foo grace period 900 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 chunk size int nbsp nbsp nbsp nbsp nbsp Default 500 td tr tr td td td style line height 130 word wrap break word p Return large lists in chunks rather than all at once Pass 0 to disable This flag is beta and may change in the future p td tr tr td colspan 2 delete emptydir data td tr tr td td td style line height 130 word wrap break word p Continue even if there are pods using emptyDir local data that will be deleted when the node is drained p td tr tr td colspan 2 disable eviction td tr tr td td td style line height 130 word wrap break word p Force drain to use delete even if eviction is supported This will bypass checking PodDisruptionBudgets use with caution p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 force td tr tr td td td style line height 130 word wrap break word p Continue even if there are pods that do not declare a controller p td tr tr td colspan 2 grace period int nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p Period of time in seconds given to each pod to terminate gracefully If negative the default value specified in the pod will be used p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for drain p td tr tr td colspan 2 ignore daemonsets td tr tr td td td style line height 130 word wrap break word p Ignore DaemonSet managed pods p td tr tr td colspan 2 pod selector string td tr tr td td td style line height 130 word wrap break word p Label selector to filter pods on the node p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 skip wait for delete timeout int td tr tr td td td style line height 130 word wrap break word p If pod DeletionTimestamp older than N seconds skip waiting for the pod Seconds must be greater than 0 to skip p td tr tr td colspan 2 timeout duration td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up zero means infinite p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl label autogenerated true | ---
title: kubectl label
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Update the labels on a resource.
* A label key and value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters each.
* Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app.
* If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
* If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
```
kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
```
##
```
# Update pod 'foo' with the label 'unhealthy' and the value 'true'
kubectl label pods foo unhealthy=true
# Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value
kubectl label --overwrite pods foo status=unhealthy
# Update all pods in the namespace
kubectl label pods --all status=unhealthy
# Update a pod identified by the type and name in "pod.json"
kubectl label -f pod.json status=unhealthy
# Update pod 'foo' only if the resource is unchanged from version 1
kubectl label pods foo status=unhealthy --resource-version=1
# Update pod 'foo' by removing a label named 'bar' if it exists
# Does not require the --overwrite flag
kubectl label pods foo bar-
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Select all resources, in the namespace of the specified resource types</p></td>
</tr>
<tr>
<td colspan="2">-A, --all-namespaces</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, check the specified action in all namespaces.</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-label"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">--field-selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to update the labels</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for label</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--list</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, display the labels for a given resource.</p></td>
</tr>
<tr>
<td colspan="2">--local</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, label will NOT contact api-server but run locally.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--overwrite</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--resource-version string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl label content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Update the labels on a resource A label key and value must begin with a letter or number and may contain letters numbers hyphens dots and underscores up to 63 characters each Optionally the key can begin with a DNS subdomain prefix and a single like example com my app If overwrite is true then existing labels can be overwritten otherwise attempting to overwrite a label will result in an error If resource version is specified then updates will use this resource version otherwise the existing resource version will be used kubectl label overwrite f FILENAME TYPE NAME KEY 1 VAL 1 KEY N VAL N resource version version Update pod foo with the label unhealthy and the value true kubectl label pods foo unhealthy true Update pod foo with the label status and the value unhealthy overwriting any existing value kubectl label overwrite pods foo status unhealthy Update all pods in the namespace kubectl label pods all status unhealthy Update a pod identified by the type and name in pod json kubectl label f pod json status unhealthy Update pod foo only if the resource is unchanged from version 1 kubectl label pods foo status unhealthy resource version 1 Update pod foo by removing a label named bar if it exists Does not require the overwrite flag kubectl label pods foo bar table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all td tr tr td td td style line height 130 word wrap break word p Select all resources in the namespace of the specified resource types p td tr tr td colspan 2 A all namespaces td tr tr td td td style line height 130 word wrap break word p If true check the specified action in all namespaces p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl label td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 field selector string td tr tr td td td style line height 130 word wrap break word p Selector field query to filter on supports and e g field selector key1 value1 key2 value2 The server only supports a limited number of field queries per type p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to update the labels p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for label p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 list td tr tr td td td style line height 130 word wrap break word p If true display the labels for a given resource p td tr tr td colspan 2 local td tr tr td td td style line height 130 word wrap break word p If true label will NOT contact api server but run locally p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 overwrite td tr tr td td td style line height 130 word wrap break word p If true allow labels to be overwritten otherwise reject label updates that overwrite existing labels p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 resource version string td tr tr td td td style line height 130 word wrap break word p If non empty the labels update will only succeed if this is the current resource version for the object Only valid when specifying a single resource p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference title kubectl auth whoami weight 30 autogenerated true | ---
title: kubectl auth whoami
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Experimental: Check who you are and your attributes (groups, extra).
This command is helpful to get yourself aware of the current user attributes,
especially when dynamic authentication, e.g., token webhook, auth proxy, or OIDC provider,
is enabled in the Kubernetes cluster.
```
kubectl auth whoami
```
##
```
# Get your subject attributes
kubectl auth whoami
# Get your subject attributes in JSON format
kubectl auth whoami -o json
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for whoami</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl auth](../) - Inspect authorization
| kubernetes reference | title kubectl auth whoami content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Experimental Check who you are and your attributes groups extra This command is helpful to get yourself aware of the current user attributes especially when dynamic authentication e g token webhook auth proxy or OIDC provider is enabled in the Kubernetes cluster kubectl auth whoami Get your subject attributes kubectl auth whoami Get your subject attributes in JSON format kubectl auth whoami o json table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for whoami p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl auth Inspect authorization |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 autogenerated true title kubectl auth reconcile | ---
title: kubectl auth reconcile
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Reconciles rules for RBAC role, role binding, cluster role, and cluster role binding objects.
Missing objects are created, and the containing namespace is created for namespaced objects, if required.
Existing roles are updated to include the permissions in the input objects, and remove extra permissions if --remove-extra-permissions is specified.
Existing bindings are updated to include the subjects in the input objects, and remove extra subjects if --remove-extra-subjects is specified.
This is preferred to 'apply' for RBAC resources so that semantically-aware merging of rules and subjects is done.
```
kubectl auth reconcile -f FILENAME
```
##
```
# Reconcile RBAC resources from a file
kubectl auth reconcile -f my-rbac-rules.yaml
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to reconcile.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for reconcile</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--remove-extra-permissions</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, removes extra permissions added to roles</p></td>
</tr>
<tr>
<td colspan="2">--remove-extra-subjects</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, removes extra subjects added to rolebindings</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl auth](../) - Inspect authorization
| kubernetes reference | title kubectl auth reconcile content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Reconciles rules for RBAC role role binding cluster role and cluster role binding objects Missing objects are created and the containing namespace is created for namespaced objects if required Existing roles are updated to include the permissions in the input objects and remove extra permissions if remove extra permissions is specified Existing bindings are updated to include the subjects in the input objects and remove extra subjects if remove extra subjects is specified This is preferred to apply for RBAC resources so that semantically aware merging of rules and subjects is done kubectl auth reconcile f FILENAME Reconcile RBAC resources from a file kubectl auth reconcile f my rbac rules yaml table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to reconcile p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for reconcile p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 remove extra permissions td tr tr td td td style line height 130 word wrap break word p If true removes extra permissions added to roles p td tr tr td colspan 2 remove extra subjects td tr tr td td td style line height 130 word wrap break word p If true removes extra subjects added to rolebindings p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl auth Inspect authorization |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl auth can i autogenerated true | ---
title: kubectl auth can-i
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Check whether an action is allowed.
VERB is a logical Kubernetes API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubernetes resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL that starts with "/". NAME is the name of a particular Kubernetes resource. This command pairs nicely with impersonation. See --as global flag.
```
kubectl auth can-i VERB [TYPE | TYPE/NAME | NONRESOURCEURL]
```
##
```
# Check to see if I can create pods in any namespace
kubectl auth can-i create pods --all-namespaces
# Check to see if I can list deployments in my current namespace
kubectl auth can-i list deployments.apps
# Check to see if service account "foo" of namespace "dev" can list pods in the namespace "prod"
# You must be allowed to use impersonation for the global option "--as"
kubectl auth can-i list pods --as=system:serviceaccount:dev:foo -n prod
# Check to see if I can do everything in my current namespace ("*" means all)
kubectl auth can-i '*' '*'
# Check to see if I can get the job named "bar" in namespace "foo"
kubectl auth can-i list jobs.batch/bar -n foo
# Check to see if I can read pod logs
kubectl auth can-i get pods --subresource=log
# Check to see if I can access the URL /logs/
kubectl auth can-i get /logs/
# Check to see if I can approve certificates.k8s.io
kubectl auth can-i approve certificates.k8s.io
# List all allowed actions in namespace "foo"
kubectl auth can-i --list --namespace=foo
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-A, --all-namespaces</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, check the specified action in all namespaces.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for can-i</p></td>
</tr>
<tr>
<td colspan="2">--list</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, prints all allowed actions.</p></td>
</tr>
<tr>
<td colspan="2">--no-headers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, prints allowed actions without headers</p></td>
</tr>
<tr>
<td colspan="2">-q, --quiet</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, suppress output and just return the exit code.</p></td>
</tr>
<tr>
<td colspan="2">--subresource string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>SubResource such as pod/log or deployment/scale</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl auth](../) - Inspect authorization
| kubernetes reference | title kubectl auth can i content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Check whether an action is allowed VERB is a logical Kubernetes API verb like get list watch delete etc TYPE is a Kubernetes resource Shortcuts and groups will be resolved NONRESOURCEURL is a partial URL that starts with NAME is the name of a particular Kubernetes resource This command pairs nicely with impersonation See as global flag kubectl auth can i VERB TYPE TYPE NAME NONRESOURCEURL Check to see if I can create pods in any namespace kubectl auth can i create pods all namespaces Check to see if I can list deployments in my current namespace kubectl auth can i list deployments apps Check to see if service account foo of namespace dev can list pods in the namespace prod You must be allowed to use impersonation for the global option as kubectl auth can i list pods as system serviceaccount dev foo n prod Check to see if I can do everything in my current namespace means all kubectl auth can i Check to see if I can get the job named bar in namespace foo kubectl auth can i list jobs batch bar n foo Check to see if I can read pod logs kubectl auth can i get pods subresource log Check to see if I can access the URL logs kubectl auth can i get logs Check to see if I can approve certificates k8s io kubectl auth can i approve certificates k8s io List all allowed actions in namespace foo kubectl auth can i list namespace foo table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 A all namespaces td tr tr td td td style line height 130 word wrap break word p If true check the specified action in all namespaces p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for can i p td tr tr td colspan 2 list td tr tr td td td style line height 130 word wrap break word p If true prints all allowed actions p td tr tr td colspan 2 no headers td tr tr td td td style line height 130 word wrap break word p If true prints allowed actions without headers p td tr tr td colspan 2 q quiet td tr tr td td td style line height 130 word wrap break word p If true suppress output and just return the exit code p td tr tr td colspan 2 subresource string td tr tr td td td style line height 130 word wrap break word p SubResource such as pod log or deployment scale p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl auth Inspect authorization |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl auth autogenerated true | ---
title: kubectl auth
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Inspect authorization.
```
kubectl auth [flags]
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for auth</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
* [kubectl auth can-i](kubectl_auth_can-i/) - Check whether an action is allowed
* [kubectl auth reconcile](kubectl_auth_reconcile/) - Reconciles rules for RBAC role, role binding, cluster role, and cluster role binding objects
* [kubectl auth whoami](kubectl_auth_whoami/) - Experimental: Check self subject attributes
| kubernetes reference | title kubectl auth content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Inspect authorization kubectl auth flags table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for auth p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager kubectl auth can i kubectl auth can i Check whether an action is allowed kubectl auth reconcile kubectl auth reconcile Reconciles rules for RBAC role role binding cluster role and cluster role binding objects kubectl auth whoami kubectl auth whoami Experimental Check self subject attributes |
kubernetes reference nolist true contenttype tool reference weight 30 autogenerated true title kubectl cp | ---
title: kubectl cp
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Copy files and directories to and from containers.
```
kubectl cp <file-spec-src> <file-spec-dest>
```
##
```
# !!!Important Note!!!
# Requires that the 'tar' binary is present in your container
# image. If 'tar' is not present, 'kubectl cp' will fail.
#
# For advanced use cases, such as symlinks, wildcard expansion or
# file mode preservation, consider using 'kubectl exec'.
# Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace <some-namespace>
tar cf - /tmp/foo | kubectl exec -i -n <some-namespace> <some-pod> -- tar xf - -C /tmp/bar
# Copy /tmp/foo from a remote pod to /tmp/bar locally
kubectl exec -n <some-namespace> <some-pod> -- tar cf - /tmp/foo | tar xf - -C /tmp/bar
# Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the default namespace
kubectl cp /tmp/foo_dir <some-pod>:/tmp/bar_dir
# Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container
kubectl cp /tmp/foo <some-pod>:/tmp/bar -c <specific-container>
# Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace <some-namespace>
kubectl cp /tmp/foo <some-namespace>/<some-pod>:/tmp/bar
# Copy /tmp/foo from a remote pod to /tmp/bar locally
kubectl cp <some-namespace>/<some-pod>:/tmp/foo /tmp/bar
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-c, --container string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Container name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for cp</p></td>
</tr>
<tr>
<td colspan="2">--no-preserve</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The copied file/directory's ownership and permissions will not be preserved in the container</p></td>
</tr>
<tr>
<td colspan="2">--retries int</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Set number of retries to complete a copy operation from a container. Specify 0 to disable or any negative value for infinite retrying. The default is 0 (no retry).</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl cp content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Copy files and directories to and from containers kubectl cp file spec src file spec dest Important Note Requires that the tar binary is present in your container image If tar is not present kubectl cp will fail For advanced use cases such as symlinks wildcard expansion or file mode preservation consider using kubectl exec Copy tmp foo local file to tmp bar in a remote pod in namespace some namespace tar cf tmp foo kubectl exec i n some namespace some pod tar xf C tmp bar Copy tmp foo from a remote pod to tmp bar locally kubectl exec n some namespace some pod tar cf tmp foo tar xf C tmp bar Copy tmp foo dir local directory to tmp bar dir in a remote pod in the default namespace kubectl cp tmp foo dir some pod tmp bar dir Copy tmp foo local file to tmp bar in a remote pod in a specific container kubectl cp tmp foo some pod tmp bar c specific container Copy tmp foo local file to tmp bar in a remote pod in namespace some namespace kubectl cp tmp foo some namespace some pod tmp bar Copy tmp foo from a remote pod to tmp bar locally kubectl cp some namespace some pod tmp foo tmp bar table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 c container string td tr tr td td td style line height 130 word wrap break word p Container name If omitted use the kubectl kubernetes io default container annotation for selecting the container to be attached or the first container in the pod will be chosen p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for cp p td tr tr td colspan 2 no preserve td tr tr td td td style line height 130 word wrap break word p The copied file directory s ownership and permissions will not be preserved in the container p td tr tr td colspan 2 retries int td tr tr td td td style line height 130 word wrap break word p Set number of retries to complete a copy operation from a container Specify 0 to disable or any negative value for infinite retrying The default is 0 no retry p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference title kubectl port forward nolist true contenttype tool reference weight 30 autogenerated true | ---
title: kubectl port-forward
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Forward one or more local ports to a pod.
Use resource type/name such as deployment/mydeployment to select a pod. Resource type defaults to 'pod' if omitted.
If there are multiple pods matching the criteria, a pod will be selected automatically. The forwarding session ends when the selected pod terminates, and a rerun of the command is needed to resume forwarding.
```
kubectl port-forward TYPE/NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N]
```
##
```
# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
kubectl port-forward pod/mypod 5000 6000
# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment
kubectl port-forward deployment/mydeployment 5000 6000
# Listen on port 8443 locally, forwarding to the targetPort of the service's port named "https" in a pod selected by the service
kubectl port-forward service/myservice 8443:https
# Listen on port 8888 locally, forwarding to 5000 in the pod
kubectl port-forward pod/mypod 8888:5000
# Listen on port 8888 on all addresses, forwarding to 5000 in the pod
kubectl port-forward --address 0.0.0.0 pod/mypod 8888:5000
# Listen on port 8888 on localhost and selected IP, forwarding to 5000 in the pod
kubectl port-forward --address localhost,10.19.21.23 pod/mypod 8888:5000
# Listen on a random port locally, forwarding to 5000 in the pod
kubectl port-forward pod/mypod :5000
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--address strings Default: "localhost"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Addresses to listen on (comma separated). Only accepts IP addresses or localhost as a value. When localhost is supplied, kubectl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these addresses are available to bind.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for port-forward</p></td>
</tr>
<tr>
<td colspan="2">--pod-running-timeout duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl port forward content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Forward one or more local ports to a pod Use resource type name such as deployment mydeployment to select a pod Resource type defaults to pod if omitted If there are multiple pods matching the criteria a pod will be selected automatically The forwarding session ends when the selected pod terminates and a rerun of the command is needed to resume forwarding kubectl port forward TYPE NAME options LOCAL PORT REMOTE PORT LOCAL PORT N REMOTE PORT N Listen on ports 5000 and 6000 locally forwarding data to from ports 5000 and 6000 in the pod kubectl port forward pod mypod 5000 6000 Listen on ports 5000 and 6000 locally forwarding data to from ports 5000 and 6000 in a pod selected by the deployment kubectl port forward deployment mydeployment 5000 6000 Listen on port 8443 locally forwarding to the targetPort of the service s port named https in a pod selected by the service kubectl port forward service myservice 8443 https Listen on port 8888 locally forwarding to 5000 in the pod kubectl port forward pod mypod 8888 5000 Listen on port 8888 on all addresses forwarding to 5000 in the pod kubectl port forward address 0 0 0 0 pod mypod 8888 5000 Listen on port 8888 on localhost and selected IP forwarding to 5000 in the pod kubectl port forward address localhost 10 19 21 23 pod mypod 8888 5000 Listen on a random port locally forwarding to 5000 in the pod kubectl port forward pod mypod 5000 table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 address strings nbsp nbsp nbsp nbsp nbsp Default localhost td tr tr td td td style line height 130 word wrap break word p Addresses to listen on comma separated Only accepts IP addresses or localhost as a value When localhost is supplied kubectl will try to bind on both 127 0 0 1 and 1 and will fail if neither of these addresses are available to bind p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for port forward p td tr tr td colspan 2 pod running timeout duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p The length of time like 5s 2m or 3h higher than zero to wait until at least one pod is running p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl replace autogenerated true | ---
title: kubectl replace
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Replace a resource by file name or stdin.
JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by
$ kubectl get TYPE NAME -o yaml
```
kubectl replace -f FILENAME
```
##
```
# Replace a pod using the data in pod.json
kubectl replace -f ./pod.json
# Replace a pod based on the JSON passed into stdin
cat pod.json | kubectl replace -f -
# Update a single-container pod's image version (tag) to v4
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
# Force replace, delete and then re-create the resource
kubectl replace --force -f ./pod.json
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--cascade string[="background"] Default: "background"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "background", "orphan", or "foreground". Selects the deletion cascading strategy for the dependents (e.g. Pods created by a ReplicationController). Defaults to background.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-replace"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The files that contain the configurations to replace.</p></td>
</tr>
<tr>
<td colspan="2">--force</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.</p></td>
</tr>
<tr>
<td colspan="2">--grace-period int Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion).</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for replace</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process a kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">--raw string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Raw URI to PUT to the server. Uses the transport specified by the kubeconfig file.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--save-config</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--subresource string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If specified, replace will operate on the subresource of the requested object. Must be one of [status scale]. This flag is beta and may change in the future.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">--timeout duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object</p></td>
</tr>
<tr>
<td colspan="2">--validate string[="strict"] Default: "strict"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be one of: strict (or true), warn, ignore (or false).<br/>"true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not.<br/>"warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise.<br/>"false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields.</p></td>
</tr>
<tr>
<td colspan="2">--wait</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, wait for resources to be gone before returning. This waits for finalizers.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl replace content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Replace a resource by file name or stdin JSON and YAML formats are accepted If replacing an existing resource the complete resource spec must be provided This can be obtained by kubectl get TYPE NAME o yaml kubectl replace f FILENAME Replace a pod using the data in pod json kubectl replace f pod json Replace a pod based on the JSON passed into stdin cat pod json kubectl replace f Update a single container pod s image version tag to v4 kubectl get pod mypod o yaml sed s image myimage 1 v4 kubectl replace f Force replace delete and then re create the resource kubectl replace force f pod json table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 cascade string background nbsp nbsp nbsp nbsp nbsp Default background td tr tr td td td style line height 130 word wrap break word p Must be quot background quot quot orphan quot or quot foreground quot Selects the deletion cascading strategy for the dependents e g Pods created by a ReplicationController Defaults to background p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl replace td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p The files that contain the configurations to replace p td tr tr td colspan 2 force td tr tr td td td style line height 130 word wrap break word p If true immediately remove resources from API and bypass graceful deletion Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation p td tr tr td colspan 2 grace period int nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p Period of time in seconds given to the resource to terminate gracefully Ignored if negative Set to 1 for immediate shutdown Can only be set to 0 when force is true force deletion p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for replace p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process a kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 raw string td tr tr td td td style line height 130 word wrap break word p Raw URI to PUT to the server Uses the transport specified by the kubeconfig file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 save config td tr tr td td td style line height 130 word wrap break word p If true the configuration of current object will be saved in its annotation Otherwise the annotation will be unchanged This flag is useful when you want to perform kubectl apply on this object in the future p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 subresource string td tr tr td td td style line height 130 word wrap break word p If specified replace will operate on the subresource of the requested object Must be one of status scale This flag is beta and may change in the future p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 timeout duration td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a delete zero means determine a timeout from the size of the object p td tr tr td colspan 2 validate string strict nbsp nbsp nbsp nbsp nbsp Default strict td tr tr td td td style line height 130 word wrap break word p Must be one of strict or true warn ignore or false br quot true quot or quot strict quot will use a schema to validate the input and fail the request if invalid It will perform server side validation if ServerSideFieldValidation is enabled on the api server but will fall back to less reliable client side validation if not br quot warn quot will warn about unknown or duplicate fields without blocking the request if server side field validation is enabled on the API server and behave as quot ignore quot otherwise br quot false quot or quot ignore quot will not perform any schema validation silently dropping any unknown or duplicate fields p td tr tr td colspan 2 wait td tr tr td td td style line height 130 word wrap break word p If true wait for resources to be gone before returning This waits for finalizers p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 autogenerated true title kubectl get | ---
title: kubectl get
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Display one or many resources.
Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the --selector flag. If the desired resource type is namespaced you will only see results in the current namespace if you don't specify any namespace.
By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resources.
Use "kubectl api-resources" for a complete list of supported resources.
```
kubectl get [(-o|--output=)json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file|custom-columns|custom-columns-file|wide] (TYPE[.VERSION][.GROUP] [NAME | -l label] | TYPE[.VERSION][.GROUP]/NAME ...) [flags]
```
##
```
# List all pods in ps output format
kubectl get pods
# List all pods in ps output format with more information (such as node name)
kubectl get pods -o wide
# List a single replication controller with specified NAME in ps output format
kubectl get replicationcontroller web
# List deployments in JSON output format, in the "v1" version of the "apps" API group
kubectl get deployments.v1.apps -o json
# List a single pod in JSON output format
kubectl get -o json pod web-pod-13je7
# List a pod identified by type and name specified in "pod.yaml" in JSON output format
kubectl get -f pod.yaml -o json
# List resources from a directory with kustomization.yaml - e.g. dir/kustomization.yaml
kubectl get -k dir/
# Return only the phase value of the specified pod
kubectl get -o template pod/web-pod-13je7 --template=
# List resource information in custom columns
kubectl get pod test-pod -o custom-columns=CONTAINER:.spec.containers[0].name,IMAGE:.spec.containers[0].image
# List all replication controllers and services together in ps output format
kubectl get rc,services
# List one or more resources by their type and names
kubectl get rc/web service/frontend pods/web-pod-13je7
# List the 'status' subresource for a single pod
kubectl get pod web-pod-13je7 --subresource status
# List all deployments in namespace 'backend'
kubectl get deployments.apps --namespace backend
# List all pods existing in all namespaces
kubectl get pods --all-namespaces
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-A, --all-namespaces</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.</p></td>
</tr>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">--chunk-size int Default: 500</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future.</p></td>
</tr>
<tr>
<td colspan="2">--field-selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to get from a server.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for get</p></td>
</tr>
<tr>
<td colspan="2">--ignore-not-found</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If the requested object does not exist the command will return exit code 0.</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-L, --label-columns strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2...</p></td>
</tr>
<tr>
<td colspan="2">--no-headers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When using the default or custom-column output format, don't print headers (default print headers).</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide). See custom columns [https://kubernetes.io/docs/reference/kubectl/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [https://kubernetes.io/docs/reference/kubectl/jsonpath/].</p></td>
</tr>
<tr>
<td colspan="2">--output-watch-events</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output watch event objects when --watch or --watch-only is used. Existing objects are output as initial ADDED events.</p></td>
</tr>
<tr>
<td colspan="2">--raw string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Raw URI to request from the server. Uses the transport specified by the kubeconfig file.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--server-print Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, have the server return the appropriate table output. Supports extension APIs and CRDs.</p></td>
</tr>
<tr>
<td colspan="2">--show-kind</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, list the resource type for the requested object(s).</p></td>
</tr>
<tr>
<td colspan="2">--show-labels</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When printing, show all labels as the last column (default hide labels column)</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--sort-by string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.</p></td>
</tr>
<tr>
<td colspan="2">--subresource string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If specified, gets the subresource of the requested object. Must be one of [status scale]. This flag is beta and may change in the future.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
<tr>
<td colspan="2">-w, --watch</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>After listing/getting the requested object, watch for changes.</p></td>
</tr>
<tr>
<td colspan="2">--watch-only</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Watch for changes to the requested object(s), without listing/getting first.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl get content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Display one or many resources Prints a table of the most important information about the specified resources You can filter the list using a label selector and the selector flag If the desired resource type is namespaced you will only see results in the current namespace if you don t specify any namespace By specifying the output as template and providing a Go template as the value of the template flag you can filter the attributes of the fetched resources Use kubectl api resources for a complete list of supported resources kubectl get o output json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file custom columns custom columns file wide TYPE VERSION GROUP NAME l label TYPE VERSION GROUP NAME flags List all pods in ps output format kubectl get pods List all pods in ps output format with more information such as node name kubectl get pods o wide List a single replication controller with specified NAME in ps output format kubectl get replicationcontroller web List deployments in JSON output format in the v1 version of the apps API group kubectl get deployments v1 apps o json List a single pod in JSON output format kubectl get o json pod web pod 13je7 List a pod identified by type and name specified in pod yaml in JSON output format kubectl get f pod yaml o json List resources from a directory with kustomization yaml e g dir kustomization yaml kubectl get k dir Return only the phase value of the specified pod kubectl get o template pod web pod 13je7 template List resource information in custom columns kubectl get pod test pod o custom columns CONTAINER spec containers 0 name IMAGE spec containers 0 image List all replication controllers and services together in ps output format kubectl get rc services List one or more resources by their type and names kubectl get rc web service frontend pods web pod 13je7 List the status subresource for a single pod kubectl get pod web pod 13je7 subresource status List all deployments in namespace backend kubectl get deployments apps namespace backend List all pods existing in all namespaces kubectl get pods all namespaces table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 A all namespaces td tr tr td td td style line height 130 word wrap break word p If present list the requested object s across all namespaces Namespace in current context is ignored even if specified with namespace p td tr tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 chunk size int nbsp nbsp nbsp nbsp nbsp Default 500 td tr tr td td td style line height 130 word wrap break word p Return large lists in chunks rather than all at once Pass 0 to disable This flag is beta and may change in the future p td tr tr td colspan 2 field selector string td tr tr td td td style line height 130 word wrap break word p Selector field query to filter on supports and e g field selector key1 value1 key2 value2 The server only supports a limited number of field queries per type p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to get from a server p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for get p td tr tr td colspan 2 ignore not found td tr tr td td td style line height 130 word wrap break word p If the requested object does not exist the command will return exit code 0 p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 L label columns strings td tr tr td td td style line height 130 word wrap break word p Accepts a comma separated list of labels that are going to be presented as columns Names are case sensitive You can also use multiple flag options like L label1 L label2 p td tr tr td colspan 2 no headers td tr tr td td td style line height 130 word wrap break word p When using the default or custom column output format don t print headers default print headers p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file custom columns custom columns file wide See custom columns https kubernetes io docs reference kubectl custom columns golang template http golang org pkg text template pkg overview and jsonpath template https kubernetes io docs reference kubectl jsonpath p td tr tr td colspan 2 output watch events td tr tr td td td style line height 130 word wrap break word p Output watch event objects when watch or watch only is used Existing objects are output as initial ADDED events p td tr tr td colspan 2 raw string td tr tr td td td style line height 130 word wrap break word p Raw URI to request from the server Uses the transport specified by the kubeconfig file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 server print nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true have the server return the appropriate table output Supports extension APIs and CRDs p td tr tr td colspan 2 show kind td tr tr td td td style line height 130 word wrap break word p If present list the resource type for the requested object s p td tr tr td colspan 2 show labels td tr tr td td td style line height 130 word wrap break word p When printing show all labels as the last column default hide labels column p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 sort by string td tr tr td td td style line height 130 word wrap break word p If non empty sort list types using this field specification The field specification is expressed as a JSONPath expression e g metadata name The field in the API resource specified by this JSONPath expression must be an integer or a string p td tr tr td colspan 2 subresource string td tr tr td td td style line height 130 word wrap break word p If specified gets the subresource of the requested object Must be one of status scale This flag is beta and may change in the future p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tr td colspan 2 w watch td tr tr td td td style line height 130 word wrap break word p After listing getting the requested object watch for changes p td tr tr td colspan 2 watch only td tr tr td td td style line height 130 word wrap break word p Watch for changes to the requested object s without listing getting first p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference title kubectl diff nolist true contenttype tool reference weight 30 autogenerated true | ---
title: kubectl diff
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Diff configurations specified by file name or stdin between the current online configuration, and the configuration as it would be if applied.
The output is always YAML.
KUBECTL_EXTERNAL_DIFF environment variable can be used to select your own diff command. Users can use external commands with params too, example: KUBECTL_EXTERNAL_DIFF="colordiff -N -u"
By default, the "diff" command available in your path will be run with the "-u" (unified diff) and "-N" (treat absent files as empty) options.
Exit status: 0 No differences were found. 1 Differences were found. >1 Kubectl or diff failed with an error.
Note: KUBECTL_EXTERNAL_DIFF, if used, is expected to follow that convention.
```
kubectl diff -f FILENAME
```
##
```
# Diff resources included in pod.json
kubectl diff -f pod.json
# Diff file read from stdin
cat service.yaml | kubectl diff -f -
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--concurrency int Default: 1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Number of objects to process in parallel when diffing against the live version. Larger number = faster, but more memory, I/O and CPU over that shorter period of time.</p></td>
</tr>
<tr>
<td colspan="2">--field-manager string Default: "kubectl-client-side-apply"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the manager used to track field ownership.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files contains the configuration to diff</p></td>
</tr>
<tr>
<td colspan="2">--force-conflicts</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, server-side apply will force the changes against conflicts.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for diff</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--prune</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Include resources that would be deleted by pruning. Can be used with -l and default shows all resources would be pruned</p></td>
</tr>
<tr>
<td colspan="2">--prune-allowlist strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Overwrite the default allowlist with <group/version/kind> for --prune</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--server-side</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, apply runs in the server instead of the client.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, include managed fields in the diff.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl diff content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Diff configurations specified by file name or stdin between the current online configuration and the configuration as it would be if applied The output is always YAML KUBECTL EXTERNAL DIFF environment variable can be used to select your own diff command Users can use external commands with params too example KUBECTL EXTERNAL DIFF colordiff N u By default the diff command available in your path will be run with the u unified diff and N treat absent files as empty options Exit status 0 No differences were found 1 Differences were found gt 1 Kubectl or diff failed with an error Note KUBECTL EXTERNAL DIFF if used is expected to follow that convention kubectl diff f FILENAME Diff resources included in pod json kubectl diff f pod json Diff file read from stdin cat service yaml kubectl diff f table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 concurrency int nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p Number of objects to process in parallel when diffing against the live version Larger number faster but more memory I O and CPU over that shorter period of time p td tr tr td colspan 2 field manager string nbsp nbsp nbsp nbsp nbsp Default kubectl client side apply td tr tr td td td style line height 130 word wrap break word p Name of the manager used to track field ownership p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files contains the configuration to diff p td tr tr td colspan 2 force conflicts td tr tr td td td style line height 130 word wrap break word p If true server side apply will force the changes against conflicts p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for diff p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 prune td tr tr td td td style line height 130 word wrap break word p Include resources that would be deleted by pruning Can be used with l and default shows all resources would be pruned p td tr tr td colspan 2 prune allowlist strings td tr tr td td td style line height 130 word wrap break word p Overwrite the default allowlist with lt group version kind gt for prune p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 server side td tr tr td td td style line height 130 word wrap break word p If true apply runs in the server instead of the client p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true include managed fields in the diff p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl delete autogenerated true | ---
title: kubectl delete
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Delete resources by file names, stdin, resources and names, or by resources and label selector.
JSON and YAML formats are accepted. Only one type of argument may be specified: file names, resources and names, or resources and label selector.
Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must specify the --force flag. Note: only a subset of resources support graceful deletion. In absence of the support, the --grace-period flag is ignored.
IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods, the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately.
Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource.
After a CustomResourceDefinition is deleted, invalidation of discovery cache may take up to 6 hours. If you don't want to wait, you might want to run "kubectl api-resources" to refresh the discovery cache.
```
kubectl delete ([-f FILENAME] | [-k DIRECTORY] | TYPE [(NAME | -l label | --all)])
```
##
```
# Delete a pod using the type and name specified in pod.json
kubectl delete -f ./pod.json
# Delete resources from a directory containing kustomization.yaml - e.g. dir/kustomization.yaml
kubectl delete -k dir
# Delete resources from all files that end with '.json'
kubectl delete -f '*.json'
# Delete a pod based on the type and name in the JSON passed into stdin
cat pod.json | kubectl delete -f -
# Delete pods and services with same names "baz" and "foo"
kubectl delete pod,service baz foo
# Delete pods and services with label name=myLabel
kubectl delete pods,services -l name=myLabel
# Delete a pod with minimal delay
kubectl delete pod foo --now
# Force delete a pod on a dead node
kubectl delete pod foo --force
# Delete all pods
kubectl delete pods --all
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--all</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Delete all resources, in the namespace of the specified resource types.</p></td>
</tr>
<tr>
<td colspan="2">-A, --all-namespaces</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.</p></td>
</tr>
<tr>
<td colspan="2">--cascade string[="background"] Default: "background"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "background", "orphan", or "foreground". Selects the deletion cascading strategy for the dependents (e.g. Pods created by a ReplicationController). Defaults to background.</p></td>
</tr>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">--field-selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>containing the resource to delete.</p></td>
</tr>
<tr>
<td colspan="2">--force</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.</p></td>
</tr>
<tr>
<td colspan="2">--grace-period int Default: -1</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion).</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for delete</p></td>
</tr>
<tr>
<td colspan="2">--ignore-not-found</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified.</p></td>
</tr>
<tr>
<td colspan="2">-i, --interactive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, delete resource only when user confirms.</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process a kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">--now</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, resources are signaled for immediate shutdown (same as --grace-period=1).</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output mode. Use "-o name" for shorter output (resource/name).</p></td>
</tr>
<tr>
<td colspan="2">--raw string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Raw URI to DELETE to the server. Uses the transport specified by the kubeconfig file.</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
<tr>
<td colspan="2">--timeout duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object</p></td>
</tr>
<tr>
<td colspan="2">--wait Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, wait for resources to be gone before returning. This waits for finalizers.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl delete content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Delete resources by file names stdin resources and names or by resources and label selector JSON and YAML formats are accepted Only one type of argument may be specified file names resources and names or resources and label selector Some resources such as pods support graceful deletion These resources define a default period before they are forcibly terminated the grace period but you may override that value with the grace period flag or pass now to set a grace period of 1 Because these resources often represent entities in the cluster deletion may not be acknowledged immediately If the node hosting a pod is down or cannot reach the API server termination may take significantly longer than the grace period To force delete a resource you must specify the force flag Note only a subset of resources support graceful deletion In absence of the support the grace period flag is ignored IMPORTANT Force deleting pods does not wait for confirmation that the pod s processes have been terminated which can leave those processes running until the node detects the deletion and completes graceful deletion If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency Only force delete pods when you are sure the pod is terminated or if your application can tolerate multiple copies of the same pod running at once Also if you force delete pods the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately Note that the delete command does NOT do resource version checks so if someone submits an update to a resource right when you submit a delete their update will be lost along with the rest of the resource After a CustomResourceDefinition is deleted invalidation of discovery cache may take up to 6 hours If you don t want to wait you might want to run kubectl api resources to refresh the discovery cache kubectl delete f FILENAME k DIRECTORY TYPE NAME l label all Delete a pod using the type and name specified in pod json kubectl delete f pod json Delete resources from a directory containing kustomization yaml e g dir kustomization yaml kubectl delete k dir Delete resources from all files that end with json kubectl delete f json Delete a pod based on the type and name in the JSON passed into stdin cat pod json kubectl delete f Delete pods and services with same names baz and foo kubectl delete pod service baz foo Delete pods and services with label name myLabel kubectl delete pods services l name myLabel Delete a pod with minimal delay kubectl delete pod foo now Force delete a pod on a dead node kubectl delete pod foo force Delete all pods kubectl delete pods all table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 all td tr tr td td td style line height 130 word wrap break word p Delete all resources in the namespace of the specified resource types p td tr tr td colspan 2 A all namespaces td tr tr td td td style line height 130 word wrap break word p If present list the requested object s across all namespaces Namespace in current context is ignored even if specified with namespace p td tr tr td colspan 2 cascade string background nbsp nbsp nbsp nbsp nbsp Default background td tr tr td td td style line height 130 word wrap break word p Must be quot background quot quot orphan quot or quot foreground quot Selects the deletion cascading strategy for the dependents e g Pods created by a ReplicationController Defaults to background p td tr tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 field selector string td tr tr td td td style line height 130 word wrap break word p Selector field query to filter on supports and e g field selector key1 value1 key2 value2 The server only supports a limited number of field queries per type p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p containing the resource to delete p td tr tr td colspan 2 force td tr tr td td td style line height 130 word wrap break word p If true immediately remove resources from API and bypass graceful deletion Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation p td tr tr td colspan 2 grace period int nbsp nbsp nbsp nbsp nbsp Default 1 td tr tr td td td style line height 130 word wrap break word p Period of time in seconds given to the resource to terminate gracefully Ignored if negative Set to 1 for immediate shutdown Can only be set to 0 when force is true force deletion p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for delete p td tr tr td colspan 2 ignore not found td tr tr td td td style line height 130 word wrap break word p Treat quot resource not found quot as a successful delete Defaults to quot true quot when all is specified p td tr tr td colspan 2 i interactive td tr tr td td td style line height 130 word wrap break word p If true delete resource only when user confirms p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process a kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 now td tr tr td td td style line height 130 word wrap break word p If true resources are signaled for immediate shutdown same as grace period 1 p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output mode Use quot o name quot for shorter output resource name p td tr tr td colspan 2 raw string td tr tr td td td style line height 130 word wrap break word p Raw URI to DELETE to the server Uses the transport specified by the kubeconfig file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tr td colspan 2 timeout duration td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a delete zero means determine a timeout from the size of the object p td tr tr td colspan 2 wait nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true wait for resources to be gone before returning This waits for finalizers p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl certificate approve autogenerated true | ---
title: kubectl certificate approve
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Approve a certificate signing request.
kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requester with the attributes requested in the CSR.
SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.
```
kubectl certificate approve (-f FILENAME | NAME)
```
##
```
# Approve CSR 'csr-sqgzp'
kubectl certificate approve csr-sqgzp
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to update</p></td>
</tr>
<tr>
<td colspan="2">--force</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Update the CSR even if it is already approved.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for approve</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl certificate](../) - Modify certificate resources
| kubernetes reference | title kubectl certificate approve content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Approve a certificate signing request kubectl certificate approve allows a cluster admin to approve a certificate signing request CSR This action tells a certificate signing controller to issue a certificate to the requester with the attributes requested in the CSR SECURITY NOTICE Depending on the requested attributes the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity Before approving a CSR ensure you understand what the signed certificate can do kubectl certificate approve f FILENAME NAME Approve CSR csr sqgzp kubectl certificate approve csr sqgzp table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to update p td tr tr td colspan 2 force td tr tr td td td style line height 130 word wrap break word p Update the CSR even if it is already approved p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for approve p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl certificate Modify certificate resources |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl certificate deny autogenerated true | ---
title: kubectl certificate deny
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Deny a certificate signing request.
kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requester.
```
kubectl certificate deny (-f FILENAME | NAME)
```
##
```
# Deny CSR 'csr-sqgzp'
kubectl certificate deny csr-sqgzp
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--allow-missing-template-keys Default: true</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.</p></td>
</tr>
<tr>
<td colspan="2">-f, --filename strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Filename, directory, or URL to files identifying the resource to update</p></td>
</tr>
<tr>
<td colspan="2">--force</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Update the CSR even if it is already denied.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for deny</p></td>
</tr>
<tr>
<td colspan="2">-k, --kustomize string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the kustomization directory. This flag can't be used together with -f or -R.</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).</p></td>
</tr>
<tr>
<td colspan="2">-R, --recursive</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</p></td>
</tr>
<tr>
<td colspan="2">--show-managed-fields</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, keep the managedFields when printing objects in JSON or YAML format.</p></td>
</tr>
<tr>
<td colspan="2">--template string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl certificate](../) - Modify certificate resources
| kubernetes reference | title kubectl certificate deny content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Deny a certificate signing request kubectl certificate deny allows a cluster admin to deny a certificate signing request CSR This action tells a certificate signing controller to not to issue a certificate to the requester kubectl certificate deny f FILENAME NAME Deny CSR csr sqgzp kubectl certificate deny csr sqgzp table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 allow missing template keys nbsp nbsp nbsp nbsp nbsp Default true td tr tr td td td style line height 130 word wrap break word p If true ignore any errors in templates when a field or map key is missing in the template Only applies to golang and jsonpath output formats p td tr tr td colspan 2 f filename strings td tr tr td td td style line height 130 word wrap break word p Filename directory or URL to files identifying the resource to update p td tr tr td colspan 2 force td tr tr td td td style line height 130 word wrap break word p Update the CSR even if it is already denied p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for deny p td tr tr td colspan 2 k kustomize string td tr tr td td td style line height 130 word wrap break word p Process the kustomization directory This flag can t be used together with f or R p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of json yaml name go template go template file template templatefile jsonpath jsonpath as json jsonpath file p td tr tr td colspan 2 R recursive td tr tr td td td style line height 130 word wrap break word p Process the directory used in f filename recursively Useful when you want to manage related manifests organized within the same directory p td tr tr td colspan 2 show managed fields td tr tr td td td style line height 130 word wrap break word p If true keep the managedFields when printing objects in JSON or YAML format p td tr tr td colspan 2 template string td tr tr td td td style line height 130 word wrap break word p Template string or path to template file to use when o go template o go template file The template format is golang templates http golang org pkg text template pkg overview p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl certificate Modify certificate resources |
kubernetes reference nolist true contenttype tool reference weight 30 title kubectl certificate autogenerated true | ---
title: kubectl certificate
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Modify certificate resources.
```
kubectl certificate SUBCOMMAND
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for certificate</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
* [kubectl certificate approve](kubectl_certificate_approve/) - Approve a certificate signing request
* [kubectl certificate deny](kubectl_certificate_deny/) - Deny a certificate signing request
| kubernetes reference | title kubectl certificate content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Modify certificate resources kubectl certificate SUBCOMMAND table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for certificate p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager kubectl certificate approve kubectl certificate approve Approve a certificate signing request kubectl certificate deny kubectl certificate deny Deny a certificate signing request |
kubernetes reference nolist true contenttype tool reference title kubectl cordon weight 30 autogenerated true | ---
title: kubectl cordon
content_type: tool-reference
weight: 30
auto_generated: true
no_list: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Mark node as unschedulable.
```
kubectl cordon NODE
```
##
```
# Mark node "foo" as unschedulable
kubectl cordon foo
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--dry-run string[="unchanged"] Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.</p></td>
</tr>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for cordon</p></td>
</tr>
<tr>
<td colspan="2">-l, --selector string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager
| kubernetes reference | title kubectl cordon content type tool reference weight 30 auto generated true no list true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Mark node as unschedulable kubectl cordon NODE Mark node foo as unschedulable kubectl cordon foo table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 dry run string unchanged nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Must be quot none quot quot server quot or quot client quot If client strategy only print the object that would be sent without sending it If server strategy submit server side request without persisting the resource p td tr tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for cordon p td tr tr td colspan 2 l selector string td tr tr td td td style line height 130 word wrap break word p Selector label query to filter on supports and e g l key1 value1 key2 value2 Matching objects must satisfy all of the specified label constraints p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p Path to the kubeconfig file to use for CLI requests p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl kubectl kubectl controls the Kubernetes cluster manager |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference title kubectl config get users weight 30 autogenerated true | ---
title: kubectl config get-users
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Display users defined in the kubeconfig.
```
kubectl config get-users [flags]
```
##
```
# List the users that kubectl knows about
kubectl config get-users
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for get-users</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use a particular kubeconfig file</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl config](../) - Modify kubeconfig files
| kubernetes reference | title kubectl config get users content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Display users defined in the kubeconfig kubectl config get users flags List the users that kubectl knows about kubectl config get users table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for get users p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p use a particular kubeconfig file p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl config Modify kubeconfig files |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl config unset autogenerated true | ---
title: kubectl config unset
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Unset an individual value in a kubeconfig file.
PROPERTY_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
```
kubectl config unset PROPERTY_NAME
```
##
```
# Unset the current-context
kubectl config unset current-context
# Unset namespace in foo context
kubectl config unset contexts.foo.namespace
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for unset</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use a particular kubeconfig file</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl config](../) - Modify kubeconfig files
| kubernetes reference | title kubectl config unset content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Unset an individual value in a kubeconfig file PROPERTY NAME is a dot delimited name where each token represents either an attribute name or a map key Map keys may not contain dots kubectl config unset PROPERTY NAME Unset the current context kubectl config unset current context Unset namespace in foo context kubectl config unset contexts foo namespace table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for unset p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p use a particular kubeconfig file p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl config Modify kubeconfig files |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl config delete user autogenerated true | ---
title: kubectl config delete-user
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Delete the specified user from the kubeconfig.
```
kubectl config delete-user NAME
```
##
```
# Delete the minikube user
kubectl config delete-user minikube
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for delete-user</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use a particular kubeconfig file</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl config](../) - Modify kubeconfig files
| kubernetes reference | title kubectl config delete user content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Delete the specified user from the kubeconfig kubectl config delete user NAME Delete the minikube user kubectl config delete user minikube table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for delete user p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p use a particular kubeconfig file p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl config Modify kubeconfig files |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference title kubectl config delete cluster weight 30 autogenerated true | ---
title: kubectl config delete-cluster
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Delete the specified cluster from the kubeconfig.
```
kubectl config delete-cluster NAME
```
##
```
# Delete the minikube cluster
kubectl config delete-cluster minikube
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for delete-cluster</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use a particular kubeconfig file</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl config](../) - Modify kubeconfig files
| kubernetes reference | title kubectl config delete cluster content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Delete the specified cluster from the kubeconfig kubectl config delete cluster NAME Delete the minikube cluster kubectl config delete cluster minikube table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for delete cluster p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p use a particular kubeconfig file p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl config Modify kubeconfig files |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl config delete context autogenerated true | ---
title: kubectl config delete-context
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Delete the specified context from the kubeconfig.
```
kubectl config delete-context NAME
```
##
```
# Delete the context for the minikube cluster
kubectl config delete-context minikube
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for delete-context</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use a particular kubeconfig file</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl config](../) - Modify kubeconfig files
| kubernetes reference | title kubectl config delete context content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Delete the specified context from the kubeconfig kubectl config delete context NAME Delete the context for the minikube cluster kubectl config delete context minikube table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for delete context p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p use a particular kubeconfig file p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl config Modify kubeconfig files |
kubernetes reference The file is auto generated from the Go source code of the component using a generic contenttype tool reference weight 30 title kubectl config get contexts autogenerated true | ---
title: kubectl config get-contexts
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Display one or many contexts from the kubeconfig file.
```
kubectl config get-contexts [(-o|--output=)name)]
```
##
```
# List all the contexts in your kubeconfig file
kubectl config get-contexts
# Describe one context in your kubeconfig file
kubectl config get-contexts my-context
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for get-contexts</p></td>
</tr>
<tr>
<td colspan="2">--no-headers</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>When using the default or custom-column output format, don't print headers (default print headers).</p></td>
</tr>
<tr>
<td colspan="2">-o, --output string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Output format. One of: (name).</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use a particular kubeconfig file</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl config](../) - Modify kubeconfig files
| kubernetes reference | title kubectl config get contexts content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Display one or many contexts from the kubeconfig file kubectl config get contexts o output name List all the contexts in your kubeconfig file kubectl config get contexts Describe one context in your kubeconfig file kubectl config get contexts my context table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for get contexts p td tr tr td colspan 2 no headers td tr tr td td td style line height 130 word wrap break word p When using the default or custom column output format don t print headers default print headers p td tr tr td colspan 2 o output string td tr tr td td td style line height 130 word wrap break word p Output format One of name p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p use a particular kubeconfig file p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl config Modify kubeconfig files |
kubernetes reference The file is auto generated from the Go source code of the component using a generic title kubectl config current context contenttype tool reference weight 30 autogenerated true | ---
title: kubectl config current-context
content_type: tool-reference
weight: 30
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
##
Display the current-context.
```
kubectl config current-context [flags]
```
##
```
# Display the current-context
kubectl config current-context
```
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">-h, --help</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for current-context</p></td>
</tr>
</tbody>
</table>
##
<table style="width: 100%; table-layout: fixed;">
<colgroup>
<col span="1" style="width: 10px;" />
<col span="1" />
</colgroup>
<tbody>
<tr>
<td colspan="2">--as string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
</tr>
<tr>
<td colspan="2">--as-group strings</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
</tr>
<tr>
<td colspan="2">--as-uid string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
</tr>
<tr>
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
</tr>
<tr>
<td colspan="2">--certificate-authority string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
</tr>
<tr>
<td colspan="2">--client-certificate string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--client-key string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
</tr>
<tr>
<td colspan="2">--cluster string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
</tr>
<tr>
<td colspan="2">--context string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
</tr>
<tr>
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
</tr>
<tr>
<td colspan="2">--disable-compression</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
</tr>
<tr>
<td colspan="2">--insecure-skip-tls-verify</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
</tr>
<tr>
<td colspan="2">--kubeconfig string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use a particular kubeconfig file</p></td>
</tr>
<tr>
<td colspan="2">--match-server-version</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
</tr>
<tr>
<td colspan="2">-n, --namespace string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
</tr>
<tr>
<td colspan="2">--password string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--profile string Default: "none"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
</tr>
<tr>
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
</tr>
<tr>
<td colspan="2">--request-timeout string Default: "0"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.</p></td>
</tr>
<tr>
<td colspan="2">-s, --server string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-password string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-table string Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>
<tr>
<td colspan="2">--storage-driver-user string Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>
<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
</tr>
<tr>
<td colspan="2">--token string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--user string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
</tr>
<tr>
<td colspan="2">--username string</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
</tr>
<tr>
<td colspan="2">--version version[=true]</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
</tr>
<tr>
<td colspan="2">--warnings-as-errors</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
</tr>
</tbody>
</table>
##
* [kubectl config](../) - Modify kubeconfig files
| kubernetes reference | title kubectl config current context content type tool reference weight 30 auto generated true The file is auto generated from the Go source code of the component using a generic generator https github com kubernetes sigs reference docs To learn how to generate the reference documentation please read Contributing to the reference documentation docs contribute generate ref docs To update the reference content please follow the Contributing upstream docs contribute generate ref docs contribute upstream guide You can file document formatting bugs against the reference docs https github com kubernetes sigs reference docs project Display the current context kubectl config current context flags Display the current context kubectl config current context table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 h help td tr tr td td td style line height 130 word wrap break word p help for current context p td tr tbody table table style width 100 table layout fixed colgroup col span 1 style width 10px col span 1 colgroup tbody tr td colspan 2 as string td tr tr td td td style line height 130 word wrap break word p Username to impersonate for the operation User could be a regular user or a service account in a namespace p td tr tr td colspan 2 as group strings td tr tr td td td style line height 130 word wrap break word p Group to impersonate for the operation this flag can be repeated to specify multiple groups p td tr tr td colspan 2 as uid string td tr tr td td td style line height 130 word wrap break word p UID to impersonate for the operation p td tr tr td colspan 2 cache dir string nbsp nbsp nbsp nbsp nbsp Default HOME kube cache td tr tr td td td style line height 130 word wrap break word p Default cache directory p td tr tr td colspan 2 certificate authority string td tr tr td td td style line height 130 word wrap break word p Path to a cert file for the certificate authority p td tr tr td colspan 2 client certificate string td tr tr td td td style line height 130 word wrap break word p Path to a client certificate file for TLS p td tr tr td colspan 2 client key string td tr tr td td td style line height 130 word wrap break word p Path to a client key file for TLS p td tr tr td colspan 2 cluster string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig cluster to use p td tr tr td colspan 2 context string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig context to use p td tr tr td colspan 2 default not ready toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 default unreachable toleration seconds int nbsp nbsp nbsp nbsp nbsp Default 300 td tr tr td td td style line height 130 word wrap break word p 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 p td tr tr td colspan 2 disable compression td tr tr td td td style line height 130 word wrap break word p If true opt out of response compression for all requests to the server p td tr tr td colspan 2 insecure skip tls verify td tr tr td td td style line height 130 word wrap break word p If true the server s certificate will not be checked for validity This will make your HTTPS connections insecure p td tr tr td colspan 2 kubeconfig string td tr tr td td td style line height 130 word wrap break word p use a particular kubeconfig file p td tr tr td colspan 2 match server version td tr tr td td td style line height 130 word wrap break word p Require server version to match client version p td tr tr td colspan 2 n namespace string td tr tr td td td style line height 130 word wrap break word p If present the namespace scope for this CLI request p td tr tr td colspan 2 password string td tr tr td td td style line height 130 word wrap break word p Password for basic authentication to the API server p td tr tr td colspan 2 profile string nbsp nbsp nbsp nbsp nbsp Default none td tr tr td td td style line height 130 word wrap break word p Name of profile to capture One of none cpu heap goroutine threadcreate block mutex p td tr tr td colspan 2 profile output string nbsp nbsp nbsp nbsp nbsp Default profile pprof td tr tr td td td style line height 130 word wrap break word p Name of the file to write the profile to p td tr tr td colspan 2 request timeout string nbsp nbsp nbsp nbsp nbsp Default 0 td tr tr td td td style line height 130 word wrap break word p The length of time to wait before giving up on a single server request Non zero values should contain a corresponding time unit e g 1s 2m 3h A value of zero means don t timeout requests p td tr tr td colspan 2 s server string td tr tr td td td style line height 130 word wrap break word p The address and port of the Kubernetes API server p td tr tr td colspan 2 storage driver buffer duration duration nbsp nbsp nbsp nbsp nbsp Default 1m0s td tr tr td td td style line height 130 word wrap break word p Writes in the storage driver will be buffered for this duration and committed to the non memory backends as a single transaction p td tr tr td colspan 2 storage driver db string nbsp nbsp nbsp nbsp nbsp Default cadvisor td tr tr td td td style line height 130 word wrap break word p database name p td tr tr td colspan 2 storage driver host string nbsp nbsp nbsp nbsp nbsp Default localhost 8086 td tr tr td td td style line height 130 word wrap break word p database host port p td tr tr td colspan 2 storage driver password string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database password p td tr tr td colspan 2 storage driver secure td tr tr td td td style line height 130 word wrap break word p use secure connection with database p td tr tr td colspan 2 storage driver table string nbsp nbsp nbsp nbsp nbsp Default stats td tr tr td td td style line height 130 word wrap break word p table name p td tr tr td colspan 2 storage driver user string nbsp nbsp nbsp nbsp nbsp Default root td tr tr td td td style line height 130 word wrap break word p database username p td tr tr td colspan 2 tls server name string td tr tr td td td style line height 130 word wrap break word p Server name to use for server certificate validation If it is not provided the hostname used to contact the server is used p td tr tr td colspan 2 token string td tr tr td td td style line height 130 word wrap break word p Bearer token for authentication to the API server p td tr tr td colspan 2 user string td tr tr td td td style line height 130 word wrap break word p The name of the kubeconfig user to use p td tr tr td colspan 2 username string td tr tr td td td style line height 130 word wrap break word p Username for basic authentication to the API server p td tr tr td colspan 2 version version true td tr tr td td td style line height 130 word wrap break word p version version raw prints version information and quits version vX Y Z sets the reported version p td tr tr td colspan 2 warnings as errors td tr tr td td td style line height 130 word wrap break word p Treat warnings received from the server as errors and exit with a non zero exit code p td tr tbody table kubectl config Modify kubeconfig files |
Subsets and Splits