questions
stringlengths 4
1.65k
| answers
stringlengths 1.73k
353k
| site
stringclasses 24
values | answers_cleaned
stringlengths 1.73k
353k
|
|---|---|---|---|
istio owner istio wg policies and telemetry maintainers Using Prometheus for production scale monitoring test no title Observability Best Practices forceinlinetoc true Best practices for observing applications using Istio weight 50 | ---
title: Observability Best Practices
description: Best practices for observing applications using Istio.
force_inline_toc: true
weight: 50
owner: istio/wg-policies-and-telemetry-maintainers
test: no
---
## Using Prometheus for production-scale monitoring
The recommended approach for production-scale monitoring of Istio meshes with Prometheus
is to use [hierarchical federation](https://prometheus.io/docs/prometheus/latest/federation/#hierarchical-federation)
in combination with a collection of [recording rules](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).
Although installing Istio does not deploy [Prometheus](http://prometheus.io) by default, the
[Getting Started](/docs/setup/getting-started/) instructions install the `Option 1: Quick Start` deployment
of Prometheus described in the [Prometheus integration guide](/docs/ops/integrations/prometheus/).
This deployment of Prometheus is intentionally configured with a very short retention window (6 hours). The
quick-start Prometheus deployment is also configured to collect metrics from each Envoy proxy
running in the mesh, augmenting each metric with a set of labels about their origin (`instance`,
`pod`, and `namespace`).
### Workload-level aggregation via recording rules
In order to aggregate metrics across instances and pods, update the default Prometheus configuration with
the following recording rules:
groups:
- name: "istio.recording-rules"
interval: 5s
rules:
- record: "workload:istio_requests_total"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_requests_total)
- record: "workload:istio_request_duration_milliseconds_count"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_duration_milliseconds_count)
- record: "workload:istio_request_duration_milliseconds_sum"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_duration_milliseconds_sum)
- record: "workload:istio_request_duration_milliseconds_bucket"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_duration_milliseconds_bucket)
- record: "workload:istio_request_bytes_count"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_bytes_count)
- record: "workload:istio_request_bytes_sum"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_bytes_sum)
- record: "workload:istio_request_bytes_bucket"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_bytes_bucket)
- record: "workload:istio_response_bytes_count"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_response_bytes_count)
- record: "workload:istio_response_bytes_sum"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_response_bytes_sum)
- record: "workload:istio_response_bytes_bucket"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_response_bytes_bucket)
- record: "workload:istio_tcp_sent_bytes_total"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_tcp_sent_bytes_total)
- record: "workload:istio_tcp_received_bytes_total"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_tcp_received_bytes_total)
- record: "workload:istio_tcp_connections_opened_total"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_tcp_connections_opened_total)
- record: "workload:istio_tcp_connections_closed_total"
expr: |
sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_tcp_connections_closed_total)
apiVersion: monitoring.coreos.com/v1
kind: PrometheusRule
metadata:
name: istio-metrics-aggregation
labels:
app.kubernetes.io/name: istio-prometheus
spec:
groups:
- name: "istio.metricsAggregation-rules"
interval: 5s
rules:
- record: "workload:istio_requests_total"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_requests_total)"
- record: "workload:istio_request_duration_milliseconds_count"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_duration_milliseconds_count)"
- record: "workload:istio_request_duration_milliseconds_sum"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_duration_milliseconds_sum)"
- record: "workload:istio_request_duration_milliseconds_bucket"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_duration_milliseconds_bucket)"
- record: "workload:istio_request_bytes_count"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_bytes_count)"
- record: "workload:istio_request_bytes_sum"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_bytes_sum)"
- record: "workload:istio_request_bytes_bucket"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_request_bytes_bucket)"
- record: "workload:istio_response_bytes_count"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_response_bytes_count)"
- record: "workload:istio_response_bytes_sum"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_response_bytes_sum)"
- record: "workload:istio_response_bytes_bucket"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_response_bytes_bucket)"
- record: "workload:istio_tcp_sent_bytes_total"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_tcp_sent_bytes_total)"
- record: "workload:istio_tcp_received_bytes_total"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_tcp_received_bytes_total)"
- record: "workload:istio_tcp_connections_opened_total"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_tcp_connections_opened_total)"
- record: "workload:istio_tcp_connections_closed_total"
expr: "sum without(instance, kubernetes_namespace, kubernetes_pod_name) (istio_tcp_connections_closed_total)"
The recording rules above only aggregate across pods and instances. They still preserve the full set of
[Istio Standard Metrics](/docs/reference/config/metrics/), including all Istio dimensions. While this
will help with controlling metrics cardinality via federation, you may want to further optimize the recording rules
to match your existing dashboards, alerts, and ad-hoc queries.
For more information on tailoring your recording rules, see the section on
[Optimizing metrics collection with recording rules](/docs/ops/best-practices/observability/#optimizing-metrics-collection-with-recording-rules).
### Federation using workload-level aggregated metrics
To establish Prometheus federation, modify the configuration of your production-ready deployment of Prometheus to
scrape the federation endpoint of the Istio Prometheus.
Add the following job to your configuration:
- job_name: 'istio-prometheus'
honor_labels: true
metrics_path: '/federate'
kubernetes_sd_configs:
- role: pod
namespaces:
names: ['istio-system']
metric_relabel_configs:
- source_labels: [__name__]
regex: 'workload:(.*)'
target_label: __name__
action: replace
params:
'match[]':
- '{__name__=~"workload:(.*)"}'
- '{__name__=~"pilot(.*)"}'
If you are using the [Prometheus Operator](https://github.com/coreos/prometheus-operator), use the following configuration instead:
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: istio-federation
labels:
app.kubernetes.io/name: istio-prometheus
spec:
namespaceSelector:
matchNames:
- istio-system
selector:
matchLabels:
app: prometheus
endpoints:
- interval: 30s
scrapeTimeout: 30s
params:
'match[]':
- '{__name__=~"workload:(.*)"}'
- '{__name__=~"pilot(.*)"}'
path: /federate
targetPort: 9090
honorLabels: true
metricRelabelings:
- sourceLabels: ["__name__"]
regex: 'workload:(.*)'
targetLabel: "__name__"
action: replace
The key to the federation configuration is matching on the job in the Istio-deployed Prometheus that is collecting
[Istio Standard Metrics](/docs/reference/config/metrics/) and renaming any metrics collected by removing
the prefix used in the workload-level recording rules (`workload:`). This will allow existing dashboards and
queries to seamlessly continue working when pointed at the production Prometheus instance (and away from the Istio instance).
You can also include additional metrics (for example, envoy, go, etc.) when setting up federation.
Control plane metrics are also collected and federated up to the production Prometheus.
### Optimizing metrics collection with recording rules
Beyond just using recording rules to [aggregate over pods and instances](#workload-level-aggregation-via-recording-rules), you may
want to use recording rules to generate aggregated metrics tailored specifically to your existing dashboards and alerts. Optimizing
your collection in this manner can result in large savings in resource consumption in your production instance of Prometheus, in
addition to faster query performance.
For example, imagine a custom monitoring dashboard that used the following Prometheus queries:
* Total rate of requests averaged over the past minute by destination service name and namespace
sum(irate(istio_requests_total{reporter="source"}[1m]))
by (
destination_canonical_service,
destination_workload_namespace
)
* P95 client latency averaged over the past minute by source and destination service names and namespace
histogram_quantile(0.95,
sum(irate(istio_request_duration_milliseconds_bucket{reporter="source"}[1m]))
by (
destination_canonical_service,
destination_workload_namespace,
source_canonical_service,
source_workload_namespace,
le
)
)
The following set of recording rules could be added to the Istio Prometheus configuration, using the `istio` prefix
to make identifying these metrics for federation simple.
groups:
- name: "istio.recording-rules"
interval: 5s
rules:
- record: "istio:istio_requests:by_destination_service:rate1m"
expr: |
sum(irate(istio_requests_total{reporter="destination"}[1m]))
by (
destination_canonical_service,
destination_workload_namespace
)
- record: "istio:istio_request_duration_milliseconds_bucket:p95:rate1m"
expr: |
histogram_quantile(0.95,
sum(irate(istio_request_duration_milliseconds_bucket{reporter="source"}[1m]))
by (
destination_canonical_service,
destination_workload_namespace,
source_canonical_service,
source_workload_namespace,
le
)
)
The production instance of Prometheus would then be updated to federate from the Istio instance with:
* match clause of `{__name__=~"istio:(.*)"}`
* metric relabeling config with: `regex: "istio:(.*)"`
The original queries would then be replaced with:
* `istio_requests:by_destination_service:rate1m`
* `avg(istio_request_duration_milliseconds_bucket:p95:rate1m)`
A detailed write-up on [metrics collection optimization in production at AutoTrader](https://karlstoney.com/2020/02/25/federated-prometheus-to-reduce-metric-cardinality/)
provides a more fleshed out example of aggregating directly to the queries that power dashboards and alerts.
| istio | title Observability Best Practices description Best practices for observing applications using Istio force inline toc true weight 50 owner istio wg policies and telemetry maintainers test no Using Prometheus for production scale monitoring The recommended approach for production scale monitoring of Istio meshes with Prometheus is to use hierarchical federation https prometheus io docs prometheus latest federation hierarchical federation in combination with a collection of recording rules https prometheus io docs prometheus latest configuration recording rules Although installing Istio does not deploy Prometheus http prometheus io by default the Getting Started docs setup getting started instructions install the Option 1 Quick Start deployment of Prometheus described in the Prometheus integration guide docs ops integrations prometheus This deployment of Prometheus is intentionally configured with a very short retention window 6 hours The quick start Prometheus deployment is also configured to collect metrics from each Envoy proxy running in the mesh augmenting each metric with a set of labels about their origin instance pod and namespace Workload level aggregation via recording rules In order to aggregate metrics across instances and pods update the default Prometheus configuration with the following recording rules groups name istio recording rules interval 5s rules record workload istio requests total expr sum without instance kubernetes namespace kubernetes pod name istio requests total record workload istio request duration milliseconds count expr sum without instance kubernetes namespace kubernetes pod name istio request duration milliseconds count record workload istio request duration milliseconds sum expr sum without instance kubernetes namespace kubernetes pod name istio request duration milliseconds sum record workload istio request duration milliseconds bucket expr sum without instance kubernetes namespace kubernetes pod name istio request duration milliseconds bucket record workload istio request bytes count expr sum without instance kubernetes namespace kubernetes pod name istio request bytes count record workload istio request bytes sum expr sum without instance kubernetes namespace kubernetes pod name istio request bytes sum record workload istio request bytes bucket expr sum without instance kubernetes namespace kubernetes pod name istio request bytes bucket record workload istio response bytes count expr sum without instance kubernetes namespace kubernetes pod name istio response bytes count record workload istio response bytes sum expr sum without instance kubernetes namespace kubernetes pod name istio response bytes sum record workload istio response bytes bucket expr sum without instance kubernetes namespace kubernetes pod name istio response bytes bucket record workload istio tcp sent bytes total expr sum without instance kubernetes namespace kubernetes pod name istio tcp sent bytes total record workload istio tcp received bytes total expr sum without instance kubernetes namespace kubernetes pod name istio tcp received bytes total record workload istio tcp connections opened total expr sum without instance kubernetes namespace kubernetes pod name istio tcp connections opened total record workload istio tcp connections closed total expr sum without instance kubernetes namespace kubernetes pod name istio tcp connections closed total apiVersion monitoring coreos com v1 kind PrometheusRule metadata name istio metrics aggregation labels app kubernetes io name istio prometheus spec groups name istio metricsAggregation rules interval 5s rules record workload istio requests total expr sum without instance kubernetes namespace kubernetes pod name istio requests total record workload istio request duration milliseconds count expr sum without instance kubernetes namespace kubernetes pod name istio request duration milliseconds count record workload istio request duration milliseconds sum expr sum without instance kubernetes namespace kubernetes pod name istio request duration milliseconds sum record workload istio request duration milliseconds bucket expr sum without instance kubernetes namespace kubernetes pod name istio request duration milliseconds bucket record workload istio request bytes count expr sum without instance kubernetes namespace kubernetes pod name istio request bytes count record workload istio request bytes sum expr sum without instance kubernetes namespace kubernetes pod name istio request bytes sum record workload istio request bytes bucket expr sum without instance kubernetes namespace kubernetes pod name istio request bytes bucket record workload istio response bytes count expr sum without instance kubernetes namespace kubernetes pod name istio response bytes count record workload istio response bytes sum expr sum without instance kubernetes namespace kubernetes pod name istio response bytes sum record workload istio response bytes bucket expr sum without instance kubernetes namespace kubernetes pod name istio response bytes bucket record workload istio tcp sent bytes total expr sum without instance kubernetes namespace kubernetes pod name istio tcp sent bytes total record workload istio tcp received bytes total expr sum without instance kubernetes namespace kubernetes pod name istio tcp received bytes total record workload istio tcp connections opened total expr sum without instance kubernetes namespace kubernetes pod name istio tcp connections opened total record workload istio tcp connections closed total expr sum without instance kubernetes namespace kubernetes pod name istio tcp connections closed total The recording rules above only aggregate across pods and instances They still preserve the full set of Istio Standard Metrics docs reference config metrics including all Istio dimensions While this will help with controlling metrics cardinality via federation you may want to further optimize the recording rules to match your existing dashboards alerts and ad hoc queries For more information on tailoring your recording rules see the section on Optimizing metrics collection with recording rules docs ops best practices observability optimizing metrics collection with recording rules Federation using workload level aggregated metrics To establish Prometheus federation modify the configuration of your production ready deployment of Prometheus to scrape the federation endpoint of the Istio Prometheus Add the following job to your configuration job name istio prometheus honor labels true metrics path federate kubernetes sd configs role pod namespaces names istio system metric relabel configs source labels name regex workload target label name action replace params match name workload name pilot If you are using the Prometheus Operator https github com coreos prometheus operator use the following configuration instead apiVersion monitoring coreos com v1 kind ServiceMonitor metadata name istio federation labels app kubernetes io name istio prometheus spec namespaceSelector matchNames istio system selector matchLabels app prometheus endpoints interval 30s scrapeTimeout 30s params match name workload name pilot path federate targetPort 9090 honorLabels true metricRelabelings sourceLabels name regex workload targetLabel name action replace The key to the federation configuration is matching on the job in the Istio deployed Prometheus that is collecting Istio Standard Metrics docs reference config metrics and renaming any metrics collected by removing the prefix used in the workload level recording rules workload This will allow existing dashboards and queries to seamlessly continue working when pointed at the production Prometheus instance and away from the Istio instance You can also include additional metrics for example envoy go etc when setting up federation Control plane metrics are also collected and federated up to the production Prometheus Optimizing metrics collection with recording rules Beyond just using recording rules to aggregate over pods and instances workload level aggregation via recording rules you may want to use recording rules to generate aggregated metrics tailored specifically to your existing dashboards and alerts Optimizing your collection in this manner can result in large savings in resource consumption in your production instance of Prometheus in addition to faster query performance For example imagine a custom monitoring dashboard that used the following Prometheus queries Total rate of requests averaged over the past minute by destination service name and namespace sum irate istio requests total reporter source 1m by destination canonical service destination workload namespace P95 client latency averaged over the past minute by source and destination service names and namespace histogram quantile 0 95 sum irate istio request duration milliseconds bucket reporter source 1m by destination canonical service destination workload namespace source canonical service source workload namespace le The following set of recording rules could be added to the Istio Prometheus configuration using the istio prefix to make identifying these metrics for federation simple groups name istio recording rules interval 5s rules record istio istio requests by destination service rate1m expr sum irate istio requests total reporter destination 1m by destination canonical service destination workload namespace record istio istio request duration milliseconds bucket p95 rate1m expr histogram quantile 0 95 sum irate istio request duration milliseconds bucket reporter source 1m by destination canonical service destination workload namespace source canonical service source workload namespace le The production instance of Prometheus would then be updated to federate from the Istio instance with match clause of name istio metric relabeling config with regex istio The original queries would then be replaced with istio requests by destination service rate1m avg istio request duration milliseconds bucket p95 rate1m A detailed write up on metrics collection optimization in production at AutoTrader https karlstoney com 2020 02 25 federated prometheus to reduce metric cardinality provides a more fleshed out example of aggregating directly to the queries that power dashboards and alerts |
istio docs ops traffic management deploy guidelines title Traffic Management Best Practices weight 20 owner istio wg networking maintainers aliases help ops traffic management deploy guidelines forceinlinetoc true Configuration best practices to avoid networking or traffic management issues help ops deploy guidelines | ---
title: Traffic Management Best Practices
description: Configuration best practices to avoid networking or traffic management issues.
force_inline_toc: true
weight: 20
aliases:
- /help/ops/traffic-management/deploy-guidelines
- /help/ops/deploy-guidelines
- /docs/ops/traffic-management/deploy-guidelines
owner: istio/wg-networking-maintainers
test: n/a
---
This section provides specific deployment or configuration guidelines to avoid networking or traffic management issues.
## Set default routes for services
Although the default Istio behavior conveniently sends traffic from any
source to all versions of a destination service without any rules being set,
creating a `VirtualService` with a default route for every service,
right from the start, is generally considered a best practice in Istio.
Even if you initially have only one version of a service, as soon as you decide
to deploy a second version, you need to have a routing rule in place **before**
the new version is started, to prevent it from immediately receiving traffic
in an uncontrolled way.
Another potential issue when relying on Istio's default round-robin routing is
due to a subtlety in Istio's destination rule evaluation algorithm.
When routing a request, Envoy first evaluates route rules in virtual services
to determine if a particular subset is being routed to.
If so, only then will it activate any destination rule policies corresponding to the subset.
Consequently, Istio only applies the policies you define for specific subsets if
you **explicitly** routed traffic to the corresponding subset.
For example, consider the following destination rule as the one and only configuration defined for the
*reviews* service, that is, there are no route rules in a corresponding `VirtualService` definition:
apiVersion: networking.istio.io/v1
kind: DestinationRule
metadata:
name: reviews
spec:
host: reviews
subsets:
- name: v1
labels:
version: v1
trafficPolicy:
connectionPool:
tcp:
maxConnections: 100
Even if Istio’s default round-robin routing calls "v1" instances on occasion,
maybe even always if "v1" is the only running version, the above traffic policy
will never be invoked.
You can fix the above example in one of two ways. You can either move the
traffic policy up a level in the `DestinationRule` to make it apply to any version:
apiVersion: networking.istio.io/v1
kind: DestinationRule
metadata:
name: reviews
spec:
host: reviews
trafficPolicy:
connectionPool:
tcp:
maxConnections: 100
subsets:
- name: v1
labels:
version: v1
Or, better yet, define a proper route rule for the service in the `VirtualService` definition.
For example, add a simple route rule for "reviews:v1":
apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
name: reviews
spec:
hosts:
- reviews
http:
- route:
- destination:
host: reviews
subset: v1
## Control configuration sharing across namespaces {#cross-namespace-configuration}
You can define virtual services, destination rules, or service entries
in one namespace and then reuse them in other namespaces, if they are exported
to those namespaces.
Istio exports all traffic management resources to all namespaces by default,
but you can override the visibility with the `exportTo` field.
For example, only requests from workloads in the same namespace can be affected by the following virtual service:
apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
name: myservice
spec:
hosts:
- myservice.com
exportTo:
- "."
http:
- route:
- destination:
host: myservice
You can similarly control the visibility of a Kubernetes `Service` using the `networking.istio.io/exportTo` annotation.
Setting the visibility of destination rules in a particular namespace doesn't
guarantee the rule is used. Exporting a destination rule to other namespaces enables you to use it
in those namespaces, but to actually be applied during a request the namespace also needs to be
on the destination rule lookup path:
1. client namespace
1. service namespace
1. the configured `meshconfig.rootNamespace` namespace (`istio-system` by default)
For example, consider the following destination rule:
apiVersion: networking.istio.io/v1
kind: DestinationRule
metadata:
name: myservice
spec:
host: myservice.default.svc.cluster.local
trafficPolicy:
connectionPool:
tcp:
maxConnections: 100
Let's assume you create this destination rule in namespace `ns1`.
If you send a request to the `myservice` service from a client in `ns1`, the destination
rule would be applied, because it is in the first namespace on the lookup path, that is,
in the client namespace.
If you now send the request from a different namespace, for example `ns2`,
the client is no longer in the same namespace as the destination rule, `ns1`.
Because the corresponding service, `myservice.default.svc.cluster.local`, is also not in `ns1`,
but rather in the `default` namespace, the destination rule will also not be found in
the second namespace of the lookup path, the service namespace.
Even if the `myservice` service is exported to all namespaces and therefore visible
in `ns2` and the destination rule is also exported to all namespaces, including `ns2`,
it will not be applied during the request from `ns2` because it's not in any
of the namespaces on the lookup path.
You can avoid this problem by creating the destination rule in the same namespace as
the corresponding service, `default` in this example. It would then get applied to requests
from clients in any namespace.
You can also move the destination rule to the `istio-system` namespace, the third namespace on
the lookup path, although this isn't recommended unless the destination rule is really a global
configuration that is applicable in all namespaces, and it would require administrator authority.
Istio uses this restricted destination rule lookup path for two reasons:
1. Prevent destination rules from being defined that can override the behavior of services
in completely unrelated namespaces.
1. Have a clear lookup order in case there is more than one destination rule for
the same host.
## Split large virtual services and destination rules into multiple resources {#split-virtual-services}
In situations where it is inconvenient to define the complete set of route rules or policies for a particular
host in a single `VirtualService` or `DestinationRule` resource, it may be preferable to incrementally specify
the configuration for the host in multiple resources.
The control plane will merge such destination rules
and merge such virtual services if they are bound to a gateway.
Consider the case of a `VirtualService` bound to an ingress gateway exposing an application host which uses
path-based delegation to several implementation services, something like this:
apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
name: myapp
spec:
hosts:
- myapp.com
gateways:
- myapp-gateway
http:
- match:
- uri:
prefix: /service1
route:
- destination:
host: service1.default.svc.cluster.local
- match:
- uri:
prefix: /service2
route:
- destination:
host: service2.default.svc.cluster.local
- match:
...
The downside of this kind of configuration is that other configuration (e.g., route rules) for any of the
underlying microservices, will need to also be included in this single configuration file, instead of
in separate resources associated with, and potentially owned by, the individual service teams.
See [Route rules have no effect on ingress gateway requests](/docs/ops/common-problems/network-issues/#route-rules-have-no-effect-on-ingress-gateway-requests)
for details.
To avoid this problem, it may be preferable to break up the configuration of `myapp.com` into several
`VirtualService` fragments, one per backend service. For example:
apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
name: myapp-service1
spec:
hosts:
- myapp.com
gateways:
- myapp-gateway
http:
- match:
- uri:
prefix: /service1
route:
- destination:
host: service1.default.svc.cluster.local
---
apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
name: myapp-service2
spec:
hosts:
- myapp.com
gateways:
- myapp-gateway
http:
- match:
- uri:
prefix: /service2
route:
- destination:
host: service2.default.svc.cluster.local
---
apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
name: myapp-...
When a second and subsequent `VirtualService` for an existing host is applied, `istiod` will merge
the additional route rules into the existing configuration of the host. There are, however, several
caveats with this feature that must be considered carefully when using it.
1. Although the order of evaluation for rules in any given source `VirtualService` will be retained,
the cross-resource order is UNDEFINED. In other words, there is no guaranteed order of evaluation
for rules across the fragment configurations, so it will only have predictable behavior if there
are no conflicting rules or order dependency between rules across fragments.
1. There should only be one "catch-all" rule (i.e., a rule without a `match` field) in the fragments.
All such "catch-all" rules will be moved to the end of the list in the merged configuration, but
since they catch all requests, whichever is applied first will essentially override and disable any others.
1. A `VirtualService` can only be fragmented this way if it is bound to a gateway.
Host merging is not supported in sidecars.
A `DestinationRule` can also be fragmented with similar merge semantics and restrictions.
1. There should only be one definition of any given subset across multiple destination rules for the same host.
If there is more than one with the same name, the first definition is used and any following duplicates are discarded.
No merging of subset content is supported.
1. There should only be one top-level `trafficPolicy` for the same host.
When top-level traffic policies are defined in multiple destination rules, the first one processed will be used.
Any following top-level `trafficPolicy` configuration is discarded.
1. Unlike virtual service merging, destination rule merging works in both sidecars and gateways.
## Avoid 503 errors while reconfiguring service routes
When setting route rules to direct traffic to specific versions (subsets) of a service, care must be taken to ensure
that the subsets are available before they are used in the routes. Otherwise, calls to the service may return
503 errors during a reconfiguration period.
Creating both the `VirtualServices` and `DestinationRules` that define the corresponding subsets using a single `kubectl`
call (e.g., `kubectl apply -f myVirtualServiceAndDestinationRule.yaml` is not sufficient because the
resources propagate (from the configuration server, i.e., Kubernetes API server) to the istiod instances in an eventually consistent manner. If the
`VirtualService` using the subsets arrives before the `DestinationRule` where the subsets are defined, the Envoy configuration generated by istiod would refer to non-existent upstream pools. This results in HTTP 503 errors until all configuration objects are available to istiod.
To make sure services will have zero down-time when configuring routes with subsets, follow a "make-before-break" process as described below:
* When adding new subsets:
1. Update `DestinationRules` to add a new subset first, before updating any `VirtualServices` that use it. Apply the rule using `kubectl` or any platform-specific tooling.
1. Wait a few seconds for the `DestinationRule` configuration to propagate to the Envoy sidecars
1. Update the `VirtualService` to refer to the newly added subsets.
* When removing subsets:
1. Update `VirtualServices` to remove any references to a subset, before removing the subset from a `DestinationRule`.
1. Wait a few seconds for the `VirtualService` configuration to propagate to the Envoy sidecars.
1. Update the `DestinationRule` to remove the unused subsets. | istio | title Traffic Management Best Practices description Configuration best practices to avoid networking or traffic management issues force inline toc true weight 20 aliases help ops traffic management deploy guidelines help ops deploy guidelines docs ops traffic management deploy guidelines owner istio wg networking maintainers test n a This section provides specific deployment or configuration guidelines to avoid networking or traffic management issues Set default routes for services Although the default Istio behavior conveniently sends traffic from any source to all versions of a destination service without any rules being set creating a VirtualService with a default route for every service right from the start is generally considered a best practice in Istio Even if you initially have only one version of a service as soon as you decide to deploy a second version you need to have a routing rule in place before the new version is started to prevent it from immediately receiving traffic in an uncontrolled way Another potential issue when relying on Istio s default round robin routing is due to a subtlety in Istio s destination rule evaluation algorithm When routing a request Envoy first evaluates route rules in virtual services to determine if a particular subset is being routed to If so only then will it activate any destination rule policies corresponding to the subset Consequently Istio only applies the policies you define for specific subsets if you explicitly routed traffic to the corresponding subset For example consider the following destination rule as the one and only configuration defined for the reviews service that is there are no route rules in a corresponding VirtualService definition apiVersion networking istio io v1 kind DestinationRule metadata name reviews spec host reviews subsets name v1 labels version v1 trafficPolicy connectionPool tcp maxConnections 100 Even if Istio s default round robin routing calls v1 instances on occasion maybe even always if v1 is the only running version the above traffic policy will never be invoked You can fix the above example in one of two ways You can either move the traffic policy up a level in the DestinationRule to make it apply to any version apiVersion networking istio io v1 kind DestinationRule metadata name reviews spec host reviews trafficPolicy connectionPool tcp maxConnections 100 subsets name v1 labels version v1 Or better yet define a proper route rule for the service in the VirtualService definition For example add a simple route rule for reviews v1 apiVersion networking istio io v1 kind VirtualService metadata name reviews spec hosts reviews http route destination host reviews subset v1 Control configuration sharing across namespaces cross namespace configuration You can define virtual services destination rules or service entries in one namespace and then reuse them in other namespaces if they are exported to those namespaces Istio exports all traffic management resources to all namespaces by default but you can override the visibility with the exportTo field For example only requests from workloads in the same namespace can be affected by the following virtual service apiVersion networking istio io v1 kind VirtualService metadata name myservice spec hosts myservice com exportTo http route destination host myservice You can similarly control the visibility of a Kubernetes Service using the networking istio io exportTo annotation Setting the visibility of destination rules in a particular namespace doesn t guarantee the rule is used Exporting a destination rule to other namespaces enables you to use it in those namespaces but to actually be applied during a request the namespace also needs to be on the destination rule lookup path 1 client namespace 1 service namespace 1 the configured meshconfig rootNamespace namespace istio system by default For example consider the following destination rule apiVersion networking istio io v1 kind DestinationRule metadata name myservice spec host myservice default svc cluster local trafficPolicy connectionPool tcp maxConnections 100 Let s assume you create this destination rule in namespace ns1 If you send a request to the myservice service from a client in ns1 the destination rule would be applied because it is in the first namespace on the lookup path that is in the client namespace If you now send the request from a different namespace for example ns2 the client is no longer in the same namespace as the destination rule ns1 Because the corresponding service myservice default svc cluster local is also not in ns1 but rather in the default namespace the destination rule will also not be found in the second namespace of the lookup path the service namespace Even if the myservice service is exported to all namespaces and therefore visible in ns2 and the destination rule is also exported to all namespaces including ns2 it will not be applied during the request from ns2 because it s not in any of the namespaces on the lookup path You can avoid this problem by creating the destination rule in the same namespace as the corresponding service default in this example It would then get applied to requests from clients in any namespace You can also move the destination rule to the istio system namespace the third namespace on the lookup path although this isn t recommended unless the destination rule is really a global configuration that is applicable in all namespaces and it would require administrator authority Istio uses this restricted destination rule lookup path for two reasons 1 Prevent destination rules from being defined that can override the behavior of services in completely unrelated namespaces 1 Have a clear lookup order in case there is more than one destination rule for the same host Split large virtual services and destination rules into multiple resources split virtual services In situations where it is inconvenient to define the complete set of route rules or policies for a particular host in a single VirtualService or DestinationRule resource it may be preferable to incrementally specify the configuration for the host in multiple resources The control plane will merge such destination rules and merge such virtual services if they are bound to a gateway Consider the case of a VirtualService bound to an ingress gateway exposing an application host which uses path based delegation to several implementation services something like this apiVersion networking istio io v1 kind VirtualService metadata name myapp spec hosts myapp com gateways myapp gateway http match uri prefix service1 route destination host service1 default svc cluster local match uri prefix service2 route destination host service2 default svc cluster local match The downside of this kind of configuration is that other configuration e g route rules for any of the underlying microservices will need to also be included in this single configuration file instead of in separate resources associated with and potentially owned by the individual service teams See Route rules have no effect on ingress gateway requests docs ops common problems network issues route rules have no effect on ingress gateway requests for details To avoid this problem it may be preferable to break up the configuration of myapp com into several VirtualService fragments one per backend service For example apiVersion networking istio io v1 kind VirtualService metadata name myapp service1 spec hosts myapp com gateways myapp gateway http match uri prefix service1 route destination host service1 default svc cluster local apiVersion networking istio io v1 kind VirtualService metadata name myapp service2 spec hosts myapp com gateways myapp gateway http match uri prefix service2 route destination host service2 default svc cluster local apiVersion networking istio io v1 kind VirtualService metadata name myapp When a second and subsequent VirtualService for an existing host is applied istiod will merge the additional route rules into the existing configuration of the host There are however several caveats with this feature that must be considered carefully when using it 1 Although the order of evaluation for rules in any given source VirtualService will be retained the cross resource order is UNDEFINED In other words there is no guaranteed order of evaluation for rules across the fragment configurations so it will only have predictable behavior if there are no conflicting rules or order dependency between rules across fragments 1 There should only be one catch all rule i e a rule without a match field in the fragments All such catch all rules will be moved to the end of the list in the merged configuration but since they catch all requests whichever is applied first will essentially override and disable any others 1 A VirtualService can only be fragmented this way if it is bound to a gateway Host merging is not supported in sidecars A DestinationRule can also be fragmented with similar merge semantics and restrictions 1 There should only be one definition of any given subset across multiple destination rules for the same host If there is more than one with the same name the first definition is used and any following duplicates are discarded No merging of subset content is supported 1 There should only be one top level trafficPolicy for the same host When top level traffic policies are defined in multiple destination rules the first one processed will be used Any following top level trafficPolicy configuration is discarded 1 Unlike virtual service merging destination rule merging works in both sidecars and gateways Avoid 503 errors while reconfiguring service routes When setting route rules to direct traffic to specific versions subsets of a service care must be taken to ensure that the subsets are available before they are used in the routes Otherwise calls to the service may return 503 errors during a reconfiguration period Creating both the VirtualServices and DestinationRules that define the corresponding subsets using a single kubectl call e g kubectl apply f myVirtualServiceAndDestinationRule yaml is not sufficient because the resources propagate from the configuration server i e Kubernetes API server to the istiod instances in an eventually consistent manner If the VirtualService using the subsets arrives before the DestinationRule where the subsets are defined the Envoy configuration generated by istiod would refer to non existent upstream pools This results in HTTP 503 errors until all configuration objects are available to istiod To make sure services will have zero down time when configuring routes with subsets follow a make before break process as described below When adding new subsets 1 Update DestinationRules to add a new subset first before updating any VirtualServices that use it Apply the rule using kubectl or any platform specific tooling 1 Wait a few seconds for the DestinationRule configuration to propagate to the Envoy sidecars 1 Update the VirtualService to refer to the newly added subsets When removing subsets 1 Update VirtualServices to remove any references to a subset before removing the subset from a DestinationRule 1 Wait a few seconds for the VirtualService configuration to propagate to the Envoy sidecars 1 Update the DestinationRule to remove the unused subsets |
kubernetes reference weight 70 chenopis approvers nolist true contenttype concept Reference mainmenu true title Reference | ---
title: Reference
approvers:
- chenopis
linkTitle: "Reference"
main_menu: true
weight: 70
content_type: concept
no_list: true
---
<!-- overview -->
This section of the Kubernetes documentation contains references.
<!-- body -->
## API Reference
* [Glossary](/docs/reference/glossary/) - a comprehensive, standardized list of Kubernetes terminology
* [Kubernetes API Reference](/docs/reference/kubernetes-api/)
* [One-page API Reference for Kubernetes ](/docs/reference/generated/kubernetes-api//)
* [Using The Kubernetes API](/docs/reference/using-api/) - overview of the API for Kubernetes.
* [API access control](/docs/reference/access-authn-authz/) - details on how Kubernetes controls API access
* [Well-Known Labels, Annotations and Taints](/docs/reference/labels-annotations-taints/)
## Officially supported client libraries
To call the Kubernetes API from a programming language, you can use
[client libraries](/docs/reference/using-api/client-libraries/). Officially supported
client libraries:
- [Kubernetes Go client library](https://github.com/kubernetes/client-go/)
- [Kubernetes Python client library](https://github.com/kubernetes-client/python)
- [Kubernetes Java client library](https://github.com/kubernetes-client/java)
- [Kubernetes JavaScript client library](https://github.com/kubernetes-client/javascript)
- [Kubernetes C# client library](https://github.com/kubernetes-client/csharp)
- [Kubernetes Haskell client library](https://github.com/kubernetes-client/haskell)
## CLI
* [kubectl](/docs/reference/kubectl/) - Main CLI tool for running commands and managing Kubernetes clusters.
* [JSONPath](/docs/reference/kubectl/jsonpath/) - Syntax guide for using [JSONPath expressions](https://goessner.net/articles/JsonPath/) with kubectl.
* [kubeadm](/docs/reference/setup-tools/kubeadm/) - CLI tool to easily provision a secure Kubernetes cluster.
## Components
* [kubelet](/docs/reference/command-line-tools-reference/kubelet/) - The
primary agent that runs on each node. The kubelet takes a set of PodSpecs
and ensures that the described containers are running and healthy.
* [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) -
REST API that validates and configures data for API objects such as pods,
services, replication controllers.
* [kube-controller-manager](/docs/reference/command-line-tools-reference/kube-controller-manager/) -
Daemon that embeds the core control loops shipped with Kubernetes.
* [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - Can
do simple TCP/UDP stream forwarding or round-robin TCP/UDP forwarding across
a set of back-ends.
* [kube-scheduler](/docs/reference/command-line-tools-reference/kube-scheduler/) -
Scheduler that manages availability, performance, and capacity.
* [Scheduler Policies](/docs/reference/scheduling/policies)
* [Scheduler Profiles](/docs/reference/scheduling/config#profiles)
* List of [ports and protocols](/docs/reference/networking/ports-and-protocols/) that
should be open on control plane and worker nodes
## Config APIs
This section hosts the documentation for "unpublished" APIs which are used to
configure kubernetes components or tools. Most of these APIs are not exposed
by the API server in a RESTful way though they are essential for a user or an
operator to use or manage a cluster.
* [kubeconfig (v1)](/docs/reference/config-api/kubeconfig.v1/)
* [kube-apiserver admission (v1)](/docs/reference/config-api/apiserver-admission.v1/)
* [kube-apiserver configuration (v1alpha1)](/docs/reference/config-api/apiserver-config.v1alpha1/) and
* [kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/) and
[kube-apiserver configuration (v1)](/docs/reference/config-api/apiserver-config.v1/)
* [kube-apiserver event rate limit (v1alpha1)](/docs/reference/config-api/apiserver-eventratelimit.v1alpha1/)
* [kubelet configuration (v1alpha1)](/docs/reference/config-api/kubelet-config.v1alpha1/) and
[kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/)
[kubelet configuration (v1)](/docs/reference/config-api/kubelet-config.v1/)
* [kubelet credential providers (v1)](/docs/reference/config-api/kubelet-credentialprovider.v1/)
* [kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) and
[kube-scheduler configuration (v1)](/docs/reference/config-api/kube-scheduler-config.v1/)
* [kube-controller-manager configuration (v1alpha1)](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/)
* [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
* [`audit.k8s.io/v1` API](/docs/reference/config-api/apiserver-audit.v1/)
* [Client authentication API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/) and
[Client authentication API (v1)](/docs/reference/config-api/client-authentication.v1/)
* [WebhookAdmission configuration (v1)](/docs/reference/config-api/apiserver-webhookadmission.v1/)
* [ImagePolicy API (v1alpha1)](/docs/reference/config-api/imagepolicy.v1alpha1/)
## Config API for kubeadm
* [v1beta3](/docs/reference/config-api/kubeadm-config.v1beta3/)
* [v1beta4](/docs/reference/config-api/kubeadm-config.v1beta4/)
## External APIs
These are the APIs defined by the Kubernetes project, but are not implemented
by the core project:
* [Metrics API (v1beta1)](/docs/reference/external-api/metrics.v1beta1/)
* [Custom Metrics API (v1beta2)](/docs/reference/external-api/custom-metrics.v1beta2)
* [External Metrics API (v1beta1)](/docs/reference/external-api/external-metrics.v1beta1)
## Design Docs
An archive of the design docs for Kubernetes functionality. Good starting points are
[Kubernetes Architecture](https://git.k8s.io/design-proposals-archive/architecture/architecture.md) and
[Kubernetes Design Overview](https://git.k8s.io/design-proposals-archive).
| kubernetes reference | title Reference approvers chenopis linkTitle Reference main menu true weight 70 content type concept no list true overview This section of the Kubernetes documentation contains references body API Reference Glossary docs reference glossary a comprehensive standardized list of Kubernetes terminology Kubernetes API Reference docs reference kubernetes api One page API Reference for Kubernetes docs reference generated kubernetes api Using The Kubernetes API docs reference using api overview of the API for Kubernetes API access control docs reference access authn authz details on how Kubernetes controls API access Well Known Labels Annotations and Taints docs reference labels annotations taints Officially supported client libraries To call the Kubernetes API from a programming language you can use client libraries docs reference using api client libraries Officially supported client libraries Kubernetes Go client library https github com kubernetes client go Kubernetes Python client library https github com kubernetes client python Kubernetes Java client library https github com kubernetes client java Kubernetes JavaScript client library https github com kubernetes client javascript Kubernetes C client library https github com kubernetes client csharp Kubernetes Haskell client library https github com kubernetes client haskell CLI kubectl docs reference kubectl Main CLI tool for running commands and managing Kubernetes clusters JSONPath docs reference kubectl jsonpath Syntax guide for using JSONPath expressions https goessner net articles JsonPath with kubectl kubeadm docs reference setup tools kubeadm CLI tool to easily provision a secure Kubernetes cluster Components kubelet docs reference command line tools reference kubelet The primary agent that runs on each node The kubelet takes a set of PodSpecs and ensures that the described containers are running and healthy kube apiserver docs reference command line tools reference kube apiserver REST API that validates and configures data for API objects such as pods services replication controllers kube controller manager docs reference command line tools reference kube controller manager Daemon that embeds the core control loops shipped with Kubernetes kube proxy docs reference command line tools reference kube proxy Can do simple TCP UDP stream forwarding or round robin TCP UDP forwarding across a set of back ends kube scheduler docs reference command line tools reference kube scheduler Scheduler that manages availability performance and capacity Scheduler Policies docs reference scheduling policies Scheduler Profiles docs reference scheduling config profiles List of ports and protocols docs reference networking ports and protocols that should be open on control plane and worker nodes Config APIs This section hosts the documentation for unpublished APIs which are used to configure kubernetes components or tools Most of these APIs are not exposed by the API server in a RESTful way though they are essential for a user or an operator to use or manage a cluster kubeconfig v1 docs reference config api kubeconfig v1 kube apiserver admission v1 docs reference config api apiserver admission v1 kube apiserver configuration v1alpha1 docs reference config api apiserver config v1alpha1 and kube apiserver configuration v1beta1 docs reference config api apiserver config v1beta1 and kube apiserver configuration v1 docs reference config api apiserver config v1 kube apiserver event rate limit v1alpha1 docs reference config api apiserver eventratelimit v1alpha1 kubelet configuration v1alpha1 docs reference config api kubelet config v1alpha1 and kubelet configuration v1beta1 docs reference config api kubelet config v1beta1 kubelet configuration v1 docs reference config api kubelet config v1 kubelet credential providers v1 docs reference config api kubelet credentialprovider v1 kube scheduler configuration v1beta3 docs reference config api kube scheduler config v1beta3 and kube scheduler configuration v1 docs reference config api kube scheduler config v1 kube controller manager configuration v1alpha1 docs reference config api kube controller manager config v1alpha1 kube proxy configuration v1alpha1 docs reference config api kube proxy config v1alpha1 audit k8s io v1 API docs reference config api apiserver audit v1 Client authentication API v1beta1 docs reference config api client authentication v1beta1 and Client authentication API v1 docs reference config api client authentication v1 WebhookAdmission configuration v1 docs reference config api apiserver webhookadmission v1 ImagePolicy API v1alpha1 docs reference config api imagepolicy v1alpha1 Config API for kubeadm v1beta3 docs reference config api kubeadm config v1beta3 v1beta4 docs reference config api kubeadm config v1beta4 External APIs These are the APIs defined by the Kubernetes project but are not implemented by the core project Metrics API v1beta1 docs reference external api metrics v1beta1 Custom Metrics API v1beta2 docs reference external api custom metrics v1beta2 External Metrics API v1beta1 docs reference external api external metrics v1beta1 Design Docs An archive of the design docs for Kubernetes functionality Good starting points are Kubernetes Architecture https git k8s io design proposals archive architecture architecture md and Kubernetes Design Overview https git k8s io design proposals archive |
kubernetes reference title SubjectAccessReview import k8s io api authorization v1 contenttype apireference apiVersion authorization k8s io v1 kind SubjectAccessReview apimetadata weight 4 autogenerated true SubjectAccessReview checks whether or not a user or group can perform an action | ---
api_metadata:
apiVersion: "authorization.k8s.io/v1"
import: "k8s.io/api/authorization/v1"
kind: "SubjectAccessReview"
content_type: "api_reference"
description: "SubjectAccessReview checks whether or not a user or group can perform an action."
title: "SubjectAccessReview"
weight: 4
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.
-->
`apiVersion: authorization.k8s.io/v1`
`import "k8s.io/api/authorization/v1"`
## SubjectAccessReview {#SubjectAccessReview}
SubjectAccessReview checks whether or not a user or group can perform an action.
<hr>
- **apiVersion**: authorization.k8s.io/v1
- **kind**: SubjectAccessReview
- **metadata** (<a href="">ObjectMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">SubjectAccessReviewSpec</a>), required
Spec holds information about the request being evaluated
- **status** (<a href="">SubjectAccessReviewStatus</a>)
Status is filled in by the server and indicates whether the request is allowed or not
## SubjectAccessReviewSpec {#SubjectAccessReviewSpec}
SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set
<hr>
- **extra** (map[string][]string)
Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
- **groups** ([]string)
*Atomic: will be replaced during a merge*
Groups is the groups you're testing for.
- **nonResourceAttributes** (NonResourceAttributes)
NonResourceAttributes describes information for a non-resource access request
<a name="NonResourceAttributes"></a>
*NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface*
- **nonResourceAttributes.path** (string)
Path is the URL path of the request
- **nonResourceAttributes.verb** (string)
Verb is the standard HTTP verb
- **resourceAttributes** (ResourceAttributes)
ResourceAuthorizationAttributes describes information for a resource access request
<a name="ResourceAttributes"></a>
*ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface*
- **resourceAttributes.fieldSelector** (FieldSelectorAttributes)
fieldSelector describes the limitation on access based on field. It can only limit access, not broaden it.
This field is alpha-level. To use this field, you must enable the `AuthorizeWithSelectors` feature gate (disabled by default).
<a name="FieldSelectorAttributes"></a>
*FieldSelectorAttributes indicates a field limited access. Webhook authors are encouraged to * ensure rawSelector and requirements are not both set * consider the requirements field if set * not try to parse or consider the rawSelector field if set. This is to avoid another CVE-2022-2880 (i.e. getting different systems to agree on how exactly to parse a query is not something we want), see https://www.oxeye.io/resources/golang-parameter-smuggling-attack for more details. For the *SubjectAccessReview endpoints of the kube-apiserver: * If rawSelector is empty and requirements are empty, the request is not limited. * If rawSelector is present and requirements are empty, the rawSelector will be parsed and limited if the parsing succeeds. * If rawSelector is empty and requirements are present, the requirements should be honored * If rawSelector is present and requirements are present, the request is invalid.*
- **resourceAttributes.fieldSelector.rawSelector** (string)
rawSelector is the serialization of a field selector that would be included in a query parameter. Webhook implementations are encouraged to ignore rawSelector. The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present.
- **resourceAttributes.fieldSelector.requirements** ([]FieldSelectorRequirement)
*Atomic: will be replaced during a merge*
requirements is the parsed interpretation of a field selector. All requirements must be met for a resource instance to match the selector. Webhook implementations should handle requirements, but how to handle them is up to the webhook. Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements are not understood.
<a name="FieldSelectorRequirement"></a>
*FieldSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.*
- **resourceAttributes.fieldSelector.requirements.key** (string), required
key is the field selector key that the requirement applies to.
- **resourceAttributes.fieldSelector.requirements.operator** (string), required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. The list of operators may grow in the future.
- **resourceAttributes.fieldSelector.requirements.values** ([]string)
*Atomic: will be replaced during a merge*
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty.
- **resourceAttributes.group** (string)
Group is the API Group of the Resource. "*" means all.
- **resourceAttributes.labelSelector** (LabelSelectorAttributes)
labelSelector describes the limitation on access based on labels. It can only limit access, not broaden it.
This field is alpha-level. To use this field, you must enable the `AuthorizeWithSelectors` feature gate (disabled by default).
<a name="LabelSelectorAttributes"></a>
*LabelSelectorAttributes indicates a label limited access. Webhook authors are encouraged to * ensure rawSelector and requirements are not both set * consider the requirements field if set * not try to parse or consider the rawSelector field if set. This is to avoid another CVE-2022-2880 (i.e. getting different systems to agree on how exactly to parse a query is not something we want), see https://www.oxeye.io/resources/golang-parameter-smuggling-attack for more details. For the *SubjectAccessReview endpoints of the kube-apiserver: * If rawSelector is empty and requirements are empty, the request is not limited. * If rawSelector is present and requirements are empty, the rawSelector will be parsed and limited if the parsing succeeds. * If rawSelector is empty and requirements are present, the requirements should be honored * If rawSelector is present and requirements are present, the request is invalid.*
- **resourceAttributes.labelSelector.rawSelector** (string)
rawSelector is the serialization of a field selector that would be included in a query parameter. Webhook implementations are encouraged to ignore rawSelector. The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present.
- **resourceAttributes.labelSelector.requirements** ([]LabelSelectorRequirement)
*Atomic: will be replaced during a merge*
requirements is the parsed interpretation of a label selector. All requirements must be met for a resource instance to match the selector. Webhook implementations should handle requirements, but how to handle them is up to the webhook. Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements are not understood.
<a name="LabelSelectorRequirement"></a>
*A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.*
- **resourceAttributes.labelSelector.requirements.key** (string), required
key is the label key that the selector applies to.
- **resourceAttributes.labelSelector.requirements.operator** (string), required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- **resourceAttributes.labelSelector.requirements.values** ([]string)
*Atomic: will be replaced during a merge*
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- **resourceAttributes.name** (string)
Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
- **resourceAttributes.namespace** (string)
Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
- **resourceAttributes.resource** (string)
Resource is one of the existing resource types. "*" means all.
- **resourceAttributes.subresource** (string)
Subresource is one of the existing resource types. "" means none.
- **resourceAttributes.verb** (string)
Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
- **resourceAttributes.version** (string)
Version is the API Version of the Resource. "*" means all.
- **uid** (string)
UID information about the requesting user.
- **user** (string)
User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups
## SubjectAccessReviewStatus {#SubjectAccessReviewStatus}
SubjectAccessReviewStatus
<hr>
- **allowed** (boolean), required
Allowed is required. True if the action would be allowed, false otherwise.
- **denied** (boolean)
Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
- **evaluationError** (string)
EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
- **reason** (string)
Reason is optional. It indicates why a request was allowed or denied.
## Operations {#Operations}
<hr>
### `create` create a SubjectAccessReview
#### HTTP Request
POST /apis/authorization.k8s.io/v1/subjectaccessreviews
#### Parameters
- **body**: <a href="">SubjectAccessReview</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">SubjectAccessReview</a>): OK
201 (<a href="">SubjectAccessReview</a>): Created
202 (<a href="">SubjectAccessReview</a>): Accepted
401: Unauthorized
| kubernetes reference | api metadata apiVersion authorization k8s io v1 import k8s io api authorization v1 kind SubjectAccessReview content type api reference description SubjectAccessReview checks whether or not a user or group can perform an action title SubjectAccessReview weight 4 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 apiVersion authorization k8s io v1 import k8s io api authorization v1 SubjectAccessReview SubjectAccessReview SubjectAccessReview checks whether or not a user or group can perform an action hr apiVersion authorization k8s io v1 kind SubjectAccessReview metadata a href ObjectMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href SubjectAccessReviewSpec a required Spec holds information about the request being evaluated status a href SubjectAccessReviewStatus a Status is filled in by the server and indicates whether the request is allowed or not SubjectAccessReviewSpec SubjectAccessReviewSpec SubjectAccessReviewSpec is a description of the access request Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set hr extra map string string Extra corresponds to the user Info GetExtra method from the authenticator Since that is input to the authorizer it needs a reflection here groups string Atomic will be replaced during a merge Groups is the groups you re testing for nonResourceAttributes NonResourceAttributes NonResourceAttributes describes information for a non resource access request a name NonResourceAttributes a NonResourceAttributes includes the authorization attributes available for non resource requests to the Authorizer interface nonResourceAttributes path string Path is the URL path of the request nonResourceAttributes verb string Verb is the standard HTTP verb resourceAttributes ResourceAttributes ResourceAuthorizationAttributes describes information for a resource access request a name ResourceAttributes a ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface resourceAttributes fieldSelector FieldSelectorAttributes fieldSelector describes the limitation on access based on field It can only limit access not broaden it This field is alpha level To use this field you must enable the AuthorizeWithSelectors feature gate disabled by default a name FieldSelectorAttributes a FieldSelectorAttributes indicates a field limited access Webhook authors are encouraged to ensure rawSelector and requirements are not both set consider the requirements field if set not try to parse or consider the rawSelector field if set This is to avoid another CVE 2022 2880 i e getting different systems to agree on how exactly to parse a query is not something we want see https www oxeye io resources golang parameter smuggling attack for more details For the SubjectAccessReview endpoints of the kube apiserver If rawSelector is empty and requirements are empty the request is not limited If rawSelector is present and requirements are empty the rawSelector will be parsed and limited if the parsing succeeds If rawSelector is empty and requirements are present the requirements should be honored If rawSelector is present and requirements are present the request is invalid resourceAttributes fieldSelector rawSelector string rawSelector is the serialization of a field selector that would be included in a query parameter Webhook implementations are encouraged to ignore rawSelector The kube apiserver s SubjectAccessReview will parse the rawSelector as long as the requirements are not present resourceAttributes fieldSelector requirements FieldSelectorRequirement Atomic will be replaced during a merge requirements is the parsed interpretation of a field selector All requirements must be met for a resource instance to match the selector Webhook implementations should handle requirements but how to handle them is up to the webhook Since requirements can only limit the request it is safe to authorize as unlimited request if the requirements are not understood a name FieldSelectorRequirement a FieldSelectorRequirement is a selector that contains values a key and an operator that relates the key and values resourceAttributes fieldSelector requirements key string required key is the field selector key that the requirement applies to resourceAttributes fieldSelector requirements operator string required operator represents a key s relationship to a set of values Valid operators are In NotIn Exists DoesNotExist The list of operators may grow in the future resourceAttributes fieldSelector requirements values string Atomic will be replaced during a merge values is an array of string values If the operator is In or NotIn the values array must be non empty If the operator is Exists or DoesNotExist the values array must be empty resourceAttributes group string Group is the API Group of the Resource means all resourceAttributes labelSelector LabelSelectorAttributes labelSelector describes the limitation on access based on labels It can only limit access not broaden it This field is alpha level To use this field you must enable the AuthorizeWithSelectors feature gate disabled by default a name LabelSelectorAttributes a LabelSelectorAttributes indicates a label limited access Webhook authors are encouraged to ensure rawSelector and requirements are not both set consider the requirements field if set not try to parse or consider the rawSelector field if set This is to avoid another CVE 2022 2880 i e getting different systems to agree on how exactly to parse a query is not something we want see https www oxeye io resources golang parameter smuggling attack for more details For the SubjectAccessReview endpoints of the kube apiserver If rawSelector is empty and requirements are empty the request is not limited If rawSelector is present and requirements are empty the rawSelector will be parsed and limited if the parsing succeeds If rawSelector is empty and requirements are present the requirements should be honored If rawSelector is present and requirements are present the request is invalid resourceAttributes labelSelector rawSelector string rawSelector is the serialization of a field selector that would be included in a query parameter Webhook implementations are encouraged to ignore rawSelector The kube apiserver s SubjectAccessReview will parse the rawSelector as long as the requirements are not present resourceAttributes labelSelector requirements LabelSelectorRequirement Atomic will be replaced during a merge requirements is the parsed interpretation of a label selector All requirements must be met for a resource instance to match the selector Webhook implementations should handle requirements but how to handle them is up to the webhook Since requirements can only limit the request it is safe to authorize as unlimited request if the requirements are not understood a name LabelSelectorRequirement a A label selector requirement is a selector that contains values a key and an operator that relates the key and values resourceAttributes labelSelector requirements key string required key is the label key that the selector applies to resourceAttributes labelSelector requirements operator string required operator represents a key s relationship to a set of values Valid operators are In NotIn Exists and DoesNotExist resourceAttributes labelSelector requirements values string Atomic will be replaced during a merge values is an array of string values If the operator is In or NotIn the values array must be non empty If the operator is Exists or DoesNotExist the values array must be empty This array is replaced during a strategic merge patch resourceAttributes name string Name is the name of the resource being requested for a get or deleted for a delete empty means all resourceAttributes namespace string Namespace is the namespace of the action being requested Currently there is no distinction between no namespace and all namespaces empty is defaulted for LocalSubjectAccessReviews empty is empty for cluster scoped resources empty means all for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview resourceAttributes resource string Resource is one of the existing resource types means all resourceAttributes subresource string Subresource is one of the existing resource types means none resourceAttributes verb string Verb is a kubernetes resource API verb like get list watch create update delete proxy means all resourceAttributes version string Version is the API Version of the Resource means all uid string UID information about the requesting user user string User is the user you re testing for If you specify User but not Groups then is it interpreted as What if User were not a member of any groups SubjectAccessReviewStatus SubjectAccessReviewStatus SubjectAccessReviewStatus hr allowed boolean required Allowed is required True if the action would be allowed false otherwise denied boolean Denied is optional True if the action would be denied otherwise false If both allowed is false and denied is false then the authorizer has no opinion on whether to authorize the action Denied may not be true if Allowed is true evaluationError string EvaluationError is an indication that some error occurred during the authorization check It is entirely possible to get an error and be able to continue determine authorization status in spite of it For instance RBAC can be missing a role but enough roles are still present and bound to reason about the request reason string Reason is optional It indicates why a request was allowed or denied Operations Operations hr create create a SubjectAccessReview HTTP Request POST apis authorization k8s io v1 subjectaccessreviews Parameters body a href SubjectAccessReview a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href SubjectAccessReview a OK 201 a href SubjectAccessReview a Created 202 a href SubjectAccessReview a Accepted 401 Unauthorized |
kubernetes reference ClusterRoleBinding references a ClusterRole but not contain it weight 6 title ClusterRoleBinding import k8s io api rbac v1 apiVersion rbac authorization k8s io v1 contenttype apireference apimetadata kind ClusterRoleBinding autogenerated true | ---
api_metadata:
apiVersion: "rbac.authorization.k8s.io/v1"
import: "k8s.io/api/rbac/v1"
kind: "ClusterRoleBinding"
content_type: "api_reference"
description: "ClusterRoleBinding references a ClusterRole, but not contain it."
title: "ClusterRoleBinding"
weight: 6
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.
-->
`apiVersion: rbac.authorization.k8s.io/v1`
`import "k8s.io/api/rbac/v1"`
## ClusterRoleBinding {#ClusterRoleBinding}
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
<hr>
- **apiVersion**: rbac.authorization.k8s.io/v1
- **kind**: ClusterRoleBinding
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata.
- **roleRef** (RoleRef), required
RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable.
<a name="RoleRef"></a>
*RoleRef contains information that points to the role being used*
- **roleRef.apiGroup** (string), required
APIGroup is the group for the resource being referenced
- **roleRef.kind** (string), required
Kind is the type of resource being referenced
- **roleRef.name** (string), required
Name is the name of resource being referenced
- **subjects** ([]Subject)
*Atomic: will be replaced during a merge*
Subjects holds references to the objects the role applies to.
<a name="Subject"></a>
*Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.*
- **subjects.kind** (string), required
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
- **subjects.name** (string), required
Name of the object being referenced.
- **subjects.apiGroup** (string)
APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
- **subjects.namespace** (string)
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
## ClusterRoleBindingList {#ClusterRoleBindingList}
ClusterRoleBindingList is a collection of ClusterRoleBindings
<hr>
- **apiVersion**: rbac.authorization.k8s.io/v1
- **kind**: ClusterRoleBindingList
- **metadata** (<a href="">ListMeta</a>)
Standard object's metadata.
- **items** ([]<a href="">ClusterRoleBinding</a>), required
Items is a list of ClusterRoleBindings
## Operations {#Operations}
<hr>
### `get` read the specified ClusterRoleBinding
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterRoleBinding
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterRoleBinding</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ClusterRoleBinding
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ClusterRoleBindingList</a>): OK
401: Unauthorized
### `create` create a ClusterRoleBinding
#### HTTP Request
POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
#### Parameters
- **body**: <a href="">ClusterRoleBinding</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterRoleBinding</a>): OK
201 (<a href="">ClusterRoleBinding</a>): Created
202 (<a href="">ClusterRoleBinding</a>): Accepted
401: Unauthorized
### `update` replace the specified ClusterRoleBinding
#### HTTP Request
PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterRoleBinding
- **body**: <a href="">ClusterRoleBinding</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterRoleBinding</a>): OK
201 (<a href="">ClusterRoleBinding</a>): Created
401: Unauthorized
### `patch` partially update the specified ClusterRoleBinding
#### HTTP Request
PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterRoleBinding
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterRoleBinding</a>): OK
201 (<a href="">ClusterRoleBinding</a>): Created
401: Unauthorized
### `delete` delete a ClusterRoleBinding
#### HTTP Request
DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterRoleBinding
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ClusterRoleBinding
#### HTTP Request
DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion rbac authorization k8s io v1 import k8s io api rbac v1 kind ClusterRoleBinding content type api reference description ClusterRoleBinding references a ClusterRole but not contain it title ClusterRoleBinding weight 6 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 apiVersion rbac authorization k8s io v1 import k8s io api rbac v1 ClusterRoleBinding ClusterRoleBinding ClusterRoleBinding references a ClusterRole but not contain it It can reference a ClusterRole in the global namespace and adds who information via Subject hr apiVersion rbac authorization k8s io v1 kind ClusterRoleBinding metadata a href ObjectMeta a Standard object s metadata roleRef RoleRef required RoleRef can only reference a ClusterRole in the global namespace If the RoleRef cannot be resolved the Authorizer must return an error This field is immutable a name RoleRef a RoleRef contains information that points to the role being used roleRef apiGroup string required APIGroup is the group for the resource being referenced roleRef kind string required Kind is the type of resource being referenced roleRef name string required Name is the name of resource being referenced subjects Subject Atomic will be replaced during a merge Subjects holds references to the objects the role applies to a name Subject a Subject contains a reference to the object or user identities a role binding applies to This can either hold a direct API object reference or a value for non objects such as user and group names subjects kind string required Kind of object being referenced Values defined by this API group are User Group and ServiceAccount If the Authorizer does not recognized the kind value the Authorizer should report an error subjects name string required Name of the object being referenced subjects apiGroup string APIGroup holds the API group of the referenced subject Defaults to for ServiceAccount subjects Defaults to rbac authorization k8s io for User and Group subjects subjects namespace string Namespace of the referenced object If the object kind is non namespace such as User or Group and this value is not empty the Authorizer should report an error ClusterRoleBindingList ClusterRoleBindingList ClusterRoleBindingList is a collection of ClusterRoleBindings hr apiVersion rbac authorization k8s io v1 kind ClusterRoleBindingList metadata a href ListMeta a Standard object s metadata items a href ClusterRoleBinding a required Items is a list of ClusterRoleBindings Operations Operations hr get read the specified ClusterRoleBinding HTTP Request GET apis rbac authorization k8s io v1 clusterrolebindings name Parameters name in path string required name of the ClusterRoleBinding pretty in query string a href pretty a Response 200 a href ClusterRoleBinding a OK 401 Unauthorized list list or watch objects of kind ClusterRoleBinding HTTP Request GET apis rbac authorization k8s io v1 clusterrolebindings Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ClusterRoleBindingList a OK 401 Unauthorized create create a ClusterRoleBinding HTTP Request POST apis rbac authorization k8s io v1 clusterrolebindings Parameters body a href ClusterRoleBinding a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ClusterRoleBinding a OK 201 a href ClusterRoleBinding a Created 202 a href ClusterRoleBinding a Accepted 401 Unauthorized update replace the specified ClusterRoleBinding HTTP Request PUT apis rbac authorization k8s io v1 clusterrolebindings name Parameters name in path string required name of the ClusterRoleBinding body a href ClusterRoleBinding a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ClusterRoleBinding a OK 201 a href ClusterRoleBinding a Created 401 Unauthorized patch partially update the specified ClusterRoleBinding HTTP Request PATCH apis rbac authorization k8s io v1 clusterrolebindings name Parameters name in path string required name of the ClusterRoleBinding body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ClusterRoleBinding a OK 201 a href ClusterRoleBinding a Created 401 Unauthorized delete delete a ClusterRoleBinding HTTP Request DELETE apis rbac authorization k8s io v1 clusterrolebindings name Parameters name in path string required name of the ClusterRoleBinding body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ClusterRoleBinding HTTP Request DELETE apis rbac authorization k8s io v1 clusterrolebindings Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference weight 2 import k8s io api authorization v1 contenttype apireference SelfSubjectAccessReview checks whether or the current user can perform an action apiVersion authorization k8s io v1 apimetadata title SelfSubjectAccessReview autogenerated true kind SelfSubjectAccessReview | ---
api_metadata:
apiVersion: "authorization.k8s.io/v1"
import: "k8s.io/api/authorization/v1"
kind: "SelfSubjectAccessReview"
content_type: "api_reference"
description: "SelfSubjectAccessReview checks whether or the current user can perform an action."
title: "SelfSubjectAccessReview"
weight: 2
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.
-->
`apiVersion: authorization.k8s.io/v1`
`import "k8s.io/api/authorization/v1"`
## SelfSubjectAccessReview {#SelfSubjectAccessReview}
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
<hr>
- **apiVersion**: authorization.k8s.io/v1
- **kind**: SelfSubjectAccessReview
- **metadata** (<a href="">ObjectMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">SelfSubjectAccessReviewSpec</a>), required
Spec holds information about the request being evaluated. user and groups must be empty
- **status** (<a href="">SubjectAccessReviewStatus</a>)
Status is filled in by the server and indicates whether the request is allowed or not
## SelfSubjectAccessReviewSpec {#SelfSubjectAccessReviewSpec}
SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set
<hr>
- **nonResourceAttributes** (NonResourceAttributes)
NonResourceAttributes describes information for a non-resource access request
<a name="NonResourceAttributes"></a>
*NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface*
- **nonResourceAttributes.path** (string)
Path is the URL path of the request
- **nonResourceAttributes.verb** (string)
Verb is the standard HTTP verb
- **resourceAttributes** (ResourceAttributes)
ResourceAuthorizationAttributes describes information for a resource access request
<a name="ResourceAttributes"></a>
*ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface*
- **resourceAttributes.fieldSelector** (FieldSelectorAttributes)
fieldSelector describes the limitation on access based on field. It can only limit access, not broaden it.
This field is alpha-level. To use this field, you must enable the `AuthorizeWithSelectors` feature gate (disabled by default).
<a name="FieldSelectorAttributes"></a>
*FieldSelectorAttributes indicates a field limited access. Webhook authors are encouraged to * ensure rawSelector and requirements are not both set * consider the requirements field if set * not try to parse or consider the rawSelector field if set. This is to avoid another CVE-2022-2880 (i.e. getting different systems to agree on how exactly to parse a query is not something we want), see https://www.oxeye.io/resources/golang-parameter-smuggling-attack for more details. For the *SubjectAccessReview endpoints of the kube-apiserver: * If rawSelector is empty and requirements are empty, the request is not limited. * If rawSelector is present and requirements are empty, the rawSelector will be parsed and limited if the parsing succeeds. * If rawSelector is empty and requirements are present, the requirements should be honored * If rawSelector is present and requirements are present, the request is invalid.*
- **resourceAttributes.fieldSelector.rawSelector** (string)
rawSelector is the serialization of a field selector that would be included in a query parameter. Webhook implementations are encouraged to ignore rawSelector. The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present.
- **resourceAttributes.fieldSelector.requirements** ([]FieldSelectorRequirement)
*Atomic: will be replaced during a merge*
requirements is the parsed interpretation of a field selector. All requirements must be met for a resource instance to match the selector. Webhook implementations should handle requirements, but how to handle them is up to the webhook. Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements are not understood.
<a name="FieldSelectorRequirement"></a>
*FieldSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.*
- **resourceAttributes.fieldSelector.requirements.key** (string), required
key is the field selector key that the requirement applies to.
- **resourceAttributes.fieldSelector.requirements.operator** (string), required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. The list of operators may grow in the future.
- **resourceAttributes.fieldSelector.requirements.values** ([]string)
*Atomic: will be replaced during a merge*
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty.
- **resourceAttributes.group** (string)
Group is the API Group of the Resource. "*" means all.
- **resourceAttributes.labelSelector** (LabelSelectorAttributes)
labelSelector describes the limitation on access based on labels. It can only limit access, not broaden it.
This field is alpha-level. To use this field, you must enable the `AuthorizeWithSelectors` feature gate (disabled by default).
<a name="LabelSelectorAttributes"></a>
*LabelSelectorAttributes indicates a label limited access. Webhook authors are encouraged to * ensure rawSelector and requirements are not both set * consider the requirements field if set * not try to parse or consider the rawSelector field if set. This is to avoid another CVE-2022-2880 (i.e. getting different systems to agree on how exactly to parse a query is not something we want), see https://www.oxeye.io/resources/golang-parameter-smuggling-attack for more details. For the *SubjectAccessReview endpoints of the kube-apiserver: * If rawSelector is empty and requirements are empty, the request is not limited. * If rawSelector is present and requirements are empty, the rawSelector will be parsed and limited if the parsing succeeds. * If rawSelector is empty and requirements are present, the requirements should be honored * If rawSelector is present and requirements are present, the request is invalid.*
- **resourceAttributes.labelSelector.rawSelector** (string)
rawSelector is the serialization of a field selector that would be included in a query parameter. Webhook implementations are encouraged to ignore rawSelector. The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present.
- **resourceAttributes.labelSelector.requirements** ([]LabelSelectorRequirement)
*Atomic: will be replaced during a merge*
requirements is the parsed interpretation of a label selector. All requirements must be met for a resource instance to match the selector. Webhook implementations should handle requirements, but how to handle them is up to the webhook. Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements are not understood.
<a name="LabelSelectorRequirement"></a>
*A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.*
- **resourceAttributes.labelSelector.requirements.key** (string), required
key is the label key that the selector applies to.
- **resourceAttributes.labelSelector.requirements.operator** (string), required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- **resourceAttributes.labelSelector.requirements.values** ([]string)
*Atomic: will be replaced during a merge*
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- **resourceAttributes.name** (string)
Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
- **resourceAttributes.namespace** (string)
Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
- **resourceAttributes.resource** (string)
Resource is one of the existing resource types. "*" means all.
- **resourceAttributes.subresource** (string)
Subresource is one of the existing resource types. "" means none.
- **resourceAttributes.verb** (string)
Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
- **resourceAttributes.version** (string)
Version is the API Version of the Resource. "*" means all.
## Operations {#Operations}
<hr>
### `create` create a SelfSubjectAccessReview
#### HTTP Request
POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews
#### Parameters
- **body**: <a href="">SelfSubjectAccessReview</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">SelfSubjectAccessReview</a>): OK
201 (<a href="">SelfSubjectAccessReview</a>): Created
202 (<a href="">SelfSubjectAccessReview</a>): Accepted
401: Unauthorized
| kubernetes reference | api metadata apiVersion authorization k8s io v1 import k8s io api authorization v1 kind SelfSubjectAccessReview content type api reference description SelfSubjectAccessReview checks whether or the current user can perform an action title SelfSubjectAccessReview weight 2 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 apiVersion authorization k8s io v1 import k8s io api authorization v1 SelfSubjectAccessReview SelfSubjectAccessReview SelfSubjectAccessReview checks whether or the current user can perform an action Not filling in a spec namespace means in all namespaces Self is a special case because users should always be able to check whether they can perform an action hr apiVersion authorization k8s io v1 kind SelfSubjectAccessReview metadata a href ObjectMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href SelfSubjectAccessReviewSpec a required Spec holds information about the request being evaluated user and groups must be empty status a href SubjectAccessReviewStatus a Status is filled in by the server and indicates whether the request is allowed or not SelfSubjectAccessReviewSpec SelfSubjectAccessReviewSpec SelfSubjectAccessReviewSpec is a description of the access request Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set hr nonResourceAttributes NonResourceAttributes NonResourceAttributes describes information for a non resource access request a name NonResourceAttributes a NonResourceAttributes includes the authorization attributes available for non resource requests to the Authorizer interface nonResourceAttributes path string Path is the URL path of the request nonResourceAttributes verb string Verb is the standard HTTP verb resourceAttributes ResourceAttributes ResourceAuthorizationAttributes describes information for a resource access request a name ResourceAttributes a ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface resourceAttributes fieldSelector FieldSelectorAttributes fieldSelector describes the limitation on access based on field It can only limit access not broaden it This field is alpha level To use this field you must enable the AuthorizeWithSelectors feature gate disabled by default a name FieldSelectorAttributes a FieldSelectorAttributes indicates a field limited access Webhook authors are encouraged to ensure rawSelector and requirements are not both set consider the requirements field if set not try to parse or consider the rawSelector field if set This is to avoid another CVE 2022 2880 i e getting different systems to agree on how exactly to parse a query is not something we want see https www oxeye io resources golang parameter smuggling attack for more details For the SubjectAccessReview endpoints of the kube apiserver If rawSelector is empty and requirements are empty the request is not limited If rawSelector is present and requirements are empty the rawSelector will be parsed and limited if the parsing succeeds If rawSelector is empty and requirements are present the requirements should be honored If rawSelector is present and requirements are present the request is invalid resourceAttributes fieldSelector rawSelector string rawSelector is the serialization of a field selector that would be included in a query parameter Webhook implementations are encouraged to ignore rawSelector The kube apiserver s SubjectAccessReview will parse the rawSelector as long as the requirements are not present resourceAttributes fieldSelector requirements FieldSelectorRequirement Atomic will be replaced during a merge requirements is the parsed interpretation of a field selector All requirements must be met for a resource instance to match the selector Webhook implementations should handle requirements but how to handle them is up to the webhook Since requirements can only limit the request it is safe to authorize as unlimited request if the requirements are not understood a name FieldSelectorRequirement a FieldSelectorRequirement is a selector that contains values a key and an operator that relates the key and values resourceAttributes fieldSelector requirements key string required key is the field selector key that the requirement applies to resourceAttributes fieldSelector requirements operator string required operator represents a key s relationship to a set of values Valid operators are In NotIn Exists DoesNotExist The list of operators may grow in the future resourceAttributes fieldSelector requirements values string Atomic will be replaced during a merge values is an array of string values If the operator is In or NotIn the values array must be non empty If the operator is Exists or DoesNotExist the values array must be empty resourceAttributes group string Group is the API Group of the Resource means all resourceAttributes labelSelector LabelSelectorAttributes labelSelector describes the limitation on access based on labels It can only limit access not broaden it This field is alpha level To use this field you must enable the AuthorizeWithSelectors feature gate disabled by default a name LabelSelectorAttributes a LabelSelectorAttributes indicates a label limited access Webhook authors are encouraged to ensure rawSelector and requirements are not both set consider the requirements field if set not try to parse or consider the rawSelector field if set This is to avoid another CVE 2022 2880 i e getting different systems to agree on how exactly to parse a query is not something we want see https www oxeye io resources golang parameter smuggling attack for more details For the SubjectAccessReview endpoints of the kube apiserver If rawSelector is empty and requirements are empty the request is not limited If rawSelector is present and requirements are empty the rawSelector will be parsed and limited if the parsing succeeds If rawSelector is empty and requirements are present the requirements should be honored If rawSelector is present and requirements are present the request is invalid resourceAttributes labelSelector rawSelector string rawSelector is the serialization of a field selector that would be included in a query parameter Webhook implementations are encouraged to ignore rawSelector The kube apiserver s SubjectAccessReview will parse the rawSelector as long as the requirements are not present resourceAttributes labelSelector requirements LabelSelectorRequirement Atomic will be replaced during a merge requirements is the parsed interpretation of a label selector All requirements must be met for a resource instance to match the selector Webhook implementations should handle requirements but how to handle them is up to the webhook Since requirements can only limit the request it is safe to authorize as unlimited request if the requirements are not understood a name LabelSelectorRequirement a A label selector requirement is a selector that contains values a key and an operator that relates the key and values resourceAttributes labelSelector requirements key string required key is the label key that the selector applies to resourceAttributes labelSelector requirements operator string required operator represents a key s relationship to a set of values Valid operators are In NotIn Exists and DoesNotExist resourceAttributes labelSelector requirements values string Atomic will be replaced during a merge values is an array of string values If the operator is In or NotIn the values array must be non empty If the operator is Exists or DoesNotExist the values array must be empty This array is replaced during a strategic merge patch resourceAttributes name string Name is the name of the resource being requested for a get or deleted for a delete empty means all resourceAttributes namespace string Namespace is the namespace of the action being requested Currently there is no distinction between no namespace and all namespaces empty is defaulted for LocalSubjectAccessReviews empty is empty for cluster scoped resources empty means all for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview resourceAttributes resource string Resource is one of the existing resource types means all resourceAttributes subresource string Subresource is one of the existing resource types means none resourceAttributes verb string Verb is a kubernetes resource API verb like get list watch create update delete proxy means all resourceAttributes version string Version is the API Version of the Resource means all Operations Operations hr create create a SelfSubjectAccessReview HTTP Request POST apis authorization k8s io v1 selfsubjectaccessreviews Parameters body a href SelfSubjectAccessReview a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href SelfSubjectAccessReview a OK 201 a href SelfSubjectAccessReview a Created 202 a href SelfSubjectAccessReview a Accepted 401 Unauthorized |
kubernetes reference kind SelfSubjectRulesReview import k8s io api authorization v1 SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace contenttype apireference apiVersion authorization k8s io v1 apimetadata weight 3 title SelfSubjectRulesReview autogenerated true | ---
api_metadata:
apiVersion: "authorization.k8s.io/v1"
import: "k8s.io/api/authorization/v1"
kind: "SelfSubjectRulesReview"
content_type: "api_reference"
description: "SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace."
title: "SelfSubjectRulesReview"
weight: 3
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.
-->
`apiVersion: authorization.k8s.io/v1`
`import "k8s.io/api/authorization/v1"`
## SelfSubjectRulesReview {#SelfSubjectRulesReview}
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
<hr>
- **apiVersion**: authorization.k8s.io/v1
- **kind**: SelfSubjectRulesReview
- **metadata** (<a href="">ObjectMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">SelfSubjectRulesReviewSpec</a>), required
Spec holds information about the request being evaluated.
- **status** (SubjectRulesReviewStatus)
Status is filled in by the server and indicates the set of actions a user can perform.
<a name="SubjectRulesReviewStatus"></a>
*SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.*
- **status.incomplete** (boolean), required
Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
- **status.nonResourceRules** ([]NonResourceRule), required
*Atomic: will be replaced during a merge*
NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
<a name="NonResourceRule"></a>
*NonResourceRule holds information that describes a rule for the non-resource*
- **status.nonResourceRules.verbs** ([]string), required
*Atomic: will be replaced during a merge*
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
- **status.nonResourceRules.nonResourceURLs** ([]string)
*Atomic: will be replaced during a merge*
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all.
- **status.resourceRules** ([]ResourceRule), required
*Atomic: will be replaced during a merge*
ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
<a name="ResourceRule"></a>
*ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.*
- **status.resourceRules.verbs** ([]string), required
*Atomic: will be replaced during a merge*
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
- **status.resourceRules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
- **status.resourceRules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
- **status.resourceRules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups.
"*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
- **status.evaluationError** (string)
EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
## SelfSubjectRulesReviewSpec {#SelfSubjectRulesReviewSpec}
SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview.
<hr>
- **namespace** (string)
Namespace to evaluate rules for. Required.
## Operations {#Operations}
<hr>
### `create` create a SelfSubjectRulesReview
#### HTTP Request
POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews
#### Parameters
- **body**: <a href="">SelfSubjectRulesReview</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">SelfSubjectRulesReview</a>): OK
201 (<a href="">SelfSubjectRulesReview</a>): Created
202 (<a href="">SelfSubjectRulesReview</a>): Accepted
401: Unauthorized
| kubernetes reference | api metadata apiVersion authorization k8s io v1 import k8s io api authorization v1 kind SelfSubjectRulesReview content type api reference description SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace title SelfSubjectRulesReview weight 3 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 apiVersion authorization k8s io v1 import k8s io api authorization v1 SelfSubjectRulesReview SelfSubjectRulesReview SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace The returned list of actions may be incomplete depending on the server s authorization mode and any errors experienced during the evaluation SelfSubjectRulesReview should be used by UIs to show hide actions or to quickly let an end user reason about their permissions It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy cache lifetime revocation and correctness concerns SubjectAccessReview and LocalAccessReview are the correct way to defer authorization decisions to the API server hr apiVersion authorization k8s io v1 kind SelfSubjectRulesReview metadata a href ObjectMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href SelfSubjectRulesReviewSpec a required Spec holds information about the request being evaluated status SubjectRulesReviewStatus Status is filled in by the server and indicates the set of actions a user can perform a name SubjectRulesReviewStatus a SubjectRulesReviewStatus contains the result of a rules check This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation Because authorization rules are additive if a rule appears in a list it s safe to assume the subject has that permission even if that list is incomplete status incomplete boolean required Incomplete is true when the rules returned by this call are incomplete This is most commonly encountered when an authorizer such as an external authorizer doesn t support rules evaluation status nonResourceRules NonResourceRule required Atomic will be replaced during a merge NonResourceRules is the list of actions the subject is allowed to perform on non resources The list ordering isn t significant may contain duplicates and possibly be incomplete a name NonResourceRule a NonResourceRule holds information that describes a rule for the non resource status nonResourceRules verbs string required Atomic will be replaced during a merge Verb is a list of kubernetes non resource API verbs like get post put delete patch head options means all status nonResourceRules nonResourceURLs string Atomic will be replaced during a merge NonResourceURLs is a set of partial urls that a user should have access to s are allowed but only as the full final step in the path means all status resourceRules ResourceRule required Atomic will be replaced during a merge ResourceRules is the list of actions the subject is allowed to perform on resources The list ordering isn t significant may contain duplicates and possibly be incomplete a name ResourceRule a ResourceRule is the list of actions the subject is allowed to perform on resources The list ordering isn t significant may contain duplicates and possibly be incomplete status resourceRules verbs string required Atomic will be replaced during a merge Verb is a list of kubernetes resource API verbs like get list watch create update delete proxy means all status resourceRules apiGroups string Atomic will be replaced during a merge APIGroups is the name of the APIGroup that contains the resources If multiple API groups are specified any action requested against one of the enumerated resources in any API group will be allowed means all status resourceRules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed means all status resourceRules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to means all in the specified apiGroups foo represents the subresource foo for all resources in the specified apiGroups status evaluationError string EvaluationError can appear in combination with Rules It indicates an error occurred during rule evaluation such as an authorizer that doesn t support rule evaluation and that ResourceRules and or NonResourceRules may be incomplete SelfSubjectRulesReviewSpec SelfSubjectRulesReviewSpec SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview hr namespace string Namespace to evaluate rules for Required Operations Operations hr create create a SelfSubjectRulesReview HTTP Request POST apis authorization k8s io v1 selfsubjectrulesreviews Parameters body a href SelfSubjectRulesReview a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href SelfSubjectRulesReview a OK 201 a href SelfSubjectRulesReview a Created 202 a href SelfSubjectRulesReview a Accepted 401 Unauthorized |
kubernetes reference kind LocalSubjectAccessReview LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace title LocalSubjectAccessReview import k8s io api authorization v1 contenttype apireference apiVersion authorization k8s io v1 apimetadata autogenerated true weight 1 | ---
api_metadata:
apiVersion: "authorization.k8s.io/v1"
import: "k8s.io/api/authorization/v1"
kind: "LocalSubjectAccessReview"
content_type: "api_reference"
description: "LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace."
title: "LocalSubjectAccessReview"
weight: 1
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.
-->
`apiVersion: authorization.k8s.io/v1`
`import "k8s.io/api/authorization/v1"`
## LocalSubjectAccessReview {#LocalSubjectAccessReview}
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
<hr>
- **apiVersion**: authorization.k8s.io/v1
- **kind**: LocalSubjectAccessReview
- **metadata** (<a href="">ObjectMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">SubjectAccessReviewSpec</a>), required
Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
- **status** (<a href="">SubjectAccessReviewStatus</a>)
Status is filled in by the server and indicates whether the request is allowed or not
## Operations {#Operations}
<hr>
### `create` create a LocalSubjectAccessReview
#### HTTP Request
POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">LocalSubjectAccessReview</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">LocalSubjectAccessReview</a>): OK
201 (<a href="">LocalSubjectAccessReview</a>): Created
202 (<a href="">LocalSubjectAccessReview</a>): Accepted
401: Unauthorized
| kubernetes reference | api metadata apiVersion authorization k8s io v1 import k8s io api authorization v1 kind LocalSubjectAccessReview content type api reference description LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace title LocalSubjectAccessReview weight 1 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 apiVersion authorization k8s io v1 import k8s io api authorization v1 LocalSubjectAccessReview LocalSubjectAccessReview LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking hr apiVersion authorization k8s io v1 kind LocalSubjectAccessReview metadata a href ObjectMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href SubjectAccessReviewSpec a required Spec holds information about the request being evaluated spec namespace must be equal to the namespace you made the request against If empty it is defaulted status a href SubjectAccessReviewStatus a Status is filled in by the server and indicates whether the request is allowed or not Operations Operations hr create create a LocalSubjectAccessReview HTTP Request POST apis authorization k8s io v1 namespaces namespace localsubjectaccessreviews Parameters namespace in path string required a href namespace a body a href LocalSubjectAccessReview a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href LocalSubjectAccessReview a OK 201 a href LocalSubjectAccessReview a Created 202 a href LocalSubjectAccessReview a Accepted 401 Unauthorized |
kubernetes reference import k8s io api rbac v1 apiVersion rbac authorization k8s io v1 contenttype apireference title RoleBinding weight 8 apimetadata autogenerated true kind RoleBinding RoleBinding references a role but does not contain it | ---
api_metadata:
apiVersion: "rbac.authorization.k8s.io/v1"
import: "k8s.io/api/rbac/v1"
kind: "RoleBinding"
content_type: "api_reference"
description: "RoleBinding references a role, but does not contain it."
title: "RoleBinding"
weight: 8
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.
-->
`apiVersion: rbac.authorization.k8s.io/v1`
`import "k8s.io/api/rbac/v1"`
## RoleBinding {#RoleBinding}
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
<hr>
- **apiVersion**: rbac.authorization.k8s.io/v1
- **kind**: RoleBinding
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata.
- **roleRef** (RoleRef), required
RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable.
<a name="RoleRef"></a>
*RoleRef contains information that points to the role being used*
- **roleRef.apiGroup** (string), required
APIGroup is the group for the resource being referenced
- **roleRef.kind** (string), required
Kind is the type of resource being referenced
- **roleRef.name** (string), required
Name is the name of resource being referenced
- **subjects** ([]Subject)
*Atomic: will be replaced during a merge*
Subjects holds references to the objects the role applies to.
<a name="Subject"></a>
*Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.*
- **subjects.kind** (string), required
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
- **subjects.name** (string), required
Name of the object being referenced.
- **subjects.apiGroup** (string)
APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
- **subjects.namespace** (string)
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
## RoleBindingList {#RoleBindingList}
RoleBindingList is a collection of RoleBindings
<hr>
- **apiVersion**: rbac.authorization.k8s.io/v1
- **kind**: RoleBindingList
- **metadata** (<a href="">ListMeta</a>)
Standard object's metadata.
- **items** ([]<a href="">RoleBinding</a>), required
Items is a list of RoleBindings
## Operations {#Operations}
<hr>
### `get` read the specified RoleBinding
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the RoleBinding
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">RoleBinding</a>): OK
401: Unauthorized
### `list` list or watch objects of kind RoleBinding
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">RoleBindingList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind RoleBinding
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/rolebindings
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">RoleBindingList</a>): OK
401: Unauthorized
### `create` create a RoleBinding
#### HTTP Request
POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">RoleBinding</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">RoleBinding</a>): OK
201 (<a href="">RoleBinding</a>): Created
202 (<a href="">RoleBinding</a>): Accepted
401: Unauthorized
### `update` replace the specified RoleBinding
#### HTTP Request
PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the RoleBinding
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">RoleBinding</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">RoleBinding</a>): OK
201 (<a href="">RoleBinding</a>): Created
401: Unauthorized
### `patch` partially update the specified RoleBinding
#### HTTP Request
PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the RoleBinding
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">RoleBinding</a>): OK
201 (<a href="">RoleBinding</a>): Created
401: Unauthorized
### `delete` delete a RoleBinding
#### HTTP Request
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the RoleBinding
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of RoleBinding
#### HTTP Request
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion rbac authorization k8s io v1 import k8s io api rbac v1 kind RoleBinding content type api reference description RoleBinding references a role but does not contain it title RoleBinding weight 8 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 apiVersion rbac authorization k8s io v1 import k8s io api rbac v1 RoleBinding RoleBinding RoleBinding references a role but does not contain it It can reference a Role in the same namespace or a ClusterRole in the global namespace It adds who information via Subjects and namespace information by which namespace it exists in RoleBindings in a given namespace only have effect in that namespace hr apiVersion rbac authorization k8s io v1 kind RoleBinding metadata a href ObjectMeta a Standard object s metadata roleRef RoleRef required RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace If the RoleRef cannot be resolved the Authorizer must return an error This field is immutable a name RoleRef a RoleRef contains information that points to the role being used roleRef apiGroup string required APIGroup is the group for the resource being referenced roleRef kind string required Kind is the type of resource being referenced roleRef name string required Name is the name of resource being referenced subjects Subject Atomic will be replaced during a merge Subjects holds references to the objects the role applies to a name Subject a Subject contains a reference to the object or user identities a role binding applies to This can either hold a direct API object reference or a value for non objects such as user and group names subjects kind string required Kind of object being referenced Values defined by this API group are User Group and ServiceAccount If the Authorizer does not recognized the kind value the Authorizer should report an error subjects name string required Name of the object being referenced subjects apiGroup string APIGroup holds the API group of the referenced subject Defaults to for ServiceAccount subjects Defaults to rbac authorization k8s io for User and Group subjects subjects namespace string Namespace of the referenced object If the object kind is non namespace such as User or Group and this value is not empty the Authorizer should report an error RoleBindingList RoleBindingList RoleBindingList is a collection of RoleBindings hr apiVersion rbac authorization k8s io v1 kind RoleBindingList metadata a href ListMeta a Standard object s metadata items a href RoleBinding a required Items is a list of RoleBindings Operations Operations hr get read the specified RoleBinding HTTP Request GET apis rbac authorization k8s io v1 namespaces namespace rolebindings name Parameters name in path string required name of the RoleBinding namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href RoleBinding a OK 401 Unauthorized list list or watch objects of kind RoleBinding HTTP Request GET apis rbac authorization k8s io v1 namespaces namespace rolebindings Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href RoleBindingList a OK 401 Unauthorized list list or watch objects of kind RoleBinding HTTP Request GET apis rbac authorization k8s io v1 rolebindings Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href RoleBindingList a OK 401 Unauthorized create create a RoleBinding HTTP Request POST apis rbac authorization k8s io v1 namespaces namespace rolebindings Parameters namespace in path string required a href namespace a body a href RoleBinding a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href RoleBinding a OK 201 a href RoleBinding a Created 202 a href RoleBinding a Accepted 401 Unauthorized update replace the specified RoleBinding HTTP Request PUT apis rbac authorization k8s io v1 namespaces namespace rolebindings name Parameters name in path string required name of the RoleBinding namespace in path string required a href namespace a body a href RoleBinding a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href RoleBinding a OK 201 a href RoleBinding a Created 401 Unauthorized patch partially update the specified RoleBinding HTTP Request PATCH apis rbac authorization k8s io v1 namespaces namespace rolebindings name Parameters name in path string required name of the RoleBinding namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href RoleBinding a OK 201 a href RoleBinding a Created 401 Unauthorized delete delete a RoleBinding HTTP Request DELETE apis rbac authorization k8s io v1 namespaces namespace rolebindings name Parameters name in path string required name of the RoleBinding namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of RoleBinding HTTP Request DELETE apis rbac authorization k8s io v1 namespaces namespace rolebindings Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference weight 7 title Role import k8s io api rbac v1 apiVersion rbac authorization k8s io v1 contenttype apireference Role is a namespaced logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding apimetadata autogenerated true kind Role | ---
api_metadata:
apiVersion: "rbac.authorization.k8s.io/v1"
import: "k8s.io/api/rbac/v1"
kind: "Role"
content_type: "api_reference"
description: "Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding."
title: "Role"
weight: 7
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.
-->
`apiVersion: rbac.authorization.k8s.io/v1`
`import "k8s.io/api/rbac/v1"`
## Role {#Role}
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
<hr>
- **apiVersion**: rbac.authorization.k8s.io/v1
- **kind**: Role
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata.
- **rules** ([]PolicyRule)
*Atomic: will be replaced during a merge*
Rules holds all the PolicyRules for this Role
<a name="PolicyRule"></a>
*PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.*
- **rules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
- **rules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to. '*' represents all resources.
- **rules.verbs** ([]string), required
*Atomic: will be replaced during a merge*
Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.
- **rules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **rules.nonResourceURLs** ([]string)
*Atomic: will be replaced during a merge*
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
## RoleList {#RoleList}
RoleList is a collection of Roles
<hr>
- **apiVersion**: rbac.authorization.k8s.io/v1
- **kind**: RoleList
- **metadata** (<a href="">ListMeta</a>)
Standard object's metadata.
- **items** ([]<a href="">Role</a>), required
Items is a list of Roles
## Operations {#Operations}
<hr>
### `get` read the specified Role
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Role
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Role</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Role
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">RoleList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Role
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/roles
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">RoleList</a>): OK
401: Unauthorized
### `create` create a Role
#### HTTP Request
POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Role</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Role</a>): OK
201 (<a href="">Role</a>): Created
202 (<a href="">Role</a>): Accepted
401: Unauthorized
### `update` replace the specified Role
#### HTTP Request
PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Role
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Role</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Role</a>): OK
201 (<a href="">Role</a>): Created
401: Unauthorized
### `patch` partially update the specified Role
#### HTTP Request
PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Role
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Role</a>): OK
201 (<a href="">Role</a>): Created
401: Unauthorized
### `delete` delete a Role
#### HTTP Request
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Role
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Role
#### HTTP Request
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion rbac authorization k8s io v1 import k8s io api rbac v1 kind Role content type api reference description Role is a namespaced logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding title Role weight 7 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 apiVersion rbac authorization k8s io v1 import k8s io api rbac v1 Role Role Role is a namespaced logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding hr apiVersion rbac authorization k8s io v1 kind Role metadata a href ObjectMeta a Standard object s metadata rules PolicyRule Atomic will be replaced during a merge Rules holds all the PolicyRules for this Role a name PolicyRule a PolicyRule holds information that describes a policy rule but does not contain information about who the rule applies to or which namespace the rule applies to rules apiGroups string Atomic will be replaced during a merge APIGroups is the name of the APIGroup that contains the resources If multiple API groups are specified any action requested against one of the enumerated resources in any API group will be allowed represents the core API group and represents all API groups rules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to represents all resources rules verbs string required Atomic will be replaced during a merge Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule represents all verbs rules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed rules nonResourceURLs string Atomic will be replaced during a merge NonResourceURLs is a set of partial urls that a user should have access to s are allowed but only as the full final step in the path Since non resource URLs are not namespaced this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding Rules can either apply to API resources such as pods or secrets or non resource URL paths such as api but not both RoleList RoleList RoleList is a collection of Roles hr apiVersion rbac authorization k8s io v1 kind RoleList metadata a href ListMeta a Standard object s metadata items a href Role a required Items is a list of Roles Operations Operations hr get read the specified Role HTTP Request GET apis rbac authorization k8s io v1 namespaces namespace roles name Parameters name in path string required name of the Role namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Role a OK 401 Unauthorized list list or watch objects of kind Role HTTP Request GET apis rbac authorization k8s io v1 namespaces namespace roles Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href RoleList a OK 401 Unauthorized list list or watch objects of kind Role HTTP Request GET apis rbac authorization k8s io v1 roles Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href RoleList a OK 401 Unauthorized create create a Role HTTP Request POST apis rbac authorization k8s io v1 namespaces namespace roles Parameters namespace in path string required a href namespace a body a href Role a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Role a OK 201 a href Role a Created 202 a href Role a Accepted 401 Unauthorized update replace the specified Role HTTP Request PUT apis rbac authorization k8s io v1 namespaces namespace roles name Parameters name in path string required name of the Role namespace in path string required a href namespace a body a href Role a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Role a OK 201 a href Role a Created 401 Unauthorized patch partially update the specified Role HTTP Request PATCH apis rbac authorization k8s io v1 namespaces namespace roles name Parameters name in path string required name of the Role namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Role a OK 201 a href Role a Created 401 Unauthorized delete delete a Role HTTP Request DELETE apis rbac authorization k8s io v1 namespaces namespace roles name Parameters name in path string required name of the Role namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of Role HTTP Request DELETE apis rbac authorization k8s io v1 namespaces namespace roles Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind ClusterRole weight 5 title ClusterRole import k8s io api rbac v1 apiVersion rbac authorization k8s io v1 contenttype apireference apimetadata autogenerated true ClusterRole is a cluster level logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding | ---
api_metadata:
apiVersion: "rbac.authorization.k8s.io/v1"
import: "k8s.io/api/rbac/v1"
kind: "ClusterRole"
content_type: "api_reference"
description: "ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding."
title: "ClusterRole"
weight: 5
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.
-->
`apiVersion: rbac.authorization.k8s.io/v1`
`import "k8s.io/api/rbac/v1"`
## ClusterRole {#ClusterRole}
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
<hr>
- **apiVersion**: rbac.authorization.k8s.io/v1
- **kind**: ClusterRole
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata.
- **aggregationRule** (AggregationRule)
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
<a name="AggregationRule"></a>
*AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole*
- **aggregationRule.clusterRoleSelectors** ([]<a href="">LabelSelector</a>)
*Atomic: will be replaced during a merge*
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
- **rules** ([]PolicyRule)
*Atomic: will be replaced during a merge*
Rules holds all the PolicyRules for this ClusterRole
<a name="PolicyRule"></a>
*PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.*
- **rules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
- **rules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to. '*' represents all resources.
- **rules.verbs** ([]string), required
*Atomic: will be replaced during a merge*
Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.
- **rules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **rules.nonResourceURLs** ([]string)
*Atomic: will be replaced during a merge*
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
## ClusterRoleList {#ClusterRoleList}
ClusterRoleList is a collection of ClusterRoles
<hr>
- **apiVersion**: rbac.authorization.k8s.io/v1
- **kind**: ClusterRoleList
- **metadata** (<a href="">ListMeta</a>)
Standard object's metadata.
- **items** ([]<a href="">ClusterRole</a>), required
Items is a list of ClusterRoles
## Operations {#Operations}
<hr>
### `get` read the specified ClusterRole
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterRole
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterRole</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ClusterRole
#### HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/clusterroles
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ClusterRoleList</a>): OK
401: Unauthorized
### `create` create a ClusterRole
#### HTTP Request
POST /apis/rbac.authorization.k8s.io/v1/clusterroles
#### Parameters
- **body**: <a href="">ClusterRole</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterRole</a>): OK
201 (<a href="">ClusterRole</a>): Created
202 (<a href="">ClusterRole</a>): Accepted
401: Unauthorized
### `update` replace the specified ClusterRole
#### HTTP Request
PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterRole
- **body**: <a href="">ClusterRole</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterRole</a>): OK
201 (<a href="">ClusterRole</a>): Created
401: Unauthorized
### `patch` partially update the specified ClusterRole
#### HTTP Request
PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterRole
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterRole</a>): OK
201 (<a href="">ClusterRole</a>): Created
401: Unauthorized
### `delete` delete a ClusterRole
#### HTTP Request
DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterRole
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ClusterRole
#### HTTP Request
DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion rbac authorization k8s io v1 import k8s io api rbac v1 kind ClusterRole content type api reference description ClusterRole is a cluster level logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding title ClusterRole weight 5 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 apiVersion rbac authorization k8s io v1 import k8s io api rbac v1 ClusterRole ClusterRole ClusterRole is a cluster level logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding hr apiVersion rbac authorization k8s io v1 kind ClusterRole metadata a href ObjectMeta a Standard object s metadata aggregationRule AggregationRule AggregationRule is an optional field that describes how to build the Rules for this ClusterRole If AggregationRule is set then the Rules are controller managed and direct changes to Rules will be stomped by the controller a name AggregationRule a AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole aggregationRule clusterRoleSelectors a href LabelSelector a Atomic will be replaced during a merge ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules If any of the selectors match then the ClusterRole s permissions will be added rules PolicyRule Atomic will be replaced during a merge Rules holds all the PolicyRules for this ClusterRole a name PolicyRule a PolicyRule holds information that describes a policy rule but does not contain information about who the rule applies to or which namespace the rule applies to rules apiGroups string Atomic will be replaced during a merge APIGroups is the name of the APIGroup that contains the resources If multiple API groups are specified any action requested against one of the enumerated resources in any API group will be allowed represents the core API group and represents all API groups rules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to represents all resources rules verbs string required Atomic will be replaced during a merge Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule represents all verbs rules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed rules nonResourceURLs string Atomic will be replaced during a merge NonResourceURLs is a set of partial urls that a user should have access to s are allowed but only as the full final step in the path Since non resource URLs are not namespaced this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding Rules can either apply to API resources such as pods or secrets or non resource URL paths such as api but not both ClusterRoleList ClusterRoleList ClusterRoleList is a collection of ClusterRoles hr apiVersion rbac authorization k8s io v1 kind ClusterRoleList metadata a href ListMeta a Standard object s metadata items a href ClusterRole a required Items is a list of ClusterRoles Operations Operations hr get read the specified ClusterRole HTTP Request GET apis rbac authorization k8s io v1 clusterroles name Parameters name in path string required name of the ClusterRole pretty in query string a href pretty a Response 200 a href ClusterRole a OK 401 Unauthorized list list or watch objects of kind ClusterRole HTTP Request GET apis rbac authorization k8s io v1 clusterroles Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ClusterRoleList a OK 401 Unauthorized create create a ClusterRole HTTP Request POST apis rbac authorization k8s io v1 clusterroles Parameters body a href ClusterRole a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ClusterRole a OK 201 a href ClusterRole a Created 202 a href ClusterRole a Accepted 401 Unauthorized update replace the specified ClusterRole HTTP Request PUT apis rbac authorization k8s io v1 clusterroles name Parameters name in path string required name of the ClusterRole body a href ClusterRole a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ClusterRole a OK 201 a href ClusterRole a Created 401 Unauthorized patch partially update the specified ClusterRole HTTP Request PATCH apis rbac authorization k8s io v1 clusterroles name Parameters name in path string required name of the ClusterRole body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ClusterRole a OK 201 a href ClusterRole a Created 401 Unauthorized delete delete a ClusterRole HTTP Request DELETE apis rbac authorization k8s io v1 clusterroles name Parameters name in path string required name of the ClusterRole body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ClusterRole HTTP Request DELETE apis rbac authorization k8s io v1 clusterroles Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title ResourceClaim v1alpha3 weight 16 kind ResourceClaim contenttype apireference apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 apimetadata autogenerated true ResourceClaim describes a request for access to resources in the cluster for use by workloads | ---
api_metadata:
apiVersion: "resource.k8s.io/v1alpha3"
import: "k8s.io/api/resource/v1alpha3"
kind: "ResourceClaim"
content_type: "api_reference"
description: "ResourceClaim describes a request for access to resources in the cluster, for use by workloads."
title: "ResourceClaim v1alpha3"
weight: 16
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.
-->
`apiVersion: resource.k8s.io/v1alpha3`
`import "k8s.io/api/resource/v1alpha3"`
## ResourceClaim {#ResourceClaim}
ResourceClaim describes a request for access to resources in the cluster, for use by workloads. For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: ResourceClaim
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata
- **spec** (<a href="">ResourceClaimSpec</a>), required
Spec describes what is being requested and how to configure it. The spec is immutable.
- **status** (<a href="">ResourceClaimStatus</a>)
Status describes whether the claim is ready to use and what has been allocated.
## ResourceClaimSpec {#ResourceClaimSpec}
ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it.
<hr>
- **controller** (string)
Controller is the name of the DRA driver that is meant to handle allocation of this claim. If empty, allocation is handled by the scheduler while scheduling a pod.
Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.
This is an alpha field and requires enabling the DRAControlPlaneController feature gate.
- **devices** (DeviceClaim)
Devices defines how to request devices.
<a name="DeviceClaim"></a>
*DeviceClaim defines how to request devices with a ResourceClaim.*
- **devices.config** ([]DeviceClaimConfiguration)
*Atomic: will be replaced during a merge*
This field holds configuration for multiple potential drivers which could satisfy requests in this claim. It is ignored while allocating the claim.
<a name="DeviceClaimConfiguration"></a>
*DeviceClaimConfiguration is used for configuration parameters in DeviceClaim.*
- **devices.config.opaque** (OpaqueDeviceConfiguration)
Opaque provides driver-specific configuration parameters.
<a name="OpaqueDeviceConfiguration"></a>
*OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.*
- **devices.config.opaque.driver** (string), required
Driver is used to determine which kubelet plugin needs to be passed these configuration parameters.
An admission policy provided by the driver developer could use this to decide whether it needs to validate them.
Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.
- **devices.config.opaque.parameters** (RawExtension), required
Parameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" + "apiVersion" for Kubernetes types), with conversion between different versions.
<a name="RawExtension"></a>
*RawExtension is used to hold extensions in external versions.
To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.
// Internal package:
type MyAPIObject struct {
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.Object `json:"myPlugin"`
}
type PluginA struct {
AOption string `json:"aOption"`
}
// External package:
type MyAPIObject struct {
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.RawExtension `json:"myPlugin"`
}
type PluginA struct {
AOption string `json:"aOption"`
}
// On the wire, the JSON will look something like this:
{
"kind":"MyAPIObject",
"apiVersion":"v1",
"myPlugin": {
"kind":"PluginA",
"aOption":"foo",
},
}
So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)*
- **devices.config.requests** ([]string)
*Atomic: will be replaced during a merge*
Requests lists the names of requests where the configuration applies. If empty, it applies to all requests.
- **devices.constraints** ([]DeviceConstraint)
*Atomic: will be replaced during a merge*
These constraints must be satisfied by the set of devices that get allocated for the claim.
<a name="DeviceConstraint"></a>
*DeviceConstraint must have exactly one field set besides Requests.*
- **devices.constraints.matchAttribute** (string)
MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices.
For example, if you specified "dra.example.com/numa" (a hypothetical example!), then only devices in the same NUMA node will be chosen. A device which does not have that attribute will not be chosen. All devices should use a value of the same type for this attribute because that is part of its specification, but if one device doesn't, then it also will not be chosen.
Must include the domain qualifier.
- **devices.constraints.requests** ([]string)
*Atomic: will be replaced during a merge*
Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint. If this is not specified, this constraint applies to all requests in this claim.
- **devices.requests** ([]DeviceRequest)
*Atomic: will be replaced during a merge*
Requests represent individual requests for distinct devices which must all be satisfied. If empty, nothing needs to be allocated.
<a name="DeviceRequest"></a>
*DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices.
A DeviceClassName is currently required. Clients must check that it is indeed set. It's absence indicates that something changed in a way that is not supported by the client yet, in which case it must refuse to handle the request.*
- **devices.requests.deviceClassName** (string), required
DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.
A class is required. Which classes are available depends on the cluster.
Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.
- **devices.requests.name** (string), required
Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim.
Must be a DNS label.
- **devices.requests.adminAccess** (boolean)
AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They ignore all ordinary claims to the device with respect to access modes and any resource allocations.
- **devices.requests.allocationMode** (string)
AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:
- ExactCount: This request is for a specific number of devices.
This is the default. The exact number is provided in the
count field.
- All: This request is for all of the matching devices in a pool.
Allocation will fail if some devices are already allocated,
unless adminAccess is requested.
If AlloctionMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field.
More modes may get added in the future. Clients must refuse to handle requests with unknown modes.
- **devices.requests.count** (int64)
Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
- **devices.requests.selectors** ([]DeviceSelector)
*Atomic: will be replaced during a merge*
Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
<a name="DeviceSelector"></a>
*DeviceSelector must have exactly one field set.*
- **devices.requests.selectors.cel** (CELDeviceSelector)
CEL contains a CEL expression for selecting a device.
<a name="CELDeviceSelector"></a>
*CELDeviceSelector contains a CEL expression for selecting a device.*
- **devices.requests.selectors.cel.expression** (string), required
Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other result is an error and causes allocation of devices to abort.
The expression's input is an object named "device", which carries the following properties:
- driver (string): the name of the driver which defines this device.
- attributes (map[string]object): the device's attributes, grouped by prefix
(e.g. device.attributes["dra.example.com"] evaluates to an object with all
of the attributes which were prefixed by "dra.example.com".
- capacity (map[string]object): the device's capacities, grouped by prefix.
Example: Consider a device with driver="dra.example.com", which exposes two attributes named "model" and "ext.example.com/family" and which exposes one capacity named "modules". This input to this expression would have the following fields:
device.driver
device.attributes["dra.example.com"].model
device.attributes["ext.example.com"].family
device.capacity["dra.example.com"].modules
The device.driver field can be used to check for a specific driver, either as a high-level precondition (i.e. you only want to consider devices from this driver) or as part of a multi-clause expression that is meant to consider devices from different drivers.
The value type of each attribute is defined by the device definition, and users who write these expressions must consult the documentation for their specific drivers. The value type of each capacity is Quantity.
If an unknown prefix is used as a lookup in either device.attributes or device.capacity, an empty map will be returned. Any reference to an unknown field will cause an evaluation error and allocation to abort.
A robust expression should check for the existence of attributes before referencing them.
For ease of use, the cel.bind() function is enabled, and can be used to simplify expressions that access multiple attributes with the same domain. For example:
cel.bind(dra, device.attributes["dra.example.com"], dra.someBool && dra.anotherBool)
## ResourceClaimStatus {#ResourceClaimStatus}
ResourceClaimStatus tracks whether the resource has been allocated and what the result of that was.
<hr>
- **allocation** (AllocationResult)
Allocation is set once the claim has been allocated successfully.
<a name="AllocationResult"></a>
*AllocationResult contains attributes of an allocated resource.*
- **allocation.controller** (string)
Controller is the name of the DRA driver which handled the allocation. That driver is also responsible for deallocating the claim. It is empty when the claim can be deallocated without involving a driver.
A driver may allocate devices provided by other drivers, so this driver name here can be different from the driver names listed for the results.
This is an alpha field and requires enabling the DRAControlPlaneController feature gate.
- **allocation.devices** (DeviceAllocationResult)
Devices is the result of allocating devices.
<a name="DeviceAllocationResult"></a>
*DeviceAllocationResult is the result of allocating devices.*
- **allocation.devices.config** ([]DeviceAllocationConfiguration)
*Atomic: will be replaced during a merge*
This field is a combination of all the claim and class configuration parameters. Drivers can distinguish between those based on a flag.
This includes configuration parameters for drivers which have no allocated devices in the result because it is up to the drivers which configuration parameters they support. They can silently ignore unknown configuration parameters.
<a name="DeviceAllocationConfiguration"></a>
*DeviceAllocationConfiguration gets embedded in an AllocationResult.*
- **allocation.devices.config.source** (string), required
Source records whether the configuration comes from a class and thus is not something that a normal user would have been able to set or from a claim.
- **allocation.devices.config.opaque** (OpaqueDeviceConfiguration)
Opaque provides driver-specific configuration parameters.
<a name="OpaqueDeviceConfiguration"></a>
*OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.*
- **allocation.devices.config.opaque.driver** (string), required
Driver is used to determine which kubelet plugin needs to be passed these configuration parameters.
An admission policy provided by the driver developer could use this to decide whether it needs to validate them.
Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.
- **allocation.devices.config.opaque.parameters** (RawExtension), required
Parameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" + "apiVersion" for Kubernetes types), with conversion between different versions.
<a name="RawExtension"></a>
*RawExtension is used to hold extensions in external versions.
To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.
// Internal package:
type MyAPIObject struct {
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.Object `json:"myPlugin"`
}
type PluginA struct {
AOption string `json:"aOption"`
}
// External package:
type MyAPIObject struct {
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.RawExtension `json:"myPlugin"`
}
type PluginA struct {
AOption string `json:"aOption"`
}
// On the wire, the JSON will look something like this:
{
"kind":"MyAPIObject",
"apiVersion":"v1",
"myPlugin": {
"kind":"PluginA",
"aOption":"foo",
},
}
So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)*
- **allocation.devices.config.requests** ([]string)
*Atomic: will be replaced during a merge*
Requests lists the names of requests where the configuration applies. If empty, its applies to all requests.
- **allocation.devices.results** ([]DeviceRequestAllocationResult)
*Atomic: will be replaced during a merge*
Results lists all allocated devices.
<a name="DeviceRequestAllocationResult"></a>
*DeviceRequestAllocationResult contains the allocation result for one request.*
- **allocation.devices.results.device** (string), required
Device references one device instance via its name in the driver's resource pool. It must be a DNS label.
- **allocation.devices.results.driver** (string), required
Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node.
Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.
- **allocation.devices.results.pool** (string), required
This name together with the driver name and the device name field identify which device was allocated (`\<driver name>/\<pool name>/\<device name>`).
Must not be longer than 253 characters and may contain one or more DNS sub-domains separated by slashes.
- **allocation.devices.results.request** (string), required
Request is the name of the request in the claim which caused this device to be allocated. Multiple devices may have been allocated per request.
- **allocation.nodeSelector** (NodeSelector)
NodeSelector defines where the allocated resources are available. If unset, they are available everywhere.
<a name="NodeSelector"></a>
*A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.*
- **allocation.nodeSelector.nodeSelectorTerms** ([]NodeSelectorTerm), required
*Atomic: will be replaced during a merge*
Required. A list of node selector terms. The terms are ORed.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **allocation.nodeSelector.nodeSelectorTerms.matchExpressions** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's labels.
- **allocation.nodeSelector.nodeSelectorTerms.matchFields** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's fields.
- **deallocationRequested** (boolean)
Indicates that a claim is to be deallocated. While this is set, no new consumers may be added to ReservedFor.
This is only used if the claim needs to be deallocated by a DRA driver. That driver then must deallocate this claim and reset the field together with clearing the Allocation field.
This is an alpha field and requires enabling the DRAControlPlaneController feature gate.
- **reservedFor** ([]ResourceClaimConsumerReference)
*Patch strategy: merge on key `uid`*
*Map: unique values on key uid will be kept during a merge*
ReservedFor indicates which entities are currently allowed to use the claim. A Pod which references a ResourceClaim which is not reserved for that Pod will not be started. A claim that is in use or might be in use because it has been reserved must not get deallocated.
In a cluster with multiple scheduler instances, two pods might get scheduled concurrently by different schedulers. When they reference the same ResourceClaim which already has reached its maximum number of consumers, only one pod can be scheduled.
Both schedulers try to add their pod to the claim.status.reservedFor field, but only the update that reaches the API server first gets stored. The other one fails with an error and the scheduler which issued it knows that it must put the pod back into the queue, waiting for the ResourceClaim to become usable again.
There can be at most 32 such reservations. This may get increased in the future, but not reduced.
<a name="ResourceClaimConsumerReference"></a>
*ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim. The user must be a resource in the same namespace as the ResourceClaim.*
- **reservedFor.name** (string), required
Name is the name of resource being referenced.
- **reservedFor.resource** (string), required
Resource is the type of resource being referenced, for example "pods".
- **reservedFor.uid** (string), required
UID identifies exactly one incarnation of the resource.
- **reservedFor.apiGroup** (string)
APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources.
## ResourceClaimList {#ResourceClaimList}
ResourceClaimList is a collection of claims.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: ResourceClaimList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata
- **items** ([]<a href="">ResourceClaim</a>), required
Items is the list of resource claims.
## Operations {#Operations}
<hr>
### `get` read the specified ResourceClaim
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaim</a>): OK
401: Unauthorized
### `get` read status of the specified ResourceClaim
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaim</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ResourceClaim
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ResourceClaimList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ResourceClaim
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/resourceclaims
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ResourceClaimList</a>): OK
401: Unauthorized
### `create` create a ResourceClaim
#### HTTP Request
POST /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ResourceClaim</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaim</a>): OK
201 (<a href="">ResourceClaim</a>): Created
202 (<a href="">ResourceClaim</a>): Accepted
401: Unauthorized
### `update` replace the specified ResourceClaim
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ResourceClaim</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaim</a>): OK
201 (<a href="">ResourceClaim</a>): Created
401: Unauthorized
### `update` replace status of the specified ResourceClaim
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ResourceClaim</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaim</a>): OK
201 (<a href="">ResourceClaim</a>): Created
401: Unauthorized
### `patch` partially update the specified ResourceClaim
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaim</a>): OK
201 (<a href="">ResourceClaim</a>): Created
401: Unauthorized
### `patch` partially update status of the specified ResourceClaim
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaim</a>): OK
201 (<a href="">ResourceClaim</a>): Created
401: Unauthorized
### `delete` delete a ResourceClaim
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">ResourceClaim</a>): OK
202 (<a href="">ResourceClaim</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ResourceClaim
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaims
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 kind ResourceClaim content type api reference description ResourceClaim describes a request for access to resources in the cluster for use by workloads title ResourceClaim v1alpha3 weight 16 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 apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 ResourceClaim ResourceClaim ResourceClaim describes a request for access to resources in the cluster for use by workloads For example if a workload needs an accelerator device with specific properties this is how that request is expressed The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated This is an alpha type and requires enabling the DynamicResourceAllocation feature gate hr apiVersion resource k8s io v1alpha3 kind ResourceClaim metadata a href ObjectMeta a Standard object metadata spec a href ResourceClaimSpec a required Spec describes what is being requested and how to configure it The spec is immutable status a href ResourceClaimStatus a Status describes whether the claim is ready to use and what has been allocated ResourceClaimSpec ResourceClaimSpec ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it hr controller string Controller is the name of the DRA driver that is meant to handle allocation of this claim If empty allocation is handled by the scheduler while scheduling a pod Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver This is an alpha field and requires enabling the DRAControlPlaneController feature gate devices DeviceClaim Devices defines how to request devices a name DeviceClaim a DeviceClaim defines how to request devices with a ResourceClaim devices config DeviceClaimConfiguration Atomic will be replaced during a merge This field holds configuration for multiple potential drivers which could satisfy requests in this claim It is ignored while allocating the claim a name DeviceClaimConfiguration a DeviceClaimConfiguration is used for configuration parameters in DeviceClaim devices config opaque OpaqueDeviceConfiguration Opaque provides driver specific configuration parameters a name OpaqueDeviceConfiguration a OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor devices config opaque driver string required Driver is used to determine which kubelet plugin needs to be passed these configuration parameters An admission policy provided by the driver developer could use this to decide whether it needs to validate them Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver devices config opaque parameters RawExtension required Parameters can contain arbitrary data It is the responsibility of the driver developer to handle validation and versioning Typically this includes self identification and a version kind apiVersion for Kubernetes types with conversion between different versions a name RawExtension a RawExtension is used to hold extensions in external versions To use this make a field which has RawExtension as its type in your external versioned struct and Object in your internal struct You also need to register your various plugin types Internal package type MyAPIObject struct runtime TypeMeta json inline MyPlugin runtime Object json myPlugin type PluginA struct AOption string json aOption External package type MyAPIObject struct runtime TypeMeta json inline MyPlugin runtime RawExtension json myPlugin type PluginA struct AOption string json aOption On the wire the JSON will look something like this kind MyAPIObject apiVersion v1 myPlugin kind PluginA aOption foo So what happens Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject That causes the raw JSON to be stored but not unpacked The next step is to copy using pkg conversion into the internal struct The runtime package s DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension turning it into the correct object type and storing it in the Object TODO In the case where the object is of an unknown type a runtime Unknown object will be created and stored devices config requests string Atomic will be replaced during a merge Requests lists the names of requests where the configuration applies If empty it applies to all requests devices constraints DeviceConstraint Atomic will be replaced during a merge These constraints must be satisfied by the set of devices that get allocated for the claim a name DeviceConstraint a DeviceConstraint must have exactly one field set besides Requests devices constraints matchAttribute string MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices For example if you specified dra example com numa a hypothetical example then only devices in the same NUMA node will be chosen A device which does not have that attribute will not be chosen All devices should use a value of the same type for this attribute because that is part of its specification but if one device doesn t then it also will not be chosen Must include the domain qualifier devices constraints requests string Atomic will be replaced during a merge Requests is a list of the one or more requests in this claim which must co satisfy this constraint If a request is fulfilled by multiple devices then all of the devices must satisfy the constraint If this is not specified this constraint applies to all requests in this claim devices requests DeviceRequest Atomic will be replaced during a merge Requests represent individual requests for distinct devices which must all be satisfied If empty nothing needs to be allocated a name DeviceRequest a DeviceRequest is a request for devices required for a claim This is typically a request for a single resource like a device but can also ask for several identical devices A DeviceClassName is currently required Clients must check that it is indeed set It s absence indicates that something changed in a way that is not supported by the client yet in which case it must refuse to handle the request devices requests deviceClassName string required DeviceClassName references a specific DeviceClass which can define additional configuration and selectors to be inherited by this request A class is required Which classes are available depends on the cluster Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices If users are free to request anything without restrictions then administrators can create an empty DeviceClass for users to reference devices requests name string required Name can be used to reference this request in a pod spec containers resources claims entry and in a constraint of the claim Must be a DNS label devices requests adminAccess boolean AdminAccess indicates that this is a claim for administrative access to the device s Claims with AdminAccess are expected to be used for monitoring or other management services for a device They ignore all ordinary claims to the device with respect to access modes and any resource allocations devices requests allocationMode string AllocationMode and its related fields define how devices are allocated to satisfy this request Supported values are ExactCount This request is for a specific number of devices This is the default The exact number is provided in the count field All This request is for all of the matching devices in a pool Allocation will fail if some devices are already allocated unless adminAccess is requested If AlloctionMode is not specified the default mode is ExactCount If the mode is ExactCount and count is not specified the default count is one Any other requests must specify this field More modes may get added in the future Clients must refuse to handle requests with unknown modes devices requests count int64 Count is used only when the count mode is ExactCount Must be greater than zero If AllocationMode is ExactCount and this field is not specified the default is one devices requests selectors DeviceSelector Atomic will be replaced during a merge Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request All selectors must be satisfied for a device to be considered a name DeviceSelector a DeviceSelector must have exactly one field set devices requests selectors cel CELDeviceSelector CEL contains a CEL expression for selecting a device a name CELDeviceSelector a CELDeviceSelector contains a CEL expression for selecting a device devices requests selectors cel expression string required Expression is a CEL expression which evaluates a single device It must evaluate to true when the device under consideration satisfies the desired criteria and false when it does not Any other result is an error and causes allocation of devices to abort The expression s input is an object named device which carries the following properties driver string the name of the driver which defines this device attributes map string object the device s attributes grouped by prefix e g device attributes dra example com evaluates to an object with all of the attributes which were prefixed by dra example com capacity map string object the device s capacities grouped by prefix Example Consider a device with driver dra example com which exposes two attributes named model and ext example com family and which exposes one capacity named modules This input to this expression would have the following fields device driver device attributes dra example com model device attributes ext example com family device capacity dra example com modules The device driver field can be used to check for a specific driver either as a high level precondition i e you only want to consider devices from this driver or as part of a multi clause expression that is meant to consider devices from different drivers The value type of each attribute is defined by the device definition and users who write these expressions must consult the documentation for their specific drivers The value type of each capacity is Quantity If an unknown prefix is used as a lookup in either device attributes or device capacity an empty map will be returned Any reference to an unknown field will cause an evaluation error and allocation to abort A robust expression should check for the existence of attributes before referencing them For ease of use the cel bind function is enabled and can be used to simplify expressions that access multiple attributes with the same domain For example cel bind dra device attributes dra example com dra someBool dra anotherBool ResourceClaimStatus ResourceClaimStatus ResourceClaimStatus tracks whether the resource has been allocated and what the result of that was hr allocation AllocationResult Allocation is set once the claim has been allocated successfully a name AllocationResult a AllocationResult contains attributes of an allocated resource allocation controller string Controller is the name of the DRA driver which handled the allocation That driver is also responsible for deallocating the claim It is empty when the claim can be deallocated without involving a driver A driver may allocate devices provided by other drivers so this driver name here can be different from the driver names listed for the results This is an alpha field and requires enabling the DRAControlPlaneController feature gate allocation devices DeviceAllocationResult Devices is the result of allocating devices a name DeviceAllocationResult a DeviceAllocationResult is the result of allocating devices allocation devices config DeviceAllocationConfiguration Atomic will be replaced during a merge This field is a combination of all the claim and class configuration parameters Drivers can distinguish between those based on a flag This includes configuration parameters for drivers which have no allocated devices in the result because it is up to the drivers which configuration parameters they support They can silently ignore unknown configuration parameters a name DeviceAllocationConfiguration a DeviceAllocationConfiguration gets embedded in an AllocationResult allocation devices config source string required Source records whether the configuration comes from a class and thus is not something that a normal user would have been able to set or from a claim allocation devices config opaque OpaqueDeviceConfiguration Opaque provides driver specific configuration parameters a name OpaqueDeviceConfiguration a OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor allocation devices config opaque driver string required Driver is used to determine which kubelet plugin needs to be passed these configuration parameters An admission policy provided by the driver developer could use this to decide whether it needs to validate them Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver allocation devices config opaque parameters RawExtension required Parameters can contain arbitrary data It is the responsibility of the driver developer to handle validation and versioning Typically this includes self identification and a version kind apiVersion for Kubernetes types with conversion between different versions a name RawExtension a RawExtension is used to hold extensions in external versions To use this make a field which has RawExtension as its type in your external versioned struct and Object in your internal struct You also need to register your various plugin types Internal package type MyAPIObject struct runtime TypeMeta json inline MyPlugin runtime Object json myPlugin type PluginA struct AOption string json aOption External package type MyAPIObject struct runtime TypeMeta json inline MyPlugin runtime RawExtension json myPlugin type PluginA struct AOption string json aOption On the wire the JSON will look something like this kind MyAPIObject apiVersion v1 myPlugin kind PluginA aOption foo So what happens Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject That causes the raw JSON to be stored but not unpacked The next step is to copy using pkg conversion into the internal struct The runtime package s DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension turning it into the correct object type and storing it in the Object TODO In the case where the object is of an unknown type a runtime Unknown object will be created and stored allocation devices config requests string Atomic will be replaced during a merge Requests lists the names of requests where the configuration applies If empty its applies to all requests allocation devices results DeviceRequestAllocationResult Atomic will be replaced during a merge Results lists all allocated devices a name DeviceRequestAllocationResult a DeviceRequestAllocationResult contains the allocation result for one request allocation devices results device string required Device references one device instance via its name in the driver s resource pool It must be a DNS label allocation devices results driver string required Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver allocation devices results pool string required This name together with the driver name and the device name field identify which device was allocated driver name pool name device name Must not be longer than 253 characters and may contain one or more DNS sub domains separated by slashes allocation devices results request string required Request is the name of the request in the claim which caused this device to be allocated Multiple devices may have been allocated per request allocation nodeSelector NodeSelector NodeSelector defines where the allocated resources are available If unset they are available everywhere a name NodeSelector a A node selector represents the union of the results of one or more label queries over a set of nodes that is it represents the OR of the selectors represented by the node selector terms allocation nodeSelector nodeSelectorTerms NodeSelectorTerm required Atomic will be replaced during a merge Required A list of node selector terms The terms are ORed a name NodeSelectorTerm a A null or empty node selector term matches no objects The requirements of them are ANDed The TopologySelectorTerm type implements a subset of the NodeSelectorTerm allocation nodeSelector nodeSelectorTerms matchExpressions a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s labels allocation nodeSelector nodeSelectorTerms matchFields a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s fields deallocationRequested boolean Indicates that a claim is to be deallocated While this is set no new consumers may be added to ReservedFor This is only used if the claim needs to be deallocated by a DRA driver That driver then must deallocate this claim and reset the field together with clearing the Allocation field This is an alpha field and requires enabling the DRAControlPlaneController feature gate reservedFor ResourceClaimConsumerReference Patch strategy merge on key uid Map unique values on key uid will be kept during a merge ReservedFor indicates which entities are currently allowed to use the claim A Pod which references a ResourceClaim which is not reserved for that Pod will not be started A claim that is in use or might be in use because it has been reserved must not get deallocated In a cluster with multiple scheduler instances two pods might get scheduled concurrently by different schedulers When they reference the same ResourceClaim which already has reached its maximum number of consumers only one pod can be scheduled Both schedulers try to add their pod to the claim status reservedFor field but only the update that reaches the API server first gets stored The other one fails with an error and the scheduler which issued it knows that it must put the pod back into the queue waiting for the ResourceClaim to become usable again There can be at most 32 such reservations This may get increased in the future but not reduced a name ResourceClaimConsumerReference a ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim The user must be a resource in the same namespace as the ResourceClaim reservedFor name string required Name is the name of resource being referenced reservedFor resource string required Resource is the type of resource being referenced for example pods reservedFor uid string required UID identifies exactly one incarnation of the resource reservedFor apiGroup string APIGroup is the group for the resource being referenced It is empty for the core API This matches the group in the APIVersion that is used when creating the resources ResourceClaimList ResourceClaimList ResourceClaimList is a collection of claims hr apiVersion resource k8s io v1alpha3 kind ResourceClaimList metadata a href ListMeta a Standard list metadata items a href ResourceClaim a required Items is the list of resource claims Operations Operations hr get read the specified ResourceClaim HTTP Request GET apis resource k8s io v1alpha3 namespaces namespace resourceclaims name Parameters name in path string required name of the ResourceClaim namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ResourceClaim a OK 401 Unauthorized get read status of the specified ResourceClaim HTTP Request GET apis resource k8s io v1alpha3 namespaces namespace resourceclaims name status Parameters name in path string required name of the ResourceClaim namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ResourceClaim a OK 401 Unauthorized list list or watch objects of kind ResourceClaim HTTP Request GET apis resource k8s io v1alpha3 namespaces namespace resourceclaims Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ResourceClaimList a OK 401 Unauthorized list list or watch objects of kind ResourceClaim HTTP Request GET apis resource k8s io v1alpha3 resourceclaims Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ResourceClaimList a OK 401 Unauthorized create create a ResourceClaim HTTP Request POST apis resource k8s io v1alpha3 namespaces namespace resourceclaims Parameters namespace in path string required a href namespace a body a href ResourceClaim a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceClaim a OK 201 a href ResourceClaim a Created 202 a href ResourceClaim a Accepted 401 Unauthorized update replace the specified ResourceClaim HTTP Request PUT apis resource k8s io v1alpha3 namespaces namespace resourceclaims name Parameters name in path string required name of the ResourceClaim namespace in path string required a href namespace a body a href ResourceClaim a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceClaim a OK 201 a href ResourceClaim a Created 401 Unauthorized update replace status of the specified ResourceClaim HTTP Request PUT apis resource k8s io v1alpha3 namespaces namespace resourceclaims name status Parameters name in path string required name of the ResourceClaim namespace in path string required a href namespace a body a href ResourceClaim a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceClaim a OK 201 a href ResourceClaim a Created 401 Unauthorized patch partially update the specified ResourceClaim HTTP Request PATCH apis resource k8s io v1alpha3 namespaces namespace resourceclaims name Parameters name in path string required name of the ResourceClaim namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ResourceClaim a OK 201 a href ResourceClaim a Created 401 Unauthorized patch partially update status of the specified ResourceClaim HTTP Request PATCH apis resource k8s io v1alpha3 namespaces namespace resourceclaims name status Parameters name in path string required name of the ResourceClaim namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ResourceClaim a OK 201 a href ResourceClaim a Created 401 Unauthorized delete delete a ResourceClaim HTTP Request DELETE apis resource k8s io v1alpha3 namespaces namespace resourceclaims name Parameters name in path string required name of the ResourceClaim namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href ResourceClaim a OK 202 a href ResourceClaim a Accepted 401 Unauthorized deletecollection delete collection of ResourceClaim HTTP Request DELETE apis resource k8s io v1alpha3 namespaces namespace resourceclaims Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference autogenerated true contenttype apireference apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 apimetadata weight 15 kind PodSchedulingContext PodSchedulingContext objects hold information that is needed to schedule a Pod with ResourceClaims that use WaitForFirstConsumer allocation mode title PodSchedulingContext v1alpha3 | ---
api_metadata:
apiVersion: "resource.k8s.io/v1alpha3"
import: "k8s.io/api/resource/v1alpha3"
kind: "PodSchedulingContext"
content_type: "api_reference"
description: "PodSchedulingContext objects hold information that is needed to schedule a Pod with ResourceClaims that use \"WaitForFirstConsumer\" allocation mode."
title: "PodSchedulingContext v1alpha3"
weight: 15
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.
-->
`apiVersion: resource.k8s.io/v1alpha3`
`import "k8s.io/api/resource/v1alpha3"`
## PodSchedulingContext {#PodSchedulingContext}
PodSchedulingContext objects hold information that is needed to schedule a Pod with ResourceClaims that use "WaitForFirstConsumer" allocation mode.
This is an alpha type and requires enabling the DRAControlPlaneController feature gate.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: PodSchedulingContext
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata
- **spec** (<a href="">PodSchedulingContextSpec</a>), required
Spec describes where resources for the Pod are needed.
- **status** (<a href="">PodSchedulingContextStatus</a>)
Status describes where resources for the Pod can be allocated.
## PodSchedulingContextSpec {#PodSchedulingContextSpec}
PodSchedulingContextSpec describes where resources for the Pod are needed.
<hr>
- **potentialNodes** ([]string)
*Atomic: will be replaced during a merge*
PotentialNodes lists nodes where the Pod might be able to run.
The size of this field is limited to 128. This is large enough for many clusters. Larger clusters may need more attempts to find a node that suits all pending resources. This may get increased in the future, but not reduced.
- **selectedNode** (string)
SelectedNode is the node for which allocation of ResourceClaims that are referenced by the Pod and that use "WaitForFirstConsumer" allocation is to be attempted.
## PodSchedulingContextStatus {#PodSchedulingContextStatus}
PodSchedulingContextStatus describes where resources for the Pod can be allocated.
<hr>
- **resourceClaims** ([]ResourceClaimSchedulingStatus)
*Map: unique values on key name will be kept during a merge*
ResourceClaims describes resource availability for each pod.spec.resourceClaim entry where the corresponding ResourceClaim uses "WaitForFirstConsumer" allocation mode.
<a name="ResourceClaimSchedulingStatus"></a>
*ResourceClaimSchedulingStatus contains information about one particular ResourceClaim with "WaitForFirstConsumer" allocation mode.*
- **resourceClaims.name** (string), required
Name matches the pod.spec.resourceClaims[*].Name field.
- **resourceClaims.unsuitableNodes** ([]string)
*Atomic: will be replaced during a merge*
UnsuitableNodes lists nodes that the ResourceClaim cannot be allocated for.
The size of this field is limited to 128, the same as for PodSchedulingSpec.PotentialNodes. This may get increased in the future, but not reduced.
## PodSchedulingContextList {#PodSchedulingContextList}
PodSchedulingContextList is a collection of Pod scheduling objects.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: PodSchedulingContextList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata
- **items** ([]<a href="">PodSchedulingContext</a>), required
Items is the list of PodSchedulingContext objects.
## Operations {#Operations}
<hr>
### `get` read the specified PodSchedulingContext
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodSchedulingContext</a>): OK
401: Unauthorized
### `get` read status of the specified PodSchedulingContext
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodSchedulingContext</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PodSchedulingContext
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PodSchedulingContextList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PodSchedulingContext
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/podschedulingcontexts
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PodSchedulingContextList</a>): OK
401: Unauthorized
### `create` create a PodSchedulingContext
#### HTTP Request
POST /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PodSchedulingContext</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodSchedulingContext</a>): OK
201 (<a href="">PodSchedulingContext</a>): Created
202 (<a href="">PodSchedulingContext</a>): Accepted
401: Unauthorized
### `update` replace the specified PodSchedulingContext
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PodSchedulingContext</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodSchedulingContext</a>): OK
201 (<a href="">PodSchedulingContext</a>): Created
401: Unauthorized
### `update` replace status of the specified PodSchedulingContext
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PodSchedulingContext</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodSchedulingContext</a>): OK
201 (<a href="">PodSchedulingContext</a>): Created
401: Unauthorized
### `patch` partially update the specified PodSchedulingContext
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodSchedulingContext</a>): OK
201 (<a href="">PodSchedulingContext</a>): Created
401: Unauthorized
### `patch` partially update status of the specified PodSchedulingContext
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodSchedulingContext</a>): OK
201 (<a href="">PodSchedulingContext</a>): Created
401: Unauthorized
### `delete` delete a PodSchedulingContext
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">PodSchedulingContext</a>): OK
202 (<a href="">PodSchedulingContext</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of PodSchedulingContext
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/podschedulingcontexts
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 kind PodSchedulingContext content type api reference description PodSchedulingContext objects hold information that is needed to schedule a Pod with ResourceClaims that use WaitForFirstConsumer allocation mode title PodSchedulingContext v1alpha3 weight 15 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 apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 PodSchedulingContext PodSchedulingContext PodSchedulingContext objects hold information that is needed to schedule a Pod with ResourceClaims that use WaitForFirstConsumer allocation mode This is an alpha type and requires enabling the DRAControlPlaneController feature gate hr apiVersion resource k8s io v1alpha3 kind PodSchedulingContext metadata a href ObjectMeta a Standard object metadata spec a href PodSchedulingContextSpec a required Spec describes where resources for the Pod are needed status a href PodSchedulingContextStatus a Status describes where resources for the Pod can be allocated PodSchedulingContextSpec PodSchedulingContextSpec PodSchedulingContextSpec describes where resources for the Pod are needed hr potentialNodes string Atomic will be replaced during a merge PotentialNodes lists nodes where the Pod might be able to run The size of this field is limited to 128 This is large enough for many clusters Larger clusters may need more attempts to find a node that suits all pending resources This may get increased in the future but not reduced selectedNode string SelectedNode is the node for which allocation of ResourceClaims that are referenced by the Pod and that use WaitForFirstConsumer allocation is to be attempted PodSchedulingContextStatus PodSchedulingContextStatus PodSchedulingContextStatus describes where resources for the Pod can be allocated hr resourceClaims ResourceClaimSchedulingStatus Map unique values on key name will be kept during a merge ResourceClaims describes resource availability for each pod spec resourceClaim entry where the corresponding ResourceClaim uses WaitForFirstConsumer allocation mode a name ResourceClaimSchedulingStatus a ResourceClaimSchedulingStatus contains information about one particular ResourceClaim with WaitForFirstConsumer allocation mode resourceClaims name string required Name matches the pod spec resourceClaims Name field resourceClaims unsuitableNodes string Atomic will be replaced during a merge UnsuitableNodes lists nodes that the ResourceClaim cannot be allocated for The size of this field is limited to 128 the same as for PodSchedulingSpec PotentialNodes This may get increased in the future but not reduced PodSchedulingContextList PodSchedulingContextList PodSchedulingContextList is a collection of Pod scheduling objects hr apiVersion resource k8s io v1alpha3 kind PodSchedulingContextList metadata a href ListMeta a Standard list metadata items a href PodSchedulingContext a required Items is the list of PodSchedulingContext objects Operations Operations hr get read the specified PodSchedulingContext HTTP Request GET apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts name Parameters name in path string required name of the PodSchedulingContext namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href PodSchedulingContext a OK 401 Unauthorized get read status of the specified PodSchedulingContext HTTP Request GET apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts name status Parameters name in path string required name of the PodSchedulingContext namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href PodSchedulingContext a OK 401 Unauthorized list list or watch objects of kind PodSchedulingContext HTTP Request GET apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PodSchedulingContextList a OK 401 Unauthorized list list or watch objects of kind PodSchedulingContext HTTP Request GET apis resource k8s io v1alpha3 podschedulingcontexts Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PodSchedulingContextList a OK 401 Unauthorized create create a PodSchedulingContext HTTP Request POST apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts Parameters namespace in path string required a href namespace a body a href PodSchedulingContext a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PodSchedulingContext a OK 201 a href PodSchedulingContext a Created 202 a href PodSchedulingContext a Accepted 401 Unauthorized update replace the specified PodSchedulingContext HTTP Request PUT apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts name Parameters name in path string required name of the PodSchedulingContext namespace in path string required a href namespace a body a href PodSchedulingContext a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PodSchedulingContext a OK 201 a href PodSchedulingContext a Created 401 Unauthorized update replace status of the specified PodSchedulingContext HTTP Request PUT apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts name status Parameters name in path string required name of the PodSchedulingContext namespace in path string required a href namespace a body a href PodSchedulingContext a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PodSchedulingContext a OK 201 a href PodSchedulingContext a Created 401 Unauthorized patch partially update the specified PodSchedulingContext HTTP Request PATCH apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts name Parameters name in path string required name of the PodSchedulingContext namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PodSchedulingContext a OK 201 a href PodSchedulingContext a Created 401 Unauthorized patch partially update status of the specified PodSchedulingContext HTTP Request PATCH apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts name status Parameters name in path string required name of the PodSchedulingContext namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PodSchedulingContext a OK 201 a href PodSchedulingContext a Created 401 Unauthorized delete delete a PodSchedulingContext HTTP Request DELETE apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts name Parameters name in path string required name of the PodSchedulingContext namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href PodSchedulingContext a OK 202 a href PodSchedulingContext a Accepted 401 Unauthorized deletecollection delete collection of PodSchedulingContext HTTP Request DELETE apis resource k8s io v1alpha3 namespaces namespace podschedulingcontexts Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind ResourceClaimTemplate title ResourceClaimTemplate v1alpha3 weight 17 contenttype apireference apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 apimetadata autogenerated true ResourceClaimTemplate is used to produce ResourceClaim objects | ---
api_metadata:
apiVersion: "resource.k8s.io/v1alpha3"
import: "k8s.io/api/resource/v1alpha3"
kind: "ResourceClaimTemplate"
content_type: "api_reference"
description: "ResourceClaimTemplate is used to produce ResourceClaim objects."
title: "ResourceClaimTemplate v1alpha3"
weight: 17
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.
-->
`apiVersion: resource.k8s.io/v1alpha3`
`import "k8s.io/api/resource/v1alpha3"`
## ResourceClaimTemplate {#ResourceClaimTemplate}
ResourceClaimTemplate is used to produce ResourceClaim objects.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: ResourceClaimTemplate
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata
- **spec** (<a href="">ResourceClaimTemplateSpec</a>), required
Describes the ResourceClaim that is to be generated.
This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore.
## ResourceClaimTemplateSpec {#ResourceClaimTemplateSpec}
ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.
<hr>
- **spec** (<a href="">ResourceClaimSpec</a>), required
Spec for the ResourceClaim. The entire content is copied unchanged into the ResourceClaim that gets created from this template. The same fields as in a ResourceClaim are also valid here.
- **metadata** (<a href="">ObjectMeta</a>)
ObjectMeta may contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
## ResourceClaimTemplateList {#ResourceClaimTemplateList}
ResourceClaimTemplateList is a collection of claim templates.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: ResourceClaimTemplateList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata
- **items** ([]<a href="">ResourceClaimTemplate</a>), required
Items is the list of resource claim templates.
## Operations {#Operations}
<hr>
### `get` read the specified ResourceClaimTemplate
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaimtemplates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaimTemplate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaimTemplate</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ResourceClaimTemplate
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaimtemplates
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ResourceClaimTemplateList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ResourceClaimTemplate
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/resourceclaimtemplates
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ResourceClaimTemplateList</a>): OK
401: Unauthorized
### `create` create a ResourceClaimTemplate
#### HTTP Request
POST /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaimtemplates
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ResourceClaimTemplate</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaimTemplate</a>): OK
201 (<a href="">ResourceClaimTemplate</a>): Created
202 (<a href="">ResourceClaimTemplate</a>): Accepted
401: Unauthorized
### `update` replace the specified ResourceClaimTemplate
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaimtemplates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaimTemplate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ResourceClaimTemplate</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaimTemplate</a>): OK
201 (<a href="">ResourceClaimTemplate</a>): Created
401: Unauthorized
### `patch` partially update the specified ResourceClaimTemplate
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaimtemplates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaimTemplate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceClaimTemplate</a>): OK
201 (<a href="">ResourceClaimTemplate</a>): Created
401: Unauthorized
### `delete` delete a ResourceClaimTemplate
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaimtemplates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceClaimTemplate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">ResourceClaimTemplate</a>): OK
202 (<a href="">ResourceClaimTemplate</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ResourceClaimTemplate
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/namespaces/{namespace}/resourceclaimtemplates
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 kind ResourceClaimTemplate content type api reference description ResourceClaimTemplate is used to produce ResourceClaim objects title ResourceClaimTemplate v1alpha3 weight 17 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 apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 ResourceClaimTemplate ResourceClaimTemplate ResourceClaimTemplate is used to produce ResourceClaim objects This is an alpha type and requires enabling the DynamicResourceAllocation feature gate hr apiVersion resource k8s io v1alpha3 kind ResourceClaimTemplate metadata a href ObjectMeta a Standard object metadata spec a href ResourceClaimTemplateSpec a required Describes the ResourceClaim that is to be generated This field is immutable A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore ResourceClaimTemplateSpec ResourceClaimTemplateSpec ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim hr spec a href ResourceClaimSpec a required Spec for the ResourceClaim The entire content is copied unchanged into the ResourceClaim that gets created from this template The same fields as in a ResourceClaim are also valid here metadata a href ObjectMeta a ObjectMeta may contain labels and annotations that will be copied into the PVC when creating it No other fields are allowed and will be rejected during validation ResourceClaimTemplateList ResourceClaimTemplateList ResourceClaimTemplateList is a collection of claim templates hr apiVersion resource k8s io v1alpha3 kind ResourceClaimTemplateList metadata a href ListMeta a Standard list metadata items a href ResourceClaimTemplate a required Items is the list of resource claim templates Operations Operations hr get read the specified ResourceClaimTemplate HTTP Request GET apis resource k8s io v1alpha3 namespaces namespace resourceclaimtemplates name Parameters name in path string required name of the ResourceClaimTemplate namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ResourceClaimTemplate a OK 401 Unauthorized list list or watch objects of kind ResourceClaimTemplate HTTP Request GET apis resource k8s io v1alpha3 namespaces namespace resourceclaimtemplates Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ResourceClaimTemplateList a OK 401 Unauthorized list list or watch objects of kind ResourceClaimTemplate HTTP Request GET apis resource k8s io v1alpha3 resourceclaimtemplates Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ResourceClaimTemplateList a OK 401 Unauthorized create create a ResourceClaimTemplate HTTP Request POST apis resource k8s io v1alpha3 namespaces namespace resourceclaimtemplates Parameters namespace in path string required a href namespace a body a href ResourceClaimTemplate a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceClaimTemplate a OK 201 a href ResourceClaimTemplate a Created 202 a href ResourceClaimTemplate a Accepted 401 Unauthorized update replace the specified ResourceClaimTemplate HTTP Request PUT apis resource k8s io v1alpha3 namespaces namespace resourceclaimtemplates name Parameters name in path string required name of the ResourceClaimTemplate namespace in path string required a href namespace a body a href ResourceClaimTemplate a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceClaimTemplate a OK 201 a href ResourceClaimTemplate a Created 401 Unauthorized patch partially update the specified ResourceClaimTemplate HTTP Request PATCH apis resource k8s io v1alpha3 namespaces namespace resourceclaimtemplates name Parameters name in path string required name of the ResourceClaimTemplate namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ResourceClaimTemplate a OK 201 a href ResourceClaimTemplate a Created 401 Unauthorized delete delete a ResourceClaimTemplate HTTP Request DELETE apis resource k8s io v1alpha3 namespaces namespace resourceclaimtemplates name Parameters name in path string required name of the ResourceClaimTemplate namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href ResourceClaimTemplate a OK 202 a href ResourceClaimTemplate a Accepted 401 Unauthorized deletecollection delete collection of ResourceClaimTemplate HTTP Request DELETE apis resource k8s io v1alpha3 namespaces namespace resourceclaimtemplates Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion apps v1 contenttype apireference DaemonSet represents the configuration of a daemon set kind DaemonSet title DaemonSet apimetadata autogenerated true weight 9 import k8s io api apps v1 | ---
api_metadata:
apiVersion: "apps/v1"
import: "k8s.io/api/apps/v1"
kind: "DaemonSet"
content_type: "api_reference"
description: "DaemonSet represents the configuration of a daemon set."
title: "DaemonSet"
weight: 9
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.
-->
`apiVersion: apps/v1`
`import "k8s.io/api/apps/v1"`
## DaemonSet {#DaemonSet}
DaemonSet represents the configuration of a daemon set.
<hr>
- **apiVersion**: apps/v1
- **kind**: DaemonSet
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">DaemonSetSpec</a>)
The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">DaemonSetStatus</a>)
The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## DaemonSetSpec {#DaemonSetSpec}
DaemonSetSpec is the specification of a daemon set.
<hr>
- **selector** (<a href="">LabelSelector</a>), required
A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **template** (<a href="">PodTemplateSpec</a>), required
An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). The only allowed template.spec.restartPolicy value is "Always". More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
- **minReadySeconds** (int32)
The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).
- **updateStrategy** (DaemonSetUpdateStrategy)
An update strategy to replace existing DaemonSet pods with new pods.
<a name="DaemonSetUpdateStrategy"></a>
*DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.*
- **updateStrategy.type** (string)
Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
- **updateStrategy.rollingUpdate** (RollingUpdateDaemonSet)
Rolling update config params. Present only if type = "RollingUpdate".
<a name="RollingUpdateDaemonSet"></a>
*Spec to control the desired behavior of daemon set rolling update.*
- **updateStrategy.rollingUpdate.maxSurge** (IntOrString)
The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **updateStrategy.rollingUpdate.maxUnavailable** (IntOrString)
The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **revisionHistoryLimit** (int32)
The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
## DaemonSetStatus {#DaemonSetStatus}
DaemonSetStatus represents the current status of a daemon set.
<hr>
- **numberReady** (int32), required
numberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running with a Ready Condition.
- **numberAvailable** (int32)
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
- **numberUnavailable** (int32)
The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
- **numberMisscheduled** (int32), required
The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
- **desiredNumberScheduled** (int32), required
The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
- **currentNumberScheduled** (int32), required
The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
- **updatedNumberScheduled** (int32)
The total number of nodes that are running updated daemon pod
- **collisionCount** (int32)
Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
- **conditions** ([]DaemonSetCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Represents the latest available observations of a DaemonSet's current state.
<a name="DaemonSetCondition"></a>
*DaemonSetCondition describes the state of a DaemonSet at a certain point.*
- **conditions.status** (string), required
Status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
Type of DaemonSet condition.
- **conditions.lastTransitionTime** (Time)
Last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
A human readable message indicating details about the transition.
- **conditions.reason** (string)
The reason for the condition's last transition.
- **observedGeneration** (int64)
The most recent generation observed by the daemon set controller.
## DaemonSetList {#DaemonSetList}
DaemonSetList is a collection of daemon sets.
<hr>
- **apiVersion**: apps/v1
- **kind**: DaemonSetList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">DaemonSet</a>), required
A list of daemon sets.
## Operations {#Operations}
<hr>
### `get` read the specified DaemonSet
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the DaemonSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DaemonSet</a>): OK
401: Unauthorized
### `get` read status of the specified DaemonSet
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the DaemonSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DaemonSet</a>): OK
401: Unauthorized
### `list` list or watch objects of kind DaemonSet
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/daemonsets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">DaemonSetList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind DaemonSet
#### HTTP Request
GET /apis/apps/v1/daemonsets
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">DaemonSetList</a>): OK
401: Unauthorized
### `create` create a DaemonSet
#### HTTP Request
POST /apis/apps/v1/namespaces/{namespace}/daemonsets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DaemonSet</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DaemonSet</a>): OK
201 (<a href="">DaemonSet</a>): Created
202 (<a href="">DaemonSet</a>): Accepted
401: Unauthorized
### `update` replace the specified DaemonSet
#### HTTP Request
PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the DaemonSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DaemonSet</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DaemonSet</a>): OK
201 (<a href="">DaemonSet</a>): Created
401: Unauthorized
### `update` replace status of the specified DaemonSet
#### HTTP Request
PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the DaemonSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DaemonSet</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DaemonSet</a>): OK
201 (<a href="">DaemonSet</a>): Created
401: Unauthorized
### `patch` partially update the specified DaemonSet
#### HTTP Request
PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the DaemonSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DaemonSet</a>): OK
201 (<a href="">DaemonSet</a>): Created
401: Unauthorized
### `patch` partially update status of the specified DaemonSet
#### HTTP Request
PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the DaemonSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DaemonSet</a>): OK
201 (<a href="">DaemonSet</a>): Created
401: Unauthorized
### `delete` delete a DaemonSet
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the DaemonSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of DaemonSet
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion apps v1 import k8s io api apps v1 kind DaemonSet content type api reference description DaemonSet represents the configuration of a daemon set title DaemonSet weight 9 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 apiVersion apps v1 import k8s io api apps v1 DaemonSet DaemonSet DaemonSet represents the configuration of a daemon set hr apiVersion apps v1 kind DaemonSet metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href DaemonSetSpec a The desired behavior of this daemon set More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href DaemonSetStatus a The current status of this daemon set This data may be out of date by some window of time Populated by the system Read only More info https git k8s io community contributors devel sig architecture api conventions md spec and status DaemonSetSpec DaemonSetSpec DaemonSetSpec is the specification of a daemon set hr selector a href LabelSelector a required A label query over pods that are managed by the daemon set Must match in order to be controlled It must match the pod template s labels More info https kubernetes io docs concepts overview working with objects labels label selectors template a href PodTemplateSpec a required An object that describes the pod that will be created The DaemonSet will create exactly one copy of this pod on every node that matches the template s node selector or on every node if no node selector is specified The only allowed template spec restartPolicy value is Always More info https kubernetes io docs concepts workloads controllers replicationcontroller pod template minReadySeconds int32 The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing for it to be considered available Defaults to 0 pod will be considered available as soon as it is ready updateStrategy DaemonSetUpdateStrategy An update strategy to replace existing DaemonSet pods with new pods a name DaemonSetUpdateStrategy a DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet updateStrategy type string Type of daemon set update Can be RollingUpdate or OnDelete Default is RollingUpdate updateStrategy rollingUpdate RollingUpdateDaemonSet Rolling update config params Present only if type RollingUpdate a name RollingUpdateDaemonSet a Spec to control the desired behavior of daemon set rolling update updateStrategy rollingUpdate maxSurge IntOrString The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update Value can be an absolute number ex 5 or a percentage of desired pods ex 10 This can not be 0 if MaxUnavailable is 0 Absolute number is calculated from percentage by rounding up to a minimum of 1 Default value is 0 Example when this is set to 30 at most 30 of the total number of nodes that should be running the daemon pod i e status desiredNumberScheduled can have their a new pod created before the old pod is marked as deleted The update starts by launching new pods on 30 of nodes Once an updated pod is available Ready for at least minReadySeconds the old DaemonSet pod on that node is marked deleted If the old pod becomes unavailable for any reason Ready transitions to false is evicted or is drained an updated pod is immediatedly created on that node without considering surge limits Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails and so resource intensive daemonsets should take into account that they may cause evictions during disruption a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number updateStrategy rollingUpdate maxUnavailable IntOrString The maximum number of DaemonSet pods that can be unavailable during the update Value can be an absolute number ex 5 or a percentage of total number of DaemonSet pods at the start of the update ex 10 Absolute number is calculated from percentage by rounding up This cannot be 0 if MaxSurge is 0 Default value is 1 Example when this is set to 30 at most 30 of the total number of nodes that should be running the daemon pod i e status desiredNumberScheduled can have their pods stopped for an update at any given time The update starts by stopping at most 30 of those DaemonSet pods and then brings up new DaemonSet pods in their place Once the new pods are available it then proceeds onto other DaemonSet pods thus ensuring that at least 70 of original number of DaemonSet pods are available at all times during the update a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number revisionHistoryLimit int32 The number of old history to retain to allow rollback This is a pointer to distinguish between explicit zero and not specified Defaults to 10 DaemonSetStatus DaemonSetStatus DaemonSetStatus represents the current status of a daemon set hr numberReady int32 required numberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running with a Ready Condition numberAvailable int32 The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available ready for at least spec minReadySeconds numberUnavailable int32 The number of nodes that should be running the daemon pod and have none of the daemon pod running and available ready for at least spec minReadySeconds numberMisscheduled int32 required The number of nodes that are running the daemon pod but are not supposed to run the daemon pod More info https kubernetes io docs concepts workloads controllers daemonset desiredNumberScheduled int32 required The total number of nodes that should be running the daemon pod including nodes correctly running the daemon pod More info https kubernetes io docs concepts workloads controllers daemonset currentNumberScheduled int32 required The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod More info https kubernetes io docs concepts workloads controllers daemonset updatedNumberScheduled int32 The total number of nodes that are running updated daemon pod collisionCount int32 Count of hash collisions for the DaemonSet The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision conditions DaemonSetCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge Represents the latest available observations of a DaemonSet s current state a name DaemonSetCondition a DaemonSetCondition describes the state of a DaemonSet at a certain point conditions status string required Status of the condition one of True False Unknown conditions type string required Type of DaemonSet condition conditions lastTransitionTime Time Last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string A human readable message indicating details about the transition conditions reason string The reason for the condition s last transition observedGeneration int64 The most recent generation observed by the daemon set controller DaemonSetList DaemonSetList DaemonSetList is a collection of daemon sets hr apiVersion apps v1 kind DaemonSetList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href DaemonSet a required A list of daemon sets Operations Operations hr get read the specified DaemonSet HTTP Request GET apis apps v1 namespaces namespace daemonsets name Parameters name in path string required name of the DaemonSet namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href DaemonSet a OK 401 Unauthorized get read status of the specified DaemonSet HTTP Request GET apis apps v1 namespaces namespace daemonsets name status Parameters name in path string required name of the DaemonSet namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href DaemonSet a OK 401 Unauthorized list list or watch objects of kind DaemonSet HTTP Request GET apis apps v1 namespaces namespace daemonsets Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href DaemonSetList a OK 401 Unauthorized list list or watch objects of kind DaemonSet HTTP Request GET apis apps v1 daemonsets Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href DaemonSetList a OK 401 Unauthorized create create a DaemonSet HTTP Request POST apis apps v1 namespaces namespace daemonsets Parameters namespace in path string required a href namespace a body a href DaemonSet a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href DaemonSet a OK 201 a href DaemonSet a Created 202 a href DaemonSet a Accepted 401 Unauthorized update replace the specified DaemonSet HTTP Request PUT apis apps v1 namespaces namespace daemonsets name Parameters name in path string required name of the DaemonSet namespace in path string required a href namespace a body a href DaemonSet a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href DaemonSet a OK 201 a href DaemonSet a Created 401 Unauthorized update replace status of the specified DaemonSet HTTP Request PUT apis apps v1 namespaces namespace daemonsets name status Parameters name in path string required name of the DaemonSet namespace in path string required a href namespace a body a href DaemonSet a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href DaemonSet a OK 201 a href DaemonSet a Created 401 Unauthorized patch partially update the specified DaemonSet HTTP Request PATCH apis apps v1 namespaces namespace daemonsets name Parameters name in path string required name of the DaemonSet namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href DaemonSet a OK 201 a href DaemonSet a Created 401 Unauthorized patch partially update status of the specified DaemonSet HTTP Request PATCH apis apps v1 namespaces namespace daemonsets name status Parameters name in path string required name of the DaemonSet namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href DaemonSet a OK 201 a href DaemonSet a Created 401 Unauthorized delete delete a DaemonSet HTTP Request DELETE apis apps v1 namespaces namespace daemonsets name Parameters name in path string required name of the DaemonSet namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of DaemonSet HTTP Request DELETE apis apps v1 namespaces namespace daemonsets Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title Job kind Job contenttype apireference weight 10 apiVersion batch v1 apimetadata Job represents the configuration of a single job autogenerated true import k8s io api batch v1 | ---
api_metadata:
apiVersion: "batch/v1"
import: "k8s.io/api/batch/v1"
kind: "Job"
content_type: "api_reference"
description: "Job represents the configuration of a single job."
title: "Job"
weight: 10
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.
-->
`apiVersion: batch/v1`
`import "k8s.io/api/batch/v1"`
## Job {#Job}
Job represents the configuration of a single job.
<hr>
- **apiVersion**: batch/v1
- **kind**: Job
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">JobSpec</a>)
Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">JobStatus</a>)
Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## JobSpec {#JobSpec}
JobSpec describes how the job execution will look like.
<hr>
### Replicas
- **template** (<a href="">PodTemplateSpec</a>), required
Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are "Never" or "OnFailure". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
- **parallelism** (int32)
Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) \< .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
### Lifecycle
- **completions** (int32)
Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
- **completionMode** (string)
completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`.
`NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other.
`Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`.
More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.
- **backoffLimit** (int32)
Specifies the number of retries before marking this job failed. Defaults to 6
- **activeDeadlineSeconds** (int64)
Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.
- **ttlSecondsAfterFinished** (int32)
ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.
- **suspend** (boolean)
suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.
### Selector
- **selector** (<a href="">LabelSelector</a>)
A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **manualSelector** (boolean)
manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector
### Beta level
- **podFailurePolicy** (PodFailurePolicy)
Specifies the policy of handling failed pods. In particular, it allows to specify the set of actions and conditions which need to be satisfied to take the associated action. If empty, the default behaviour applies - the counter of failed pods, represented by the jobs's .status.failed field, is incremented and it is checked against the backoffLimit. This field cannot be used in combination with restartPolicy=OnFailure.
<a name="PodFailurePolicy"></a>
*PodFailurePolicy describes how failed pods influence the backoffLimit.*
- **podFailurePolicy.rules** ([]PodFailurePolicyRule), required
*Atomic: will be replaced during a merge*
A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed.
<a name="PodFailurePolicyRule"></a>
*PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule.*
- **podFailurePolicy.rules.action** (string), required
Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are:
- FailJob: indicates that the pod's job is marked as Failed and all
running pods are terminated.
- FailIndex: indicates that the pod's index is marked as Failed and will
not be restarted.
This value is beta-level. It can be used when the
`JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
- Ignore: indicates that the counter towards the .backoffLimit is not
incremented and a replacement pod is created.
- Count: indicates that the pod is handled in the default way - the
counter towards the .backoffLimit is incremented.
Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.
- **podFailurePolicy.rules.onExitCodes** (PodFailurePolicyOnExitCodesRequirement)
Represents the requirement on the container exit codes.
<a name="PodFailurePolicyOnExitCodesRequirement"></a>
*PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check.*
- **podFailurePolicy.rules.onExitCodes.operator** (string), required
Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are:
- In: the requirement is satisfied if at least one container exit code
(might be multiple if there are multiple containers not restricted
by the 'containerName' field) is in the set of specified values.
- NotIn: the requirement is satisfied if at least one container exit code
(might be multiple if there are multiple containers not restricted
by the 'containerName' field) is not in the set of specified values.
Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied.
- **podFailurePolicy.rules.onExitCodes.values** ([]int32), required
*Set: unique values will be kept during a merge*
Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value '0' cannot be used for the In operator. At least one element is required. At most 255 elements are allowed.
- **podFailurePolicy.rules.onExitCodes.containerName** (string)
Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template.
- **podFailurePolicy.rules.onPodConditions** ([]PodFailurePolicyOnPodConditionsPattern)
*Atomic: will be replaced during a merge*
Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed.
<a name="PodFailurePolicyOnPodConditionsPattern"></a>
*PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type.*
- **podFailurePolicy.rules.onPodConditions.status** (string), required
Specifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True.
- **podFailurePolicy.rules.onPodConditions.type** (string), required
Specifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type.
- **successPolicy** (SuccessPolicy)
successPolicy specifies the policy when the Job can be declared as succeeded. If empty, the default behavior applies - the Job is declared as succeeded only when the number of succeeded pods equals to the completions. When the field is specified, it must be immutable and works only for the Indexed Jobs. Once the Job meets the SuccessPolicy, the lingering pods are terminated.
This field is beta-level. To use this field, you must enable the `JobSuccessPolicy` feature gate (enabled by default).
<a name="SuccessPolicy"></a>
*SuccessPolicy describes when a Job can be declared as succeeded based on the success of some indexes.*
- **successPolicy.rules** ([]SuccessPolicyRule), required
*Atomic: will be replaced during a merge*
rules represents the list of alternative rules for the declaring the Jobs as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met, the "SucceededCriteriaMet" condition is added, and the lingering pods are removed. The terminal state for such a Job has the "Complete" condition. Additionally, these rules are evaluated in order; Once the Job meets one of the rules, other rules are ignored. At most 20 elements are allowed.
<a name="SuccessPolicyRule"></a>
*SuccessPolicyRule describes rule for declaring a Job as succeeded. Each rule must have at least one of the "succeededIndexes" or "succeededCount" specified.*
- **successPolicy.rules.succeededCount** (int32)
succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. When succeededCount is used along with succeededIndexes, the check is constrained only to the set of indexes specified by succeededIndexes. For example, given that succeededIndexes is "1-4", succeededCount is "3", and completed indexes are "1", "3", and "5", the Job isn't declared as succeeded because only "1" and "3" indexes are considered in that rules. When this field is null, this doesn't default to any value and is never evaluated at any time. When specified it needs to be a positive integer.
- **successPolicy.rules.succeededIndexes** (string)
succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. The list of indexes must be within 0 to ".spec.completions-1" and must not contain duplicates. At least one element is required. The indexes are represented as intervals separated by commas. The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen. The number are listed in represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". When this field is null, this field doesn't default to any value and is never evaluated at any time.
### Alpha level
- **backoffLimitPerIndex** (int32)
Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
- **managedBy** (string)
ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/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. The value cannot exceed 63 characters. This field is immutable.
This field is alpha-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (disabled by default).
- **maxFailedIndexes** (int32)
Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
- **podReplacementPolicy** (string)
podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods
when they are terminating (has a metadata.deletionTimestamp) or failed.
- Failed means to wait until a previously created Pod is fully terminated (has phase
Failed or Succeeded) before creating a replacement Pod.
When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default.
## JobStatus {#JobStatus}
JobStatus represents the current state of a Job.
<hr>
- **startTime** (Time)
Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.
Once set, the field can only be removed when the job is suspended. The field cannot be modified while the job is unsuspended or finished.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **completionTime** (Time)
Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is set when the job finishes successfully, and only then. The value cannot be updated or removed. The value indicates the same or later point in time as the startTime field.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **active** (int32)
The number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.
- **failed** (int32)
The number of pods which reached phase Failed. The value increases monotonically.
- **succeeded** (int32)
The number of pods which reached phase Succeeded. The value increases monotonically for a given spec. However, it may decrease in reaction to scale down of elastic indexed jobs.
- **completedIndexes** (string)
completedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".
- **conditions** ([]JobCondition)
*Patch strategy: merge on key `type`*
*Atomic: will be replaced during a merge*
The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true.
A job is considered finished when it is in a terminal condition, either "Complete" or "Failed". A Job cannot have both the "Complete" and "Failed" conditions. Additionally, it cannot be in the "Complete" and "FailureTarget" conditions. The "Complete", "Failed" and "FailureTarget" conditions cannot be disabled.
More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
<a name="JobCondition"></a>
*JobCondition describes current state of a job.*
- **conditions.status** (string), required
Status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
Type of job condition, Complete or Failed.
- **conditions.lastProbeTime** (Time)
Last time the condition was checked.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.lastTransitionTime** (Time)
Last time the condition transit from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
Human readable message indicating details about last transition.
- **conditions.reason** (string)
(brief) reason for the condition's last transition.
- **uncountedTerminatedPods** (UncountedTerminatedPods)
uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.
The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status:
1. Add the pod UID to the arrays in this field. 2. Remove the pod finalizer. 3. Remove the pod UID from the arrays while increasing the corresponding
counter.
Old jobs might not be tracked using this field, in which case the field remains null. The structure is empty for finished jobs.
<a name="UncountedTerminatedPods"></a>
*UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.*
- **uncountedTerminatedPods.failed** ([]string)
*Set: unique values will be kept during a merge*
failed holds UIDs of failed Pods.
- **uncountedTerminatedPods.succeeded** ([]string)
*Set: unique values will be kept during a merge*
succeeded holds UIDs of succeeded Pods.
### Beta level
- **ready** (int32)
The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).
### Alpha level
- **failedIndexes** (string)
FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". The set of failed indexes cannot overlap with the set of completed indexes.
This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
- **terminating** (int32)
The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).
This field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default).
## JobList {#JobList}
JobList is a collection of jobs.
<hr>
- **apiVersion**: batch/v1
- **kind**: JobList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">Job</a>), required
items is the list of Jobs.
## Operations {#Operations}
<hr>
### `get` read the specified Job
#### HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Job
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Job</a>): OK
401: Unauthorized
### `get` read status of the specified Job
#### HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Job
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Job</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Job
#### HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/jobs
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">JobList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Job
#### HTTP Request
GET /apis/batch/v1/jobs
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">JobList</a>): OK
401: Unauthorized
### `create` create a Job
#### HTTP Request
POST /apis/batch/v1/namespaces/{namespace}/jobs
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Job</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Job</a>): OK
201 (<a href="">Job</a>): Created
202 (<a href="">Job</a>): Accepted
401: Unauthorized
### `update` replace the specified Job
#### HTTP Request
PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Job
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Job</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Job</a>): OK
201 (<a href="">Job</a>): Created
401: Unauthorized
### `update` replace status of the specified Job
#### HTTP Request
PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Job
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Job</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Job</a>): OK
201 (<a href="">Job</a>): Created
401: Unauthorized
### `patch` partially update the specified Job
#### HTTP Request
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Job
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Job</a>): OK
201 (<a href="">Job</a>): Created
401: Unauthorized
### `patch` partially update status of the specified Job
#### HTTP Request
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Job
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Job</a>): OK
201 (<a href="">Job</a>): Created
401: Unauthorized
### `delete` delete a Job
#### HTTP Request
DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Job
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Job
#### HTTP Request
DELETE /apis/batch/v1/namespaces/{namespace}/jobs
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion batch v1 import k8s io api batch v1 kind Job content type api reference description Job represents the configuration of a single job title Job weight 10 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 apiVersion batch v1 import k8s io api batch v1 Job Job Job represents the configuration of a single job hr apiVersion batch v1 kind Job metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href JobSpec a Specification of the desired behavior of a job More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href JobStatus a Current status of a job More info https git k8s io community contributors devel sig architecture api conventions md spec and status JobSpec JobSpec JobSpec describes how the job execution will look like hr Replicas template a href PodTemplateSpec a required Describes the pod that will be created when executing a job The only allowed template spec restartPolicy values are Never or OnFailure More info https kubernetes io docs concepts workloads controllers jobs run to completion parallelism int32 Specifies the maximum desired number of pods the job should run at any given time The actual number of pods running in steady state will be less than this number when spec completions status successful spec parallelism i e when the work left to do is less than max parallelism More info https kubernetes io docs concepts workloads controllers jobs run to completion Lifecycle completions int32 Specifies the desired number of successfully finished pods the job should be run with Setting to null means that the success of any pod signals the success of all pods and allows parallelism to have any positive value Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job More info https kubernetes io docs concepts workloads controllers jobs run to completion completionMode string completionMode specifies how Pod completions are tracked It can be NonIndexed default or Indexed NonIndexed means that the Job is considered complete when there have been spec completions successfully completed Pods Each Pod completion is homologous to each other Indexed means that the Pods of a Job get an associated completion index from 0 to spec completions 1 available in the annotation batch kubernetes io job completion index The Job is considered complete when there is one successfully completed Pod for each index When value is Indexed spec completions must be specified and spec parallelism must be less than or equal to 10 5 In addition The Pod name takes the form job name index random string the Pod hostname takes the form job name index More completion modes can be added in the future If the Job controller observes a mode that it doesn t recognize which is possible during upgrades due to version skew the controller skips updates for the Job backoffLimit int32 Specifies the number of retries before marking this job failed Defaults to 6 activeDeadlineSeconds int64 Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it value must be positive integer If a Job is suspended at creation or through an update this timer will effectively be stopped and reset when the Job is resumed again ttlSecondsAfterFinished int32 ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution either Complete or Failed If this field is set ttlSecondsAfterFinished after the Job finishes it is eligible to be automatically deleted When the Job is being deleted its lifecycle guarantees e g finalizers will be honored If this field is unset the Job won t be automatically deleted If this field is set to zero the Job becomes eligible to be deleted immediately after it finishes suspend boolean suspend specifies whether the Job controller should create Pods or not If a Job is created with suspend set to true no Pods are created by the Job controller If a Job is suspended after creation i e the flag goes from false to true the Job controller will delete all active Pods associated with this Job Users must design their workload to gracefully handle this Suspending a Job will reset the StartTime field of the Job effectively resetting the ActiveDeadlineSeconds timer too Defaults to false Selector selector a href LabelSelector a A label query over pods that should match the pod count Normally the system sets this field for you More info https kubernetes io docs concepts overview working with objects labels label selectors manualSelector boolean manualSelector controls generation of pod labels and pod selectors Leave manualSelector unset unless you are certain what you are doing When false or unset the system pick labels unique to this job and appends those labels to the pod template When true the user is responsible for picking unique labels and specifying the selector Failure to pick a unique label may cause this and other jobs to not function correctly However You may see manualSelector true in jobs that were created with the old extensions v1beta1 API More info https kubernetes io docs concepts workloads controllers jobs run to completion specifying your own pod selector Beta level podFailurePolicy PodFailurePolicy Specifies the policy of handling failed pods In particular it allows to specify the set of actions and conditions which need to be satisfied to take the associated action If empty the default behaviour applies the counter of failed pods represented by the jobs s status failed field is incremented and it is checked against the backoffLimit This field cannot be used in combination with restartPolicy OnFailure a name PodFailurePolicy a PodFailurePolicy describes how failed pods influence the backoffLimit podFailurePolicy rules PodFailurePolicyRule required Atomic will be replaced during a merge A list of pod failure policy rules The rules are evaluated in order Once a rule matches a Pod failure the remaining of the rules are ignored When no rule matches the Pod failure the default handling applies the counter of pod failures is incremented and it is checked against the backoffLimit At most 20 elements are allowed a name PodFailurePolicyRule a PodFailurePolicyRule describes how a pod failure is handled when the requirements are met One of onExitCodes and onPodConditions but not both can be used in each rule podFailurePolicy rules action string required Specifies the action taken on a pod failure when the requirements are satisfied Possible values are FailJob indicates that the pod s job is marked as Failed and all running pods are terminated FailIndex indicates that the pod s index is marked as Failed and will not be restarted This value is beta level It can be used when the JobBackoffLimitPerIndex feature gate is enabled enabled by default Ignore indicates that the counter towards the backoffLimit is not incremented and a replacement pod is created Count indicates that the pod is handled in the default way the counter towards the backoffLimit is incremented Additional values are considered to be added in the future Clients should react to an unknown action by skipping the rule podFailurePolicy rules onExitCodes PodFailurePolicyOnExitCodesRequirement Represents the requirement on the container exit codes a name PodFailurePolicyOnExitCodesRequirement a PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes In particular it lookups the state terminated exitCode for each app container and init container status represented by the status containerStatuses and status initContainerStatuses fields in the Pod status respectively Containers completed with success exit code 0 are excluded from the requirement check podFailurePolicy rules onExitCodes operator string required Represents the relationship between the container exit code s and the specified values Containers completed with success exit code 0 are excluded from the requirement check Possible values are In the requirement is satisfied if at least one container exit code might be multiple if there are multiple containers not restricted by the containerName field is in the set of specified values NotIn the requirement is satisfied if at least one container exit code might be multiple if there are multiple containers not restricted by the containerName field is not in the set of specified values Additional values are considered to be added in the future Clients should react to an unknown operator by assuming the requirement is not satisfied podFailurePolicy rules onExitCodes values int32 required Set unique values will be kept during a merge Specifies the set of values Each returned container exit code might be multiple in case of multiple containers is checked against this set of values with respect to the operator The list of values must be ordered and must not contain duplicates Value 0 cannot be used for the In operator At least one element is required At most 255 elements are allowed podFailurePolicy rules onExitCodes containerName string Restricts the check for exit codes to the container with the specified name When null the rule applies to all containers When specified it should match one the container or initContainer names in the pod template podFailurePolicy rules onPodConditions PodFailurePolicyOnPodConditionsPattern Atomic will be replaced during a merge Represents the requirement on the pod conditions The requirement is represented as a list of pod condition patterns The requirement is satisfied if at least one pattern matches an actual pod condition At most 20 elements are allowed a name PodFailurePolicyOnPodConditionsPattern a PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type podFailurePolicy rules onPodConditions status string required Specifies the required Pod condition status To match a pod condition it is required that the specified status equals the pod condition status Defaults to True podFailurePolicy rules onPodConditions type string required Specifies the required Pod condition type To match a pod condition it is required that specified type equals the pod condition type successPolicy SuccessPolicy successPolicy specifies the policy when the Job can be declared as succeeded If empty the default behavior applies the Job is declared as succeeded only when the number of succeeded pods equals to the completions When the field is specified it must be immutable and works only for the Indexed Jobs Once the Job meets the SuccessPolicy the lingering pods are terminated This field is beta level To use this field you must enable the JobSuccessPolicy feature gate enabled by default a name SuccessPolicy a SuccessPolicy describes when a Job can be declared as succeeded based on the success of some indexes successPolicy rules SuccessPolicyRule required Atomic will be replaced during a merge rules represents the list of alternative rules for the declaring the Jobs as successful before status succeeded spec completions Once any of the rules are met the SucceededCriteriaMet condition is added and the lingering pods are removed The terminal state for such a Job has the Complete condition Additionally these rules are evaluated in order Once the Job meets one of the rules other rules are ignored At most 20 elements are allowed a name SuccessPolicyRule a SuccessPolicyRule describes rule for declaring a Job as succeeded Each rule must have at least one of the succeededIndexes or succeededCount specified successPolicy rules succeededCount int32 succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job When succeededCount is used along with succeededIndexes the check is constrained only to the set of indexes specified by succeededIndexes For example given that succeededIndexes is 1 4 succeededCount is 3 and completed indexes are 1 3 and 5 the Job isn t declared as succeeded because only 1 and 3 indexes are considered in that rules When this field is null this doesn t default to any value and is never evaluated at any time When specified it needs to be a positive integer successPolicy rules succeededIndexes string succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job The list of indexes must be within 0 to spec completions 1 and must not contain duplicates At least one element is required The indexes are represented as intervals separated by commas The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen The number are listed in represented by the first and last element of the series separated by a hyphen For example if the completed indexes are 1 3 4 5 and 7 they are represented as 1 3 5 7 When this field is null this field doesn t default to any value and is never evaluated at any time Alpha level backoffLimitPerIndex int32 Specifies the limit for the number of retries within an index before marking this index as failed When enabled the number of failures per index is kept in the pod s batch kubernetes io job index failure count annotation It can only be set when Job s completionMode Indexed and the Pod s restart policy is Never The field is immutable This field is beta level It can be used when the JobBackoffLimitPerIndex feature gate is enabled enabled by default managedBy string ManagedBy field indicates the controller that manages a Job The k8s Job controller reconciles jobs which don t have this field at all or the field value is the reserved string kubernetes io job controller but skips reconciling Jobs with a custom value for this field The value must be a valid domain prefixed path e g acme io 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 The value cannot exceed 63 characters This field is immutable This field is alpha level The job controller accepts setting the field when the feature gate JobManagedBy is enabled disabled by default maxFailedIndexes int32 Specifies the maximal number of failed indexes before marking the Job as failed when backoffLimitPerIndex is set Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated When left as null the job continues execution of all of its indexes and is marked with the Complete Job condition It can only be specified when backoffLimitPerIndex is set It can be null or up to completions It is required and must be less than or equal to 10 4 when is completions greater than 10 5 This field is beta level It can be used when the JobBackoffLimitPerIndex feature gate is enabled enabled by default podReplacementPolicy string podReplacementPolicy specifies when to create replacement Pods Possible values are TerminatingOrFailed means that we recreate pods when they are terminating has a metadata deletionTimestamp or failed Failed means to wait until a previously created Pod is fully terminated has phase Failed or Succeeded before creating a replacement Pod When using podFailurePolicy Failed is the the only allowed value TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use This is an beta field To use this enable the JobPodReplacementPolicy feature toggle This is on by default JobStatus JobStatus JobStatus represents the current state of a Job hr startTime Time Represents time when the job controller started processing a job When a Job is created in the suspended state this field is not set until the first time it is resumed This field is reset every time a Job is resumed from suspension It is represented in RFC3339 form and is in UTC Once set the field can only be removed when the job is suspended The field cannot be modified while the job is unsuspended or finished a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers completionTime Time Represents time when the job was completed It is not guaranteed to be set in happens before order across separate operations It is represented in RFC3339 form and is in UTC The completion time is set when the job finishes successfully and only then The value cannot be updated or removed The value indicates the same or later point in time as the startTime field a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers active int32 The number of pending and running pods which are not terminating without a deletionTimestamp The value is zero for finished jobs failed int32 The number of pods which reached phase Failed The value increases monotonically succeeded int32 The number of pods which reached phase Succeeded The value increases monotonically for a given spec However it may decrease in reaction to scale down of elastic indexed jobs completedIndexes string completedIndexes holds the completed indexes when spec completionMode Indexed in a text format The indexes are represented as decimal integers separated by commas The numbers are listed in increasing order Three or more consecutive numbers are compressed and represented by the first and last element of the series separated by a hyphen For example if the completed indexes are 1 3 4 5 and 7 they are represented as 1 3 5 7 conditions JobCondition Patch strategy merge on key type Atomic will be replaced during a merge The latest available observations of an object s current state When a Job fails one of the conditions will have type Failed and status true When a Job is suspended one of the conditions will have type Suspended and status true when the Job is resumed the status of this condition will become false When a Job is completed one of the conditions will have type Complete and status true A job is considered finished when it is in a terminal condition either Complete or Failed A Job cannot have both the Complete and Failed conditions Additionally it cannot be in the Complete and FailureTarget conditions The Complete Failed and FailureTarget conditions cannot be disabled More info https kubernetes io docs concepts workloads controllers jobs run to completion a name JobCondition a JobCondition describes current state of a job conditions status string required Status of the condition one of True False Unknown conditions type string required Type of job condition Complete or Failed conditions lastProbeTime Time Last time the condition was checked a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions lastTransitionTime Time Last time the condition transit from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string Human readable message indicating details about last transition conditions reason string brief reason for the condition s last transition uncountedTerminatedPods UncountedTerminatedPods uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn t yet accounted for in the status counters The job controller creates pods with a finalizer When a pod terminates succeeded or failed the controller does three steps to account for it in the job status 1 Add the pod UID to the arrays in this field 2 Remove the pod finalizer 3 Remove the pod UID from the arrays while increasing the corresponding counter Old jobs might not be tracked using this field in which case the field remains null The structure is empty for finished jobs a name UncountedTerminatedPods a UncountedTerminatedPods holds UIDs of Pods that have terminated but haven t been accounted in Job status counters uncountedTerminatedPods failed string Set unique values will be kept during a merge failed holds UIDs of failed Pods uncountedTerminatedPods succeeded string Set unique values will be kept during a merge succeeded holds UIDs of succeeded Pods Beta level ready int32 The number of active pods which have a Ready condition and are not terminating without a deletionTimestamp Alpha level failedIndexes string FailedIndexes holds the failed indexes when spec backoffLimitPerIndex is set The indexes are represented in the text format analogous as for the completedIndexes field ie they are kept as decimal integers separated by commas The numbers are listed in increasing order Three or more consecutive numbers are compressed and represented by the first and last element of the series separated by a hyphen For example if the failed indexes are 1 3 4 5 and 7 they are represented as 1 3 5 7 The set of failed indexes cannot overlap with the set of completed indexes This field is beta level It can be used when the JobBackoffLimitPerIndex feature gate is enabled enabled by default terminating int32 The number of pods which are terminating in phase Pending or Running and have a deletionTimestamp This field is beta level The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled enabled by default JobList JobList JobList is a collection of jobs hr apiVersion batch v1 kind JobList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href Job a required items is the list of Jobs Operations Operations hr get read the specified Job HTTP Request GET apis batch v1 namespaces namespace jobs name Parameters name in path string required name of the Job namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Job a OK 401 Unauthorized get read status of the specified Job HTTP Request GET apis batch v1 namespaces namespace jobs name status Parameters name in path string required name of the Job namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Job a OK 401 Unauthorized list list or watch objects of kind Job HTTP Request GET apis batch v1 namespaces namespace jobs Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href JobList a OK 401 Unauthorized list list or watch objects of kind Job HTTP Request GET apis batch v1 jobs Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href JobList a OK 401 Unauthorized create create a Job HTTP Request POST apis batch v1 namespaces namespace jobs Parameters namespace in path string required a href namespace a body a href Job a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Job a OK 201 a href Job a Created 202 a href Job a Accepted 401 Unauthorized update replace the specified Job HTTP Request PUT apis batch v1 namespaces namespace jobs name Parameters name in path string required name of the Job namespace in path string required a href namespace a body a href Job a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Job a OK 201 a href Job a Created 401 Unauthorized update replace status of the specified Job HTTP Request PUT apis batch v1 namespaces namespace jobs name status Parameters name in path string required name of the Job namespace in path string required a href namespace a body a href Job a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Job a OK 201 a href Job a Created 401 Unauthorized patch partially update the specified Job HTTP Request PATCH apis batch v1 namespaces namespace jobs name Parameters name in path string required name of the Job namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Job a OK 201 a href Job a Created 401 Unauthorized patch partially update status of the specified Job HTTP Request PATCH apis batch v1 namespaces namespace jobs name status Parameters name in path string required name of the Job namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Job a OK 201 a href Job a Created 401 Unauthorized delete delete a Job HTTP Request DELETE apis batch v1 namespaces namespace jobs name Parameters name in path string required name of the Job namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of Job HTTP Request DELETE apis batch v1 namespaces namespace jobs Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference weight 5 kind ReplicaSet apiVersion apps v1 contenttype apireference ReplicaSet ensures that a specified number of pod replicas are running at any given time apimetadata title ReplicaSet autogenerated true import k8s io api apps v1 | ---
api_metadata:
apiVersion: "apps/v1"
import: "k8s.io/api/apps/v1"
kind: "ReplicaSet"
content_type: "api_reference"
description: "ReplicaSet ensures that a specified number of pod replicas are running at any given time."
title: "ReplicaSet"
weight: 5
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.
-->
`apiVersion: apps/v1`
`import "k8s.io/api/apps/v1"`
## ReplicaSet {#ReplicaSet}
ReplicaSet ensures that a specified number of pod replicas are running at any given time.
<hr>
- **apiVersion**: apps/v1
- **kind**: ReplicaSet
- **metadata** (<a href="">ObjectMeta</a>)
If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">ReplicaSetSpec</a>)
Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">ReplicaSetStatus</a>)
Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## ReplicaSetSpec {#ReplicaSetSpec}
ReplicaSetSpec is the specification of a ReplicaSet.
<hr>
- **selector** (<a href="">LabelSelector</a>), required
Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **template** (<a href="">PodTemplateSpec</a>)
Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
- **replicas** (int32)
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
- **minReadySeconds** (int32)
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
## ReplicaSetStatus {#ReplicaSetStatus}
ReplicaSetStatus represents the current status of a ReplicaSet.
<hr>
- **replicas** (int32), required
Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
- **availableReplicas** (int32)
The number of available replicas (ready for at least minReadySeconds) for this replica set.
- **readyReplicas** (int32)
readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition.
- **fullyLabeledReplicas** (int32)
The number of pods that have labels matching the labels of the pod template of the replicaset.
- **conditions** ([]ReplicaSetCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Represents the latest available observations of a replica set's current state.
<a name="ReplicaSetCondition"></a>
*ReplicaSetCondition describes the state of a replica set at a certain point.*
- **conditions.status** (string), required
Status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
Type of replica set condition.
- **conditions.lastTransitionTime** (Time)
The last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
A human readable message indicating details about the transition.
- **conditions.reason** (string)
The reason for the condition's last transition.
- **observedGeneration** (int64)
ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
## ReplicaSetList {#ReplicaSetList}
ReplicaSetList is a collection of ReplicaSets.
<hr>
- **apiVersion**: apps/v1
- **kind**: ReplicaSetList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">ReplicaSet</a>), required
List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
## Operations {#Operations}
<hr>
### `get` read the specified ReplicaSet
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ReplicaSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicaSet</a>): OK
401: Unauthorized
### `get` read status of the specified ReplicaSet
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ReplicaSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicaSet</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ReplicaSet
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/replicasets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ReplicaSetList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ReplicaSet
#### HTTP Request
GET /apis/apps/v1/replicasets
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ReplicaSetList</a>): OK
401: Unauthorized
### `create` create a ReplicaSet
#### HTTP Request
POST /apis/apps/v1/namespaces/{namespace}/replicasets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ReplicaSet</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicaSet</a>): OK
201 (<a href="">ReplicaSet</a>): Created
202 (<a href="">ReplicaSet</a>): Accepted
401: Unauthorized
### `update` replace the specified ReplicaSet
#### HTTP Request
PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ReplicaSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ReplicaSet</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicaSet</a>): OK
201 (<a href="">ReplicaSet</a>): Created
401: Unauthorized
### `update` replace status of the specified ReplicaSet
#### HTTP Request
PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ReplicaSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ReplicaSet</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicaSet</a>): OK
201 (<a href="">ReplicaSet</a>): Created
401: Unauthorized
### `patch` partially update the specified ReplicaSet
#### HTTP Request
PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ReplicaSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicaSet</a>): OK
201 (<a href="">ReplicaSet</a>): Created
401: Unauthorized
### `patch` partially update status of the specified ReplicaSet
#### HTTP Request
PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ReplicaSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicaSet</a>): OK
201 (<a href="">ReplicaSet</a>): Created
401: Unauthorized
### `delete` delete a ReplicaSet
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ReplicaSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ReplicaSet
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/replicasets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion apps v1 import k8s io api apps v1 kind ReplicaSet content type api reference description ReplicaSet ensures that a specified number of pod replicas are running at any given time title ReplicaSet weight 5 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 apiVersion apps v1 import k8s io api apps v1 ReplicaSet ReplicaSet ReplicaSet ensures that a specified number of pod replicas are running at any given time hr apiVersion apps v1 kind ReplicaSet metadata a href ObjectMeta a If the Labels of a ReplicaSet are empty they are defaulted to be the same as the Pod s that the ReplicaSet manages Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href ReplicaSetSpec a Spec defines the specification of the desired behavior of the ReplicaSet More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href ReplicaSetStatus a Status is the most recently observed status of the ReplicaSet This data may be out of date by some window of time Populated by the system Read only More info https git k8s io community contributors devel sig architecture api conventions md spec and status ReplicaSetSpec ReplicaSetSpec ReplicaSetSpec is the specification of a ReplicaSet hr selector a href LabelSelector a required Selector is a label query over pods that should match the replica count Label keys and values that must match in order to be controlled by this replica set It must match the pod template s labels More info https kubernetes io docs concepts overview working with objects labels label selectors template a href PodTemplateSpec a Template is the object that describes the pod that will be created if insufficient replicas are detected More info https kubernetes io docs concepts workloads controllers replicationcontroller pod template replicas int32 Replicas is the number of desired replicas This is a pointer to distinguish between explicit zero and unspecified Defaults to 1 More info https kubernetes io docs concepts workloads controllers replicationcontroller what is a replicationcontroller minReadySeconds int32 Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available Defaults to 0 pod will be considered available as soon as it is ready ReplicaSetStatus ReplicaSetStatus ReplicaSetStatus represents the current status of a ReplicaSet hr replicas int32 required Replicas is the most recently observed number of replicas More info https kubernetes io docs concepts workloads controllers replicationcontroller what is a replicationcontroller availableReplicas int32 The number of available replicas ready for at least minReadySeconds for this replica set readyReplicas int32 readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition fullyLabeledReplicas int32 The number of pods that have labels matching the labels of the pod template of the replicaset conditions ReplicaSetCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge Represents the latest available observations of a replica set s current state a name ReplicaSetCondition a ReplicaSetCondition describes the state of a replica set at a certain point conditions status string required Status of the condition one of True False Unknown conditions type string required Type of replica set condition conditions lastTransitionTime Time The last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string A human readable message indicating details about the transition conditions reason string The reason for the condition s last transition observedGeneration int64 ObservedGeneration reflects the generation of the most recently observed ReplicaSet ReplicaSetList ReplicaSetList ReplicaSetList is a collection of ReplicaSets hr apiVersion apps v1 kind ReplicaSetList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href ReplicaSet a required List of ReplicaSets More info https kubernetes io docs concepts workloads controllers replicationcontroller Operations Operations hr get read the specified ReplicaSet HTTP Request GET apis apps v1 namespaces namespace replicasets name Parameters name in path string required name of the ReplicaSet namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ReplicaSet a OK 401 Unauthorized get read status of the specified ReplicaSet HTTP Request GET apis apps v1 namespaces namespace replicasets name status Parameters name in path string required name of the ReplicaSet namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ReplicaSet a OK 401 Unauthorized list list or watch objects of kind ReplicaSet HTTP Request GET apis apps v1 namespaces namespace replicasets Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ReplicaSetList a OK 401 Unauthorized list list or watch objects of kind ReplicaSet HTTP Request GET apis apps v1 replicasets Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ReplicaSetList a OK 401 Unauthorized create create a ReplicaSet HTTP Request POST apis apps v1 namespaces namespace replicasets Parameters namespace in path string required a href namespace a body a href ReplicaSet a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ReplicaSet a OK 201 a href ReplicaSet a Created 202 a href ReplicaSet a Accepted 401 Unauthorized update replace the specified ReplicaSet HTTP Request PUT apis apps v1 namespaces namespace replicasets name Parameters name in path string required name of the ReplicaSet namespace in path string required a href namespace a body a href ReplicaSet a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ReplicaSet a OK 201 a href ReplicaSet a Created 401 Unauthorized update replace status of the specified ReplicaSet HTTP Request PUT apis apps v1 namespaces namespace replicasets name status Parameters name in path string required name of the ReplicaSet namespace in path string required a href namespace a body a href ReplicaSet a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ReplicaSet a OK 201 a href ReplicaSet a Created 401 Unauthorized patch partially update the specified ReplicaSet HTTP Request PATCH apis apps v1 namespaces namespace replicasets name Parameters name in path string required name of the ReplicaSet namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ReplicaSet a OK 201 a href ReplicaSet a Created 401 Unauthorized patch partially update status of the specified ReplicaSet HTTP Request PATCH apis apps v1 namespaces namespace replicasets name status Parameters name in path string required name of the ReplicaSet namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ReplicaSet a OK 201 a href ReplicaSet a Created 401 Unauthorized delete delete a ReplicaSet HTTP Request DELETE apis apps v1 namespaces namespace replicasets name Parameters name in path string required name of the ReplicaSet namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ReplicaSet HTTP Request DELETE apis apps v1 namespaces namespace replicasets Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference weight 11 contenttype apireference kind CronJob apiVersion batch v1 apimetadata autogenerated true import k8s io api batch v1 CronJob represents the configuration of a single cron job title CronJob | ---
api_metadata:
apiVersion: "batch/v1"
import: "k8s.io/api/batch/v1"
kind: "CronJob"
content_type: "api_reference"
description: "CronJob represents the configuration of a single cron job."
title: "CronJob"
weight: 11
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.
-->
`apiVersion: batch/v1`
`import "k8s.io/api/batch/v1"`
## CronJob {#CronJob}
CronJob represents the configuration of a single cron job.
<hr>
- **apiVersion**: batch/v1
- **kind**: CronJob
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">CronJobSpec</a>)
Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">CronJobStatus</a>)
Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## CronJobSpec {#CronJobSpec}
CronJobSpec describes how the job execution will look like and when it will actually run.
<hr>
- **jobTemplate** (JobTemplateSpec), required
Specifies the job that will be created when executing a CronJob.
<a name="JobTemplateSpec"></a>
*JobTemplateSpec describes the data a Job should have when created from a template*
- **jobTemplate.metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **jobTemplate.spec** (<a href="">JobSpec</a>)
Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **schedule** (string), required
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
- **timeZone** (string)
The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones
- **concurrencyPolicy** (string)
Specifies how to treat concurrent executions of a Job. Valid values are:
- "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
- **startingDeadlineSeconds** (int64)
Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
- **suspend** (boolean)
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
- **successfulJobsHistoryLimit** (int32)
The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
- **failedJobsHistoryLimit** (int32)
The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
## CronJobStatus {#CronJobStatus}
CronJobStatus represents the current state of a cron job.
<hr>
- **active** ([]<a href="">ObjectReference</a>)
*Atomic: will be replaced during a merge*
A list of pointers to currently running jobs.
- **lastScheduleTime** (Time)
Information when was the last time the job was successfully scheduled.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **lastSuccessfulTime** (Time)
Information when was the last time the job successfully completed.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
## CronJobList {#CronJobList}
CronJobList is a collection of cron jobs.
<hr>
- **apiVersion**: batch/v1
- **kind**: CronJobList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">CronJob</a>), required
items is the list of CronJobs.
## Operations {#Operations}
<hr>
### `get` read the specified CronJob
#### HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CronJob</a>): OK
401: Unauthorized
### `get` read status of the specified CronJob
#### HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CronJob</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CronJob
#### HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/cronjobs
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">CronJobList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CronJob
#### HTTP Request
GET /apis/batch/v1/cronjobs
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">CronJobList</a>): OK
401: Unauthorized
### `create` create a CronJob
#### HTTP Request
POST /apis/batch/v1/namespaces/{namespace}/cronjobs
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">CronJob</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CronJob</a>): OK
201 (<a href="">CronJob</a>): Created
202 (<a href="">CronJob</a>): Accepted
401: Unauthorized
### `update` replace the specified CronJob
#### HTTP Request
PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">CronJob</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CronJob</a>): OK
201 (<a href="">CronJob</a>): Created
401: Unauthorized
### `update` replace status of the specified CronJob
#### HTTP Request
PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">CronJob</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CronJob</a>): OK
201 (<a href="">CronJob</a>): Created
401: Unauthorized
### `patch` partially update the specified CronJob
#### HTTP Request
PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CronJob</a>): OK
201 (<a href="">CronJob</a>): Created
401: Unauthorized
### `patch` partially update status of the specified CronJob
#### HTTP Request
PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CronJob</a>): OK
201 (<a href="">CronJob</a>): Created
401: Unauthorized
### `delete` delete a CronJob
#### HTTP Request
DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of CronJob
#### HTTP Request
DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion batch v1 import k8s io api batch v1 kind CronJob content type api reference description CronJob represents the configuration of a single cron job title CronJob weight 11 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 apiVersion batch v1 import k8s io api batch v1 CronJob CronJob CronJob represents the configuration of a single cron job hr apiVersion batch v1 kind CronJob metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href CronJobSpec a Specification of the desired behavior of a cron job including the schedule More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href CronJobStatus a Current status of a cron job More info https git k8s io community contributors devel sig architecture api conventions md spec and status CronJobSpec CronJobSpec CronJobSpec describes how the job execution will look like and when it will actually run hr jobTemplate JobTemplateSpec required Specifies the job that will be created when executing a CronJob a name JobTemplateSpec a JobTemplateSpec describes the data a Job should have when created from a template jobTemplate metadata a href ObjectMeta a Standard object s metadata of the jobs created from this template More info https git k8s io community contributors devel sig architecture api conventions md metadata jobTemplate spec a href JobSpec a Specification of the desired behavior of the job More info https git k8s io community contributors devel sig architecture api conventions md spec and status schedule string required The schedule in Cron format see https en wikipedia org wiki Cron timeZone string The time zone name for the given schedule see https en wikipedia org wiki List of tz database time zones If not specified this will default to the time zone of the kube controller manager process The set of valid time zone names and the time zone offset is loaded from the system wide time zone database by the API server during CronJob validation and the controller manager during execution If no system wide time zone database can be found a bundled version of the database is used instead If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone More information can be found in https kubernetes io docs concepts workloads controllers cron jobs time zones concurrencyPolicy string Specifies how to treat concurrent executions of a Job Valid values are Allow default allows CronJobs to run concurrently Forbid forbids concurrent runs skipping next run if previous run hasn t finished yet Replace cancels currently running job and replaces it with a new one startingDeadlineSeconds int64 Optional deadline in seconds for starting the job if it misses scheduled time for any reason Missed jobs executions will be counted as failed ones suspend boolean This flag tells the controller to suspend subsequent executions it does not apply to already started executions Defaults to false successfulJobsHistoryLimit int32 The number of successful finished jobs to retain Value must be non negative integer Defaults to 3 failedJobsHistoryLimit int32 The number of failed finished jobs to retain Value must be non negative integer Defaults to 1 CronJobStatus CronJobStatus CronJobStatus represents the current state of a cron job hr active a href ObjectReference a Atomic will be replaced during a merge A list of pointers to currently running jobs lastScheduleTime Time Information when was the last time the job was successfully scheduled a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers lastSuccessfulTime Time Information when was the last time the job successfully completed a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers CronJobList CronJobList CronJobList is a collection of cron jobs hr apiVersion batch v1 kind CronJobList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href CronJob a required items is the list of CronJobs Operations Operations hr get read the specified CronJob HTTP Request GET apis batch v1 namespaces namespace cronjobs name Parameters name in path string required name of the CronJob namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href CronJob a OK 401 Unauthorized get read status of the specified CronJob HTTP Request GET apis batch v1 namespaces namespace cronjobs name status Parameters name in path string required name of the CronJob namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href CronJob a OK 401 Unauthorized list list or watch objects of kind CronJob HTTP Request GET apis batch v1 namespaces namespace cronjobs Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href CronJobList a OK 401 Unauthorized list list or watch objects of kind CronJob HTTP Request GET apis batch v1 cronjobs Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href CronJobList a OK 401 Unauthorized create create a CronJob HTTP Request POST apis batch v1 namespaces namespace cronjobs Parameters namespace in path string required a href namespace a body a href CronJob a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CronJob a OK 201 a href CronJob a Created 202 a href CronJob a Accepted 401 Unauthorized update replace the specified CronJob HTTP Request PUT apis batch v1 namespaces namespace cronjobs name Parameters name in path string required name of the CronJob namespace in path string required a href namespace a body a href CronJob a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CronJob a OK 201 a href CronJob a Created 401 Unauthorized update replace status of the specified CronJob HTTP Request PUT apis batch v1 namespaces namespace cronjobs name status Parameters name in path string required name of the CronJob namespace in path string required a href namespace a body a href CronJob a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CronJob a OK 201 a href CronJob a Created 401 Unauthorized patch partially update the specified CronJob HTTP Request PATCH apis batch v1 namespaces namespace cronjobs name Parameters name in path string required name of the CronJob namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CronJob a OK 201 a href CronJob a Created 401 Unauthorized patch partially update status of the specified CronJob HTTP Request PATCH apis batch v1 namespaces namespace cronjobs name status Parameters name in path string required name of the CronJob namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CronJob a OK 201 a href CronJob a Created 401 Unauthorized delete delete a CronJob HTTP Request DELETE apis batch v1 namespaces namespace cronjobs name Parameters name in path string required name of the CronJob namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of CronJob HTTP Request DELETE apis batch v1 namespaces namespace cronjobs Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind HorizontalPodAutoscaler apiVersion autoscaling v1 title HorizontalPodAutoscaler configuration of a horizontal pod autoscaler contenttype apireference import k8s io api autoscaling v1 apimetadata weight 12 autogenerated true | ---
api_metadata:
apiVersion: "autoscaling/v1"
import: "k8s.io/api/autoscaling/v1"
kind: "HorizontalPodAutoscaler"
content_type: "api_reference"
description: "configuration of a horizontal pod autoscaler."
title: "HorizontalPodAutoscaler"
weight: 12
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.
-->
`apiVersion: autoscaling/v1`
`import "k8s.io/api/autoscaling/v1"`
## HorizontalPodAutoscaler {#HorizontalPodAutoscaler}
configuration of a horizontal pod autoscaler.
<hr>
- **apiVersion**: autoscaling/v1
- **kind**: HorizontalPodAutoscaler
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">HorizontalPodAutoscalerSpec</a>)
spec defines the behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
- **status** (<a href="">HorizontalPodAutoscalerStatus</a>)
status is the current information about the autoscaler.
## HorizontalPodAutoscalerSpec {#HorizontalPodAutoscalerSpec}
specification of a horizontal pod autoscaler.
<hr>
- **maxReplicas** (int32), required
maxReplicas is the upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
- **scaleTargetRef** (CrossVersionObjectReference), required
reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
<a name="CrossVersionObjectReference"></a>
*CrossVersionObjectReference contains enough information to let you identify the referred resource.*
- **scaleTargetRef.kind** (string), required
kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **scaleTargetRef.name** (string), required
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **scaleTargetRef.apiVersion** (string)
apiVersion is the API version of the referent
- **minReplicas** (int32)
minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
- **targetCPUUtilizationPercentage** (int32)
targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
## HorizontalPodAutoscalerStatus {#HorizontalPodAutoscalerStatus}
current status of a horizontal pod autoscaler
<hr>
- **currentReplicas** (int32), required
currentReplicas is the current number of replicas of pods managed by this autoscaler.
- **desiredReplicas** (int32), required
desiredReplicas is the desired number of replicas of pods managed by this autoscaler.
- **currentCPUUtilizationPercentage** (int32)
currentCPUUtilizationPercentage is the current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
- **lastScaleTime** (Time)
lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **observedGeneration** (int64)
observedGeneration is the most recent generation observed by this autoscaler.
## HorizontalPodAutoscalerList {#HorizontalPodAutoscalerList}
list of horizontal pod autoscaler objects.
<hr>
- **apiVersion**: autoscaling/v1
- **kind**: HorizontalPodAutoscalerList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata.
- **items** ([]<a href="">HorizontalPodAutoscaler</a>), required
items is the list of horizontal pod autoscaler objects.
## Operations {#Operations}
<hr>
### `get` read the specified HorizontalPodAutoscaler
#### HTTP Request
GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
### `get` read status of the specified HorizontalPodAutoscaler
#### HTTP Request
GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
### `list` list or watch objects of kind HorizontalPodAutoscaler
#### HTTP Request
GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">HorizontalPodAutoscalerList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind HorizontalPodAutoscaler
#### HTTP Request
GET /apis/autoscaling/v1/horizontalpodautoscalers
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">HorizontalPodAutoscalerList</a>): OK
401: Unauthorized
### `create` create a HorizontalPodAutoscaler
#### HTTP Request
POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">HorizontalPodAutoscaler</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
202 (<a href="">HorizontalPodAutoscaler</a>): Accepted
401: Unauthorized
### `update` replace the specified HorizontalPodAutoscaler
#### HTTP Request
PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">HorizontalPodAutoscaler</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
### `update` replace status of the specified HorizontalPodAutoscaler
#### HTTP Request
PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">HorizontalPodAutoscaler</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
### `patch` partially update the specified HorizontalPodAutoscaler
#### HTTP Request
PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
### `patch` partially update status of the specified HorizontalPodAutoscaler
#### HTTP Request
PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
### `delete` delete a HorizontalPodAutoscaler
#### HTTP Request
DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of HorizontalPodAutoscaler
#### HTTP Request
DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion autoscaling v1 import k8s io api autoscaling v1 kind HorizontalPodAutoscaler content type api reference description configuration of a horizontal pod autoscaler title HorizontalPodAutoscaler weight 12 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 apiVersion autoscaling v1 import k8s io api autoscaling v1 HorizontalPodAutoscaler HorizontalPodAutoscaler configuration of a horizontal pod autoscaler hr apiVersion autoscaling v1 kind HorizontalPodAutoscaler metadata a href ObjectMeta a Standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href HorizontalPodAutoscalerSpec a spec defines the behaviour of autoscaler More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href HorizontalPodAutoscalerStatus a status is the current information about the autoscaler HorizontalPodAutoscalerSpec HorizontalPodAutoscalerSpec specification of a horizontal pod autoscaler hr maxReplicas int32 required maxReplicas is the upper limit for the number of pods that can be set by the autoscaler cannot be smaller than MinReplicas scaleTargetRef CrossVersionObjectReference required reference to scaled resource horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource a name CrossVersionObjectReference a CrossVersionObjectReference contains enough information to let you identify the referred resource scaleTargetRef kind string required kind is the kind of the referent More info https git k8s io community contributors devel sig architecture api conventions md types kinds scaleTargetRef name string required name is the name of the referent More info https kubernetes io docs concepts overview working with objects names names scaleTargetRef apiVersion string apiVersion is the API version of the referent minReplicas int32 minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down It defaults to 1 pod minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured Scaling is active as long as at least one metric value is available targetCPUUtilizationPercentage int32 targetCPUUtilizationPercentage is the target average CPU utilization represented as a percentage of requested CPU over all the pods if not specified the default autoscaling policy will be used HorizontalPodAutoscalerStatus HorizontalPodAutoscalerStatus current status of a horizontal pod autoscaler hr currentReplicas int32 required currentReplicas is the current number of replicas of pods managed by this autoscaler desiredReplicas int32 required desiredReplicas is the desired number of replicas of pods managed by this autoscaler currentCPUUtilizationPercentage int32 currentCPUUtilizationPercentage is the current average CPU utilization over all pods represented as a percentage of requested CPU e g 70 means that an average pod is using now 70 of its requested CPU lastScaleTime Time lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods used by the autoscaler to control how often the number of pods is changed a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers observedGeneration int64 observedGeneration is the most recent generation observed by this autoscaler HorizontalPodAutoscalerList HorizontalPodAutoscalerList list of horizontal pod autoscaler objects hr apiVersion autoscaling v1 kind HorizontalPodAutoscalerList metadata a href ListMeta a Standard list metadata items a href HorizontalPodAutoscaler a required items is the list of horizontal pod autoscaler objects Operations Operations hr get read the specified HorizontalPodAutoscaler HTTP Request GET apis autoscaling v1 namespaces namespace horizontalpodautoscalers name Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 401 Unauthorized get read status of the specified HorizontalPodAutoscaler HTTP Request GET apis autoscaling v1 namespaces namespace horizontalpodautoscalers name status Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 401 Unauthorized list list or watch objects of kind HorizontalPodAutoscaler HTTP Request GET apis autoscaling v1 namespaces namespace horizontalpodautoscalers Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href HorizontalPodAutoscalerList a OK 401 Unauthorized list list or watch objects of kind HorizontalPodAutoscaler HTTP Request GET apis autoscaling v1 horizontalpodautoscalers Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href HorizontalPodAutoscalerList a OK 401 Unauthorized create create a HorizontalPodAutoscaler HTTP Request POST apis autoscaling v1 namespaces namespace horizontalpodautoscalers Parameters namespace in path string required a href namespace a body a href HorizontalPodAutoscaler a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 202 a href HorizontalPodAutoscaler a Accepted 401 Unauthorized update replace the specified HorizontalPodAutoscaler HTTP Request PUT apis autoscaling v1 namespaces namespace horizontalpodautoscalers name Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href HorizontalPodAutoscaler a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 401 Unauthorized update replace status of the specified HorizontalPodAutoscaler HTTP Request PUT apis autoscaling v1 namespaces namespace horizontalpodautoscalers name status Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href HorizontalPodAutoscaler a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 401 Unauthorized patch partially update the specified HorizontalPodAutoscaler HTTP Request PATCH apis autoscaling v1 namespaces namespace horizontalpodautoscalers name Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 401 Unauthorized patch partially update status of the specified HorizontalPodAutoscaler HTTP Request PATCH apis autoscaling v1 namespaces namespace horizontalpodautoscalers name status Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 401 Unauthorized delete delete a HorizontalPodAutoscaler HTTP Request DELETE apis autoscaling v1 namespaces namespace horizontalpodautoscalers name Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of HorizontalPodAutoscaler HTTP Request DELETE apis autoscaling v1 namespaces namespace horizontalpodautoscalers Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference weight 7 title StatefulSet StatefulSet represents a set of pods with consistent identities apiVersion apps v1 contenttype apireference apimetadata kind StatefulSet autogenerated true import k8s io api apps v1 | ---
api_metadata:
apiVersion: "apps/v1"
import: "k8s.io/api/apps/v1"
kind: "StatefulSet"
content_type: "api_reference"
description: "StatefulSet represents a set of pods with consistent identities."
title: "StatefulSet"
weight: 7
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.
-->
`apiVersion: apps/v1`
`import "k8s.io/api/apps/v1"`
## StatefulSet {#StatefulSet}
StatefulSet represents a set of pods with consistent identities. Identities are defined as:
- Network: A single stable DNS and hostname.
- Storage: As many VolumeClaims as requested.
The StatefulSet guarantees that a given network identity will always map to the same storage identity.
<hr>
- **apiVersion**: apps/v1
- **kind**: StatefulSet
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">StatefulSetSpec</a>)
Spec defines the desired identities of pods in this set.
- **status** (<a href="">StatefulSetStatus</a>)
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
## StatefulSetSpec {#StatefulSetSpec}
A StatefulSetSpec is the specification of a StatefulSet.
<hr>
- **serviceName** (string), required
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
- **selector** (<a href="">LabelSelector</a>), required
selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **template** (<a href="">PodTemplateSpec</a>), required
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format \<statefulsetname>-\<podindex>. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always".
- **replicas** (int32)
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
- **updateStrategy** (StatefulSetUpdateStrategy)
updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
<a name="StatefulSetUpdateStrategy"></a>
*StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.*
- **updateStrategy.type** (string)
Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
- **updateStrategy.rollingUpdate** (RollingUpdateStatefulSetStrategy)
RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
<a name="RollingUpdateStatefulSetStrategy"></a>
*RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.*
- **updateStrategy.rollingUpdate.maxUnavailable** (IntOrString)
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0. Defaults to 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **updateStrategy.rollingUpdate.partition** (int32)
Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.
- **podManagementPolicy** (string)
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
- **revisionHistoryLimit** (int32)
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
- **volumeClaimTemplates** ([]<a href="">PersistentVolumeClaim</a>)
*Atomic: will be replaced during a merge*
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
- **minReadySeconds** (int32)
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
- **persistentVolumeClaimRetentionPolicy** (StatefulSetPersistentVolumeClaimRetentionPolicy)
persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is beta.
<a name="StatefulSetPersistentVolumeClaimRetentionPolicy"></a>
*StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.*
- **persistentVolumeClaimRetentionPolicy.whenDeleted** (string)
WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet deletion. The `Delete` policy causes those PVCs to be deleted.
- **persistentVolumeClaimRetentionPolicy.whenScaled** (string)
WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a scaledown. The `Delete` policy causes the associated PVCs for any excess pods above the replica count to be deleted.
- **ordinals** (StatefulSetOrdinals)
ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested.
<a name="StatefulSetOrdinals"></a>
*StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet.*
- **ordinals.start** (int32)
start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive movement of replicas from one StatefulSet to another. If set, replica indices will be in the range:
[.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
If unset, defaults to 0. Replica indices will be in the range:
[0, .spec.replicas).
## StatefulSetStatus {#StatefulSetStatus}
StatefulSetStatus represents the current state of a StatefulSet.
<hr>
- **replicas** (int32), required
replicas is the number of Pods created by the StatefulSet controller.
- **readyReplicas** (int32)
readyReplicas is the number of pods created for this StatefulSet with a Ready Condition.
- **currentReplicas** (int32)
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
- **updatedReplicas** (int32)
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
- **availableReplicas** (int32)
Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset.
- **collisionCount** (int32)
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
- **conditions** ([]StatefulSetCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Represents the latest available observations of a statefulset's current state.
<a name="StatefulSetCondition"></a>
*StatefulSetCondition describes the state of a statefulset at a certain point.*
- **conditions.status** (string), required
Status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
Type of statefulset condition.
- **conditions.lastTransitionTime** (Time)
Last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
A human readable message indicating details about the transition.
- **conditions.reason** (string)
The reason for the condition's last transition.
- **currentRevision** (string)
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
- **updateRevision** (string)
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
- **observedGeneration** (int64)
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
## StatefulSetList {#StatefulSetList}
StatefulSetList is a collection of StatefulSets.
<hr>
- **apiVersion**: apps/v1
- **kind**: StatefulSetList
- **metadata** (<a href="">ListMeta</a>)
Standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">StatefulSet</a>), required
Items is the list of stateful sets.
## Operations {#Operations}
<hr>
### `get` read the specified StatefulSet
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StatefulSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StatefulSet</a>): OK
401: Unauthorized
### `get` read status of the specified StatefulSet
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the StatefulSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StatefulSet</a>): OK
401: Unauthorized
### `list` list or watch objects of kind StatefulSet
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/statefulsets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">StatefulSetList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind StatefulSet
#### HTTP Request
GET /apis/apps/v1/statefulsets
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">StatefulSetList</a>): OK
401: Unauthorized
### `create` create a StatefulSet
#### HTTP Request
POST /apis/apps/v1/namespaces/{namespace}/statefulsets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">StatefulSet</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StatefulSet</a>): OK
201 (<a href="">StatefulSet</a>): Created
202 (<a href="">StatefulSet</a>): Accepted
401: Unauthorized
### `update` replace the specified StatefulSet
#### HTTP Request
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StatefulSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">StatefulSet</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StatefulSet</a>): OK
201 (<a href="">StatefulSet</a>): Created
401: Unauthorized
### `update` replace status of the specified StatefulSet
#### HTTP Request
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the StatefulSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">StatefulSet</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StatefulSet</a>): OK
201 (<a href="">StatefulSet</a>): Created
401: Unauthorized
### `patch` partially update the specified StatefulSet
#### HTTP Request
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StatefulSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StatefulSet</a>): OK
201 (<a href="">StatefulSet</a>): Created
401: Unauthorized
### `patch` partially update status of the specified StatefulSet
#### HTTP Request
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the StatefulSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StatefulSet</a>): OK
201 (<a href="">StatefulSet</a>): Created
401: Unauthorized
### `delete` delete a StatefulSet
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StatefulSet
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of StatefulSet
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion apps v1 import k8s io api apps v1 kind StatefulSet content type api reference description StatefulSet represents a set of pods with consistent identities title StatefulSet weight 7 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 apiVersion apps v1 import k8s io api apps v1 StatefulSet StatefulSet StatefulSet represents a set of pods with consistent identities Identities are defined as Network A single stable DNS and hostname Storage As many VolumeClaims as requested The StatefulSet guarantees that a given network identity will always map to the same storage identity hr apiVersion apps v1 kind StatefulSet metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href StatefulSetSpec a Spec defines the desired identities of pods in this set status a href StatefulSetStatus a Status is the current status of Pods in this StatefulSet This data may be out of date by some window of time StatefulSetSpec StatefulSetSpec A StatefulSetSpec is the specification of a StatefulSet hr serviceName string required serviceName is the name of the service that governs this StatefulSet This service must exist before the StatefulSet and is responsible for the network identity of the set Pods get DNS hostnames that follow the pattern pod specific string serviceName default svc cluster local where pod specific string is managed by the StatefulSet controller selector a href LabelSelector a required selector is a label query over pods that should match the replica count It must match the pod template s labels More info https kubernetes io docs concepts overview working with objects labels label selectors template a href PodTemplateSpec a required template is the object that describes the pod that will be created if insufficient replicas are detected Each pod stamped out by the StatefulSet will fulfill this Template but have a unique identity from the rest of the StatefulSet Each pod will be named with the format statefulsetname podindex For example a pod in a StatefulSet named web with index number 3 would be named web 3 The only allowed template spec restartPolicy value is Always replicas int32 replicas is the desired number of replicas of the given Template These are replicas in the sense that they are instantiations of the same Template but individual replicas also have a consistent identity If unspecified defaults to 1 updateStrategy StatefulSetUpdateStrategy updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template a name StatefulSetUpdateStrategy a StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates It includes any additional parameters necessary to perform the update for the indicated strategy updateStrategy type string Type indicates the type of the StatefulSetUpdateStrategy Default is RollingUpdate updateStrategy rollingUpdate RollingUpdateStatefulSetStrategy RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType a name RollingUpdateStatefulSetStrategy a RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType updateStrategy rollingUpdate maxUnavailable IntOrString The maximum number of pods that can be unavailable during the update Value can be an absolute number ex 5 or a percentage of desired pods ex 10 Absolute number is calculated from percentage by rounding up This can not be 0 Defaults to 1 This field is alpha level and is only honored by servers that enable the MaxUnavailableStatefulSet feature The field applies to all pods in the range 0 to Replicas 1 That means if there is any unavailable pod in the range 0 to Replicas 1 it will be counted towards MaxUnavailable a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number updateStrategy rollingUpdate partition int32 Partition indicates the ordinal at which the StatefulSet should be partitioned for updates During a rolling update all pods from ordinal Replicas 1 to Partition are updated All pods from ordinal Partition 1 to 0 remain untouched This is helpful in being able to do a canary based deployment The default value is 0 podManagementPolicy string podManagementPolicy controls how pods are created during initial scale up when replacing pods on nodes or when scaling down The default policy is OrderedReady where pods are created in increasing order pod 0 then pod 1 etc and the controller will wait until each pod is ready before continuing When scaling down the pods are removed in the opposite order The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting and on scale down will delete all pods at once revisionHistoryLimit int32 revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet s revision history The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version The default value is 10 volumeClaimTemplates a href PersistentVolumeClaim a Atomic will be replaced during a merge volumeClaimTemplates is a list of claims that pods are allowed to reference The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod Every claim in this list must have at least one matching by name volumeMount in one container in the template A claim in this list takes precedence over any volumes in the template with the same name minReadySeconds int32 Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available Defaults to 0 pod will be considered available as soon as it is ready persistentVolumeClaimRetentionPolicy StatefulSetPersistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates By default all persistent volume claims are created as needed and retained until manually deleted This policy allows the lifecycle to be altered for example by deleting persistent volume claims when their stateful set is deleted or when their pod is scaled down This requires the StatefulSetAutoDeletePVC feature gate to be enabled which is beta a name StatefulSetPersistentVolumeClaimRetentionPolicy a StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates persistentVolumeClaimRetentionPolicy whenDeleted string WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted The default policy of Retain causes PVCs to not be affected by StatefulSet deletion The Delete policy causes those PVCs to be deleted persistentVolumeClaimRetentionPolicy whenScaled string WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down The default policy of Retain causes PVCs to not be affected by a scaledown The Delete policy causes the associated PVCs for any excess pods above the replica count to be deleted ordinals StatefulSetOrdinals ordinals controls the numbering of replica indices in a StatefulSet The default ordinals behavior assigns a 0 index to the first replica and increments the index by one for each additional replica requested a name StatefulSetOrdinals a StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet ordinals start int32 start is the number representing the first replica s index It may be used to number replicas from an alternate index eg 1 indexed over the default 0 indexed names or to orchestrate progressive movement of replicas from one StatefulSet to another If set replica indices will be in the range spec ordinals start spec ordinals start spec replicas If unset defaults to 0 Replica indices will be in the range 0 spec replicas StatefulSetStatus StatefulSetStatus StatefulSetStatus represents the current state of a StatefulSet hr replicas int32 required replicas is the number of Pods created by the StatefulSet controller readyReplicas int32 readyReplicas is the number of pods created for this StatefulSet with a Ready Condition currentReplicas int32 currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision updatedReplicas int32 updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision availableReplicas int32 Total number of available pods ready for at least minReadySeconds targeted by this statefulset collisionCount int32 collisionCount is the count of hash collisions for the StatefulSet The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision conditions StatefulSetCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge Represents the latest available observations of a statefulset s current state a name StatefulSetCondition a StatefulSetCondition describes the state of a statefulset at a certain point conditions status string required Status of the condition one of True False Unknown conditions type string required Type of statefulset condition conditions lastTransitionTime Time Last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string A human readable message indicating details about the transition conditions reason string The reason for the condition s last transition currentRevision string currentRevision if not empty indicates the version of the StatefulSet used to generate Pods in the sequence 0 currentReplicas updateRevision string updateRevision if not empty indicates the version of the StatefulSet used to generate Pods in the sequence replicas updatedReplicas replicas observedGeneration int64 observedGeneration is the most recent generation observed for this StatefulSet It corresponds to the StatefulSet s generation which is updated on mutation by the API Server StatefulSetList StatefulSetList StatefulSetList is a collection of StatefulSets hr apiVersion apps v1 kind StatefulSetList metadata a href ListMeta a Standard list s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href StatefulSet a required Items is the list of stateful sets Operations Operations hr get read the specified StatefulSet HTTP Request GET apis apps v1 namespaces namespace statefulsets name Parameters name in path string required name of the StatefulSet namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href StatefulSet a OK 401 Unauthorized get read status of the specified StatefulSet HTTP Request GET apis apps v1 namespaces namespace statefulsets name status Parameters name in path string required name of the StatefulSet namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href StatefulSet a OK 401 Unauthorized list list or watch objects of kind StatefulSet HTTP Request GET apis apps v1 namespaces namespace statefulsets Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href StatefulSetList a OK 401 Unauthorized list list or watch objects of kind StatefulSet HTTP Request GET apis apps v1 statefulsets Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href StatefulSetList a OK 401 Unauthorized create create a StatefulSet HTTP Request POST apis apps v1 namespaces namespace statefulsets Parameters namespace in path string required a href namespace a body a href StatefulSet a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href StatefulSet a OK 201 a href StatefulSet a Created 202 a href StatefulSet a Accepted 401 Unauthorized update replace the specified StatefulSet HTTP Request PUT apis apps v1 namespaces namespace statefulsets name Parameters name in path string required name of the StatefulSet namespace in path string required a href namespace a body a href StatefulSet a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href StatefulSet a OK 201 a href StatefulSet a Created 401 Unauthorized update replace status of the specified StatefulSet HTTP Request PUT apis apps v1 namespaces namespace statefulsets name status Parameters name in path string required name of the StatefulSet namespace in path string required a href namespace a body a href StatefulSet a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href StatefulSet a OK 201 a href StatefulSet a Created 401 Unauthorized patch partially update the specified StatefulSet HTTP Request PATCH apis apps v1 namespaces namespace statefulsets name Parameters name in path string required name of the StatefulSet namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href StatefulSet a OK 201 a href StatefulSet a Created 401 Unauthorized patch partially update status of the specified StatefulSet HTTP Request PATCH apis apps v1 namespaces namespace statefulsets name status Parameters name in path string required name of the StatefulSet namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href StatefulSet a OK 201 a href StatefulSet a Created 401 Unauthorized delete delete a StatefulSet HTTP Request DELETE apis apps v1 namespaces namespace statefulsets name Parameters name in path string required name of the StatefulSet namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of StatefulSet HTTP Request DELETE apis apps v1 namespaces namespace statefulsets Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title ResourceSlice v1alpha3 contenttype apireference apiVersion resource k8s io v1alpha3 weight 18 import k8s io api resource v1alpha3 apimetadata ResourceSlice represents one or more resources in a pool of similar resources managed by a common driver autogenerated true kind ResourceSlice | ---
api_metadata:
apiVersion: "resource.k8s.io/v1alpha3"
import: "k8s.io/api/resource/v1alpha3"
kind: "ResourceSlice"
content_type: "api_reference"
description: "ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver."
title: "ResourceSlice v1alpha3"
weight: 18
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.
-->
`apiVersion: resource.k8s.io/v1alpha3`
`import "k8s.io/api/resource/v1alpha3"`
## ResourceSlice {#ResourceSlice}
ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.
At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple \<driver name>, \<pool name>, \<device name>.
Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.
When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.
For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: ResourceSlice
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata
- **spec** (<a href="">ResourceSliceSpec</a>), required
Contains the information published by the driver.
Changing the spec automatically increments the metadata.generation number.
## ResourceSliceSpec {#ResourceSliceSpec}
ResourceSliceSpec contains the information published by the driver in one ResourceSlice.
<hr>
- **driver** (string), required
Driver identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name.
Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver. This field is immutable.
- **pool** (ResourcePool), required
Pool describes the pool that this ResourceSlice belongs to.
<a name="ResourcePool"></a>
*ResourcePool describes the pool that ResourceSlices belong to.*
- **pool.generation** (int64), required
Generation tracks the change in a pool over time. Whenever a driver changes something about one or more of the resources in a pool, it must change the generation in all ResourceSlices which are part of that pool. Consumers of ResourceSlices should only consider resources from the pool with the highest generation number. The generation may be reset by drivers, which should be fine for consumers, assuming that all ResourceSlices in a pool are updated to match or deleted.
Combined with ResourceSliceCount, this mechanism enables consumers to detect pools which are comprised of multiple ResourceSlices and are in an incomplete state.
- **pool.name** (string), required
Name is used to identify the pool. For node-local devices, this is often the node name, but this is not required.
It must not be longer than 253 characters and must consist of one or more DNS sub-domains separated by slashes. This field is immutable.
- **pool.resourceSliceCount** (int64), required
ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero.
Consumers can use this to check whether they have seen all ResourceSlices belonging to the same pool.
- **allNodes** (boolean)
AllNodes indicates that all nodes have access to the resources in the pool.
Exactly one of NodeName, NodeSelector and AllNodes must be set.
- **devices** ([]Device)
*Atomic: will be replaced during a merge*
Devices lists some or all of the devices in this pool.
Must not have more than 128 entries.
<a name="Device"></a>
*Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set.*
- **devices.name** (string), required
Name is unique identifier among all devices managed by the driver in the pool. It must be a DNS label.
- **devices.basic** (BasicDevice)
Basic defines one device instance.
<a name="BasicDevice"></a>
*BasicDevice defines one device instance.*
- **devices.basic.attributes** (map[string]DeviceAttribute)
Attributes defines the set of attributes for this device. The name of each attribute must be unique in that set.
The maximum number of attributes and capacities combined is 32.
<a name="DeviceAttribute"></a>
*DeviceAttribute must have exactly one field set.*
- **devices.basic.attributes.bool** (boolean)
BoolValue is a true/false value.
- **devices.basic.attributes.int** (int64)
IntValue is a number.
- **devices.basic.attributes.string** (string)
StringValue is a string. Must not be longer than 64 characters.
- **devices.basic.attributes.version** (string)
VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters.
- **devices.basic.capacity** (map[string]<a href="">Quantity</a>)
Capacity defines the set of capacities for this device. The name of each capacity must be unique in that set.
The maximum number of attributes and capacities combined is 32.
- **nodeName** (string)
NodeName identifies the node which provides the resources in this pool. A field selector can be used to list only ResourceSlice objects belonging to a certain node.
This field can be used to limit access from nodes to ResourceSlices with the same node name. It also indicates to autoscalers that adding new nodes of the same type as some old node might also make new resources available.
Exactly one of NodeName, NodeSelector and AllNodes must be set. This field is immutable.
- **nodeSelector** (NodeSelector)
NodeSelector defines which nodes have access to the resources in the pool, when that pool is not limited to a single node.
Must use exactly one term.
Exactly one of NodeName, NodeSelector and AllNodes must be set.
<a name="NodeSelector"></a>
*A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.*
- **nodeSelector.nodeSelectorTerms** ([]NodeSelectorTerm), required
*Atomic: will be replaced during a merge*
Required. A list of node selector terms. The terms are ORed.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **nodeSelector.nodeSelectorTerms.matchExpressions** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's labels.
- **nodeSelector.nodeSelectorTerms.matchFields** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's fields.
## ResourceSliceList {#ResourceSliceList}
ResourceSliceList is a collection of ResourceSlices.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: ResourceSliceList
- **items** ([]<a href="">ResourceSlice</a>), required
Items is the list of resource ResourceSlices.
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata
## Operations {#Operations}
<hr>
### `get` read the specified ResourceSlice
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/resourceslices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceSlice
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceSlice</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ResourceSlice
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/resourceslices
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ResourceSliceList</a>): OK
401: Unauthorized
### `create` create a ResourceSlice
#### HTTP Request
POST /apis/resource.k8s.io/v1alpha3/resourceslices
#### Parameters
- **body**: <a href="">ResourceSlice</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceSlice</a>): OK
201 (<a href="">ResourceSlice</a>): Created
202 (<a href="">ResourceSlice</a>): Accepted
401: Unauthorized
### `update` replace the specified ResourceSlice
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha3/resourceslices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceSlice
- **body**: <a href="">ResourceSlice</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceSlice</a>): OK
201 (<a href="">ResourceSlice</a>): Created
401: Unauthorized
### `patch` partially update the specified ResourceSlice
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha3/resourceslices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceSlice
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceSlice</a>): OK
201 (<a href="">ResourceSlice</a>): Created
401: Unauthorized
### `delete` delete a ResourceSlice
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/resourceslices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceSlice
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">ResourceSlice</a>): OK
202 (<a href="">ResourceSlice</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ResourceSlice
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/resourceslices
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 kind ResourceSlice content type api reference description ResourceSlice represents one or more resources in a pool of similar resources managed by a common driver title ResourceSlice v1alpha3 weight 18 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 apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 ResourceSlice ResourceSlice ResourceSlice represents one or more resources in a pool of similar resources managed by a common driver A pool may span more than one ResourceSlice and exactly how many ResourceSlices comprise a pool is determined by the driver At the moment the only supported resources are devices with attributes and capacities Each device in a given pool regardless of how many ResourceSlices must have a unique name The ResourceSlice in which a device gets published may change over time The unique identifier for a device is the tuple driver name pool name device name Whenever a driver needs to update a pool it increments the pool Spec Pool Generation number and updates all ResourceSlices with that new number and new resource definitions A consumer must only use ResourceSlices with the highest generation number and ignore all others When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives a consumer should check the number of ResourceSlices in a pool included in each ResourceSlice to determine whether its view of a pool is complete and if not should wait until the driver has completed updating the pool For resources that are not local to a node the node name is not set Instead the driver may use a node selector to specify where the devices are available This is an alpha type and requires enabling the DynamicResourceAllocation feature gate hr apiVersion resource k8s io v1alpha3 kind ResourceSlice metadata a href ObjectMeta a Standard object metadata spec a href ResourceSliceSpec a required Contains the information published by the driver Changing the spec automatically increments the metadata generation number ResourceSliceSpec ResourceSliceSpec ResourceSliceSpec contains the information published by the driver in one ResourceSlice hr driver string required Driver identifies the DRA driver providing the capacity information A field selector can be used to list only ResourceSlice objects with a certain driver name Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver This field is immutable pool ResourcePool required Pool describes the pool that this ResourceSlice belongs to a name ResourcePool a ResourcePool describes the pool that ResourceSlices belong to pool generation int64 required Generation tracks the change in a pool over time Whenever a driver changes something about one or more of the resources in a pool it must change the generation in all ResourceSlices which are part of that pool Consumers of ResourceSlices should only consider resources from the pool with the highest generation number The generation may be reset by drivers which should be fine for consumers assuming that all ResourceSlices in a pool are updated to match or deleted Combined with ResourceSliceCount this mechanism enables consumers to detect pools which are comprised of multiple ResourceSlices and are in an incomplete state pool name string required Name is used to identify the pool For node local devices this is often the node name but this is not required It must not be longer than 253 characters and must consist of one or more DNS sub domains separated by slashes This field is immutable pool resourceSliceCount int64 required ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number Must be greater than zero Consumers can use this to check whether they have seen all ResourceSlices belonging to the same pool allNodes boolean AllNodes indicates that all nodes have access to the resources in the pool Exactly one of NodeName NodeSelector and AllNodes must be set devices Device Atomic will be replaced during a merge Devices lists some or all of the devices in this pool Must not have more than 128 entries a name Device a Device represents one individual hardware instance that can be selected based on its attributes Besides the name exactly one field must be set devices name string required Name is unique identifier among all devices managed by the driver in the pool It must be a DNS label devices basic BasicDevice Basic defines one device instance a name BasicDevice a BasicDevice defines one device instance devices basic attributes map string DeviceAttribute Attributes defines the set of attributes for this device The name of each attribute must be unique in that set The maximum number of attributes and capacities combined is 32 a name DeviceAttribute a DeviceAttribute must have exactly one field set devices basic attributes bool boolean BoolValue is a true false value devices basic attributes int int64 IntValue is a number devices basic attributes string string StringValue is a string Must not be longer than 64 characters devices basic attributes version string VersionValue is a semantic version according to semver org spec 2 0 0 Must not be longer than 64 characters devices basic capacity map string a href Quantity a Capacity defines the set of capacities for this device The name of each capacity must be unique in that set The maximum number of attributes and capacities combined is 32 nodeName string NodeName identifies the node which provides the resources in this pool A field selector can be used to list only ResourceSlice objects belonging to a certain node This field can be used to limit access from nodes to ResourceSlices with the same node name It also indicates to autoscalers that adding new nodes of the same type as some old node might also make new resources available Exactly one of NodeName NodeSelector and AllNodes must be set This field is immutable nodeSelector NodeSelector NodeSelector defines which nodes have access to the resources in the pool when that pool is not limited to a single node Must use exactly one term Exactly one of NodeName NodeSelector and AllNodes must be set a name NodeSelector a A node selector represents the union of the results of one or more label queries over a set of nodes that is it represents the OR of the selectors represented by the node selector terms nodeSelector nodeSelectorTerms NodeSelectorTerm required Atomic will be replaced during a merge Required A list of node selector terms The terms are ORed a name NodeSelectorTerm a A null or empty node selector term matches no objects The requirements of them are ANDed The TopologySelectorTerm type implements a subset of the NodeSelectorTerm nodeSelector nodeSelectorTerms matchExpressions a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s labels nodeSelector nodeSelectorTerms matchFields a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s fields ResourceSliceList ResourceSliceList ResourceSliceList is a collection of ResourceSlices hr apiVersion resource k8s io v1alpha3 kind ResourceSliceList items a href ResourceSlice a required Items is the list of resource ResourceSlices metadata a href ListMeta a Standard list metadata Operations Operations hr get read the specified ResourceSlice HTTP Request GET apis resource k8s io v1alpha3 resourceslices name Parameters name in path string required name of the ResourceSlice pretty in query string a href pretty a Response 200 a href ResourceSlice a OK 401 Unauthorized list list or watch objects of kind ResourceSlice HTTP Request GET apis resource k8s io v1alpha3 resourceslices Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ResourceSliceList a OK 401 Unauthorized create create a ResourceSlice HTTP Request POST apis resource k8s io v1alpha3 resourceslices Parameters body a href ResourceSlice a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceSlice a OK 201 a href ResourceSlice a Created 202 a href ResourceSlice a Accepted 401 Unauthorized update replace the specified ResourceSlice HTTP Request PUT apis resource k8s io v1alpha3 resourceslices name Parameters name in path string required name of the ResourceSlice body a href ResourceSlice a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceSlice a OK 201 a href ResourceSlice a Created 401 Unauthorized patch partially update the specified ResourceSlice HTTP Request PATCH apis resource k8s io v1alpha3 resourceslices name Parameters name in path string required name of the ResourceSlice body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ResourceSlice a OK 201 a href ResourceSlice a Created 401 Unauthorized delete delete a ResourceSlice HTTP Request DELETE apis resource k8s io v1alpha3 resourceslices name Parameters name in path string required name of the ResourceSlice body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href ResourceSlice a OK 202 a href ResourceSlice a Accepted 401 Unauthorized deletecollection delete collection of ResourceSlice HTTP Request DELETE apis resource k8s io v1alpha3 resourceslices Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind HorizontalPodAutoscaler title HorizontalPodAutoscaler weight 13 contenttype apireference apiVersion autoscaling v2 apimetadata import k8s io api autoscaling v2 HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified autogenerated true | ---
api_metadata:
apiVersion: "autoscaling/v2"
import: "k8s.io/api/autoscaling/v2"
kind: "HorizontalPodAutoscaler"
content_type: "api_reference"
description: "HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified."
title: "HorizontalPodAutoscaler"
weight: 13
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.
-->
`apiVersion: autoscaling/v2`
`import "k8s.io/api/autoscaling/v2"`
## HorizontalPodAutoscaler {#HorizontalPodAutoscaler}
HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.
<hr>
- **apiVersion**: autoscaling/v2
- **kind**: HorizontalPodAutoscaler
- **metadata** (<a href="">ObjectMeta</a>)
metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">HorizontalPodAutoscalerSpec</a>)
spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
- **status** (<a href="">HorizontalPodAutoscalerStatus</a>)
status is the current information about the autoscaler.
## HorizontalPodAutoscalerSpec {#HorizontalPodAutoscalerSpec}
HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.
<hr>
- **maxReplicas** (int32), required
maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
- **scaleTargetRef** (CrossVersionObjectReference), required
scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
<a name="CrossVersionObjectReference"></a>
*CrossVersionObjectReference contains enough information to let you identify the referred resource.*
- **scaleTargetRef.kind** (string), required
kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **scaleTargetRef.name** (string), required
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **scaleTargetRef.apiVersion** (string)
apiVersion is the API version of the referent
- **minReplicas** (int32)
minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
- **behavior** (HorizontalPodAutoscalerBehavior)
behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.
<a name="HorizontalPodAutoscalerBehavior"></a>
*HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).*
- **behavior.scaleDown** (HPAScalingRules)
scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
<a name="HPAScalingRules"></a>
*HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.*
- **behavior.scaleDown.policies** ([]HPAScalingPolicy)
*Atomic: will be replaced during a merge*
policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
<a name="HPAScalingPolicy"></a>
*HPAScalingPolicy is a single policy which must hold true for a specified past interval.*
- **behavior.scaleDown.policies.type** (string), required
type is used to specify the scaling policy.
- **behavior.scaleDown.policies.value** (int32), required
value contains the amount of change which is permitted by the policy. It must be greater than zero
- **behavior.scaleDown.policies.periodSeconds** (int32), required
periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- **behavior.scaleDown.selectPolicy** (string)
selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
- **behavior.scaleDown.stabilizationWindowSeconds** (int32)
stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
- **behavior.scaleUp** (HPAScalingRules)
scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:
* increase no more than 4 pods per 60 seconds
* double the number of pods per 60 seconds
No stabilization is used.
<a name="HPAScalingRules"></a>
*HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.*
- **behavior.scaleUp.policies** ([]HPAScalingPolicy)
*Atomic: will be replaced during a merge*
policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
<a name="HPAScalingPolicy"></a>
*HPAScalingPolicy is a single policy which must hold true for a specified past interval.*
- **behavior.scaleUp.policies.type** (string), required
type is used to specify the scaling policy.
- **behavior.scaleUp.policies.value** (int32), required
value contains the amount of change which is permitted by the policy. It must be greater than zero
- **behavior.scaleUp.policies.periodSeconds** (int32), required
periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- **behavior.scaleUp.selectPolicy** (string)
selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
- **behavior.scaleUp.stabilizationWindowSeconds** (int32)
stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
- **metrics** ([]MetricSpec)
*Atomic: will be replaced during a merge*
metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.
<a name="MetricSpec"></a>
*MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).*
- **metrics.type** (string), required
type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- **metrics.containerResource** (ContainerResourceMetricSource)
containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
<a name="ContainerResourceMetricSource"></a>
*ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.*
- **metrics.containerResource.container** (string), required
container is the name of the container in the pods of the scaling target
- **metrics.containerResource.name** (string), required
name is the name of the resource in question.
- **metrics.containerResource.target** (MetricTarget), required
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.containerResource.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.containerResource.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.containerResource.target.averageValue** (<a href="">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.containerResource.target.value** (<a href="">Quantity</a>)
value is the target value of the metric (as a quantity).
- **metrics.external** (ExternalMetricSource)
external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
<a name="ExternalMetricSource"></a>
*ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).*
- **metrics.external.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **metrics.external.metric.name** (string), required
name is the name of the given metric
- **metrics.external.metric.selector** (<a href="">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **metrics.external.target** (MetricTarget), required
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.external.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.external.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.external.target.averageValue** (<a href="">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.external.target.value** (<a href="">Quantity</a>)
value is the target value of the metric (as a quantity).
- **metrics.object** (ObjectMetricSource)
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
<a name="ObjectMetricSource"></a>
*ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).*
- **metrics.object.describedObject** (CrossVersionObjectReference), required
describedObject specifies the descriptions of a object,such as kind,name apiVersion
<a name="CrossVersionObjectReference"></a>
*CrossVersionObjectReference contains enough information to let you identify the referred resource.*
- **metrics.object.describedObject.kind** (string), required
kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metrics.object.describedObject.name** (string), required
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **metrics.object.describedObject.apiVersion** (string)
apiVersion is the API version of the referent
- **metrics.object.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **metrics.object.metric.name** (string), required
name is the name of the given metric
- **metrics.object.metric.selector** (<a href="">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **metrics.object.target** (MetricTarget), required
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.object.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.object.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.object.target.averageValue** (<a href="">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.object.target.value** (<a href="">Quantity</a>)
value is the target value of the metric (as a quantity).
- **metrics.pods** (PodsMetricSource)
pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
<a name="PodsMetricSource"></a>
*PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.*
- **metrics.pods.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **metrics.pods.metric.name** (string), required
name is the name of the given metric
- **metrics.pods.metric.selector** (<a href="">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **metrics.pods.target** (MetricTarget), required
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.pods.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.pods.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.pods.target.averageValue** (<a href="">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.pods.target.value** (<a href="">Quantity</a>)
value is the target value of the metric (as a quantity).
- **metrics.resource** (ResourceMetricSource)
resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
<a name="ResourceMetricSource"></a>
*ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.*
- **metrics.resource.name** (string), required
name is the name of the resource in question.
- **metrics.resource.target** (MetricTarget), required
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.resource.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.resource.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.resource.target.averageValue** (<a href="">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.resource.target.value** (<a href="">Quantity</a>)
value is the target value of the metric (as a quantity).
## HorizontalPodAutoscalerStatus {#HorizontalPodAutoscalerStatus}
HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.
<hr>
- **desiredReplicas** (int32), required
desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
- **conditions** ([]HorizontalPodAutoscalerCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
<a name="HorizontalPodAutoscalerCondition"></a>
*HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.*
- **conditions.status** (string), required
status is the status of the condition (True, False, Unknown)
- **conditions.type** (string), required
type describes the current condition
- **conditions.lastTransitionTime** (Time)
lastTransitionTime is the last time the condition transitioned from one status to another
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
message is a human-readable explanation containing details about the transition
- **conditions.reason** (string)
reason is the reason for the condition's last transition.
- **currentMetrics** ([]MetricStatus)
*Atomic: will be replaced during a merge*
currentMetrics is the last read state of the metrics used by this autoscaler.
<a name="MetricStatus"></a>
*MetricStatus describes the last-read state of a single metric.*
- **currentMetrics.type** (string), required
type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- **currentMetrics.containerResource** (ContainerResourceMetricStatus)
container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
<a name="ContainerResourceMetricStatus"></a>
*ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.*
- **currentMetrics.containerResource.container** (string), required
container is the name of the container in the pods of the scaling target
- **currentMetrics.containerResource.current** (MetricValueStatus), required
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.containerResource.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.containerResource.current.averageValue** (<a href="">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.containerResource.current.value** (<a href="">Quantity</a>)
value is the current value of the metric (as a quantity).
- **currentMetrics.containerResource.name** (string), required
name is the name of the resource in question.
- **currentMetrics.external** (ExternalMetricStatus)
external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
<a name="ExternalMetricStatus"></a>
*ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.*
- **currentMetrics.external.current** (MetricValueStatus), required
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.external.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.external.current.averageValue** (<a href="">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.external.current.value** (<a href="">Quantity</a>)
value is the current value of the metric (as a quantity).
- **currentMetrics.external.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **currentMetrics.external.metric.name** (string), required
name is the name of the given metric
- **currentMetrics.external.metric.selector** (<a href="">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **currentMetrics.object** (ObjectMetricStatus)
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
<a name="ObjectMetricStatus"></a>
*ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).*
- **currentMetrics.object.current** (MetricValueStatus), required
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.object.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.object.current.averageValue** (<a href="">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.object.current.value** (<a href="">Quantity</a>)
value is the current value of the metric (as a quantity).
- **currentMetrics.object.describedObject** (CrossVersionObjectReference), required
DescribedObject specifies the descriptions of a object,such as kind,name apiVersion
<a name="CrossVersionObjectReference"></a>
*CrossVersionObjectReference contains enough information to let you identify the referred resource.*
- **currentMetrics.object.describedObject.kind** (string), required
kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **currentMetrics.object.describedObject.name** (string), required
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **currentMetrics.object.describedObject.apiVersion** (string)
apiVersion is the API version of the referent
- **currentMetrics.object.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **currentMetrics.object.metric.name** (string), required
name is the name of the given metric
- **currentMetrics.object.metric.selector** (<a href="">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **currentMetrics.pods** (PodsMetricStatus)
pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
<a name="PodsMetricStatus"></a>
*PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).*
- **currentMetrics.pods.current** (MetricValueStatus), required
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.pods.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.pods.current.averageValue** (<a href="">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.pods.current.value** (<a href="">Quantity</a>)
value is the current value of the metric (as a quantity).
- **currentMetrics.pods.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **currentMetrics.pods.metric.name** (string), required
name is the name of the given metric
- **currentMetrics.pods.metric.selector** (<a href="">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **currentMetrics.resource** (ResourceMetricStatus)
resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
<a name="ResourceMetricStatus"></a>
*ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.*
- **currentMetrics.resource.current** (MetricValueStatus), required
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.resource.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.resource.current.averageValue** (<a href="">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.resource.current.value** (<a href="">Quantity</a>)
value is the current value of the metric (as a quantity).
- **currentMetrics.resource.name** (string), required
name is the name of the resource in question.
- **currentReplicas** (int32)
currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
- **lastScaleTime** (Time)
lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **observedGeneration** (int64)
observedGeneration is the most recent generation observed by this autoscaler.
## HorizontalPodAutoscalerList {#HorizontalPodAutoscalerList}
HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.
<hr>
- **apiVersion**: autoscaling/v2
- **kind**: HorizontalPodAutoscalerList
- **metadata** (<a href="">ListMeta</a>)
metadata is the standard list metadata.
- **items** ([]<a href="">HorizontalPodAutoscaler</a>), required
items is the list of horizontal pod autoscaler objects.
## Operations {#Operations}
<hr>
### `get` read the specified HorizontalPodAutoscaler
#### HTTP Request
GET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
### `get` read status of the specified HorizontalPodAutoscaler
#### HTTP Request
GET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
### `list` list or watch objects of kind HorizontalPodAutoscaler
#### HTTP Request
GET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">HorizontalPodAutoscalerList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind HorizontalPodAutoscaler
#### HTTP Request
GET /apis/autoscaling/v2/horizontalpodautoscalers
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">HorizontalPodAutoscalerList</a>): OK
401: Unauthorized
### `create` create a HorizontalPodAutoscaler
#### HTTP Request
POST /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">HorizontalPodAutoscaler</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
202 (<a href="">HorizontalPodAutoscaler</a>): Accepted
401: Unauthorized
### `update` replace the specified HorizontalPodAutoscaler
#### HTTP Request
PUT /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">HorizontalPodAutoscaler</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
### `update` replace status of the specified HorizontalPodAutoscaler
#### HTTP Request
PUT /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">HorizontalPodAutoscaler</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
### `patch` partially update the specified HorizontalPodAutoscaler
#### HTTP Request
PATCH /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
### `patch` partially update status of the specified HorizontalPodAutoscaler
#### HTTP Request
PATCH /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">HorizontalPodAutoscaler</a>): OK
201 (<a href="">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
### `delete` delete a HorizontalPodAutoscaler
#### HTTP Request
DELETE /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the HorizontalPodAutoscaler
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of HorizontalPodAutoscaler
#### HTTP Request
DELETE /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion autoscaling v2 import k8s io api autoscaling v2 kind HorizontalPodAutoscaler content type api reference description HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified title HorizontalPodAutoscaler weight 13 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 apiVersion autoscaling v2 import k8s io api autoscaling v2 HorizontalPodAutoscaler HorizontalPodAutoscaler HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified hr apiVersion autoscaling v2 kind HorizontalPodAutoscaler metadata a href ObjectMeta a metadata is the standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href HorizontalPodAutoscalerSpec a spec is the specification for the behaviour of the autoscaler More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href HorizontalPodAutoscalerStatus a status is the current information about the autoscaler HorizontalPodAutoscalerSpec HorizontalPodAutoscalerSpec HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler hr maxReplicas int32 required maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up It cannot be less that minReplicas scaleTargetRef CrossVersionObjectReference required scaleTargetRef points to the target resource to scale and is used to the pods for which metrics should be collected as well as to actually change the replica count a name CrossVersionObjectReference a CrossVersionObjectReference contains enough information to let you identify the referred resource scaleTargetRef kind string required kind is the kind of the referent More info https git k8s io community contributors devel sig architecture api conventions md types kinds scaleTargetRef name string required name is the name of the referent More info https kubernetes io docs concepts overview working with objects names names scaleTargetRef apiVersion string apiVersion is the API version of the referent minReplicas int32 minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down It defaults to 1 pod minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured Scaling is active as long as at least one metric value is available behavior HorizontalPodAutoscalerBehavior behavior configures the scaling behavior of the target in both Up and Down directions scaleUp and scaleDown fields respectively If not set the default HPAScalingRules for scale up and scale down are used a name HorizontalPodAutoscalerBehavior a HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions scaleUp and scaleDown fields respectively behavior scaleDown HPAScalingRules scaleDown is scaling policy for scaling Down If not set the default value is to allow to scale down to minReplicas pods with a 300 second stabilization window i e the highest recommendation for the last 300sec is used a name HPAScalingRules a HPAScalingRules configures the scaling behavior for one direction These Rules are applied after calculating DesiredReplicas from metrics for the HPA They can limit the scaling velocity by specifying scaling policies They can prevent flapping by specifying the stabilization window so that the number of replicas is not set instantly instead the safest value from the stabilization window is chosen behavior scaleDown policies HPAScalingPolicy Atomic will be replaced during a merge policies is a list of potential scaling polices which can be used during scaling At least one policy must be specified otherwise the HPAScalingRules will be discarded as invalid a name HPAScalingPolicy a HPAScalingPolicy is a single policy which must hold true for a specified past interval behavior scaleDown policies type string required type is used to specify the scaling policy behavior scaleDown policies value int32 required value contains the amount of change which is permitted by the policy It must be greater than zero behavior scaleDown policies periodSeconds int32 required periodSeconds specifies the window of time for which the policy should hold true PeriodSeconds must be greater than zero and less than or equal to 1800 30 min behavior scaleDown selectPolicy string selectPolicy is used to specify which policy should be used If not set the default value Max is used behavior scaleDown stabilizationWindowSeconds int32 stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 one hour If not set use the default values For scale up 0 i e no stabilization is done For scale down 300 i e the stabilization window is 300 seconds long behavior scaleUp HPAScalingRules scaleUp is scaling policy for scaling Up If not set the default value is the higher of increase no more than 4 pods per 60 seconds double the number of pods per 60 seconds No stabilization is used a name HPAScalingRules a HPAScalingRules configures the scaling behavior for one direction These Rules are applied after calculating DesiredReplicas from metrics for the HPA They can limit the scaling velocity by specifying scaling policies They can prevent flapping by specifying the stabilization window so that the number of replicas is not set instantly instead the safest value from the stabilization window is chosen behavior scaleUp policies HPAScalingPolicy Atomic will be replaced during a merge policies is a list of potential scaling polices which can be used during scaling At least one policy must be specified otherwise the HPAScalingRules will be discarded as invalid a name HPAScalingPolicy a HPAScalingPolicy is a single policy which must hold true for a specified past interval behavior scaleUp policies type string required type is used to specify the scaling policy behavior scaleUp policies value int32 required value contains the amount of change which is permitted by the policy It must be greater than zero behavior scaleUp policies periodSeconds int32 required periodSeconds specifies the window of time for which the policy should hold true PeriodSeconds must be greater than zero and less than or equal to 1800 30 min behavior scaleUp selectPolicy string selectPolicy is used to specify which policy should be used If not set the default value Max is used behavior scaleUp stabilizationWindowSeconds int32 stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 one hour If not set use the default values For scale up 0 i e no stabilization is done For scale down 300 i e the stabilization window is 300 seconds long metrics MetricSpec Atomic will be replaced during a merge metrics contains the specifications for which to use to calculate the desired replica count the maximum replica count across all metrics will be used The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods Ergo metrics used must decrease as the pod count is increased and vice versa See the individual metric source types for more information about how each type of metric must respond If not set the default metric will be set to 80 average CPU utilization a name MetricSpec a MetricSpec specifies how to scale based on a single metric only type and one other matching field should be set at once metrics type string required type is the type of metric source It should be one of ContainerResource External Object Pods or Resource each mapping to a matching field in the object Note ContainerResource type is available on when the feature gate HPAContainerMetrics is enabled metrics containerResource ContainerResourceMetricSource containerResource refers to a resource metric such as those specified in requests and limits known to Kubernetes describing a single container in each pod of the current scale target e g CPU or memory Such metrics are built in to Kubernetes and have special scaling options on top of those available to normal per pod metrics using the pods source This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag a name ContainerResourceMetricSource a ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes as specified in requests and limits describing each pod in the current scale target e g CPU or memory The values will be averaged together before being compared to the target Such metrics are built in to Kubernetes and have special scaling options on top of those available to normal per pod metrics using the pods source Only one target type should be set metrics containerResource container string required container is the name of the container in the pods of the scaling target metrics containerResource name string required name is the name of the resource in question metrics containerResource target MetricTarget required target specifies the target value for the given metric a name MetricTarget a MetricTarget defines the target value average value or average utilization of a specific metric metrics containerResource target type string required type represents whether the metric type is Utilization Value or AverageValue metrics containerResource target averageUtilization int32 averageUtilization is the target value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods Currently only valid for Resource metric source type metrics containerResource target averageValue a href Quantity a averageValue is the target value of the average of the metric across all relevant pods as a quantity metrics containerResource target value a href Quantity a value is the target value of the metric as a quantity metrics external ExternalMetricSource external refers to a global metric that is not associated with any Kubernetes object It allows autoscaling based on information coming from components running outside of cluster for example length of queue in cloud messaging service or QPS from loadbalancer running outside of cluster a name ExternalMetricSource a ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object for example length of queue in cloud messaging service or QPS from loadbalancer running outside of cluster metrics external metric MetricIdentifier required metric identifies the target metric by name and selector a name MetricIdentifier a MetricIdentifier defines the name and optionally selector for a metric metrics external metric name string required name is the name of the given metric metrics external metric selector a href LabelSelector a selector is the string encoded form of a standard kubernetes label selector for the given metric When set it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset just the metricName will be used to gather metrics metrics external target MetricTarget required target specifies the target value for the given metric a name MetricTarget a MetricTarget defines the target value average value or average utilization of a specific metric metrics external target type string required type represents whether the metric type is Utilization Value or AverageValue metrics external target averageUtilization int32 averageUtilization is the target value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods Currently only valid for Resource metric source type metrics external target averageValue a href Quantity a averageValue is the target value of the average of the metric across all relevant pods as a quantity metrics external target value a href Quantity a value is the target value of the metric as a quantity metrics object ObjectMetricSource object refers to a metric describing a single kubernetes object for example hits per second on an Ingress object a name ObjectMetricSource a ObjectMetricSource indicates how to scale on a metric describing a kubernetes object for example hits per second on an Ingress object metrics object describedObject CrossVersionObjectReference required describedObject specifies the descriptions of a object such as kind name apiVersion a name CrossVersionObjectReference a CrossVersionObjectReference contains enough information to let you identify the referred resource metrics object describedObject kind string required kind is the kind of the referent More info https git k8s io community contributors devel sig architecture api conventions md types kinds metrics object describedObject name string required name is the name of the referent More info https kubernetes io docs concepts overview working with objects names names metrics object describedObject apiVersion string apiVersion is the API version of the referent metrics object metric MetricIdentifier required metric identifies the target metric by name and selector a name MetricIdentifier a MetricIdentifier defines the name and optionally selector for a metric metrics object metric name string required name is the name of the given metric metrics object metric selector a href LabelSelector a selector is the string encoded form of a standard kubernetes label selector for the given metric When set it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset just the metricName will be used to gather metrics metrics object target MetricTarget required target specifies the target value for the given metric a name MetricTarget a MetricTarget defines the target value average value or average utilization of a specific metric metrics object target type string required type represents whether the metric type is Utilization Value or AverageValue metrics object target averageUtilization int32 averageUtilization is the target value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods Currently only valid for Resource metric source type metrics object target averageValue a href Quantity a averageValue is the target value of the average of the metric across all relevant pods as a quantity metrics object target value a href Quantity a value is the target value of the metric as a quantity metrics pods PodsMetricSource pods refers to a metric describing each pod in the current scale target for example transactions processed per second The values will be averaged together before being compared to the target value a name PodsMetricSource a PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target for example transactions processed per second The values will be averaged together before being compared to the target value metrics pods metric MetricIdentifier required metric identifies the target metric by name and selector a name MetricIdentifier a MetricIdentifier defines the name and optionally selector for a metric metrics pods metric name string required name is the name of the given metric metrics pods metric selector a href LabelSelector a selector is the string encoded form of a standard kubernetes label selector for the given metric When set it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset just the metricName will be used to gather metrics metrics pods target MetricTarget required target specifies the target value for the given metric a name MetricTarget a MetricTarget defines the target value average value or average utilization of a specific metric metrics pods target type string required type represents whether the metric type is Utilization Value or AverageValue metrics pods target averageUtilization int32 averageUtilization is the target value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods Currently only valid for Resource metric source type metrics pods target averageValue a href Quantity a averageValue is the target value of the average of the metric across all relevant pods as a quantity metrics pods target value a href Quantity a value is the target value of the metric as a quantity metrics resource ResourceMetricSource resource refers to a resource metric such as those specified in requests and limits known to Kubernetes describing each pod in the current scale target e g CPU or memory Such metrics are built in to Kubernetes and have special scaling options on top of those available to normal per pod metrics using the pods source a name ResourceMetricSource a ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes as specified in requests and limits describing each pod in the current scale target e g CPU or memory The values will be averaged together before being compared to the target Such metrics are built in to Kubernetes and have special scaling options on top of those available to normal per pod metrics using the pods source Only one target type should be set metrics resource name string required name is the name of the resource in question metrics resource target MetricTarget required target specifies the target value for the given metric a name MetricTarget a MetricTarget defines the target value average value or average utilization of a specific metric metrics resource target type string required type represents whether the metric type is Utilization Value or AverageValue metrics resource target averageUtilization int32 averageUtilization is the target value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods Currently only valid for Resource metric source type metrics resource target averageValue a href Quantity a averageValue is the target value of the average of the metric across all relevant pods as a quantity metrics resource target value a href Quantity a value is the target value of the metric as a quantity HorizontalPodAutoscalerStatus HorizontalPodAutoscalerStatus HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler hr desiredReplicas int32 required desiredReplicas is the desired number of replicas of pods managed by this autoscaler as last calculated by the autoscaler conditions HorizontalPodAutoscalerCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge conditions is the set of conditions required for this autoscaler to scale its target and indicates whether or not those conditions are met a name HorizontalPodAutoscalerCondition a HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point conditions status string required status is the status of the condition True False Unknown conditions type string required type describes the current condition conditions lastTransitionTime Time lastTransitionTime is the last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string message is a human readable explanation containing details about the transition conditions reason string reason is the reason for the condition s last transition currentMetrics MetricStatus Atomic will be replaced during a merge currentMetrics is the last read state of the metrics used by this autoscaler a name MetricStatus a MetricStatus describes the last read state of a single metric currentMetrics type string required type is the type of metric source It will be one of ContainerResource External Object Pods or Resource each corresponds to a matching field in the object Note ContainerResource type is available on when the feature gate HPAContainerMetrics is enabled currentMetrics containerResource ContainerResourceMetricStatus container resource refers to a resource metric such as those specified in requests and limits known to Kubernetes describing a single container in each pod in the current scale target e g CPU or memory Such metrics are built in to Kubernetes and have special scaling options on top of those available to normal per pod metrics using the pods source a name ContainerResourceMetricStatus a ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes as specified in requests and limits describing a single container in each pod in the current scale target e g CPU or memory Such metrics are built in to Kubernetes and have special scaling options on top of those available to normal per pod metrics using the pods source currentMetrics containerResource container string required container is the name of the container in the pods of the scaling target currentMetrics containerResource current MetricValueStatus required current contains the current value for the given metric a name MetricValueStatus a MetricValueStatus holds the current value for a metric currentMetrics containerResource current averageUtilization int32 currentAverageUtilization is the current value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods currentMetrics containerResource current averageValue a href Quantity a averageValue is the current value of the average of the metric across all relevant pods as a quantity currentMetrics containerResource current value a href Quantity a value is the current value of the metric as a quantity currentMetrics containerResource name string required name is the name of the resource in question currentMetrics external ExternalMetricStatus external refers to a global metric that is not associated with any Kubernetes object It allows autoscaling based on information coming from components running outside of cluster for example length of queue in cloud messaging service or QPS from loadbalancer running outside of cluster a name ExternalMetricStatus a ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object currentMetrics external current MetricValueStatus required current contains the current value for the given metric a name MetricValueStatus a MetricValueStatus holds the current value for a metric currentMetrics external current averageUtilization int32 currentAverageUtilization is the current value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods currentMetrics external current averageValue a href Quantity a averageValue is the current value of the average of the metric across all relevant pods as a quantity currentMetrics external current value a href Quantity a value is the current value of the metric as a quantity currentMetrics external metric MetricIdentifier required metric identifies the target metric by name and selector a name MetricIdentifier a MetricIdentifier defines the name and optionally selector for a metric currentMetrics external metric name string required name is the name of the given metric currentMetrics external metric selector a href LabelSelector a selector is the string encoded form of a standard kubernetes label selector for the given metric When set it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset just the metricName will be used to gather metrics currentMetrics object ObjectMetricStatus object refers to a metric describing a single kubernetes object for example hits per second on an Ingress object a name ObjectMetricStatus a ObjectMetricStatus indicates the current value of a metric describing a kubernetes object for example hits per second on an Ingress object currentMetrics object current MetricValueStatus required current contains the current value for the given metric a name MetricValueStatus a MetricValueStatus holds the current value for a metric currentMetrics object current averageUtilization int32 currentAverageUtilization is the current value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods currentMetrics object current averageValue a href Quantity a averageValue is the current value of the average of the metric across all relevant pods as a quantity currentMetrics object current value a href Quantity a value is the current value of the metric as a quantity currentMetrics object describedObject CrossVersionObjectReference required DescribedObject specifies the descriptions of a object such as kind name apiVersion a name CrossVersionObjectReference a CrossVersionObjectReference contains enough information to let you identify the referred resource currentMetrics object describedObject kind string required kind is the kind of the referent More info https git k8s io community contributors devel sig architecture api conventions md types kinds currentMetrics object describedObject name string required name is the name of the referent More info https kubernetes io docs concepts overview working with objects names names currentMetrics object describedObject apiVersion string apiVersion is the API version of the referent currentMetrics object metric MetricIdentifier required metric identifies the target metric by name and selector a name MetricIdentifier a MetricIdentifier defines the name and optionally selector for a metric currentMetrics object metric name string required name is the name of the given metric currentMetrics object metric selector a href LabelSelector a selector is the string encoded form of a standard kubernetes label selector for the given metric When set it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset just the metricName will be used to gather metrics currentMetrics pods PodsMetricStatus pods refers to a metric describing each pod in the current scale target for example transactions processed per second The values will be averaged together before being compared to the target value a name PodsMetricStatus a PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target for example transactions processed per second currentMetrics pods current MetricValueStatus required current contains the current value for the given metric a name MetricValueStatus a MetricValueStatus holds the current value for a metric currentMetrics pods current averageUtilization int32 currentAverageUtilization is the current value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods currentMetrics pods current averageValue a href Quantity a averageValue is the current value of the average of the metric across all relevant pods as a quantity currentMetrics pods current value a href Quantity a value is the current value of the metric as a quantity currentMetrics pods metric MetricIdentifier required metric identifies the target metric by name and selector a name MetricIdentifier a MetricIdentifier defines the name and optionally selector for a metric currentMetrics pods metric name string required name is the name of the given metric currentMetrics pods metric selector a href LabelSelector a selector is the string encoded form of a standard kubernetes label selector for the given metric When set it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset just the metricName will be used to gather metrics currentMetrics resource ResourceMetricStatus resource refers to a resource metric such as those specified in requests and limits known to Kubernetes describing each pod in the current scale target e g CPU or memory Such metrics are built in to Kubernetes and have special scaling options on top of those available to normal per pod metrics using the pods source a name ResourceMetricStatus a ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes as specified in requests and limits describing each pod in the current scale target e g CPU or memory Such metrics are built in to Kubernetes and have special scaling options on top of those available to normal per pod metrics using the pods source currentMetrics resource current MetricValueStatus required current contains the current value for the given metric a name MetricValueStatus a MetricValueStatus holds the current value for a metric currentMetrics resource current averageUtilization int32 currentAverageUtilization is the current value of the average of the resource metric across all relevant pods represented as a percentage of the requested value of the resource for the pods currentMetrics resource current averageValue a href Quantity a averageValue is the current value of the average of the metric across all relevant pods as a quantity currentMetrics resource current value a href Quantity a value is the current value of the metric as a quantity currentMetrics resource name string required name is the name of the resource in question currentReplicas int32 currentReplicas is current number of replicas of pods managed by this autoscaler as last seen by the autoscaler lastScaleTime Time lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods used by the autoscaler to control how often the number of pods is changed a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers observedGeneration int64 observedGeneration is the most recent generation observed by this autoscaler HorizontalPodAutoscalerList HorizontalPodAutoscalerList HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects hr apiVersion autoscaling v2 kind HorizontalPodAutoscalerList metadata a href ListMeta a metadata is the standard list metadata items a href HorizontalPodAutoscaler a required items is the list of horizontal pod autoscaler objects Operations Operations hr get read the specified HorizontalPodAutoscaler HTTP Request GET apis autoscaling v2 namespaces namespace horizontalpodautoscalers name Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 401 Unauthorized get read status of the specified HorizontalPodAutoscaler HTTP Request GET apis autoscaling v2 namespaces namespace horizontalpodautoscalers name status Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 401 Unauthorized list list or watch objects of kind HorizontalPodAutoscaler HTTP Request GET apis autoscaling v2 namespaces namespace horizontalpodautoscalers Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href HorizontalPodAutoscalerList a OK 401 Unauthorized list list or watch objects of kind HorizontalPodAutoscaler HTTP Request GET apis autoscaling v2 horizontalpodautoscalers Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href HorizontalPodAutoscalerList a OK 401 Unauthorized create create a HorizontalPodAutoscaler HTTP Request POST apis autoscaling v2 namespaces namespace horizontalpodautoscalers Parameters namespace in path string required a href namespace a body a href HorizontalPodAutoscaler a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 202 a href HorizontalPodAutoscaler a Accepted 401 Unauthorized update replace the specified HorizontalPodAutoscaler HTTP Request PUT apis autoscaling v2 namespaces namespace horizontalpodautoscalers name Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href HorizontalPodAutoscaler a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 401 Unauthorized update replace status of the specified HorizontalPodAutoscaler HTTP Request PUT apis autoscaling v2 namespaces namespace horizontalpodautoscalers name status Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href HorizontalPodAutoscaler a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 401 Unauthorized patch partially update the specified HorizontalPodAutoscaler HTTP Request PATCH apis autoscaling v2 namespaces namespace horizontalpodautoscalers name Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 401 Unauthorized patch partially update status of the specified HorizontalPodAutoscaler HTTP Request PATCH apis autoscaling v2 namespaces namespace horizontalpodautoscalers name status Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href HorizontalPodAutoscaler a OK 201 a href HorizontalPodAutoscaler a Created 401 Unauthorized delete delete a HorizontalPodAutoscaler HTTP Request DELETE apis autoscaling v2 namespaces namespace horizontalpodautoscalers name Parameters name in path string required name of the HorizontalPodAutoscaler namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of HorizontalPodAutoscaler HTTP Request DELETE apis autoscaling v2 namespaces namespace horizontalpodautoscalers Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind PodTemplate apiVersion v1 PodTemplate describes a template for creating copies of a predefined pod contenttype apireference apimetadata title PodTemplate weight 3 autogenerated true import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "PodTemplate"
content_type: "api_reference"
description: "PodTemplate describes a template for creating copies of a predefined pod."
title: "PodTemplate"
weight: 3
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## PodTemplate {#PodTemplate}
PodTemplate describes a template for creating copies of a predefined pod.
<hr>
- **apiVersion**: v1
- **kind**: PodTemplate
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **template** (<a href="">PodTemplateSpec</a>)
Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## PodTemplateSpec {#PodTemplateSpec}
PodTemplateSpec describes the data a pod should have when created from a template
<hr>
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">PodSpec</a>)
Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## PodTemplateList {#PodTemplateList}
PodTemplateList is a list of PodTemplates.
<hr>
- **apiVersion**: v1
- **kind**: PodTemplateList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">PodTemplate</a>), required
List of pod templates
## Operations {#Operations}
<hr>
### `get` read the specified PodTemplate
#### HTTP Request
GET /api/v1/namespaces/{namespace}/podtemplates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodTemplate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodTemplate</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PodTemplate
#### HTTP Request
GET /api/v1/namespaces/{namespace}/podtemplates
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PodTemplateList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PodTemplate
#### HTTP Request
GET /api/v1/podtemplates
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PodTemplateList</a>): OK
401: Unauthorized
### `create` create a PodTemplate
#### HTTP Request
POST /api/v1/namespaces/{namespace}/podtemplates
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PodTemplate</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodTemplate</a>): OK
201 (<a href="">PodTemplate</a>): Created
202 (<a href="">PodTemplate</a>): Accepted
401: Unauthorized
### `update` replace the specified PodTemplate
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodTemplate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PodTemplate</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodTemplate</a>): OK
201 (<a href="">PodTemplate</a>): Created
401: Unauthorized
### `patch` partially update the specified PodTemplate
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodTemplate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodTemplate</a>): OK
201 (<a href="">PodTemplate</a>): Created
401: Unauthorized
### `delete` delete a PodTemplate
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodTemplate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">PodTemplate</a>): OK
202 (<a href="">PodTemplate</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of PodTemplate
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/podtemplates
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind PodTemplate content type api reference description PodTemplate describes a template for creating copies of a predefined pod title PodTemplate weight 3 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 apiVersion v1 import k8s io api core v1 PodTemplate PodTemplate PodTemplate describes a template for creating copies of a predefined pod hr apiVersion v1 kind PodTemplate metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata template a href PodTemplateSpec a Template defines the pods that will be created from this pod template https git k8s io community contributors devel sig architecture api conventions md spec and status PodTemplateSpec PodTemplateSpec PodTemplateSpec describes the data a pod should have when created from a template hr metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href PodSpec a Specification of the desired behavior of the pod More info https git k8s io community contributors devel sig architecture api conventions md spec and status PodTemplateList PodTemplateList PodTemplateList is a list of PodTemplates hr apiVersion v1 kind PodTemplateList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href PodTemplate a required List of pod templates Operations Operations hr get read the specified PodTemplate HTTP Request GET api v1 namespaces namespace podtemplates name Parameters name in path string required name of the PodTemplate namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href PodTemplate a OK 401 Unauthorized list list or watch objects of kind PodTemplate HTTP Request GET api v1 namespaces namespace podtemplates Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PodTemplateList a OK 401 Unauthorized list list or watch objects of kind PodTemplate HTTP Request GET api v1 podtemplates Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PodTemplateList a OK 401 Unauthorized create create a PodTemplate HTTP Request POST api v1 namespaces namespace podtemplates Parameters namespace in path string required a href namespace a body a href PodTemplate a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PodTemplate a OK 201 a href PodTemplate a Created 202 a href PodTemplate a Accepted 401 Unauthorized update replace the specified PodTemplate HTTP Request PUT api v1 namespaces namespace podtemplates name Parameters name in path string required name of the PodTemplate namespace in path string required a href namespace a body a href PodTemplate a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PodTemplate a OK 201 a href PodTemplate a Created 401 Unauthorized patch partially update the specified PodTemplate HTTP Request PATCH api v1 namespaces namespace podtemplates name Parameters name in path string required name of the PodTemplate namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PodTemplate a OK 201 a href PodTemplate a Created 401 Unauthorized delete delete a PodTemplate HTTP Request DELETE api v1 namespaces namespace podtemplates name Parameters name in path string required name of the PodTemplate namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href PodTemplate a OK 202 a href PodTemplate a Accepted 401 Unauthorized deletecollection delete collection of PodTemplate HTTP Request DELETE api v1 namespaces namespace podtemplates Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference Pod is a collection of containers that can run on a host apiVersion v1 contenttype apireference apimetadata kind Pod autogenerated true title Pod weight 1 import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "Pod"
content_type: "api_reference"
description: "Pod is a collection of containers that can run on a host."
title: "Pod"
weight: 1
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## Pod {#Pod}
Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.
<hr>
- **apiVersion**: v1
- **kind**: Pod
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">PodSpec</a>)
Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">PodStatus</a>)
Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## PodSpec {#PodSpec}
PodSpec is a description of a pod.
<hr>
### Containers
- **containers** ([]<a href="">Container</a>), required
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
- **initContainers** ([]<a href="">Container</a>)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
- **ephemeralContainers** ([]<a href="">EphemeralContainer</a>)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.
- **imagePullSecrets** ([]<a href="">LocalObjectReference</a>)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
- **enableServiceLinks** (boolean)
EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
- **os** (PodOS)
Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set.
If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions
If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.securityContext.supplementalGroupsPolicy - spec.containers[*].securityContext.appArmorProfile - spec.containers[*].securityContext.seLinuxOptions - spec.containers[*].securityContext.seccompProfile - spec.containers[*].securityContext.capabilities - spec.containers[*].securityContext.readOnlyRootFilesystem - spec.containers[*].securityContext.privileged - spec.containers[*].securityContext.allowPrivilegeEscalation - spec.containers[*].securityContext.procMount - spec.containers[*].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup
<a name="PodOS"></a>
*PodOS defines the OS parameters of a pod.*
- **os.name** (string), required
Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null
### Volumes
- **volumes** ([]<a href="">Volume</a>)
*Patch strategies: retainKeys, merge on key `name`*
*Map: unique values on key name will be kept during a merge*
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
### Scheduling
- **nodeSelector** (map[string]string)
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
- **nodeName** (string)
NodeName indicates in which node this pod is scheduled. If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName. Once this field is set, the kubelet for this node becomes responsible for the lifecycle of this pod. This field should not be used to express a desire for the pod to be scheduled on a specific node. https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename
- **affinity** (Affinity)
If specified, the pod's scheduling constraints
<a name="Affinity"></a>
*Affinity is a group of affinity scheduling rules.*
- **affinity.nodeAffinity** (<a href="">NodeAffinity</a>)
Describes node affinity scheduling rules for the pod.
- **affinity.podAffinity** (<a href="">PodAffinity</a>)
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- **affinity.podAntiAffinity** (<a href="">PodAntiAffinity</a>)
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- **tolerations** ([]Toleration)
*Atomic: will be replaced during a merge*
If specified, the pod's tolerations.
<a name="Toleration"></a>
*The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.*
- **tolerations.key** (string)
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
- **tolerations.operator** (string)
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
- **tolerations.value** (string)
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
- **tolerations.effect** (string)
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- **tolerations.tolerationSeconds** (int64)
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
- **schedulerName** (string)
If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
- **runtimeClassName** (string)
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class
- **priorityClassName** (string)
If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
- **priority** (int32)
The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
- **preemptionPolicy** (string)
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
- **topologySpreadConstraints** ([]TopologySpreadConstraint)
*Patch strategy: merge on key `topologyKey`*
*Map: unique values on keys `topologyKey, whenUnsatisfiable` will be kept during a merge*
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
<a name="TopologySpreadConstraint"></a>
*TopologySpreadConstraint specifies how to spread matching pods among the given topology.*
- **topologySpreadConstraints.maxSkew** (int32), required
MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.
- **topologySpreadConstraints.topologyKey** (string), required
TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each \<key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.
- **topologySpreadConstraints.whenUnsatisfiable** (string), required
WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,
but giving higher precedence to topologies that would help reduce the
skew.
A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.
- **topologySpreadConstraints.labelSelector** (<a href="">LabelSelector</a>)
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
- **topologySpreadConstraints.matchLabelKeys** ([]string)
*Atomic: will be replaced during a merge*
MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.
This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- **topologySpreadConstraints.minDomains** (int32)
MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.
- **topologySpreadConstraints.nodeAffinityPolicy** (string)
NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- **topologySpreadConstraints.nodeTaintsPolicy** (string)
NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.
If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- **overhead** (map[string]<a href="">Quantity</a>)
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md
### Lifecycle
- **restartPolicy** (string)
Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
- **terminationGracePeriodSeconds** (int64)
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
- **activeDeadlineSeconds** (int64)
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
- **readinessGates** ([]PodReadinessGate)
*Atomic: will be replaced during a merge*
If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
<a name="PodReadinessGate"></a>
*PodReadinessGate contains the reference to a pod condition*
- **readinessGates.conditionType** (string), required
ConditionType refers to a condition in the pod's condition list with matching type.
### Hostname and Name resolution
- **hostname** (string)
Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
- **setHostnameAsFQDN** (boolean)
If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
- **subdomain** (string)
If specified, the fully qualified Pod hostname will be "\<hostname>.\<subdomain>.\<pod namespace>.svc.\<cluster domain>". If not specified, the pod will not have a domainname at all.
- **hostAliases** ([]HostAlias)
*Patch strategy: merge on key `ip`*
*Map: unique values on key ip will be kept during a merge*
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.
<a name="HostAlias"></a>
*HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.*
- **hostAliases.ip** (string), required
IP address of the host file entry.
- **hostAliases.hostnames** ([]string)
*Atomic: will be replaced during a merge*
Hostnames for the above IP address.
- **dnsConfig** (PodDNSConfig)
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
<a name="PodDNSConfig"></a>
*PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.*
- **dnsConfig.nameservers** ([]string)
*Atomic: will be replaced during a merge*
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
- **dnsConfig.options** ([]PodDNSConfigOption)
*Atomic: will be replaced during a merge*
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
<a name="PodDNSConfigOption"></a>
*PodDNSConfigOption defines DNS resolver options of a pod.*
- **dnsConfig.options.name** (string)
Required.
- **dnsConfig.options.value** (string)
- **dnsConfig.searches** ([]string)
*Atomic: will be replaced during a merge*
A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
- **dnsPolicy** (string)
Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
### Hosts namespaces
- **hostNetwork** (boolean)
Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
- **hostPID** (boolean)
Use the host's pid namespace. Optional: Default to false.
- **hostIPC** (boolean)
Use the host's ipc namespace. Optional: Default to false.
- **shareProcessNamespace** (boolean)
Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
### Service account
- **serviceAccountName** (string)
ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
- **automountServiceAccountToken** (boolean)
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
### Security context
- **securityContext** (PodSecurityContext)
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
<a name="PodSecurityContext"></a>
*PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.*
- **securityContext.appArmorProfile** (AppArmorProfile)
appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
<a name="AppArmorProfile"></a>
*AppArmorProfile defines a pod or container's AppArmor settings.*
- **securityContext.appArmorProfile.type** (string), required
type indicates which kind of AppArmor profile will be applied. Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
- **securityContext.appArmorProfile.localhostProfile** (string)
localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
- **securityContext.fsGroup** (int64)
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.fsGroupChangePolicy** (string)
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.runAsUser** (int64)
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.runAsNonRoot** (boolean)
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- **securityContext.runAsGroup** (int64)
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.seccompProfile** (SeccompProfile)
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
<a name="SeccompProfile"></a>
*SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.*
- **securityContext.seccompProfile.type** (string), required
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
- **securityContext.seccompProfile.localhostProfile** (string)
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
- **securityContext.seLinuxOptions** (SELinuxOptions)
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
<a name="SELinuxOptions"></a>
*SELinuxOptions are the labels to be applied to the container*
- **securityContext.seLinuxOptions.level** (string)
Level is SELinux level label that applies to the container.
- **securityContext.seLinuxOptions.role** (string)
Role is a SELinux role label that applies to the container.
- **securityContext.seLinuxOptions.type** (string)
Type is a SELinux type label that applies to the container.
- **securityContext.seLinuxOptions.user** (string)
User is a SELinux user label that applies to the container.
- **securityContext.supplementalGroups** ([]int64)
*Atomic: will be replaced during a merge*
A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.supplementalGroupsPolicy** (string)
Defines how supplemental groups of the first container processes are calculated. Valid values are "Merge" and "Strict". If not specified, "Merge" is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.sysctls** ([]Sysctl)
*Atomic: will be replaced during a merge*
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
<a name="Sysctl"></a>
*Sysctl defines a kernel parameter to be set*
- **securityContext.sysctls.name** (string), required
Name of a property to set
- **securityContext.sysctls.value** (string), required
Value of a property to set
- **securityContext.windowsOptions** (WindowsSecurityContextOptions)
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
<a name="WindowsSecurityContextOptions"></a>
*WindowsSecurityContextOptions contain Windows-specific options and credentials.*
- **securityContext.windowsOptions.gmsaCredentialSpec** (string)
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
- **securityContext.windowsOptions.gmsaCredentialSpecName** (string)
GMSACredentialSpecName is the name of the GMSA credential spec to use.
- **securityContext.windowsOptions.hostProcess** (boolean)
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
- **securityContext.windowsOptions.runAsUserName** (string)
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
### Alpha level
- **hostUsers** (boolean)
Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.
- **resourceClaims** ([]PodResourceClaim)
*Patch strategies: retainKeys, merge on key `name`*
*Map: unique values on key name will be kept during a merge*
ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable.
<a name="PodResourceClaim"></a>
*PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod.
It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.*
- **resourceClaims.name** (string), required
Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL.
- **resourceClaims.resourceClaimName** (string)
ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
- **resourceClaims.resourceClaimTemplateName** (string)
ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod.
The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.
This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
- **schedulingGates** ([]PodSchedulingGate)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod.
SchedulingGates can only be set at pod creation time, and be removed only afterwards.
<a name="PodSchedulingGate"></a>
*PodSchedulingGate is associated to a Pod to guard its scheduling.*
- **schedulingGates.name** (string), required
Name of the scheduling gate. Each scheduling gate must have a unique name field.
### Deprecated
- **serviceAccount** (string)
DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
## Container {#Container}
A single application container that you want to run within a pod.
<hr>
- **name** (string), required
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
### Image
- **image** (string)
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
- **imagePullPolicy** (string)
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
### Entrypoint
- **command** ([]string)
*Atomic: will be replaced during a merge*
Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- **args** ([]string)
*Atomic: will be replaced during a merge*
Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- **workingDir** (string)
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
### Ports
- **ports** ([]ContainerPort)
*Patch strategy: merge on key `containerPort`*
*Map: unique values on keys `containerPort, protocol` will be kept during a merge*
List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
<a name="ContainerPort"></a>
*ContainerPort represents a network port in a single container.*
- **ports.containerPort** (int32), required
Number of port to expose on the pod's IP address. This must be a valid port number, 0 \< x \< 65536.
- **ports.hostIP** (string)
What host IP to bind the external port to.
- **ports.hostPort** (int32)
Number of port to expose on the host. If specified, this must be a valid port number, 0 \< x \< 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
- **ports.name** (string)
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
- **ports.protocol** (string)
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
### Environment variables
- **env** ([]EnvVar)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
List of environment variables to set in the container. Cannot be updated.
<a name="EnvVar"></a>
*EnvVar represents an environment variable present in a Container.*
- **env.name** (string), required
Name of the environment variable. Must be a C_IDENTIFIER.
- **env.value** (string)
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
- **env.valueFrom** (EnvVarSource)
Source for the environment variable's value. Cannot be used if value is not empty.
<a name="EnvVarSource"></a>
*EnvVarSource represents a source for the value of an EnvVar.*
- **env.valueFrom.configMapKeyRef** (ConfigMapKeySelector)
Selects a key of a ConfigMap.
<a name="ConfigMapKeySelector"></a>
*Selects a key from a ConfigMap.*
- **env.valueFrom.configMapKeyRef.key** (string), required
The key to select.
- **env.valueFrom.configMapKeyRef.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **env.valueFrom.configMapKeyRef.optional** (boolean)
Specify whether the ConfigMap or its key must be defined
- **env.valueFrom.fieldRef** (<a href="">ObjectFieldSelector</a>)
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\<KEY>']`, `metadata.annotations['\<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- **env.valueFrom.resourceFieldRef** (<a href="">ResourceFieldSelector</a>)
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- **env.valueFrom.secretKeyRef** (SecretKeySelector)
Selects a key of a secret in the pod's namespace
<a name="SecretKeySelector"></a>
*SecretKeySelector selects a key of a Secret.*
- **env.valueFrom.secretKeyRef.key** (string), required
The key of the secret to select from. Must be a valid secret key.
- **env.valueFrom.secretKeyRef.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **env.valueFrom.secretKeyRef.optional** (boolean)
Specify whether the Secret or its key must be defined
- **envFrom** ([]EnvFromSource)
*Atomic: will be replaced during a merge*
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
<a name="EnvFromSource"></a>
*EnvFromSource represents the source of a set of ConfigMaps*
- **envFrom.configMapRef** (ConfigMapEnvSource)
The ConfigMap to select from
<a name="ConfigMapEnvSource"></a>
*ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.*
- **envFrom.configMapRef.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **envFrom.configMapRef.optional** (boolean)
Specify whether the ConfigMap must be defined
- **envFrom.prefix** (string)
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- **envFrom.secretRef** (SecretEnvSource)
The Secret to select from
<a name="SecretEnvSource"></a>
*SecretEnvSource selects a Secret to populate the environment variables with.
The contents of the target Secret's Data field will represent the key-value pairs as environment variables.*
- **envFrom.secretRef.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **envFrom.secretRef.optional** (boolean)
Specify whether the Secret must be defined
### Volumes
- **volumeMounts** ([]VolumeMount)
*Patch strategy: merge on key `mountPath`*
*Map: unique values on key mountPath will be kept during a merge*
Pod volumes to mount into the container's filesystem. Cannot be updated.
<a name="VolumeMount"></a>
*VolumeMount describes a mounting of a Volume within a container.*
- **volumeMounts.mountPath** (string), required
Path within the container at which the volume should be mounted. Must not contain ':'.
- **volumeMounts.name** (string), required
This must match the Name of a Volume.
- **volumeMounts.mountPropagation** (string)
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
- **volumeMounts.readOnly** (boolean)
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- **volumeMounts.recursiveReadOnly** (string)
RecursiveReadOnly specifies whether read-only mounts should be handled recursively.
If ReadOnly is false, this field has no meaning and must be unspecified.
If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.
If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).
If this field is not specified, it is treated as an equivalent of Disabled.
- **volumeMounts.subPath** (string)
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
- **volumeMounts.subPathExpr** (string)
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
- **volumeDevices** ([]VolumeDevice)
*Patch strategy: merge on key `devicePath`*
*Map: unique values on key devicePath will be kept during a merge*
volumeDevices is the list of block devices to be used by the container.
<a name="VolumeDevice"></a>
*volumeDevice describes a mapping of a raw block device within a container.*
- **volumeDevices.devicePath** (string), required
devicePath is the path inside of the container that the device will be mapped to.
- **volumeDevices.name** (string), required
name must match the name of a persistentVolumeClaim in the pod
### Resources
- **resources** (ResourceRequirements)
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
<a name="ResourceRequirements"></a>
*ResourceRequirements describes the compute resource requirements.*
- **resources.claims** ([]ResourceClaim)
*Map: unique values on key name will be kept during a merge*
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
<a name="ResourceClaim"></a>
*ResourceClaim references one entry in PodSpec.ResourceClaims.*
- **resources.claims.name** (string), required
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- **resources.claims.request** (string)
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
- **resources.limits** (map[string]<a href="">Quantity</a>)
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **resources.requests** (map[string]<a href="">Quantity</a>)
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **resizePolicy** ([]ContainerResizePolicy)
*Atomic: will be replaced during a merge*
Resources resize policy for the container.
<a name="ContainerResizePolicy"></a>
*ContainerResizePolicy represents resource resize policy for the container.*
- **resizePolicy.resourceName** (string), required
Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
- **resizePolicy.restartPolicy** (string), required
Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
### Lifecycle
- **lifecycle** (Lifecycle)
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
<a name="Lifecycle"></a>
*Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.*
- **lifecycle.postStart** (<a href="">LifecycleHandler</a>)
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- **lifecycle.preStop** (<a href="">LifecycleHandler</a>)
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- **terminationMessagePath** (string)
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
- **terminationMessagePolicy** (string)
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- **livenessProbe** (<a href="">Probe</a>)
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- **readinessProbe** (<a href="">Probe</a>)
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- **startupProbe** (<a href="">Probe</a>)
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- **restartPolicy** (string)
RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
### Security Context
- **securityContext** (SecurityContext)
SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
<a name="SecurityContext"></a>
*SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.*
- **securityContext.allowPrivilegeEscalation** (boolean)
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
- **securityContext.appArmorProfile** (AppArmorProfile)
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
<a name="AppArmorProfile"></a>
*AppArmorProfile defines a pod or container's AppArmor settings.*
- **securityContext.appArmorProfile.type** (string), required
type indicates which kind of AppArmor profile will be applied. Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
- **securityContext.appArmorProfile.localhostProfile** (string)
localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
- **securityContext.capabilities** (Capabilities)
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
<a name="Capabilities"></a>
*Adds and removes POSIX capabilities from running containers.*
- **securityContext.capabilities.add** ([]string)
*Atomic: will be replaced during a merge*
Added capabilities
- **securityContext.capabilities.drop** ([]string)
*Atomic: will be replaced during a merge*
Removed capabilities
- **securityContext.procMount** (string)
procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.privileged** (boolean)
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.readOnlyRootFilesystem** (boolean)
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.runAsUser** (int64)
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.runAsNonRoot** (boolean)
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- **securityContext.runAsGroup** (int64)
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.seLinuxOptions** (SELinuxOptions)
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
<a name="SELinuxOptions"></a>
*SELinuxOptions are the labels to be applied to the container*
- **securityContext.seLinuxOptions.level** (string)
Level is SELinux level label that applies to the container.
- **securityContext.seLinuxOptions.role** (string)
Role is a SELinux role label that applies to the container.
- **securityContext.seLinuxOptions.type** (string)
Type is a SELinux type label that applies to the container.
- **securityContext.seLinuxOptions.user** (string)
User is a SELinux user label that applies to the container.
- **securityContext.seccompProfile** (SeccompProfile)
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
<a name="SeccompProfile"></a>
*SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.*
- **securityContext.seccompProfile.type** (string), required
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
- **securityContext.seccompProfile.localhostProfile** (string)
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
- **securityContext.windowsOptions** (WindowsSecurityContextOptions)
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
<a name="WindowsSecurityContextOptions"></a>
*WindowsSecurityContextOptions contain Windows-specific options and credentials.*
- **securityContext.windowsOptions.gmsaCredentialSpec** (string)
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
- **securityContext.windowsOptions.gmsaCredentialSpecName** (string)
GMSACredentialSpecName is the name of the GMSA credential spec to use.
- **securityContext.windowsOptions.hostProcess** (boolean)
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
- **securityContext.windowsOptions.runAsUserName** (string)
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
### Debugging
- **stdin** (boolean)
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
- **stdinOnce** (boolean)
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
- **tty** (boolean)
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
## EphemeralContainer {#EphemeralContainer}
An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation.
To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.
<hr>
- **name** (string), required
Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
- **targetContainerName** (string)
If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.
The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.
### Image
- **image** (string)
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
- **imagePullPolicy** (string)
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
### Entrypoint
- **command** ([]string)
*Atomic: will be replaced during a merge*
Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- **args** ([]string)
*Atomic: will be replaced during a merge*
Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- **workingDir** (string)
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
### Environment variables
- **env** ([]EnvVar)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
List of environment variables to set in the container. Cannot be updated.
<a name="EnvVar"></a>
*EnvVar represents an environment variable present in a Container.*
- **env.name** (string), required
Name of the environment variable. Must be a C_IDENTIFIER.
- **env.value** (string)
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
- **env.valueFrom** (EnvVarSource)
Source for the environment variable's value. Cannot be used if value is not empty.
<a name="EnvVarSource"></a>
*EnvVarSource represents a source for the value of an EnvVar.*
- **env.valueFrom.configMapKeyRef** (ConfigMapKeySelector)
Selects a key of a ConfigMap.
<a name="ConfigMapKeySelector"></a>
*Selects a key from a ConfigMap.*
- **env.valueFrom.configMapKeyRef.key** (string), required
The key to select.
- **env.valueFrom.configMapKeyRef.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **env.valueFrom.configMapKeyRef.optional** (boolean)
Specify whether the ConfigMap or its key must be defined
- **env.valueFrom.fieldRef** (<a href="">ObjectFieldSelector</a>)
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\<KEY>']`, `metadata.annotations['\<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- **env.valueFrom.resourceFieldRef** (<a href="">ResourceFieldSelector</a>)
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
- **env.valueFrom.secretKeyRef** (SecretKeySelector)
Selects a key of a secret in the pod's namespace
<a name="SecretKeySelector"></a>
*SecretKeySelector selects a key of a Secret.*
- **env.valueFrom.secretKeyRef.key** (string), required
The key of the secret to select from. Must be a valid secret key.
- **env.valueFrom.secretKeyRef.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **env.valueFrom.secretKeyRef.optional** (boolean)
Specify whether the Secret or its key must be defined
- **envFrom** ([]EnvFromSource)
*Atomic: will be replaced during a merge*
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
<a name="EnvFromSource"></a>
*EnvFromSource represents the source of a set of ConfigMaps*
- **envFrom.configMapRef** (ConfigMapEnvSource)
The ConfigMap to select from
<a name="ConfigMapEnvSource"></a>
*ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.*
- **envFrom.configMapRef.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **envFrom.configMapRef.optional** (boolean)
Specify whether the ConfigMap must be defined
- **envFrom.prefix** (string)
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- **envFrom.secretRef** (SecretEnvSource)
The Secret to select from
<a name="SecretEnvSource"></a>
*SecretEnvSource selects a Secret to populate the environment variables with.
The contents of the target Secret's Data field will represent the key-value pairs as environment variables.*
- **envFrom.secretRef.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **envFrom.secretRef.optional** (boolean)
Specify whether the Secret must be defined
### Volumes
- **volumeMounts** ([]VolumeMount)
*Patch strategy: merge on key `mountPath`*
*Map: unique values on key mountPath will be kept during a merge*
Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.
<a name="VolumeMount"></a>
*VolumeMount describes a mounting of a Volume within a container.*
- **volumeMounts.mountPath** (string), required
Path within the container at which the volume should be mounted. Must not contain ':'.
- **volumeMounts.name** (string), required
This must match the Name of a Volume.
- **volumeMounts.mountPropagation** (string)
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
- **volumeMounts.readOnly** (boolean)
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- **volumeMounts.recursiveReadOnly** (string)
RecursiveReadOnly specifies whether read-only mounts should be handled recursively.
If ReadOnly is false, this field has no meaning and must be unspecified.
If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.
If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).
If this field is not specified, it is treated as an equivalent of Disabled.
- **volumeMounts.subPath** (string)
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
- **volumeMounts.subPathExpr** (string)
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
- **volumeDevices** ([]VolumeDevice)
*Patch strategy: merge on key `devicePath`*
*Map: unique values on key devicePath will be kept during a merge*
volumeDevices is the list of block devices to be used by the container.
<a name="VolumeDevice"></a>
*volumeDevice describes a mapping of a raw block device within a container.*
- **volumeDevices.devicePath** (string), required
devicePath is the path inside of the container that the device will be mapped to.
- **volumeDevices.name** (string), required
name must match the name of a persistentVolumeClaim in the pod
### Resources
- **resizePolicy** ([]ContainerResizePolicy)
*Atomic: will be replaced during a merge*
Resources resize policy for the container.
<a name="ContainerResizePolicy"></a>
*ContainerResizePolicy represents resource resize policy for the container.*
- **resizePolicy.resourceName** (string), required
Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
- **resizePolicy.restartPolicy** (string), required
Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
### Lifecycle
- **terminationMessagePath** (string)
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
- **terminationMessagePolicy** (string)
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- **restartPolicy** (string)
Restart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers.
### Debugging
- **stdin** (boolean)
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
- **stdinOnce** (boolean)
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
- **tty** (boolean)
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
### Security context
- **securityContext** (SecurityContext)
Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
<a name="SecurityContext"></a>
*SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.*
- **securityContext.allowPrivilegeEscalation** (boolean)
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
- **securityContext.appArmorProfile** (AppArmorProfile)
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
<a name="AppArmorProfile"></a>
*AppArmorProfile defines a pod or container's AppArmor settings.*
- **securityContext.appArmorProfile.type** (string), required
type indicates which kind of AppArmor profile will be applied. Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
- **securityContext.appArmorProfile.localhostProfile** (string)
localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
- **securityContext.capabilities** (Capabilities)
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
<a name="Capabilities"></a>
*Adds and removes POSIX capabilities from running containers.*
- **securityContext.capabilities.add** ([]string)
*Atomic: will be replaced during a merge*
Added capabilities
- **securityContext.capabilities.drop** ([]string)
*Atomic: will be replaced during a merge*
Removed capabilities
- **securityContext.procMount** (string)
procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.privileged** (boolean)
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.readOnlyRootFilesystem** (boolean)
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.runAsUser** (int64)
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.runAsNonRoot** (boolean)
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- **securityContext.runAsGroup** (int64)
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
- **securityContext.seLinuxOptions** (SELinuxOptions)
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
<a name="SELinuxOptions"></a>
*SELinuxOptions are the labels to be applied to the container*
- **securityContext.seLinuxOptions.level** (string)
Level is SELinux level label that applies to the container.
- **securityContext.seLinuxOptions.role** (string)
Role is a SELinux role label that applies to the container.
- **securityContext.seLinuxOptions.type** (string)
Type is a SELinux type label that applies to the container.
- **securityContext.seLinuxOptions.user** (string)
User is a SELinux user label that applies to the container.
- **securityContext.seccompProfile** (SeccompProfile)
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
<a name="SeccompProfile"></a>
*SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.*
- **securityContext.seccompProfile.type** (string), required
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
- **securityContext.seccompProfile.localhostProfile** (string)
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
- **securityContext.windowsOptions** (WindowsSecurityContextOptions)
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
<a name="WindowsSecurityContextOptions"></a>
*WindowsSecurityContextOptions contain Windows-specific options and credentials.*
- **securityContext.windowsOptions.gmsaCredentialSpec** (string)
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
- **securityContext.windowsOptions.gmsaCredentialSpecName** (string)
GMSACredentialSpecName is the name of the GMSA credential spec to use.
- **securityContext.windowsOptions.hostProcess** (boolean)
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
- **securityContext.windowsOptions.runAsUserName** (string)
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
### Not allowed
- **ports** ([]ContainerPort)
*Patch strategy: merge on key `containerPort`*
*Map: unique values on keys `containerPort, protocol` will be kept during a merge*
Ports are not allowed for ephemeral containers.
<a name="ContainerPort"></a>
*ContainerPort represents a network port in a single container.*
- **ports.containerPort** (int32), required
Number of port to expose on the pod's IP address. This must be a valid port number, 0 \< x \< 65536.
- **ports.hostIP** (string)
What host IP to bind the external port to.
- **ports.hostPort** (int32)
Number of port to expose on the host. If specified, this must be a valid port number, 0 \< x \< 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
- **ports.name** (string)
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
- **ports.protocol** (string)
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
- **resources** (ResourceRequirements)
Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
<a name="ResourceRequirements"></a>
*ResourceRequirements describes the compute resource requirements.*
- **resources.claims** ([]ResourceClaim)
*Map: unique values on key name will be kept during a merge*
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
<a name="ResourceClaim"></a>
*ResourceClaim references one entry in PodSpec.ResourceClaims.*
- **resources.claims.name** (string), required
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- **resources.claims.request** (string)
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
- **resources.limits** (map[string]<a href="">Quantity</a>)
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **resources.requests** (map[string]<a href="">Quantity</a>)
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **lifecycle** (Lifecycle)
Lifecycle is not allowed for ephemeral containers.
<a name="Lifecycle"></a>
*Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.*
- **lifecycle.postStart** (<a href="">LifecycleHandler</a>)
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- **lifecycle.preStop** (<a href="">LifecycleHandler</a>)
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- **livenessProbe** (<a href="">Probe</a>)
Probes are not allowed for ephemeral containers.
- **readinessProbe** (<a href="">Probe</a>)
Probes are not allowed for ephemeral containers.
- **startupProbe** (<a href="">Probe</a>)
Probes are not allowed for ephemeral containers.
## LifecycleHandler {#LifecycleHandler}
LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.
<hr>
- **exec** (ExecAction)
Exec specifies the action to take.
<a name="ExecAction"></a>
*ExecAction describes a "run in container" action.*
- **exec.command** ([]string)
*Atomic: will be replaced during a merge*
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- **httpGet** (HTTPGetAction)
HTTPGet specifies the http request to perform.
<a name="HTTPGetAction"></a>
*HTTPGetAction describes an action based on HTTP Get requests.*
- **httpGet.port** (IntOrString), required
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **httpGet.host** (string)
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
- **httpGet.httpHeaders** ([]HTTPHeader)
*Atomic: will be replaced during a merge*
Custom headers to set in the request. HTTP allows repeated headers.
<a name="HTTPHeader"></a>
*HTTPHeader describes a custom header to be used in HTTP probes*
- **httpGet.httpHeaders.name** (string), required
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- **httpGet.httpHeaders.value** (string), required
The header field value
- **httpGet.path** (string)
Path to access on the HTTP server.
- **httpGet.scheme** (string)
Scheme to use for connecting to the host. Defaults to HTTP.
- **sleep** (SleepAction)
Sleep represents the duration that the container should sleep before being terminated.
<a name="SleepAction"></a>
*SleepAction describes a "sleep" action.*
- **sleep.seconds** (int64), required
Seconds is the number of seconds to sleep.
- **tcpSocket** (TCPSocketAction)
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
<a name="TCPSocketAction"></a>
*TCPSocketAction describes an action based on opening a socket*
- **tcpSocket.port** (IntOrString), required
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **tcpSocket.host** (string)
Optional: Host name to connect to, defaults to the pod IP.
## NodeAffinity {#NodeAffinity}
Node affinity is a group of node affinity scheduling rules.
<hr>
- **preferredDuringSchedulingIgnoredDuringExecution** ([]PreferredSchedulingTerm)
*Atomic: will be replaced during a merge*
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
<a name="PreferredSchedulingTerm"></a>
*An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).*
- **preferredDuringSchedulingIgnoredDuringExecution.preference** (NodeSelectorTerm), required
A node selector term, associated with the corresponding weight.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's labels.
- **preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's fields.
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
- **requiredDuringSchedulingIgnoredDuringExecution** (NodeSelector)
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
<a name="NodeSelector"></a>
*A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.*
- **requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms** ([]NodeSelectorTerm), required
*Atomic: will be replaced during a merge*
Required. A list of node selector terms. The terms are ORed.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's labels.
- **requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's fields.
## PodAffinity {#PodAffinity}
Pod affinity is a group of inter pod affinity scheduling rules.
<hr>
- **preferredDuringSchedulingIgnoredDuringExecution** ([]WeightedPodAffinityTerm)
*Atomic: will be replaced during a merge*
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
<a name="WeightedPodAffinityTerm"></a>
*The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)*
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm** (PodAffinityTerm), required
Required. A pod affinity term, associated with the corresponding weight.
<a name="PodAffinityTerm"></a>
*Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running*
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey** (string), required
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector** (<a href="">LabelSelector</a>)
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.matchLabelKeys** ([]string)
*Atomic: will be replaced during a merge*
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.mismatchLabelKeys** ([]string)
*Atomic: will be replaced during a merge*
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector** (<a href="">LabelSelector</a>)
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces** ([]string)
*Atomic: will be replaced during a merge*
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- **requiredDuringSchedulingIgnoredDuringExecution** ([]PodAffinityTerm)
*Atomic: will be replaced during a merge*
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
<a name="PodAffinityTerm"></a>
*Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running*
- **requiredDuringSchedulingIgnoredDuringExecution.topologyKey** (string), required
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
- **requiredDuringSchedulingIgnoredDuringExecution.labelSelector** (<a href="">LabelSelector</a>)
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
- **requiredDuringSchedulingIgnoredDuringExecution.matchLabelKeys** ([]string)
*Atomic: will be replaced during a merge*
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- **requiredDuringSchedulingIgnoredDuringExecution.mismatchLabelKeys** ([]string)
*Atomic: will be replaced during a merge*
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- **requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector** (<a href="">LabelSelector</a>)
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
- **requiredDuringSchedulingIgnoredDuringExecution.namespaces** ([]string)
*Atomic: will be replaced during a merge*
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
## PodAntiAffinity {#PodAntiAffinity}
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
<hr>
- **preferredDuringSchedulingIgnoredDuringExecution** ([]WeightedPodAffinityTerm)
*Atomic: will be replaced during a merge*
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
<a name="WeightedPodAffinityTerm"></a>
*The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)*
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm** (PodAffinityTerm), required
Required. A pod affinity term, associated with the corresponding weight.
<a name="PodAffinityTerm"></a>
*Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running*
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey** (string), required
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector** (<a href="">LabelSelector</a>)
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.matchLabelKeys** ([]string)
*Atomic: will be replaced during a merge*
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.mismatchLabelKeys** ([]string)
*Atomic: will be replaced during a merge*
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector** (<a href="">LabelSelector</a>)
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces** ([]string)
*Atomic: will be replaced during a merge*
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- **requiredDuringSchedulingIgnoredDuringExecution** ([]PodAffinityTerm)
*Atomic: will be replaced during a merge*
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
<a name="PodAffinityTerm"></a>
*Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running*
- **requiredDuringSchedulingIgnoredDuringExecution.topologyKey** (string), required
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
- **requiredDuringSchedulingIgnoredDuringExecution.labelSelector** (<a href="">LabelSelector</a>)
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
- **requiredDuringSchedulingIgnoredDuringExecution.matchLabelKeys** ([]string)
*Atomic: will be replaced during a merge*
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- **requiredDuringSchedulingIgnoredDuringExecution.mismatchLabelKeys** ([]string)
*Atomic: will be replaced during a merge*
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- **requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector** (<a href="">LabelSelector</a>)
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
- **requiredDuringSchedulingIgnoredDuringExecution.namespaces** ([]string)
*Atomic: will be replaced during a merge*
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
## Probe {#Probe}
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
<hr>
- **exec** (ExecAction)
Exec specifies the action to take.
<a name="ExecAction"></a>
*ExecAction describes a "run in container" action.*
- **exec.command** ([]string)
*Atomic: will be replaced during a merge*
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
- **httpGet** (HTTPGetAction)
HTTPGet specifies the http request to perform.
<a name="HTTPGetAction"></a>
*HTTPGetAction describes an action based on HTTP Get requests.*
- **httpGet.port** (IntOrString), required
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **httpGet.host** (string)
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
- **httpGet.httpHeaders** ([]HTTPHeader)
*Atomic: will be replaced during a merge*
Custom headers to set in the request. HTTP allows repeated headers.
<a name="HTTPHeader"></a>
*HTTPHeader describes a custom header to be used in HTTP probes*
- **httpGet.httpHeaders.name** (string), required
The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
- **httpGet.httpHeaders.value** (string), required
The header field value
- **httpGet.path** (string)
Path to access on the HTTP server.
- **httpGet.scheme** (string)
Scheme to use for connecting to the host. Defaults to HTTP.
- **tcpSocket** (TCPSocketAction)
TCPSocket specifies an action involving a TCP port.
<a name="TCPSocketAction"></a>
*TCPSocketAction describes an action based on opening a socket*
- **tcpSocket.port** (IntOrString), required
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **tcpSocket.host** (string)
Optional: Host name to connect to, defaults to the pod IP.
- **initialDelaySeconds** (int32)
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- **terminationGracePeriodSeconds** (int64)
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
- **periodSeconds** (int32)
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- **timeoutSeconds** (int32)
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- **failureThreshold** (int32)
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- **successThreshold** (int32)
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
- **grpc** (GRPCAction)
GRPC specifies an action involving a GRPC port.
<a name="GRPCAction"></a>
**
- **grpc.port** (int32), required
Port number of the gRPC service. Number must be in the range 1 to 65535.
- **grpc.service** (string)
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
If this is not specified, the default behavior is defined by gRPC.
## PodStatus {#PodStatus}
PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.
<hr>
- **nominatedNodeName** (string)
nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.
- **hostIP** (string)
hostIP holds the IP address of the host to which the pod is assigned. Empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns mean that HostIP will not be updated even if there is a node is assigned to pod
- **hostIPs** ([]HostIP)
*Patch strategy: merge on key `ip`*
*Atomic: will be replaced during a merge*
hostIPs holds the IP addresses allocated to the host. If this field is specified, the first entry must match the hostIP field. This list is empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns means that HostIPs will not be updated even if there is a node is assigned to this pod.
<a name="HostIP"></a>
*HostIP represents a single IP address allocated to the host.*
- **hostIPs.ip** (string), required
IP is the IP address assigned to the host
- **startTime** (Time)
RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **phase** (string)
The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:
Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
- **message** (string)
A human readable message indicating details about why the pod is in this condition.
- **reason** (string)
A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'
- **podIP** (string)
podIP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
- **podIPs** ([]PodIP)
*Patch strategy: merge on key `ip`*
*Map: unique values on key ip will be kept during a merge*
podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.
<a name="PodIP"></a>
*PodIP represents a single IP address allocated to the pod.*
- **podIPs.ip** (string), required
IP is the IP address assigned to the pod
- **conditions** ([]PodCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
<a name="PodCondition"></a>
*PodCondition contains details for the current condition of this pod.*
- **conditions.status** (string), required
Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
- **conditions.type** (string), required
Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
- **conditions.lastProbeTime** (Time)
Last time we probed the condition.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.lastTransitionTime** (Time)
Last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
Human-readable message indicating details about last transition.
- **conditions.reason** (string)
Unique, one-word, CamelCase reason for the condition's last transition.
- **qosClass** (string)
The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#quality-of-service-classes
- **initContainerStatuses** ([]ContainerStatus)
*Atomic: will be replaced during a merge*
The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
<a name="ContainerStatus"></a>
*ContainerStatus contains details for the current status of this container.*
- **initContainerStatuses.allocatedResources** (map[string]<a href="">Quantity</a>)
AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after successfully admitting desired pod resize.
- **initContainerStatuses.allocatedResourcesStatus** ([]ResourceStatus)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
AllocatedResourcesStatus represents the status of various resources allocated for this Pod.
<a name="ResourceStatus"></a>
**
- **initContainerStatuses.allocatedResourcesStatus.name** (string), required
Name of the resource. Must be unique within the pod and match one of the resources from the pod spec.
- **initContainerStatuses.allocatedResourcesStatus.resources** ([]ResourceHealth)
*Map: unique values on key resourceID will be kept during a merge*
List of unique Resources health. Each element in the list contains an unique resource ID and resource health. At a minimum, ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod. See ResourceID type for it's definition.
<a name="ResourceHealth"></a>
*ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680 and historical health changes are planned to be added in future iterations of a KEP.*
- **initContainerStatuses.allocatedResourcesStatus.resources.resourceID** (string), required
ResourceID is the unique identifier of the resource. See the ResourceID type for more information.
- **initContainerStatuses.allocatedResourcesStatus.resources.health** (string)
Health of the resource. can be one of:
- Healthy: operates as normal
- Unhealthy: reported unhealthy. We consider this a temporary health issue
since we do not have a mechanism today to distinguish
temporary and permanent issues.
- Unknown: The status cannot be determined.
For example, Device Plugin got unregistered and hasn't been re-registered since.
In future we may want to introduce the PermanentlyUnhealthy Status.
- **initContainerStatuses.containerID** (string)
ContainerID is the ID of the container in the format '\<type>://\<container_id>'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd").
- **initContainerStatuses.image** (string), required
Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images.
- **initContainerStatuses.imageID** (string), required
ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.
- **initContainerStatuses.lastState** (ContainerState)
LastTerminationState holds the last termination state of the container to help debug container crashes and restarts. This field is not populated if the container is still running and RestartCount is 0.
<a name="ContainerState"></a>
*ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.*
- **initContainerStatuses.lastState.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **initContainerStatuses.lastState.running.startedAt** (Time)
Time at which the container was last (re-)started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **initContainerStatuses.lastState.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **initContainerStatuses.lastState.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **initContainerStatuses.lastState.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **initContainerStatuses.lastState.terminated.startedAt** (Time)
Time at which previous execution of the container started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **initContainerStatuses.lastState.terminated.finishedAt** (Time)
Time at which the container last terminated
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **initContainerStatuses.lastState.terminated.message** (string)
Message regarding the last termination of the container
- **initContainerStatuses.lastState.terminated.reason** (string)
(brief) reason from the last termination of the container
- **initContainerStatuses.lastState.terminated.signal** (int32)
Signal from the last termination of the container
- **initContainerStatuses.lastState.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **initContainerStatuses.lastState.waiting.message** (string)
Message regarding why the container is not yet running.
- **initContainerStatuses.lastState.waiting.reason** (string)
(brief) reason the container is not yet running.
- **initContainerStatuses.name** (string), required
Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.
- **initContainerStatuses.ready** (boolean), required
Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field).
The value is typically used to determine whether a container is ready to accept traffic.
- **initContainerStatuses.resources** (ResourceRequirements)
Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized.
<a name="ResourceRequirements"></a>
*ResourceRequirements describes the compute resource requirements.*
- **initContainerStatuses.resources.claims** ([]ResourceClaim)
*Map: unique values on key name will be kept during a merge*
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
<a name="ResourceClaim"></a>
*ResourceClaim references one entry in PodSpec.ResourceClaims.*
- **initContainerStatuses.resources.claims.name** (string), required
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- **initContainerStatuses.resources.claims.request** (string)
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
- **initContainerStatuses.resources.limits** (map[string]<a href="">Quantity</a>)
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **initContainerStatuses.resources.requests** (map[string]<a href="">Quantity</a>)
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **initContainerStatuses.restartCount** (int32), required
RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative.
- **initContainerStatuses.started** (boolean)
Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false.
- **initContainerStatuses.state** (ContainerState)
State holds details about the container's current condition.
<a name="ContainerState"></a>
*ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.*
- **initContainerStatuses.state.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **initContainerStatuses.state.running.startedAt** (Time)
Time at which the container was last (re-)started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **initContainerStatuses.state.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **initContainerStatuses.state.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **initContainerStatuses.state.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **initContainerStatuses.state.terminated.startedAt** (Time)
Time at which previous execution of the container started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **initContainerStatuses.state.terminated.finishedAt** (Time)
Time at which the container last terminated
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **initContainerStatuses.state.terminated.message** (string)
Message regarding the last termination of the container
- **initContainerStatuses.state.terminated.reason** (string)
(brief) reason from the last termination of the container
- **initContainerStatuses.state.terminated.signal** (int32)
Signal from the last termination of the container
- **initContainerStatuses.state.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **initContainerStatuses.state.waiting.message** (string)
Message regarding why the container is not yet running.
- **initContainerStatuses.state.waiting.reason** (string)
(brief) reason the container is not yet running.
- **initContainerStatuses.user** (ContainerUser)
User represents user identity information initially attached to the first process of the container
<a name="ContainerUser"></a>
*ContainerUser represents user identity information*
- **initContainerStatuses.user.linux** (LinuxContainerUser)
Linux holds user identity information initially attached to the first process of the containers in Linux. Note that the actual running identity can be changed if the process has enough privilege to do so.
<a name="LinuxContainerUser"></a>
*LinuxContainerUser represents user identity information in Linux containers*
- **initContainerStatuses.user.linux.gid** (int64), required
GID is the primary gid initially attached to the first process in the container
- **initContainerStatuses.user.linux.uid** (int64), required
UID is the primary uid initially attached to the first process in the container
- **initContainerStatuses.user.linux.supplementalGroups** ([]int64)
*Atomic: will be replaced during a merge*
SupplementalGroups are the supplemental groups initially attached to the first process in the container
- **initContainerStatuses.volumeMounts** ([]VolumeMountStatus)
*Patch strategy: merge on key `mountPath`*
*Map: unique values on key mountPath will be kept during a merge*
Status of volume mounts.
<a name="VolumeMountStatus"></a>
*VolumeMountStatus shows status of volume mounts.*
- **initContainerStatuses.volumeMounts.mountPath** (string), required
MountPath corresponds to the original VolumeMount.
- **initContainerStatuses.volumeMounts.name** (string), required
Name corresponds to the name of the original VolumeMount.
- **initContainerStatuses.volumeMounts.readOnly** (boolean)
ReadOnly corresponds to the original VolumeMount.
- **initContainerStatuses.volumeMounts.recursiveReadOnly** (string)
RecursiveReadOnly must be set to Disabled, Enabled, or unspecified (for non-readonly mounts). An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled, depending on the mount result.
- **containerStatuses** ([]ContainerStatus)
*Atomic: will be replaced during a merge*
The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
<a name="ContainerStatus"></a>
*ContainerStatus contains details for the current status of this container.*
- **containerStatuses.allocatedResources** (map[string]<a href="">Quantity</a>)
AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after successfully admitting desired pod resize.
- **containerStatuses.allocatedResourcesStatus** ([]ResourceStatus)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
AllocatedResourcesStatus represents the status of various resources allocated for this Pod.
<a name="ResourceStatus"></a>
**
- **containerStatuses.allocatedResourcesStatus.name** (string), required
Name of the resource. Must be unique within the pod and match one of the resources from the pod spec.
- **containerStatuses.allocatedResourcesStatus.resources** ([]ResourceHealth)
*Map: unique values on key resourceID will be kept during a merge*
List of unique Resources health. Each element in the list contains an unique resource ID and resource health. At a minimum, ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod. See ResourceID type for it's definition.
<a name="ResourceHealth"></a>
*ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680 and historical health changes are planned to be added in future iterations of a KEP.*
- **containerStatuses.allocatedResourcesStatus.resources.resourceID** (string), required
ResourceID is the unique identifier of the resource. See the ResourceID type for more information.
- **containerStatuses.allocatedResourcesStatus.resources.health** (string)
Health of the resource. can be one of:
- Healthy: operates as normal
- Unhealthy: reported unhealthy. We consider this a temporary health issue
since we do not have a mechanism today to distinguish
temporary and permanent issues.
- Unknown: The status cannot be determined.
For example, Device Plugin got unregistered and hasn't been re-registered since.
In future we may want to introduce the PermanentlyUnhealthy Status.
- **containerStatuses.containerID** (string)
ContainerID is the ID of the container in the format '\<type>://\<container_id>'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd").
- **containerStatuses.image** (string), required
Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images.
- **containerStatuses.imageID** (string), required
ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.
- **containerStatuses.lastState** (ContainerState)
LastTerminationState holds the last termination state of the container to help debug container crashes and restarts. This field is not populated if the container is still running and RestartCount is 0.
<a name="ContainerState"></a>
*ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.*
- **containerStatuses.lastState.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **containerStatuses.lastState.running.startedAt** (Time)
Time at which the container was last (re-)started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **containerStatuses.lastState.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **containerStatuses.lastState.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **containerStatuses.lastState.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **containerStatuses.lastState.terminated.startedAt** (Time)
Time at which previous execution of the container started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **containerStatuses.lastState.terminated.finishedAt** (Time)
Time at which the container last terminated
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **containerStatuses.lastState.terminated.message** (string)
Message regarding the last termination of the container
- **containerStatuses.lastState.terminated.reason** (string)
(brief) reason from the last termination of the container
- **containerStatuses.lastState.terminated.signal** (int32)
Signal from the last termination of the container
- **containerStatuses.lastState.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **containerStatuses.lastState.waiting.message** (string)
Message regarding why the container is not yet running.
- **containerStatuses.lastState.waiting.reason** (string)
(brief) reason the container is not yet running.
- **containerStatuses.name** (string), required
Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.
- **containerStatuses.ready** (boolean), required
Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field).
The value is typically used to determine whether a container is ready to accept traffic.
- **containerStatuses.resources** (ResourceRequirements)
Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized.
<a name="ResourceRequirements"></a>
*ResourceRequirements describes the compute resource requirements.*
- **containerStatuses.resources.claims** ([]ResourceClaim)
*Map: unique values on key name will be kept during a merge*
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
<a name="ResourceClaim"></a>
*ResourceClaim references one entry in PodSpec.ResourceClaims.*
- **containerStatuses.resources.claims.name** (string), required
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- **containerStatuses.resources.claims.request** (string)
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
- **containerStatuses.resources.limits** (map[string]<a href="">Quantity</a>)
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **containerStatuses.resources.requests** (map[string]<a href="">Quantity</a>)
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **containerStatuses.restartCount** (int32), required
RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative.
- **containerStatuses.started** (boolean)
Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false.
- **containerStatuses.state** (ContainerState)
State holds details about the container's current condition.
<a name="ContainerState"></a>
*ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.*
- **containerStatuses.state.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **containerStatuses.state.running.startedAt** (Time)
Time at which the container was last (re-)started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **containerStatuses.state.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **containerStatuses.state.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **containerStatuses.state.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **containerStatuses.state.terminated.startedAt** (Time)
Time at which previous execution of the container started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **containerStatuses.state.terminated.finishedAt** (Time)
Time at which the container last terminated
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **containerStatuses.state.terminated.message** (string)
Message regarding the last termination of the container
- **containerStatuses.state.terminated.reason** (string)
(brief) reason from the last termination of the container
- **containerStatuses.state.terminated.signal** (int32)
Signal from the last termination of the container
- **containerStatuses.state.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **containerStatuses.state.waiting.message** (string)
Message regarding why the container is not yet running.
- **containerStatuses.state.waiting.reason** (string)
(brief) reason the container is not yet running.
- **containerStatuses.user** (ContainerUser)
User represents user identity information initially attached to the first process of the container
<a name="ContainerUser"></a>
*ContainerUser represents user identity information*
- **containerStatuses.user.linux** (LinuxContainerUser)
Linux holds user identity information initially attached to the first process of the containers in Linux. Note that the actual running identity can be changed if the process has enough privilege to do so.
<a name="LinuxContainerUser"></a>
*LinuxContainerUser represents user identity information in Linux containers*
- **containerStatuses.user.linux.gid** (int64), required
GID is the primary gid initially attached to the first process in the container
- **containerStatuses.user.linux.uid** (int64), required
UID is the primary uid initially attached to the first process in the container
- **containerStatuses.user.linux.supplementalGroups** ([]int64)
*Atomic: will be replaced during a merge*
SupplementalGroups are the supplemental groups initially attached to the first process in the container
- **containerStatuses.volumeMounts** ([]VolumeMountStatus)
*Patch strategy: merge on key `mountPath`*
*Map: unique values on key mountPath will be kept during a merge*
Status of volume mounts.
<a name="VolumeMountStatus"></a>
*VolumeMountStatus shows status of volume mounts.*
- **containerStatuses.volumeMounts.mountPath** (string), required
MountPath corresponds to the original VolumeMount.
- **containerStatuses.volumeMounts.name** (string), required
Name corresponds to the name of the original VolumeMount.
- **containerStatuses.volumeMounts.readOnly** (boolean)
ReadOnly corresponds to the original VolumeMount.
- **containerStatuses.volumeMounts.recursiveReadOnly** (string)
RecursiveReadOnly must be set to Disabled, Enabled, or unspecified (for non-readonly mounts). An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled, depending on the mount result.
- **ephemeralContainerStatuses** ([]ContainerStatus)
*Atomic: will be replaced during a merge*
Status for any ephemeral containers that have run in this pod.
<a name="ContainerStatus"></a>
*ContainerStatus contains details for the current status of this container.*
- **ephemeralContainerStatuses.allocatedResources** (map[string]<a href="">Quantity</a>)
AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after successfully admitting desired pod resize.
- **ephemeralContainerStatuses.allocatedResourcesStatus** ([]ResourceStatus)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
AllocatedResourcesStatus represents the status of various resources allocated for this Pod.
<a name="ResourceStatus"></a>
**
- **ephemeralContainerStatuses.allocatedResourcesStatus.name** (string), required
Name of the resource. Must be unique within the pod and match one of the resources from the pod spec.
- **ephemeralContainerStatuses.allocatedResourcesStatus.resources** ([]ResourceHealth)
*Map: unique values on key resourceID will be kept during a merge*
List of unique Resources health. Each element in the list contains an unique resource ID and resource health. At a minimum, ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod. See ResourceID type for it's definition.
<a name="ResourceHealth"></a>
*ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680 and historical health changes are planned to be added in future iterations of a KEP.*
- **ephemeralContainerStatuses.allocatedResourcesStatus.resources.resourceID** (string), required
ResourceID is the unique identifier of the resource. See the ResourceID type for more information.
- **ephemeralContainerStatuses.allocatedResourcesStatus.resources.health** (string)
Health of the resource. can be one of:
- Healthy: operates as normal
- Unhealthy: reported unhealthy. We consider this a temporary health issue
since we do not have a mechanism today to distinguish
temporary and permanent issues.
- Unknown: The status cannot be determined.
For example, Device Plugin got unregistered and hasn't been re-registered since.
In future we may want to introduce the PermanentlyUnhealthy Status.
- **ephemeralContainerStatuses.containerID** (string)
ContainerID is the ID of the container in the format '\<type>://\<container_id>'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd").
- **ephemeralContainerStatuses.image** (string), required
Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images.
- **ephemeralContainerStatuses.imageID** (string), required
ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.
- **ephemeralContainerStatuses.lastState** (ContainerState)
LastTerminationState holds the last termination state of the container to help debug container crashes and restarts. This field is not populated if the container is still running and RestartCount is 0.
<a name="ContainerState"></a>
*ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.*
- **ephemeralContainerStatuses.lastState.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **ephemeralContainerStatuses.lastState.running.startedAt** (Time)
Time at which the container was last (re-)started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **ephemeralContainerStatuses.lastState.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **ephemeralContainerStatuses.lastState.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **ephemeralContainerStatuses.lastState.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **ephemeralContainerStatuses.lastState.terminated.startedAt** (Time)
Time at which previous execution of the container started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **ephemeralContainerStatuses.lastState.terminated.finishedAt** (Time)
Time at which the container last terminated
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **ephemeralContainerStatuses.lastState.terminated.message** (string)
Message regarding the last termination of the container
- **ephemeralContainerStatuses.lastState.terminated.reason** (string)
(brief) reason from the last termination of the container
- **ephemeralContainerStatuses.lastState.terminated.signal** (int32)
Signal from the last termination of the container
- **ephemeralContainerStatuses.lastState.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **ephemeralContainerStatuses.lastState.waiting.message** (string)
Message regarding why the container is not yet running.
- **ephemeralContainerStatuses.lastState.waiting.reason** (string)
(brief) reason the container is not yet running.
- **ephemeralContainerStatuses.name** (string), required
Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.
- **ephemeralContainerStatuses.ready** (boolean), required
Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field).
The value is typically used to determine whether a container is ready to accept traffic.
- **ephemeralContainerStatuses.resources** (ResourceRequirements)
Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized.
<a name="ResourceRequirements"></a>
*ResourceRequirements describes the compute resource requirements.*
- **ephemeralContainerStatuses.resources.claims** ([]ResourceClaim)
*Map: unique values on key name will be kept during a merge*
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
<a name="ResourceClaim"></a>
*ResourceClaim references one entry in PodSpec.ResourceClaims.*
- **ephemeralContainerStatuses.resources.claims.name** (string), required
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
- **ephemeralContainerStatuses.resources.claims.request** (string)
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
- **ephemeralContainerStatuses.resources.limits** (map[string]<a href="">Quantity</a>)
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **ephemeralContainerStatuses.resources.requests** (map[string]<a href="">Quantity</a>)
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **ephemeralContainerStatuses.restartCount** (int32), required
RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative.
- **ephemeralContainerStatuses.started** (boolean)
Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false.
- **ephemeralContainerStatuses.state** (ContainerState)
State holds details about the container's current condition.
<a name="ContainerState"></a>
*ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.*
- **ephemeralContainerStatuses.state.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **ephemeralContainerStatuses.state.running.startedAt** (Time)
Time at which the container was last (re-)started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **ephemeralContainerStatuses.state.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **ephemeralContainerStatuses.state.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **ephemeralContainerStatuses.state.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **ephemeralContainerStatuses.state.terminated.startedAt** (Time)
Time at which previous execution of the container started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **ephemeralContainerStatuses.state.terminated.finishedAt** (Time)
Time at which the container last terminated
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **ephemeralContainerStatuses.state.terminated.message** (string)
Message regarding the last termination of the container
- **ephemeralContainerStatuses.state.terminated.reason** (string)
(brief) reason from the last termination of the container
- **ephemeralContainerStatuses.state.terminated.signal** (int32)
Signal from the last termination of the container
- **ephemeralContainerStatuses.state.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **ephemeralContainerStatuses.state.waiting.message** (string)
Message regarding why the container is not yet running.
- **ephemeralContainerStatuses.state.waiting.reason** (string)
(brief) reason the container is not yet running.
- **ephemeralContainerStatuses.user** (ContainerUser)
User represents user identity information initially attached to the first process of the container
<a name="ContainerUser"></a>
*ContainerUser represents user identity information*
- **ephemeralContainerStatuses.user.linux** (LinuxContainerUser)
Linux holds user identity information initially attached to the first process of the containers in Linux. Note that the actual running identity can be changed if the process has enough privilege to do so.
<a name="LinuxContainerUser"></a>
*LinuxContainerUser represents user identity information in Linux containers*
- **ephemeralContainerStatuses.user.linux.gid** (int64), required
GID is the primary gid initially attached to the first process in the container
- **ephemeralContainerStatuses.user.linux.uid** (int64), required
UID is the primary uid initially attached to the first process in the container
- **ephemeralContainerStatuses.user.linux.supplementalGroups** ([]int64)
*Atomic: will be replaced during a merge*
SupplementalGroups are the supplemental groups initially attached to the first process in the container
- **ephemeralContainerStatuses.volumeMounts** ([]VolumeMountStatus)
*Patch strategy: merge on key `mountPath`*
*Map: unique values on key mountPath will be kept during a merge*
Status of volume mounts.
<a name="VolumeMountStatus"></a>
*VolumeMountStatus shows status of volume mounts.*
- **ephemeralContainerStatuses.volumeMounts.mountPath** (string), required
MountPath corresponds to the original VolumeMount.
- **ephemeralContainerStatuses.volumeMounts.name** (string), required
Name corresponds to the name of the original VolumeMount.
- **ephemeralContainerStatuses.volumeMounts.readOnly** (boolean)
ReadOnly corresponds to the original VolumeMount.
- **ephemeralContainerStatuses.volumeMounts.recursiveReadOnly** (string)
RecursiveReadOnly must be set to Disabled, Enabled, or unspecified (for non-readonly mounts). An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled, depending on the mount result.
- **resourceClaimStatuses** ([]PodResourceClaimStatus)
*Patch strategies: retainKeys, merge on key `name`*
*Map: unique values on key name will be kept during a merge*
Status of resource claims.
<a name="PodResourceClaimStatus"></a>
*PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim which references a ResourceClaimTemplate. It stores the generated name for the corresponding ResourceClaim.*
- **resourceClaimStatuses.name** (string), required
Name uniquely identifies this resource claim inside the pod. This must match the name of an entry in pod.spec.resourceClaims, which implies that the string must be a DNS_LABEL.
- **resourceClaimStatuses.resourceClaimName** (string)
ResourceClaimName is the name of the ResourceClaim that was generated for the Pod in the namespace of the Pod. If this is unset, then generating a ResourceClaim was not necessary. The pod.spec.resourceClaims entry can be ignored in this case.
- **resize** (string)
Status of resources resize desired for pod's containers. It is empty if no resources resize is pending. Any changes to container resources will automatically set this to "Proposed"
## PodList {#PodList}
PodList is a list of Pods.
<hr>
- **items** ([]<a href="">Pod</a>), required
List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
- **apiVersion** (string)
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
## Operations {#Operations}
<hr>
### `get` read the specified Pod
#### HTTP Request
GET /api/v1/namespaces/{namespace}/pods/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
401: Unauthorized
### `get` read ephemeralcontainers of the specified Pod
#### HTTP Request
GET /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
401: Unauthorized
### `get` read log of the specified Pod
#### HTTP Request
GET /api/v1/namespaces/{namespace}/pods/{name}/log
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **container** (*in query*): string
The container for which to stream logs. Defaults to only container if there is one container in the pod.
- **follow** (*in query*): boolean
Follow the log stream of the pod. Defaults to false.
- **insecureSkipTLSVerifyBackend** (*in query*): boolean
insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).
- **limitBytes** (*in query*): integer
If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
- **pretty** (*in query*): string
<a href="">pretty</a>
- **previous** (*in query*): boolean
Return previous terminated container logs. Defaults to false.
- **sinceSeconds** (*in query*): integer
A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
- **tailLines** (*in query*): integer
If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime
- **timestamps** (*in query*): boolean
If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.
#### Response
200 (string): OK
401: Unauthorized
### `get` read status of the specified Pod
#### HTTP Request
GET /api/v1/namespaces/{namespace}/pods/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Pod
#### HTTP Request
GET /api/v1/namespaces/{namespace}/pods
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PodList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Pod
#### HTTP Request
GET /api/v1/pods
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PodList</a>): OK
401: Unauthorized
### `create` create a Pod
#### HTTP Request
POST /api/v1/namespaces/{namespace}/pods
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Pod</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
201 (<a href="">Pod</a>): Created
202 (<a href="">Pod</a>): Accepted
401: Unauthorized
### `update` replace the specified Pod
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/pods/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Pod</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
201 (<a href="">Pod</a>): Created
401: Unauthorized
### `update` replace ephemeralcontainers of the specified Pod
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Pod</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
201 (<a href="">Pod</a>): Created
401: Unauthorized
### `update` replace status of the specified Pod
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Pod</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
201 (<a href="">Pod</a>): Created
401: Unauthorized
### `patch` partially update the specified Pod
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/pods/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
201 (<a href="">Pod</a>): Created
401: Unauthorized
### `patch` partially update ephemeralcontainers of the specified Pod
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
201 (<a href="">Pod</a>): Created
401: Unauthorized
### `patch` partially update status of the specified Pod
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Pod</a>): OK
201 (<a href="">Pod</a>): Created
401: Unauthorized
### `delete` delete a Pod
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/pods/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Pod
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Pod</a>): OK
202 (<a href="">Pod</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Pod
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/pods
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind Pod content type api reference description Pod is a collection of containers that can run on a host title Pod weight 1 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 apiVersion v1 import k8s io api core v1 Pod Pod Pod is a collection of containers that can run on a host This resource is created by clients and scheduled onto hosts hr apiVersion v1 kind Pod metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href PodSpec a Specification of the desired behavior of the pod More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href PodStatus a Most recently observed status of the pod This data may not be up to date Populated by the system Read only More info https git k8s io community contributors devel sig architecture api conventions md spec and status PodSpec PodSpec PodSpec is a description of a pod hr Containers containers a href Container a required Patch strategy merge on key name Map unique values on key name will be kept during a merge List of containers belonging to the pod Containers cannot currently be added or removed There must be at least one container in a Pod Cannot be updated initContainers a href Container a Patch strategy merge on key name Map unique values on key name will be kept during a merge List of initialization containers belonging to the pod Init containers are executed in order prior to containers being started If any init container fails the pod is considered to have failed and is handled according to its restartPolicy The name for an init container or normal container must be unique among all containers Init containers may not have Lifecycle actions Readiness probes Liveness probes or Startup probes The resourceRequirements of an init container are taken into account during scheduling by finding the highest request limit for each resource type and then using the max of of that value or the sum of the normal containers Limits are applied to init containers in a similar fashion Init containers cannot currently be added or removed Cannot be updated More info https kubernetes io docs concepts workloads pods init containers ephemeralContainers a href EphemeralContainer a Patch strategy merge on key name Map unique values on key name will be kept during a merge List of ephemeral containers run in this pod Ephemeral containers may be run in an existing pod to perform user initiated actions such as debugging This list cannot be specified when creating a pod and it cannot be modified by updating the pod spec In order to add an ephemeral container to an existing pod use the pod s ephemeralcontainers subresource imagePullSecrets a href LocalObjectReference a Patch strategy merge on key name Map unique values on key name will be kept during a merge ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec If specified these secrets will be passed to individual puller implementations for them to use More info https kubernetes io docs concepts containers images specifying imagepullsecrets on a pod enableServiceLinks boolean EnableServiceLinks indicates whether information about services should be injected into pod s environment variables matching the syntax of Docker links Optional Defaults to true os PodOS Specifies the OS of the containers in the pod Some pod and container fields are restricted if this is set If the OS field is set to linux the following fields must be unset securityContext windowsOptions If the OS field is set to windows following fields must be unset spec hostPID spec hostIPC spec hostUsers spec securityContext appArmorProfile spec securityContext seLinuxOptions spec securityContext seccompProfile spec securityContext fsGroup spec securityContext fsGroupChangePolicy spec securityContext sysctls spec shareProcessNamespace spec securityContext runAsUser spec securityContext runAsGroup spec securityContext supplementalGroups spec securityContext supplementalGroupsPolicy spec containers securityContext appArmorProfile spec containers securityContext seLinuxOptions spec containers securityContext seccompProfile spec containers securityContext capabilities spec containers securityContext readOnlyRootFilesystem spec containers securityContext privileged spec containers securityContext allowPrivilegeEscalation spec containers securityContext procMount spec containers securityContext runAsUser spec containers securityContext runAsGroup a name PodOS a PodOS defines the OS parameters of a pod os name string required Name is the name of the operating system The currently supported values are linux and windows Additional value may be defined in future and can be one of https github com opencontainers runtime spec blob master config md platform specific configuration Clients should expect to handle additional values and treat unrecognized values in this field as os null Volumes volumes a href Volume a Patch strategies retainKeys merge on key name Map unique values on key name will be kept during a merge List of volumes that can be mounted by containers belonging to the pod More info https kubernetes io docs concepts storage volumes Scheduling nodeSelector map string string NodeSelector is a selector which must be true for the pod to fit on a node Selector which must match a node s labels for the pod to be scheduled on that node More info https kubernetes io docs concepts configuration assign pod node nodeName string NodeName indicates in which node this pod is scheduled If empty this pod is a candidate for scheduling by the scheduler defined in schedulerName Once this field is set the kubelet for this node becomes responsible for the lifecycle of this pod This field should not be used to express a desire for the pod to be scheduled on a specific node https kubernetes io docs concepts scheduling eviction assign pod node nodename affinity Affinity If specified the pod s scheduling constraints a name Affinity a Affinity is a group of affinity scheduling rules affinity nodeAffinity a href NodeAffinity a Describes node affinity scheduling rules for the pod affinity podAffinity a href PodAffinity a Describes pod affinity scheduling rules e g co locate this pod in the same node zone etc as some other pod s affinity podAntiAffinity a href PodAntiAffinity a Describes pod anti affinity scheduling rules e g avoid putting this pod in the same node zone etc as some other pod s tolerations Toleration Atomic will be replaced during a merge If specified the pod s tolerations a name Toleration a The pod this Toleration is attached to tolerates any taint that matches the triple key value effect using the matching operator operator tolerations key string Key is the taint key that the toleration applies to Empty means match all taint keys If the key is empty operator must be Exists this combination means to match all values and all keys tolerations operator string Operator represents a key s relationship to the value Valid operators are Exists and Equal Defaults to Equal Exists is equivalent to wildcard for value so that a pod can tolerate all taints of a particular category tolerations value string Value is the taint value the toleration matches to If the operator is Exists the value should be empty otherwise just a regular string tolerations effect string Effect indicates the taint effect to match Empty means match all taint effects When specified allowed values are NoSchedule PreferNoSchedule and NoExecute tolerations tolerationSeconds int64 TolerationSeconds represents the period of time the toleration which must be of effect NoExecute otherwise this field is ignored tolerates the taint By default it is not set which means tolerate the taint forever do not evict Zero and negative values will be treated as 0 evict immediately by the system schedulerName string If specified the pod will be dispatched by specified scheduler If not specified the pod will be dispatched by default scheduler runtimeClassName string RuntimeClassName refers to a RuntimeClass object in the node k8s io group which should be used to run this pod If no RuntimeClass resource matches the named class the pod will not be run If unset or empty the legacy RuntimeClass will be used which is an implicit class with an empty definition that uses the default runtime handler More info https git k8s io enhancements keps sig node 585 runtime class priorityClassName string If specified indicates the pod s priority system node critical and system cluster critical are two special keywords which indicate the highest priorities with the former being the highest priority Any other name must be defined by creating a PriorityClass object with that name If not specified the pod priority will be default or zero if there is no default priority int32 The priority value Various system components use this field to find the priority of the pod When Priority Admission Controller is enabled it prevents users from setting this field The admission controller populates this field from PriorityClassName The higher the value the higher the priority preemptionPolicy string PreemptionPolicy is the Policy for preempting pods with lower priority One of Never PreemptLowerPriority Defaults to PreemptLowerPriority if unset topologySpreadConstraints TopologySpreadConstraint Patch strategy merge on key topologyKey Map unique values on keys topologyKey whenUnsatisfiable will be kept during a merge TopologySpreadConstraints describes how a group of pods ought to spread across topology domains Scheduler will schedule pods in a way which abides by the constraints All topologySpreadConstraints are ANDed a name TopologySpreadConstraint a TopologySpreadConstraint specifies how to spread matching pods among the given topology topologySpreadConstraints maxSkew int32 required MaxSkew describes the degree to which pods may be unevenly distributed When whenUnsatisfiable DoNotSchedule it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains For example in a 3 zone cluster MaxSkew is set to 1 and pods with the same labelSelector spread as 2 2 1 In this case the global minimum is 1 zone1 zone2 zone3 P P P P P if MaxSkew is 1 incoming pod can only be scheduled to zone3 to become 2 2 2 scheduling it onto zone1 zone2 would make the ActualSkew 3 1 on zone1 zone2 violate MaxSkew 1 if MaxSkew is 2 incoming pod can be scheduled onto any zone When whenUnsatisfiable ScheduleAnyway it is used to give higher precedence to topologies that satisfy it It s a required field Default value is 1 and 0 is not allowed topologySpreadConstraints topologyKey string required TopologyKey is the key of node labels Nodes that have a label with this key and identical values are considered to be in the same topology We consider each key value as a bucket and try to put balanced number of pods into each bucket We define a domain as a particular instance of a topology Also we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy e g If TopologyKey is kubernetes io hostname each Node is a domain of that topology And if TopologyKey is topology kubernetes io zone each zone is a domain of that topology It s a required field topologySpreadConstraints whenUnsatisfiable string required WhenUnsatisfiable indicates how to deal with a pod if it doesn t satisfy the spread constraint DoNotSchedule default tells the scheduler not to schedule it ScheduleAnyway tells the scheduler to schedule the pod in any location but giving higher precedence to topologies that would help reduce the skew A constraint is considered Unsatisfiable for an incoming pod if and only if every possible node assignment for that pod would violate MaxSkew on some topology For example in a 3 zone cluster MaxSkew is set to 1 and pods with the same labelSelector spread as 3 1 1 zone1 zone2 zone3 P P P P P If WhenUnsatisfiable is set to DoNotSchedule incoming pod can only be scheduled to zone2 zone3 to become 3 2 1 3 1 2 as ActualSkew 2 1 on zone2 zone3 satisfies MaxSkew 1 In other words the cluster can still be imbalanced but scheduler won t make it more imbalanced It s a required field topologySpreadConstraints labelSelector a href LabelSelector a LabelSelector is used to find matching pods Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain topologySpreadConstraints matchLabelKeys string Atomic will be replaced during a merge MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated The keys are used to lookup values from the incoming pod labels those key value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod The same key is forbidden to exist in both MatchLabelKeys and LabelSelector MatchLabelKeys cannot be set when LabelSelector isn t set Keys that don t exist in the incoming pod labels will be ignored A null or empty list means only match against labelSelector This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled enabled by default topologySpreadConstraints minDomains int32 MinDomains indicates a minimum number of eligible domains When the number of eligible domains with matching topology keys is less than minDomains Pod Topology Spread treats global minimum as 0 and then the calculation of Skew is performed And when the number of eligible domains with matching topology keys equals or greater than minDomains this value has no effect on scheduling As a result when the number of eligible domains is less than minDomains scheduler won t schedule more than maxSkew Pods to those domains If value is nil the constraint behaves as if MinDomains is equal to 1 Valid values are integers greater than 0 When value is not nil WhenUnsatisfiable must be DoNotSchedule For example in a 3 zone cluster MaxSkew is set to 2 MinDomains is set to 5 and pods with the same labelSelector spread as 2 2 2 zone1 zone2 zone3 P P P P P P The number of domains is less than 5 MinDomains so global minimum is treated as 0 In this situation new pod with the same labelSelector cannot be scheduled because computed skew will be 3 3 0 if new Pod is scheduled to any of the three zones it will violate MaxSkew topologySpreadConstraints nodeAffinityPolicy string NodeAffinityPolicy indicates how we will treat Pod s nodeAffinity nodeSelector when calculating pod topology spread skew Options are Honor only nodes matching nodeAffinity nodeSelector are included in the calculations Ignore nodeAffinity nodeSelector are ignored All nodes are included in the calculations If this value is nil the behavior is equivalent to the Honor policy This is a beta level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag topologySpreadConstraints nodeTaintsPolicy string NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew Options are Honor nodes without taints along with tainted nodes for which the incoming pod has a toleration are included Ignore node taints are ignored All nodes are included If this value is nil the behavior is equivalent to the Ignore policy This is a beta level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag overhead map string a href Quantity a Overhead represents the resource overhead associated with running a pod for a given RuntimeClass This field will be autopopulated at admission time by the RuntimeClass admission controller If the RuntimeClass admission controller is enabled overhead must not be set in Pod create requests The RuntimeClass admission controller will reject Pod create requests which have the overhead already set If RuntimeClass is configured and selected in the PodSpec Overhead will be set to the value defined in the corresponding RuntimeClass otherwise it will remain unset and treated as zero More info https git k8s io enhancements keps sig node 688 pod overhead README md Lifecycle restartPolicy string Restart policy for all containers within the pod One of Always OnFailure Never In some contexts only a subset of those values may be permitted Default to Always More info https kubernetes io docs concepts workloads pods pod lifecycle restart policy terminationGracePeriodSeconds int64 Optional duration in seconds the pod needs to terminate gracefully May be decreased in delete request Value must be non negative integer The value zero indicates stop immediately via the kill signal no opportunity to shut down If this value is nil the default grace period will be used instead The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal Set this value longer than the expected cleanup time for your process Defaults to 30 seconds activeDeadlineSeconds int64 Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers Value must be a positive integer readinessGates PodReadinessGate Atomic will be replaced during a merge If specified all readiness gates will be evaluated for pod readiness A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to True More info https git k8s io enhancements keps sig network 580 pod readiness gates a name PodReadinessGate a PodReadinessGate contains the reference to a pod condition readinessGates conditionType string required ConditionType refers to a condition in the pod s condition list with matching type Hostname and Name resolution hostname string Specifies the hostname of the Pod If not specified the pod s hostname will be set to a system defined value setHostnameAsFQDN boolean If true the pod s hostname will be configured as the pod s FQDN rather than the leaf name the default In Linux containers this means setting the FQDN in the hostname field of the kernel the nodename field of struct utsname In Windows containers this means setting the registry value of hostname for the registry key HKEY LOCAL MACHINE SYSTEM CurrentControlSet Services Tcpip Parameters to FQDN If a pod does not have FQDN this has no effect Default to false subdomain string If specified the fully qualified Pod hostname will be hostname subdomain pod namespace svc cluster domain If not specified the pod will not have a domainname at all hostAliases HostAlias Patch strategy merge on key ip Map unique values on key ip will be kept during a merge HostAliases is an optional list of hosts and IPs that will be injected into the pod s hosts file if specified a name HostAlias a HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod s hosts file hostAliases ip string required IP address of the host file entry hostAliases hostnames string Atomic will be replaced during a merge Hostnames for the above IP address dnsConfig PodDNSConfig Specifies the DNS parameters of a pod Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy a name PodDNSConfig a PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy dnsConfig nameservers string Atomic will be replaced during a merge A list of DNS name server IP addresses This will be appended to the base nameservers generated from DNSPolicy Duplicated nameservers will be removed dnsConfig options PodDNSConfigOption Atomic will be replaced during a merge A list of DNS resolver options This will be merged with the base options generated from DNSPolicy Duplicated entries will be removed Resolution options given in Options will override those that appear in the base DNSPolicy a name PodDNSConfigOption a PodDNSConfigOption defines DNS resolver options of a pod dnsConfig options name string Required dnsConfig options value string dnsConfig searches string Atomic will be replaced during a merge A list of DNS search domains for host name lookup This will be appended to the base search paths generated from DNSPolicy Duplicated search paths will be removed dnsPolicy string Set DNS policy for the pod Defaults to ClusterFirst Valid values are ClusterFirstWithHostNet ClusterFirst Default or None DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy To have DNS options set along with hostNetwork you have to specify DNS policy explicitly to ClusterFirstWithHostNet Hosts namespaces hostNetwork boolean Host networking requested for this pod Use the host s network namespace If this option is set the ports that will be used must be specified Default to false hostPID boolean Use the host s pid namespace Optional Default to false hostIPC boolean Use the host s ipc namespace Optional Default to false shareProcessNamespace boolean Share a single process namespace between all of the containers in a pod When this is set containers will be able to view and signal processes from other containers in the same pod and the first process in each container will not be assigned PID 1 HostPID and ShareProcessNamespace cannot both be set Optional Default to false Service account serviceAccountName string ServiceAccountName is the name of the ServiceAccount to use to run this pod More info https kubernetes io docs tasks configure pod container configure service account automountServiceAccountToken boolean AutomountServiceAccountToken indicates whether a service account token should be automatically mounted Security context securityContext PodSecurityContext SecurityContext holds pod level security attributes and common container settings Optional Defaults to empty See type description for default values of each field a name PodSecurityContext a PodSecurityContext holds pod level security attributes and common container settings Some fields are also present in container securityContext Field values of container securityContext take precedence over field values of PodSecurityContext securityContext appArmorProfile AppArmorProfile appArmorProfile is the AppArmor options to use by the containers in this pod Note that this field cannot be set when spec os name is windows a name AppArmorProfile a AppArmorProfile defines a pod or container s AppArmor settings securityContext appArmorProfile type string required type indicates which kind of AppArmor profile will be applied Valid options are Localhost a profile pre loaded on the node RuntimeDefault the container runtime s default profile Unconfined no AppArmor enforcement securityContext appArmorProfile localhostProfile string localhostProfile indicates a profile loaded on the node that should be used The profile must be preconfigured on the node to work Must match the loaded name of the profile Must be set if and only if type is Localhost securityContext fsGroup int64 A special supplemental group that applies to all containers in a pod Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod 1 The owning GID will be the FSGroup 2 The setgid bit is set new files created in the volume will be owned by FSGroup 3 The permission bits are OR d with rw rw If unset the Kubelet will not modify the ownership and permissions of any volume Note that this field cannot be set when spec os name is windows securityContext fsGroupChangePolicy string fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod This field will only apply to volume types which support fsGroup based ownership and permissions It will have no effect on ephemeral volume types such as secret configmaps and emptydir Valid values are OnRootMismatch and Always If not specified Always is used Note that this field cannot be set when spec os name is windows securityContext runAsUser int64 The UID to run the entrypoint of the container process Defaults to user specified in image metadata if unspecified May also be set in SecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence for that container Note that this field cannot be set when spec os name is windows securityContext runAsNonRoot boolean Indicates that the container must run as a non root user If true the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 root and fail to start the container if it does If unset or false no such validation will be performed May also be set in SecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence securityContext runAsGroup int64 The GID to run the entrypoint of the container process Uses runtime default if unset May also be set in SecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence for that container Note that this field cannot be set when spec os name is windows securityContext seccompProfile SeccompProfile The seccomp options to use by the containers in this pod Note that this field cannot be set when spec os name is windows a name SeccompProfile a SeccompProfile defines a pod container s seccomp profile settings Only one profile source may be set securityContext seccompProfile type string required type indicates which kind of seccomp profile will be applied Valid options are Localhost a profile defined in a file on the node should be used RuntimeDefault the container runtime default profile should be used Unconfined no profile should be applied securityContext seccompProfile localhostProfile string localhostProfile indicates a profile defined in a file on the node should be used The profile must be preconfigured on the node to work Must be a descending path relative to the kubelet s configured seccomp profile location Must be set if type is Localhost Must NOT be set for any other type securityContext seLinuxOptions SELinuxOptions The SELinux context to be applied to all containers If unspecified the container runtime will allocate a random SELinux context for each container May also be set in SecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence for that container Note that this field cannot be set when spec os name is windows a name SELinuxOptions a SELinuxOptions are the labels to be applied to the container securityContext seLinuxOptions level string Level is SELinux level label that applies to the container securityContext seLinuxOptions role string Role is a SELinux role label that applies to the container securityContext seLinuxOptions type string Type is a SELinux type label that applies to the container securityContext seLinuxOptions user string User is a SELinux user label that applies to the container securityContext supplementalGroups int64 Atomic will be replaced during a merge A list of groups applied to the first process run in each container in addition to the container s primary GID and fsGroup if specified If the SupplementalGroupsPolicy feature is enabled the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image If unspecified no additional groups are added though group memberships defined in the container image may still be used depending on the supplementalGroupsPolicy field Note that this field cannot be set when spec os name is windows securityContext supplementalGroupsPolicy string Defines how supplemental groups of the first container processes are calculated Valid values are Merge and Strict If not specified Merge is used Alpha Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature Note that this field cannot be set when spec os name is windows securityContext sysctls Sysctl Atomic will be replaced during a merge Sysctls hold a list of namespaced sysctls used for the pod Pods with unsupported sysctls by the container runtime might fail to launch Note that this field cannot be set when spec os name is windows a name Sysctl a Sysctl defines a kernel parameter to be set securityContext sysctls name string required Name of a property to set securityContext sysctls value string required Value of a property to set securityContext windowsOptions WindowsSecurityContextOptions The Windows specific settings applied to all containers If unspecified the options within a container s SecurityContext will be used If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Note that this field cannot be set when spec os name is linux a name WindowsSecurityContextOptions a WindowsSecurityContextOptions contain Windows specific options and credentials securityContext windowsOptions gmsaCredentialSpec string GMSACredentialSpec is where the GMSA admission webhook https github com kubernetes sigs windows gmsa inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field securityContext windowsOptions gmsaCredentialSpecName string GMSACredentialSpecName is the name of the GMSA credential spec to use securityContext windowsOptions hostProcess boolean HostProcess determines if a container should be run as a Host Process container All of a Pod s containers must have the same effective HostProcess value it is not allowed to have a mix of HostProcess containers and non HostProcess containers In addition if HostProcess is true then HostNetwork must also be set to true securityContext windowsOptions runAsUserName string The UserName in Windows to run the entrypoint of the container process Defaults to the user specified in image metadata if unspecified May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Alpha level hostUsers boolean Use the host s user namespace Optional Default to true If set to true or not present the pod will be run in the host user namespace useful for when the pod needs a feature only available to the host user namespace such as loading a kernel module with CAP SYS MODULE When set to false a new userns is created for the pod Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host This field is alpha level and is only honored by servers that enable the UserNamespacesSupport feature resourceClaims PodResourceClaim Patch strategies retainKeys merge on key name Map unique values on key name will be kept during a merge ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start The resources will be made available to those containers which consume them by name This is an alpha field and requires enabling the DynamicResourceAllocation feature gate This field is immutable a name PodResourceClaim a PodResourceClaim references exactly one ResourceClaim either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod It adds a name to it that uniquely identifies the ResourceClaim inside the Pod Containers that need access to the ResourceClaim reference it with this name resourceClaims name string required Name uniquely identifies this resource claim inside the pod This must be a DNS LABEL resourceClaims resourceClaimName string ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set resourceClaims resourceClaimTemplateName string ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod The template will be used to create a new ResourceClaim which will be bound to this pod When this pod is deleted the ResourceClaim will also be deleted The pod name and resource name along with a generated component will be used to form a unique name for the ResourceClaim which will be recorded in pod status resourceClaimStatuses This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set schedulingGates PodSchedulingGate Patch strategy merge on key name Map unique values on key name will be kept during a merge SchedulingGates is an opaque list of values that if specified will block scheduling the pod If schedulingGates is not empty the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod SchedulingGates can only be set at pod creation time and be removed only afterwards a name PodSchedulingGate a PodSchedulingGate is associated to a Pod to guard its scheduling schedulingGates name string required Name of the scheduling gate Each scheduling gate must have a unique name field Deprecated serviceAccount string DeprecatedServiceAccount is a deprecated alias for ServiceAccountName Deprecated Use serviceAccountName instead Container Container A single application container that you want to run within a pod hr name string required Name of the container specified as a DNS LABEL Each container in a pod must have a unique name DNS LABEL Cannot be updated Image image string Container image name More info https kubernetes io docs concepts containers images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets imagePullPolicy string Image pull policy One of Always Never IfNotPresent Defaults to Always if latest tag is specified or IfNotPresent otherwise Cannot be updated More info https kubernetes io docs concepts containers images updating images Entrypoint command string Atomic will be replaced during a merge Entrypoint array Not executed within a shell The container image s ENTRYPOINT is used if this is not provided Variable references VAR NAME are expanded using the container s environment If a variable cannot be resolved the reference in the input string will be unchanged Double are reduced to a single which allows for escaping the VAR NAME syntax i e VAR NAME will produce the string literal VAR NAME Escaped references will never be expanded regardless of whether the variable exists or not Cannot be updated More info https kubernetes io docs tasks inject data application define command argument container running a command in a shell args string Atomic will be replaced during a merge Arguments to the entrypoint The container image s CMD is used if this is not provided Variable references VAR NAME are expanded using the container s environment If a variable cannot be resolved the reference in the input string will be unchanged Double are reduced to a single which allows for escaping the VAR NAME syntax i e VAR NAME will produce the string literal VAR NAME Escaped references will never be expanded regardless of whether the variable exists or not Cannot be updated More info https kubernetes io docs tasks inject data application define command argument container running a command in a shell workingDir string Container s working directory If not specified the container runtime s default will be used which might be configured in the container image Cannot be updated Ports ports ContainerPort Patch strategy merge on key containerPort Map unique values on keys containerPort protocol will be kept during a merge List of ports to expose from the container Not specifying a port here DOES NOT prevent that port from being exposed Any port which is listening on the default 0 0 0 0 address inside a container will be accessible from the network Modifying this array with strategic merge patch may corrupt the data For more information See https github com kubernetes kubernetes issues 108255 Cannot be updated a name ContainerPort a ContainerPort represents a network port in a single container ports containerPort int32 required Number of port to expose on the pod s IP address This must be a valid port number 0 x 65536 ports hostIP string What host IP to bind the external port to ports hostPort int32 Number of port to expose on the host If specified this must be a valid port number 0 x 65536 If HostNetwork is specified this must match ContainerPort Most containers do not need this ports name string If specified this must be an IANA SVC NAME and unique within the pod Each named port in a pod must have a unique name Name for the port that can be referred to by services ports protocol string Protocol for port Must be UDP TCP or SCTP Defaults to TCP Environment variables env EnvVar Patch strategy merge on key name Map unique values on key name will be kept during a merge List of environment variables to set in the container Cannot be updated a name EnvVar a EnvVar represents an environment variable present in a Container env name string required Name of the environment variable Must be a C IDENTIFIER env value string Variable references VAR NAME are expanded using the previously defined environment variables in the container and any service environment variables If a variable cannot be resolved the reference in the input string will be unchanged Double are reduced to a single which allows for escaping the VAR NAME syntax i e VAR NAME will produce the string literal VAR NAME Escaped references will never be expanded regardless of whether the variable exists or not Defaults to env valueFrom EnvVarSource Source for the environment variable s value Cannot be used if value is not empty a name EnvVarSource a EnvVarSource represents a source for the value of an EnvVar env valueFrom configMapKeyRef ConfigMapKeySelector Selects a key of a ConfigMap a name ConfigMapKeySelector a Selects a key from a ConfigMap env valueFrom configMapKeyRef key string required The key to select env valueFrom configMapKeyRef name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names env valueFrom configMapKeyRef optional boolean Specify whether the ConfigMap or its key must be defined env valueFrom fieldRef a href ObjectFieldSelector a Selects a field of the pod supports metadata name metadata namespace metadata labels KEY metadata annotations KEY spec nodeName spec serviceAccountName status hostIP status podIP status podIPs env valueFrom resourceFieldRef a href ResourceFieldSelector a Selects a resource of the container only resources limits and requests limits cpu limits memory limits ephemeral storage requests cpu requests memory and requests ephemeral storage are currently supported env valueFrom secretKeyRef SecretKeySelector Selects a key of a secret in the pod s namespace a name SecretKeySelector a SecretKeySelector selects a key of a Secret env valueFrom secretKeyRef key string required The key of the secret to select from Must be a valid secret key env valueFrom secretKeyRef name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names env valueFrom secretKeyRef optional boolean Specify whether the Secret or its key must be defined envFrom EnvFromSource Atomic will be replaced during a merge List of sources to populate environment variables in the container The keys defined within a source must be a C IDENTIFIER All invalid keys will be reported as an event when the container is starting When a key exists in multiple sources the value associated with the last source will take precedence Values defined by an Env with a duplicate key will take precedence Cannot be updated a name EnvFromSource a EnvFromSource represents the source of a set of ConfigMaps envFrom configMapRef ConfigMapEnvSource The ConfigMap to select from a name ConfigMapEnvSource a ConfigMapEnvSource selects a ConfigMap to populate the environment variables with The contents of the target ConfigMap s Data field will represent the key value pairs as environment variables envFrom configMapRef name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names envFrom configMapRef optional boolean Specify whether the ConfigMap must be defined envFrom prefix string An optional identifier to prepend to each key in the ConfigMap Must be a C IDENTIFIER envFrom secretRef SecretEnvSource The Secret to select from a name SecretEnvSource a SecretEnvSource selects a Secret to populate the environment variables with The contents of the target Secret s Data field will represent the key value pairs as environment variables envFrom secretRef name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names envFrom secretRef optional boolean Specify whether the Secret must be defined Volumes volumeMounts VolumeMount Patch strategy merge on key mountPath Map unique values on key mountPath will be kept during a merge Pod volumes to mount into the container s filesystem Cannot be updated a name VolumeMount a VolumeMount describes a mounting of a Volume within a container volumeMounts mountPath string required Path within the container at which the volume should be mounted Must not contain volumeMounts name string required This must match the Name of a Volume volumeMounts mountPropagation string mountPropagation determines how mounts are propagated from the host to container and the other way around When not set MountPropagationNone is used This field is beta in 1 10 When RecursiveReadOnly is set to IfPossible or to Enabled MountPropagation must be None or unspecified which defaults to None volumeMounts readOnly boolean Mounted read only if true read write otherwise false or unspecified Defaults to false volumeMounts recursiveReadOnly string RecursiveReadOnly specifies whether read only mounts should be handled recursively If ReadOnly is false this field has no meaning and must be unspecified If ReadOnly is true and this field is set to Disabled the mount is not made recursively read only If this field is set to IfPossible the mount is made recursively read only if it is supported by the container runtime If this field is set to Enabled the mount is made recursively read only if it is supported by the container runtime otherwise the pod will not be started and an error will be generated to indicate the reason If this field is set to IfPossible or Enabled MountPropagation must be set to None or be unspecified which defaults to None If this field is not specified it is treated as an equivalent of Disabled volumeMounts subPath string Path within the volume from which the container s volume should be mounted Defaults to volume s root volumeMounts subPathExpr string Expanded path within the volume from which the container s volume should be mounted Behaves similarly to SubPath but environment variable references VAR NAME are expanded using the container s environment Defaults to volume s root SubPathExpr and SubPath are mutually exclusive volumeDevices VolumeDevice Patch strategy merge on key devicePath Map unique values on key devicePath will be kept during a merge volumeDevices is the list of block devices to be used by the container a name VolumeDevice a volumeDevice describes a mapping of a raw block device within a container volumeDevices devicePath string required devicePath is the path inside of the container that the device will be mapped to volumeDevices name string required name must match the name of a persistentVolumeClaim in the pod Resources resources ResourceRequirements Compute Resources required by this container Cannot be updated More info https kubernetes io docs concepts configuration manage resources containers a name ResourceRequirements a ResourceRequirements describes the compute resource requirements resources claims ResourceClaim Map unique values on key name will be kept during a merge Claims lists the names of resources defined in spec resourceClaims that are used by this container This is an alpha field and requires enabling the DynamicResourceAllocation feature gate This field is immutable It can only be set for containers a name ResourceClaim a ResourceClaim references one entry in PodSpec ResourceClaims resources claims name string required Name must match the name of one entry in pod spec resourceClaims of the Pod where this field is used It makes that resource available inside a container resources claims request string Request is the name chosen for a request in the referenced claim If empty everything from the claim is made available otherwise only the result of this request resources limits map string a href Quantity a Limits describes the maximum amount of compute resources allowed More info https kubernetes io docs concepts configuration manage resources containers resources requests map string a href Quantity a Requests describes the minimum amount of compute resources required If Requests is omitted for a container it defaults to Limits if that is explicitly specified otherwise to an implementation defined value Requests cannot exceed Limits More info https kubernetes io docs concepts configuration manage resources containers resizePolicy ContainerResizePolicy Atomic will be replaced during a merge Resources resize policy for the container a name ContainerResizePolicy a ContainerResizePolicy represents resource resize policy for the container resizePolicy resourceName string required Name of the resource to which this resource resize policy applies Supported values cpu memory resizePolicy restartPolicy string required Restart policy to apply when specified resource is resized If not specified it defaults to NotRequired Lifecycle lifecycle Lifecycle Actions that the management system should take in response to container lifecycle events Cannot be updated a name Lifecycle a Lifecycle describes actions that the management system should take in response to container lifecycle events For the PostStart and PreStop lifecycle handlers management of the container blocks until the action is complete unless the container process fails in which case the handler is aborted lifecycle postStart a href LifecycleHandler a PostStart is called immediately after a container is created If the handler fails the container is terminated and restarted according to its restart policy Other management of the container blocks until the hook completes More info https kubernetes io docs concepts containers container lifecycle hooks container hooks lifecycle preStop a href LifecycleHandler a PreStop is called immediately before a container is terminated due to an API request or management event such as liveness startup probe failure preemption resource contention etc The handler is not called if the container crashes or exits The Pod s termination grace period countdown begins before the PreStop hook is executed Regardless of the outcome of the handler the container will eventually terminate within the Pod s termination grace period unless delayed by finalizers Other management of the container blocks until the hook completes or until the termination grace period is reached More info https kubernetes io docs concepts containers container lifecycle hooks container hooks terminationMessagePath string Optional Path at which the file to which the container s termination message will be written is mounted into the container s filesystem Message written is intended to be brief final status such as an assertion failure message Will be truncated by the node if greater than 4096 bytes The total message length across all containers will be limited to 12kb Defaults to dev termination log Cannot be updated terminationMessagePolicy string Indicate how the termination message should be populated File will use the contents of terminationMessagePath to populate the container status message on both success and failure FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error The log output is limited to 2048 bytes or 80 lines whichever is smaller Defaults to File Cannot be updated livenessProbe a href Probe a Periodic probe of container liveness Container will be restarted if the probe fails Cannot be updated More info https kubernetes io docs concepts workloads pods pod lifecycle container probes readinessProbe a href Probe a Periodic probe of container service readiness Container will be removed from service endpoints if the probe fails Cannot be updated More info https kubernetes io docs concepts workloads pods pod lifecycle container probes startupProbe a href Probe a StartupProbe indicates that the Pod has successfully initialized If specified no other probes are executed until this completes successfully If this probe fails the Pod will be restarted just as if the livenessProbe failed This can be used to provide different probe parameters at the beginning of a Pod s lifecycle when it might take a long time to load data or warm a cache than during steady state operation This cannot be updated More info https kubernetes io docs concepts workloads pods pod lifecycle container probes restartPolicy string RestartPolicy defines the restart behavior of individual containers in a pod This field may only be set for init containers and the only allowed value is Always For non init containers or when this field is not specified the restart behavior is defined by the Pod s restart policy and the container type Setting the RestartPolicy as Always for the init container will have the following effect this init container will be continually restarted on exit until all regular containers have terminated Once all regular containers have completed all init containers with restartPolicy Always will be shut down This lifecycle differs from normal init containers and is often referred to as a sidecar container Although this init container still starts in the init container sequence it does not wait for the container to complete before proceeding to the next init container Instead the next init container starts immediately after this init container is started or after any startupProbe has successfully completed Security Context securityContext SecurityContext SecurityContext defines the security options the container should be run with If set the fields of SecurityContext override the equivalent fields of PodSecurityContext More info https kubernetes io docs tasks configure pod container security context a name SecurityContext a SecurityContext holds security configuration that will be applied to a container Some fields are present in both SecurityContext and PodSecurityContext When both are set the values in SecurityContext take precedence securityContext allowPrivilegeEscalation boolean AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process This bool directly controls if the no new privs flag will be set on the container process AllowPrivilegeEscalation is true always when the container is 1 run as Privileged 2 has CAP SYS ADMIN Note that this field cannot be set when spec os name is windows securityContext appArmorProfile AppArmorProfile appArmorProfile is the AppArmor options to use by this container If set this profile overrides the pod s appArmorProfile Note that this field cannot be set when spec os name is windows a name AppArmorProfile a AppArmorProfile defines a pod or container s AppArmor settings securityContext appArmorProfile type string required type indicates which kind of AppArmor profile will be applied Valid options are Localhost a profile pre loaded on the node RuntimeDefault the container runtime s default profile Unconfined no AppArmor enforcement securityContext appArmorProfile localhostProfile string localhostProfile indicates a profile loaded on the node that should be used The profile must be preconfigured on the node to work Must match the loaded name of the profile Must be set if and only if type is Localhost securityContext capabilities Capabilities The capabilities to add drop when running containers Defaults to the default set of capabilities granted by the container runtime Note that this field cannot be set when spec os name is windows a name Capabilities a Adds and removes POSIX capabilities from running containers securityContext capabilities add string Atomic will be replaced during a merge Added capabilities securityContext capabilities drop string Atomic will be replaced during a merge Removed capabilities securityContext procMount string procMount denotes the type of proc mount to use for the containers The default value is Default which uses the container runtime defaults for readonly paths and masked paths This requires the ProcMountType feature flag to be enabled Note that this field cannot be set when spec os name is windows securityContext privileged boolean Run container in privileged mode Processes in privileged containers are essentially equivalent to root on the host Defaults to false Note that this field cannot be set when spec os name is windows securityContext readOnlyRootFilesystem boolean Whether this container has a read only root filesystem Default is false Note that this field cannot be set when spec os name is windows securityContext runAsUser int64 The UID to run the entrypoint of the container process Defaults to user specified in image metadata if unspecified May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Note that this field cannot be set when spec os name is windows securityContext runAsNonRoot boolean Indicates that the container must run as a non root user If true the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 root and fail to start the container if it does If unset or false no such validation will be performed May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence securityContext runAsGroup int64 The GID to run the entrypoint of the container process Uses runtime default if unset May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Note that this field cannot be set when spec os name is windows securityContext seLinuxOptions SELinuxOptions The SELinux context to be applied to the container If unspecified the container runtime will allocate a random SELinux context for each container May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Note that this field cannot be set when spec os name is windows a name SELinuxOptions a SELinuxOptions are the labels to be applied to the container securityContext seLinuxOptions level string Level is SELinux level label that applies to the container securityContext seLinuxOptions role string Role is a SELinux role label that applies to the container securityContext seLinuxOptions type string Type is a SELinux type label that applies to the container securityContext seLinuxOptions user string User is a SELinux user label that applies to the container securityContext seccompProfile SeccompProfile The seccomp options to use by this container If seccomp options are provided at both the pod container level the container options override the pod options Note that this field cannot be set when spec os name is windows a name SeccompProfile a SeccompProfile defines a pod container s seccomp profile settings Only one profile source may be set securityContext seccompProfile type string required type indicates which kind of seccomp profile will be applied Valid options are Localhost a profile defined in a file on the node should be used RuntimeDefault the container runtime default profile should be used Unconfined no profile should be applied securityContext seccompProfile localhostProfile string localhostProfile indicates a profile defined in a file on the node should be used The profile must be preconfigured on the node to work Must be a descending path relative to the kubelet s configured seccomp profile location Must be set if type is Localhost Must NOT be set for any other type securityContext windowsOptions WindowsSecurityContextOptions The Windows specific settings applied to all containers If unspecified the options from the PodSecurityContext will be used If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Note that this field cannot be set when spec os name is linux a name WindowsSecurityContextOptions a WindowsSecurityContextOptions contain Windows specific options and credentials securityContext windowsOptions gmsaCredentialSpec string GMSACredentialSpec is where the GMSA admission webhook https github com kubernetes sigs windows gmsa inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field securityContext windowsOptions gmsaCredentialSpecName string GMSACredentialSpecName is the name of the GMSA credential spec to use securityContext windowsOptions hostProcess boolean HostProcess determines if a container should be run as a Host Process container All of a Pod s containers must have the same effective HostProcess value it is not allowed to have a mix of HostProcess containers and non HostProcess containers In addition if HostProcess is true then HostNetwork must also be set to true securityContext windowsOptions runAsUserName string The UserName in Windows to run the entrypoint of the container process Defaults to the user specified in image metadata if unspecified May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Debugging stdin boolean Whether this container should allocate a buffer for stdin in the container runtime If this is not set reads from stdin in the container will always result in EOF Default is false stdinOnce boolean Whether the container runtime should close the stdin channel after it has been opened by a single attach When stdin is true the stdin stream will remain open across multiple attach sessions If stdinOnce is set to true stdin is opened on container start is empty until the first client attaches to stdin and then remains open and accepts data until the client disconnects at which time stdin is closed and remains closed until the container is restarted If this flag is false a container processes that reads from stdin will never receive an EOF Default is false tty boolean Whether this container should allocate a TTY for itself also requires stdin to be true Default is false EphemeralContainer EphemeralContainer An EphemeralContainer is a temporary container that you may add to an existing Pod for user initiated activities such as debugging Ephemeral containers have no resource or scheduling guarantees and they will not be restarted when they exit or when a Pod is removed or restarted The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation To add an ephemeral container use the ephemeralcontainers subresource of an existing Pod Ephemeral containers may not be removed or restarted hr name string required Name of the ephemeral container specified as a DNS LABEL This name must be unique among all containers init containers and ephemeral containers targetContainerName string If set the name of the container from PodSpec that this ephemeral container targets The ephemeral container will be run in the namespaces IPC PID etc of this container If not set then the ephemeral container uses the namespaces configured in the Pod spec The container runtime must implement support for this feature If the runtime does not support namespace targeting then the result of setting this field is undefined Image image string Container image name More info https kubernetes io docs concepts containers images imagePullPolicy string Image pull policy One of Always Never IfNotPresent Defaults to Always if latest tag is specified or IfNotPresent otherwise Cannot be updated More info https kubernetes io docs concepts containers images updating images Entrypoint command string Atomic will be replaced during a merge Entrypoint array Not executed within a shell The image s ENTRYPOINT is used if this is not provided Variable references VAR NAME are expanded using the container s environment If a variable cannot be resolved the reference in the input string will be unchanged Double are reduced to a single which allows for escaping the VAR NAME syntax i e VAR NAME will produce the string literal VAR NAME Escaped references will never be expanded regardless of whether the variable exists or not Cannot be updated More info https kubernetes io docs tasks inject data application define command argument container running a command in a shell args string Atomic will be replaced during a merge Arguments to the entrypoint The image s CMD is used if this is not provided Variable references VAR NAME are expanded using the container s environment If a variable cannot be resolved the reference in the input string will be unchanged Double are reduced to a single which allows for escaping the VAR NAME syntax i e VAR NAME will produce the string literal VAR NAME Escaped references will never be expanded regardless of whether the variable exists or not Cannot be updated More info https kubernetes io docs tasks inject data application define command argument container running a command in a shell workingDir string Container s working directory If not specified the container runtime s default will be used which might be configured in the container image Cannot be updated Environment variables env EnvVar Patch strategy merge on key name Map unique values on key name will be kept during a merge List of environment variables to set in the container Cannot be updated a name EnvVar a EnvVar represents an environment variable present in a Container env name string required Name of the environment variable Must be a C IDENTIFIER env value string Variable references VAR NAME are expanded using the previously defined environment variables in the container and any service environment variables If a variable cannot be resolved the reference in the input string will be unchanged Double are reduced to a single which allows for escaping the VAR NAME syntax i e VAR NAME will produce the string literal VAR NAME Escaped references will never be expanded regardless of whether the variable exists or not Defaults to env valueFrom EnvVarSource Source for the environment variable s value Cannot be used if value is not empty a name EnvVarSource a EnvVarSource represents a source for the value of an EnvVar env valueFrom configMapKeyRef ConfigMapKeySelector Selects a key of a ConfigMap a name ConfigMapKeySelector a Selects a key from a ConfigMap env valueFrom configMapKeyRef key string required The key to select env valueFrom configMapKeyRef name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names env valueFrom configMapKeyRef optional boolean Specify whether the ConfigMap or its key must be defined env valueFrom fieldRef a href ObjectFieldSelector a Selects a field of the pod supports metadata name metadata namespace metadata labels KEY metadata annotations KEY spec nodeName spec serviceAccountName status hostIP status podIP status podIPs env valueFrom resourceFieldRef a href ResourceFieldSelector a Selects a resource of the container only resources limits and requests limits cpu limits memory limits ephemeral storage requests cpu requests memory and requests ephemeral storage are currently supported env valueFrom secretKeyRef SecretKeySelector Selects a key of a secret in the pod s namespace a name SecretKeySelector a SecretKeySelector selects a key of a Secret env valueFrom secretKeyRef key string required The key of the secret to select from Must be a valid secret key env valueFrom secretKeyRef name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names env valueFrom secretKeyRef optional boolean Specify whether the Secret or its key must be defined envFrom EnvFromSource Atomic will be replaced during a merge List of sources to populate environment variables in the container The keys defined within a source must be a C IDENTIFIER All invalid keys will be reported as an event when the container is starting When a key exists in multiple sources the value associated with the last source will take precedence Values defined by an Env with a duplicate key will take precedence Cannot be updated a name EnvFromSource a EnvFromSource represents the source of a set of ConfigMaps envFrom configMapRef ConfigMapEnvSource The ConfigMap to select from a name ConfigMapEnvSource a ConfigMapEnvSource selects a ConfigMap to populate the environment variables with The contents of the target ConfigMap s Data field will represent the key value pairs as environment variables envFrom configMapRef name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names envFrom configMapRef optional boolean Specify whether the ConfigMap must be defined envFrom prefix string An optional identifier to prepend to each key in the ConfigMap Must be a C IDENTIFIER envFrom secretRef SecretEnvSource The Secret to select from a name SecretEnvSource a SecretEnvSource selects a Secret to populate the environment variables with The contents of the target Secret s Data field will represent the key value pairs as environment variables envFrom secretRef name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names envFrom secretRef optional boolean Specify whether the Secret must be defined Volumes volumeMounts VolumeMount Patch strategy merge on key mountPath Map unique values on key mountPath will be kept during a merge Pod volumes to mount into the container s filesystem Subpath mounts are not allowed for ephemeral containers Cannot be updated a name VolumeMount a VolumeMount describes a mounting of a Volume within a container volumeMounts mountPath string required Path within the container at which the volume should be mounted Must not contain volumeMounts name string required This must match the Name of a Volume volumeMounts mountPropagation string mountPropagation determines how mounts are propagated from the host to container and the other way around When not set MountPropagationNone is used This field is beta in 1 10 When RecursiveReadOnly is set to IfPossible or to Enabled MountPropagation must be None or unspecified which defaults to None volumeMounts readOnly boolean Mounted read only if true read write otherwise false or unspecified Defaults to false volumeMounts recursiveReadOnly string RecursiveReadOnly specifies whether read only mounts should be handled recursively If ReadOnly is false this field has no meaning and must be unspecified If ReadOnly is true and this field is set to Disabled the mount is not made recursively read only If this field is set to IfPossible the mount is made recursively read only if it is supported by the container runtime If this field is set to Enabled the mount is made recursively read only if it is supported by the container runtime otherwise the pod will not be started and an error will be generated to indicate the reason If this field is set to IfPossible or Enabled MountPropagation must be set to None or be unspecified which defaults to None If this field is not specified it is treated as an equivalent of Disabled volumeMounts subPath string Path within the volume from which the container s volume should be mounted Defaults to volume s root volumeMounts subPathExpr string Expanded path within the volume from which the container s volume should be mounted Behaves similarly to SubPath but environment variable references VAR NAME are expanded using the container s environment Defaults to volume s root SubPathExpr and SubPath are mutually exclusive volumeDevices VolumeDevice Patch strategy merge on key devicePath Map unique values on key devicePath will be kept during a merge volumeDevices is the list of block devices to be used by the container a name VolumeDevice a volumeDevice describes a mapping of a raw block device within a container volumeDevices devicePath string required devicePath is the path inside of the container that the device will be mapped to volumeDevices name string required name must match the name of a persistentVolumeClaim in the pod Resources resizePolicy ContainerResizePolicy Atomic will be replaced during a merge Resources resize policy for the container a name ContainerResizePolicy a ContainerResizePolicy represents resource resize policy for the container resizePolicy resourceName string required Name of the resource to which this resource resize policy applies Supported values cpu memory resizePolicy restartPolicy string required Restart policy to apply when specified resource is resized If not specified it defaults to NotRequired Lifecycle terminationMessagePath string Optional Path at which the file to which the container s termination message will be written is mounted into the container s filesystem Message written is intended to be brief final status such as an assertion failure message Will be truncated by the node if greater than 4096 bytes The total message length across all containers will be limited to 12kb Defaults to dev termination log Cannot be updated terminationMessagePolicy string Indicate how the termination message should be populated File will use the contents of terminationMessagePath to populate the container status message on both success and failure FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error The log output is limited to 2048 bytes or 80 lines whichever is smaller Defaults to File Cannot be updated restartPolicy string Restart policy for the container to manage the restart behavior of each container within a pod This may only be set for init containers You cannot set this field on ephemeral containers Debugging stdin boolean Whether this container should allocate a buffer for stdin in the container runtime If this is not set reads from stdin in the container will always result in EOF Default is false stdinOnce boolean Whether the container runtime should close the stdin channel after it has been opened by a single attach When stdin is true the stdin stream will remain open across multiple attach sessions If stdinOnce is set to true stdin is opened on container start is empty until the first client attaches to stdin and then remains open and accepts data until the client disconnects at which time stdin is closed and remains closed until the container is restarted If this flag is false a container processes that reads from stdin will never receive an EOF Default is false tty boolean Whether this container should allocate a TTY for itself also requires stdin to be true Default is false Security context securityContext SecurityContext Optional SecurityContext defines the security options the ephemeral container should be run with If set the fields of SecurityContext override the equivalent fields of PodSecurityContext a name SecurityContext a SecurityContext holds security configuration that will be applied to a container Some fields are present in both SecurityContext and PodSecurityContext When both are set the values in SecurityContext take precedence securityContext allowPrivilegeEscalation boolean AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process This bool directly controls if the no new privs flag will be set on the container process AllowPrivilegeEscalation is true always when the container is 1 run as Privileged 2 has CAP SYS ADMIN Note that this field cannot be set when spec os name is windows securityContext appArmorProfile AppArmorProfile appArmorProfile is the AppArmor options to use by this container If set this profile overrides the pod s appArmorProfile Note that this field cannot be set when spec os name is windows a name AppArmorProfile a AppArmorProfile defines a pod or container s AppArmor settings securityContext appArmorProfile type string required type indicates which kind of AppArmor profile will be applied Valid options are Localhost a profile pre loaded on the node RuntimeDefault the container runtime s default profile Unconfined no AppArmor enforcement securityContext appArmorProfile localhostProfile string localhostProfile indicates a profile loaded on the node that should be used The profile must be preconfigured on the node to work Must match the loaded name of the profile Must be set if and only if type is Localhost securityContext capabilities Capabilities The capabilities to add drop when running containers Defaults to the default set of capabilities granted by the container runtime Note that this field cannot be set when spec os name is windows a name Capabilities a Adds and removes POSIX capabilities from running containers securityContext capabilities add string Atomic will be replaced during a merge Added capabilities securityContext capabilities drop string Atomic will be replaced during a merge Removed capabilities securityContext procMount string procMount denotes the type of proc mount to use for the containers The default value is Default which uses the container runtime defaults for readonly paths and masked paths This requires the ProcMountType feature flag to be enabled Note that this field cannot be set when spec os name is windows securityContext privileged boolean Run container in privileged mode Processes in privileged containers are essentially equivalent to root on the host Defaults to false Note that this field cannot be set when spec os name is windows securityContext readOnlyRootFilesystem boolean Whether this container has a read only root filesystem Default is false Note that this field cannot be set when spec os name is windows securityContext runAsUser int64 The UID to run the entrypoint of the container process Defaults to user specified in image metadata if unspecified May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Note that this field cannot be set when spec os name is windows securityContext runAsNonRoot boolean Indicates that the container must run as a non root user If true the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 root and fail to start the container if it does If unset or false no such validation will be performed May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence securityContext runAsGroup int64 The GID to run the entrypoint of the container process Uses runtime default if unset May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Note that this field cannot be set when spec os name is windows securityContext seLinuxOptions SELinuxOptions The SELinux context to be applied to the container If unspecified the container runtime will allocate a random SELinux context for each container May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Note that this field cannot be set when spec os name is windows a name SELinuxOptions a SELinuxOptions are the labels to be applied to the container securityContext seLinuxOptions level string Level is SELinux level label that applies to the container securityContext seLinuxOptions role string Role is a SELinux role label that applies to the container securityContext seLinuxOptions type string Type is a SELinux type label that applies to the container securityContext seLinuxOptions user string User is a SELinux user label that applies to the container securityContext seccompProfile SeccompProfile The seccomp options to use by this container If seccomp options are provided at both the pod container level the container options override the pod options Note that this field cannot be set when spec os name is windows a name SeccompProfile a SeccompProfile defines a pod container s seccomp profile settings Only one profile source may be set securityContext seccompProfile type string required type indicates which kind of seccomp profile will be applied Valid options are Localhost a profile defined in a file on the node should be used RuntimeDefault the container runtime default profile should be used Unconfined no profile should be applied securityContext seccompProfile localhostProfile string localhostProfile indicates a profile defined in a file on the node should be used The profile must be preconfigured on the node to work Must be a descending path relative to the kubelet s configured seccomp profile location Must be set if type is Localhost Must NOT be set for any other type securityContext windowsOptions WindowsSecurityContextOptions The Windows specific settings applied to all containers If unspecified the options from the PodSecurityContext will be used If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Note that this field cannot be set when spec os name is linux a name WindowsSecurityContextOptions a WindowsSecurityContextOptions contain Windows specific options and credentials securityContext windowsOptions gmsaCredentialSpec string GMSACredentialSpec is where the GMSA admission webhook https github com kubernetes sigs windows gmsa inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field securityContext windowsOptions gmsaCredentialSpecName string GMSACredentialSpecName is the name of the GMSA credential spec to use securityContext windowsOptions hostProcess boolean HostProcess determines if a container should be run as a Host Process container All of a Pod s containers must have the same effective HostProcess value it is not allowed to have a mix of HostProcess containers and non HostProcess containers In addition if HostProcess is true then HostNetwork must also be set to true securityContext windowsOptions runAsUserName string The UserName in Windows to run the entrypoint of the container process Defaults to the user specified in image metadata if unspecified May also be set in PodSecurityContext If set in both SecurityContext and PodSecurityContext the value specified in SecurityContext takes precedence Not allowed ports ContainerPort Patch strategy merge on key containerPort Map unique values on keys containerPort protocol will be kept during a merge Ports are not allowed for ephemeral containers a name ContainerPort a ContainerPort represents a network port in a single container ports containerPort int32 required Number of port to expose on the pod s IP address This must be a valid port number 0 x 65536 ports hostIP string What host IP to bind the external port to ports hostPort int32 Number of port to expose on the host If specified this must be a valid port number 0 x 65536 If HostNetwork is specified this must match ContainerPort Most containers do not need this ports name string If specified this must be an IANA SVC NAME and unique within the pod Each named port in a pod must have a unique name Name for the port that can be referred to by services ports protocol string Protocol for port Must be UDP TCP or SCTP Defaults to TCP resources ResourceRequirements Resources are not allowed for ephemeral containers Ephemeral containers use spare resources already allocated to the pod a name ResourceRequirements a ResourceRequirements describes the compute resource requirements resources claims ResourceClaim Map unique values on key name will be kept during a merge Claims lists the names of resources defined in spec resourceClaims that are used by this container This is an alpha field and requires enabling the DynamicResourceAllocation feature gate This field is immutable It can only be set for containers a name ResourceClaim a ResourceClaim references one entry in PodSpec ResourceClaims resources claims name string required Name must match the name of one entry in pod spec resourceClaims of the Pod where this field is used It makes that resource available inside a container resources claims request string Request is the name chosen for a request in the referenced claim If empty everything from the claim is made available otherwise only the result of this request resources limits map string a href Quantity a Limits describes the maximum amount of compute resources allowed More info https kubernetes io docs concepts configuration manage resources containers resources requests map string a href Quantity a Requests describes the minimum amount of compute resources required If Requests is omitted for a container it defaults to Limits if that is explicitly specified otherwise to an implementation defined value Requests cannot exceed Limits More info https kubernetes io docs concepts configuration manage resources containers lifecycle Lifecycle Lifecycle is not allowed for ephemeral containers a name Lifecycle a Lifecycle describes actions that the management system should take in response to container lifecycle events For the PostStart and PreStop lifecycle handlers management of the container blocks until the action is complete unless the container process fails in which case the handler is aborted lifecycle postStart a href LifecycleHandler a PostStart is called immediately after a container is created If the handler fails the container is terminated and restarted according to its restart policy Other management of the container blocks until the hook completes More info https kubernetes io docs concepts containers container lifecycle hooks container hooks lifecycle preStop a href LifecycleHandler a PreStop is called immediately before a container is terminated due to an API request or management event such as liveness startup probe failure preemption resource contention etc The handler is not called if the container crashes or exits The Pod s termination grace period countdown begins before the PreStop hook is executed Regardless of the outcome of the handler the container will eventually terminate within the Pod s termination grace period unless delayed by finalizers Other management of the container blocks until the hook completes or until the termination grace period is reached More info https kubernetes io docs concepts containers container lifecycle hooks container hooks livenessProbe a href Probe a Probes are not allowed for ephemeral containers readinessProbe a href Probe a Probes are not allowed for ephemeral containers startupProbe a href Probe a Probes are not allowed for ephemeral containers LifecycleHandler LifecycleHandler LifecycleHandler defines a specific action that should be taken in a lifecycle hook One and only one of the fields except TCPSocket must be specified hr exec ExecAction Exec specifies the action to take a name ExecAction a ExecAction describes a run in container action exec command string Atomic will be replaced during a merge Command is the command line to execute inside the container the working directory for the command is root in the container s filesystem The command is simply exec d it is not run inside a shell so traditional shell instructions etc won t work To use a shell you need to explicitly call out to that shell Exit status of 0 is treated as live healthy and non zero is unhealthy httpGet HTTPGetAction HTTPGet specifies the http request to perform a name HTTPGetAction a HTTPGetAction describes an action based on HTTP Get requests httpGet port IntOrString required Name or number of the port to access on the container Number must be in the range 1 to 65535 Name must be an IANA SVC NAME a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number httpGet host string Host name to connect to defaults to the pod IP You probably want to set Host in httpHeaders instead httpGet httpHeaders HTTPHeader Atomic will be replaced during a merge Custom headers to set in the request HTTP allows repeated headers a name HTTPHeader a HTTPHeader describes a custom header to be used in HTTP probes httpGet httpHeaders name string required The header field name This will be canonicalized upon output so case variant names will be understood as the same header httpGet httpHeaders value string required The header field value httpGet path string Path to access on the HTTP server httpGet scheme string Scheme to use for connecting to the host Defaults to HTTP sleep SleepAction Sleep represents the duration that the container should sleep before being terminated a name SleepAction a SleepAction describes a sleep action sleep seconds int64 required Seconds is the number of seconds to sleep tcpSocket TCPSocketAction Deprecated TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified a name TCPSocketAction a TCPSocketAction describes an action based on opening a socket tcpSocket port IntOrString required Number or name of the port to access on the container Number must be in the range 1 to 65535 Name must be an IANA SVC NAME a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number tcpSocket host string Optional Host name to connect to defaults to the pod IP NodeAffinity NodeAffinity Node affinity is a group of node affinity scheduling rules hr preferredDuringSchedulingIgnoredDuringExecution PreferredSchedulingTerm Atomic will be replaced during a merge The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field but it may choose a node that violates one or more of the expressions The node that is most preferred is the one with the greatest sum of weights i e for each node that meets all of the scheduling requirements resource request requiredDuringScheduling affinity expressions etc compute a sum by iterating through the elements of this field and adding weight to the sum if the node matches the corresponding matchExpressions the node s with the highest sum are the most preferred a name PreferredSchedulingTerm a An empty preferred scheduling term matches all objects with implicit weight 0 i e it s a no op A null preferred scheduling term matches no objects i e is also a no op preferredDuringSchedulingIgnoredDuringExecution preference NodeSelectorTerm required A node selector term associated with the corresponding weight a name NodeSelectorTerm a A null or empty node selector term matches no objects The requirements of them are ANDed The TopologySelectorTerm type implements a subset of the NodeSelectorTerm preferredDuringSchedulingIgnoredDuringExecution preference matchExpressions a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s labels preferredDuringSchedulingIgnoredDuringExecution preference matchFields a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s fields preferredDuringSchedulingIgnoredDuringExecution weight int32 required Weight associated with matching the corresponding nodeSelectorTerm in the range 1 100 requiredDuringSchedulingIgnoredDuringExecution NodeSelector If the affinity requirements specified by this field are not met at scheduling time the pod will not be scheduled onto the node If the affinity requirements specified by this field cease to be met at some point during pod execution e g due to an update the system may or may not try to eventually evict the pod from its node a name NodeSelector a A node selector represents the union of the results of one or more label queries over a set of nodes that is it represents the OR of the selectors represented by the node selector terms requiredDuringSchedulingIgnoredDuringExecution nodeSelectorTerms NodeSelectorTerm required Atomic will be replaced during a merge Required A list of node selector terms The terms are ORed a name NodeSelectorTerm a A null or empty node selector term matches no objects The requirements of them are ANDed The TopologySelectorTerm type implements a subset of the NodeSelectorTerm requiredDuringSchedulingIgnoredDuringExecution nodeSelectorTerms matchExpressions a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s labels requiredDuringSchedulingIgnoredDuringExecution nodeSelectorTerms matchFields a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s fields PodAffinity PodAffinity Pod affinity is a group of inter pod affinity scheduling rules hr preferredDuringSchedulingIgnoredDuringExecution WeightedPodAffinityTerm Atomic will be replaced during a merge The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field but it may choose a node that violates one or more of the expressions The node that is most preferred is the one with the greatest sum of weights i e for each node that meets all of the scheduling requirements resource request requiredDuringScheduling affinity expressions etc compute a sum by iterating through the elements of this field and adding weight to the sum if the node has pods which matches the corresponding podAffinityTerm the node s with the highest sum are the most preferred a name WeightedPodAffinityTerm a The weights of all of the matched WeightedPodAffinityTerm fields are added per node to find the most preferred node s preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm PodAffinityTerm required Required A pod affinity term associated with the corresponding weight a name PodAffinityTerm a Defines a set of pods namely those matching the labelSelector relative to the given namespace s that this pod should be co located affinity or not co located anti affinity with where co located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which a pod of the set of pods is running preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm topologyKey string required This pod should be co located affinity or not co located anti affinity with the pods matching the labelSelector in the specified namespaces where co located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running Empty topologyKey is not allowed preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm labelSelector a href LabelSelector a A label query over a set of resources in this case pods If it s null this PodAffinityTerm matches with no Pods preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm matchLabelKeys string Atomic will be replaced during a merge MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration The keys are used to lookup values from the incoming pod labels those key value labels are merged with labelSelector as key in value to select the group of existing pods which pods will be taken into consideration for the incoming pod s pod anti affinity Keys that don t exist in the incoming pod labels will be ignored The default value is empty The same key is forbidden to exist in both matchLabelKeys and labelSelector Also matchLabelKeys cannot be set when labelSelector isn t set This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate enabled by default preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm mismatchLabelKeys string Atomic will be replaced during a merge MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration The keys are used to lookup values from the incoming pod labels those key value labels are merged with labelSelector as key notin value to select the group of existing pods which pods will be taken into consideration for the incoming pod s pod anti affinity Keys that don t exist in the incoming pod labels will be ignored The default value is empty The same key is forbidden to exist in both mismatchLabelKeys and labelSelector Also mismatchLabelKeys cannot be set when labelSelector isn t set This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate enabled by default preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm namespaceSelector a href LabelSelector a A label query over the set of namespaces that the term applies to The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field null selector and null or empty namespaces list means this pod s namespace An empty selector matches all namespaces preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm namespaces string Atomic will be replaced during a merge namespaces specifies a static list of namespace names that the term applies to The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector null or empty namespaces list and null namespaceSelector means this pod s namespace preferredDuringSchedulingIgnoredDuringExecution weight int32 required weight associated with matching the corresponding podAffinityTerm in the range 1 100 requiredDuringSchedulingIgnoredDuringExecution PodAffinityTerm Atomic will be replaced during a merge If the affinity requirements specified by this field are not met at scheduling time the pod will not be scheduled onto the node If the affinity requirements specified by this field cease to be met at some point during pod execution e g due to a pod label update the system may or may not try to eventually evict the pod from its node When there are multiple elements the lists of nodes corresponding to each podAffinityTerm are intersected i e all terms must be satisfied a name PodAffinityTerm a Defines a set of pods namely those matching the labelSelector relative to the given namespace s that this pod should be co located affinity or not co located anti affinity with where co located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which a pod of the set of pods is running requiredDuringSchedulingIgnoredDuringExecution topologyKey string required This pod should be co located affinity or not co located anti affinity with the pods matching the labelSelector in the specified namespaces where co located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running Empty topologyKey is not allowed requiredDuringSchedulingIgnoredDuringExecution labelSelector a href LabelSelector a A label query over a set of resources in this case pods If it s null this PodAffinityTerm matches with no Pods requiredDuringSchedulingIgnoredDuringExecution matchLabelKeys string Atomic will be replaced during a merge MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration The keys are used to lookup values from the incoming pod labels those key value labels are merged with labelSelector as key in value to select the group of existing pods which pods will be taken into consideration for the incoming pod s pod anti affinity Keys that don t exist in the incoming pod labels will be ignored The default value is empty The same key is forbidden to exist in both matchLabelKeys and labelSelector Also matchLabelKeys cannot be set when labelSelector isn t set This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate enabled by default requiredDuringSchedulingIgnoredDuringExecution mismatchLabelKeys string Atomic will be replaced during a merge MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration The keys are used to lookup values from the incoming pod labels those key value labels are merged with labelSelector as key notin value to select the group of existing pods which pods will be taken into consideration for the incoming pod s pod anti affinity Keys that don t exist in the incoming pod labels will be ignored The default value is empty The same key is forbidden to exist in both mismatchLabelKeys and labelSelector Also mismatchLabelKeys cannot be set when labelSelector isn t set This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate enabled by default requiredDuringSchedulingIgnoredDuringExecution namespaceSelector a href LabelSelector a A label query over the set of namespaces that the term applies to The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field null selector and null or empty namespaces list means this pod s namespace An empty selector matches all namespaces requiredDuringSchedulingIgnoredDuringExecution namespaces string Atomic will be replaced during a merge namespaces specifies a static list of namespace names that the term applies to The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector null or empty namespaces list and null namespaceSelector means this pod s namespace PodAntiAffinity PodAntiAffinity Pod anti affinity is a group of inter pod anti affinity scheduling rules hr preferredDuringSchedulingIgnoredDuringExecution WeightedPodAffinityTerm Atomic will be replaced during a merge The scheduler will prefer to schedule pods to nodes that satisfy the anti affinity expressions specified by this field but it may choose a node that violates one or more of the expressions The node that is most preferred is the one with the greatest sum of weights i e for each node that meets all of the scheduling requirements resource request requiredDuringScheduling anti affinity expressions etc compute a sum by iterating through the elements of this field and adding weight to the sum if the node has pods which matches the corresponding podAffinityTerm the node s with the highest sum are the most preferred a name WeightedPodAffinityTerm a The weights of all of the matched WeightedPodAffinityTerm fields are added per node to find the most preferred node s preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm PodAffinityTerm required Required A pod affinity term associated with the corresponding weight a name PodAffinityTerm a Defines a set of pods namely those matching the labelSelector relative to the given namespace s that this pod should be co located affinity or not co located anti affinity with where co located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which a pod of the set of pods is running preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm topologyKey string required This pod should be co located affinity or not co located anti affinity with the pods matching the labelSelector in the specified namespaces where co located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running Empty topologyKey is not allowed preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm labelSelector a href LabelSelector a A label query over a set of resources in this case pods If it s null this PodAffinityTerm matches with no Pods preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm matchLabelKeys string Atomic will be replaced during a merge MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration The keys are used to lookup values from the incoming pod labels those key value labels are merged with labelSelector as key in value to select the group of existing pods which pods will be taken into consideration for the incoming pod s pod anti affinity Keys that don t exist in the incoming pod labels will be ignored The default value is empty The same key is forbidden to exist in both matchLabelKeys and labelSelector Also matchLabelKeys cannot be set when labelSelector isn t set This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate enabled by default preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm mismatchLabelKeys string Atomic will be replaced during a merge MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration The keys are used to lookup values from the incoming pod labels those key value labels are merged with labelSelector as key notin value to select the group of existing pods which pods will be taken into consideration for the incoming pod s pod anti affinity Keys that don t exist in the incoming pod labels will be ignored The default value is empty The same key is forbidden to exist in both mismatchLabelKeys and labelSelector Also mismatchLabelKeys cannot be set when labelSelector isn t set This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate enabled by default preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm namespaceSelector a href LabelSelector a A label query over the set of namespaces that the term applies to The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field null selector and null or empty namespaces list means this pod s namespace An empty selector matches all namespaces preferredDuringSchedulingIgnoredDuringExecution podAffinityTerm namespaces string Atomic will be replaced during a merge namespaces specifies a static list of namespace names that the term applies to The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector null or empty namespaces list and null namespaceSelector means this pod s namespace preferredDuringSchedulingIgnoredDuringExecution weight int32 required weight associated with matching the corresponding podAffinityTerm in the range 1 100 requiredDuringSchedulingIgnoredDuringExecution PodAffinityTerm Atomic will be replaced during a merge If the anti affinity requirements specified by this field are not met at scheduling time the pod will not be scheduled onto the node If the anti affinity requirements specified by this field cease to be met at some point during pod execution e g due to a pod label update the system may or may not try to eventually evict the pod from its node When there are multiple elements the lists of nodes corresponding to each podAffinityTerm are intersected i e all terms must be satisfied a name PodAffinityTerm a Defines a set of pods namely those matching the labelSelector relative to the given namespace s that this pod should be co located affinity or not co located anti affinity with where co located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which a pod of the set of pods is running requiredDuringSchedulingIgnoredDuringExecution topologyKey string required This pod should be co located affinity or not co located anti affinity with the pods matching the labelSelector in the specified namespaces where co located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running Empty topologyKey is not allowed requiredDuringSchedulingIgnoredDuringExecution labelSelector a href LabelSelector a A label query over a set of resources in this case pods If it s null this PodAffinityTerm matches with no Pods requiredDuringSchedulingIgnoredDuringExecution matchLabelKeys string Atomic will be replaced during a merge MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration The keys are used to lookup values from the incoming pod labels those key value labels are merged with labelSelector as key in value to select the group of existing pods which pods will be taken into consideration for the incoming pod s pod anti affinity Keys that don t exist in the incoming pod labels will be ignored The default value is empty The same key is forbidden to exist in both matchLabelKeys and labelSelector Also matchLabelKeys cannot be set when labelSelector isn t set This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate enabled by default requiredDuringSchedulingIgnoredDuringExecution mismatchLabelKeys string Atomic will be replaced during a merge MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration The keys are used to lookup values from the incoming pod labels those key value labels are merged with labelSelector as key notin value to select the group of existing pods which pods will be taken into consideration for the incoming pod s pod anti affinity Keys that don t exist in the incoming pod labels will be ignored The default value is empty The same key is forbidden to exist in both mismatchLabelKeys and labelSelector Also mismatchLabelKeys cannot be set when labelSelector isn t set This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate enabled by default requiredDuringSchedulingIgnoredDuringExecution namespaceSelector a href LabelSelector a A label query over the set of namespaces that the term applies to The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field null selector and null or empty namespaces list means this pod s namespace An empty selector matches all namespaces requiredDuringSchedulingIgnoredDuringExecution namespaces string Atomic will be replaced during a merge namespaces specifies a static list of namespace names that the term applies to The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector null or empty namespaces list and null namespaceSelector means this pod s namespace Probe Probe Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic hr exec ExecAction Exec specifies the action to take a name ExecAction a ExecAction describes a run in container action exec command string Atomic will be replaced during a merge Command is the command line to execute inside the container the working directory for the command is root in the container s filesystem The command is simply exec d it is not run inside a shell so traditional shell instructions etc won t work To use a shell you need to explicitly call out to that shell Exit status of 0 is treated as live healthy and non zero is unhealthy httpGet HTTPGetAction HTTPGet specifies the http request to perform a name HTTPGetAction a HTTPGetAction describes an action based on HTTP Get requests httpGet port IntOrString required Name or number of the port to access on the container Number must be in the range 1 to 65535 Name must be an IANA SVC NAME a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number httpGet host string Host name to connect to defaults to the pod IP You probably want to set Host in httpHeaders instead httpGet httpHeaders HTTPHeader Atomic will be replaced during a merge Custom headers to set in the request HTTP allows repeated headers a name HTTPHeader a HTTPHeader describes a custom header to be used in HTTP probes httpGet httpHeaders name string required The header field name This will be canonicalized upon output so case variant names will be understood as the same header httpGet httpHeaders value string required The header field value httpGet path string Path to access on the HTTP server httpGet scheme string Scheme to use for connecting to the host Defaults to HTTP tcpSocket TCPSocketAction TCPSocket specifies an action involving a TCP port a name TCPSocketAction a TCPSocketAction describes an action based on opening a socket tcpSocket port IntOrString required Number or name of the port to access on the container Number must be in the range 1 to 65535 Name must be an IANA SVC NAME a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number tcpSocket host string Optional Host name to connect to defaults to the pod IP initialDelaySeconds int32 Number of seconds after the container has started before liveness probes are initiated More info https kubernetes io docs concepts workloads pods pod lifecycle container probes terminationGracePeriodSeconds int64 Optional duration in seconds the pod needs to terminate gracefully upon probe failure The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal Set this value longer than the expected cleanup time for your process If this value is nil the pod s terminationGracePeriodSeconds will be used Otherwise this value overrides the value provided by the pod spec Value must be non negative integer The value zero indicates stop immediately via the kill signal no opportunity to shut down This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate Minimum value is 1 spec terminationGracePeriodSeconds is used if unset periodSeconds int32 How often in seconds to perform the probe Default to 10 seconds Minimum value is 1 timeoutSeconds int32 Number of seconds after which the probe times out Defaults to 1 second Minimum value is 1 More info https kubernetes io docs concepts workloads pods pod lifecycle container probes failureThreshold int32 Minimum consecutive failures for the probe to be considered failed after having succeeded Defaults to 3 Minimum value is 1 successThreshold int32 Minimum consecutive successes for the probe to be considered successful after having failed Defaults to 1 Must be 1 for liveness and startup Minimum value is 1 grpc GRPCAction GRPC specifies an action involving a GRPC port a name GRPCAction a grpc port int32 required Port number of the gRPC service Number must be in the range 1 to 65535 grpc service string Service is the name of the service to place in the gRPC HealthCheckRequest see https github com grpc grpc blob master doc health checking md If this is not specified the default behavior is defined by gRPC PodStatus PodStatus PodStatus represents information about the status of a pod Status may trail the actual state of a system especially if the node that hosts the pod cannot contact the control plane hr nominatedNodeName string nominatedNodeName is set only when this pod preempts other pods on the node but it cannot be scheduled right away as preemption victims receive their graceful termination periods This field does not guarantee that the pod will be scheduled on this node Scheduler may decide to place the pod elsewhere if other nodes become available sooner Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption As a result this field may be different than PodSpec nodeName when the pod is scheduled hostIP string hostIP holds the IP address of the host to which the pod is assigned Empty if the pod has not started yet A pod can be assigned to a node that has a problem in kubelet which in turns mean that HostIP will not be updated even if there is a node is assigned to pod hostIPs HostIP Patch strategy merge on key ip Atomic will be replaced during a merge hostIPs holds the IP addresses allocated to the host If this field is specified the first entry must match the hostIP field This list is empty if the pod has not started yet A pod can be assigned to a node that has a problem in kubelet which in turns means that HostIPs will not be updated even if there is a node is assigned to this pod a name HostIP a HostIP represents a single IP address allocated to the host hostIPs ip string required IP is the IP address assigned to the host startTime Time RFC 3339 date and time at which the object was acknowledged by the Kubelet This is before the Kubelet pulled the container image s for the pod a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers phase string The phase of a Pod is a simple high level summary of where the Pod is in its lifecycle The conditions array the reason and message fields and the individual container status arrays contain more detail about the pod s status There are five possible phase values Pending The pod has been accepted by the Kubernetes system but one or more of the container images has not been created This includes time before being scheduled as well as time spent downloading images over the network which could take a while Running The pod has been bound to a node and all of the containers have been created At least one container is still running or is in the process of starting or restarting Succeeded All containers in the pod have terminated in success and will not be restarted Failed All containers in the pod have terminated and at least one container has terminated in failure The container either exited with non zero status or was terminated by the system Unknown For some reason the state of the pod could not be obtained typically due to an error in communicating with the host of the pod More info https kubernetes io docs concepts workloads pods pod lifecycle pod phase message string A human readable message indicating details about why the pod is in this condition reason string A brief CamelCase message indicating details about why the pod is in this state e g Evicted podIP string podIP address allocated to the pod Routable at least within the cluster Empty if not yet allocated podIPs PodIP Patch strategy merge on key ip Map unique values on key ip will be kept during a merge podIPs holds the IP addresses allocated to the pod If this field is specified the 0th entry must match the podIP field Pods may be allocated at most 1 value for each of IPv4 and IPv6 This list is empty if no IPs have been allocated yet a name PodIP a PodIP represents a single IP address allocated to the pod podIPs ip string required IP is the IP address assigned to the pod conditions PodCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge Current service state of pod More info https kubernetes io docs concepts workloads pods pod lifecycle pod conditions a name PodCondition a PodCondition contains details for the current condition of this pod conditions status string required Status is the status of the condition Can be True False Unknown More info https kubernetes io docs concepts workloads pods pod lifecycle pod conditions conditions type string required Type is the type of the condition More info https kubernetes io docs concepts workloads pods pod lifecycle pod conditions conditions lastProbeTime Time Last time we probed the condition a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions lastTransitionTime Time Last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string Human readable message indicating details about last transition conditions reason string Unique one word CamelCase reason for the condition s last transition qosClass string The Quality of Service QOS classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info https kubernetes io docs concepts workloads pods pod qos quality of service classes initContainerStatuses ContainerStatus Atomic will be replaced during a merge The list has one entry per init container in the manifest The most recent successful init container will have ready true the most recently started container will have startTime set More info https kubernetes io docs concepts workloads pods pod lifecycle pod and container status a name ContainerStatus a ContainerStatus contains details for the current status of this container initContainerStatuses allocatedResources map string a href Quantity a AllocatedResources represents the compute resources allocated for this container by the node Kubelet sets this value to Container Resources Requests upon successful pod admission and after successfully admitting desired pod resize initContainerStatuses allocatedResourcesStatus ResourceStatus Patch strategy merge on key name Map unique values on key name will be kept during a merge AllocatedResourcesStatus represents the status of various resources allocated for this Pod a name ResourceStatus a initContainerStatuses allocatedResourcesStatus name string required Name of the resource Must be unique within the pod and match one of the resources from the pod spec initContainerStatuses allocatedResourcesStatus resources ResourceHealth Map unique values on key resourceID will be kept during a merge List of unique Resources health Each element in the list contains an unique resource ID and resource health At a minimum ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod See ResourceID type for it s definition a name ResourceHealth a ResourceHealth represents the health of a resource It has the latest device health information This is a part of KEP https kep k8s io 4680 and historical health changes are planned to be added in future iterations of a KEP initContainerStatuses allocatedResourcesStatus resources resourceID string required ResourceID is the unique identifier of the resource See the ResourceID type for more information initContainerStatuses allocatedResourcesStatus resources health string Health of the resource can be one of Healthy operates as normal Unhealthy reported unhealthy We consider this a temporary health issue since we do not have a mechanism today to distinguish temporary and permanent issues Unknown The status cannot be determined For example Device Plugin got unregistered and hasn t been re registered since In future we may want to introduce the PermanentlyUnhealthy Status initContainerStatuses containerID string ContainerID is the ID of the container in the format type container id Where type is a container runtime identifier returned from Version call of CRI API for example containerd initContainerStatuses image string required Image is the name of container image that the container is running The container image may not match the image used in the PodSpec as it may have been resolved by the runtime More info https kubernetes io docs concepts containers images initContainerStatuses imageID string required ImageID is the image ID of the container s image The image ID may not match the image ID of the image used in the PodSpec as it may have been resolved by the runtime initContainerStatuses lastState ContainerState LastTerminationState holds the last termination state of the container to help debug container crashes and restarts This field is not populated if the container is still running and RestartCount is 0 a name ContainerState a ContainerState holds a possible state of container Only one of its members may be specified If none of them is specified the default one is ContainerStateWaiting initContainerStatuses lastState running ContainerStateRunning Details about a running container a name ContainerStateRunning a ContainerStateRunning is a running state of a container initContainerStatuses lastState running startedAt Time Time at which the container was last re started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers initContainerStatuses lastState terminated ContainerStateTerminated Details about a terminated container a name ContainerStateTerminated a ContainerStateTerminated is a terminated state of a container initContainerStatuses lastState terminated containerID string Container s ID in the format type container id initContainerStatuses lastState terminated exitCode int32 required Exit status from the last termination of the container initContainerStatuses lastState terminated startedAt Time Time at which previous execution of the container started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers initContainerStatuses lastState terminated finishedAt Time Time at which the container last terminated a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers initContainerStatuses lastState terminated message string Message regarding the last termination of the container initContainerStatuses lastState terminated reason string brief reason from the last termination of the container initContainerStatuses lastState terminated signal int32 Signal from the last termination of the container initContainerStatuses lastState waiting ContainerStateWaiting Details about a waiting container a name ContainerStateWaiting a ContainerStateWaiting is a waiting state of a container initContainerStatuses lastState waiting message string Message regarding why the container is not yet running initContainerStatuses lastState waiting reason string brief reason the container is not yet running initContainerStatuses name string required Name is a DNS LABEL representing the unique name of the container Each container in a pod must have a unique name across all container types Cannot be updated initContainerStatuses ready boolean required Ready specifies whether the container is currently passing its readiness check The value will change as readiness probes keep executing If no readiness probes are specified this field defaults to true once the container is fully started see Started field The value is typically used to determine whether a container is ready to accept traffic initContainerStatuses resources ResourceRequirements Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized a name ResourceRequirements a ResourceRequirements describes the compute resource requirements initContainerStatuses resources claims ResourceClaim Map unique values on key name will be kept during a merge Claims lists the names of resources defined in spec resourceClaims that are used by this container This is an alpha field and requires enabling the DynamicResourceAllocation feature gate This field is immutable It can only be set for containers a name ResourceClaim a ResourceClaim references one entry in PodSpec ResourceClaims initContainerStatuses resources claims name string required Name must match the name of one entry in pod spec resourceClaims of the Pod where this field is used It makes that resource available inside a container initContainerStatuses resources claims request string Request is the name chosen for a request in the referenced claim If empty everything from the claim is made available otherwise only the result of this request initContainerStatuses resources limits map string a href Quantity a Limits describes the maximum amount of compute resources allowed More info https kubernetes io docs concepts configuration manage resources containers initContainerStatuses resources requests map string a href Quantity a Requests describes the minimum amount of compute resources required If Requests is omitted for a container it defaults to Limits if that is explicitly specified otherwise to an implementation defined value Requests cannot exceed Limits More info https kubernetes io docs concepts configuration manage resources containers initContainerStatuses restartCount int32 required RestartCount holds the number of times the container has been restarted Kubelet makes an effort to always increment the value but there are cases when the state may be lost due to node restarts and then the value may be reset to 0 The value is never negative initContainerStatuses started boolean Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe Initialized as false becomes true after startupProbe is considered successful Resets to false when the container is restarted or if kubelet loses state temporarily In both cases startup probes will run again Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook The null value must be treated the same as false initContainerStatuses state ContainerState State holds details about the container s current condition a name ContainerState a ContainerState holds a possible state of container Only one of its members may be specified If none of them is specified the default one is ContainerStateWaiting initContainerStatuses state running ContainerStateRunning Details about a running container a name ContainerStateRunning a ContainerStateRunning is a running state of a container initContainerStatuses state running startedAt Time Time at which the container was last re started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers initContainerStatuses state terminated ContainerStateTerminated Details about a terminated container a name ContainerStateTerminated a ContainerStateTerminated is a terminated state of a container initContainerStatuses state terminated containerID string Container s ID in the format type container id initContainerStatuses state terminated exitCode int32 required Exit status from the last termination of the container initContainerStatuses state terminated startedAt Time Time at which previous execution of the container started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers initContainerStatuses state terminated finishedAt Time Time at which the container last terminated a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers initContainerStatuses state terminated message string Message regarding the last termination of the container initContainerStatuses state terminated reason string brief reason from the last termination of the container initContainerStatuses state terminated signal int32 Signal from the last termination of the container initContainerStatuses state waiting ContainerStateWaiting Details about a waiting container a name ContainerStateWaiting a ContainerStateWaiting is a waiting state of a container initContainerStatuses state waiting message string Message regarding why the container is not yet running initContainerStatuses state waiting reason string brief reason the container is not yet running initContainerStatuses user ContainerUser User represents user identity information initially attached to the first process of the container a name ContainerUser a ContainerUser represents user identity information initContainerStatuses user linux LinuxContainerUser Linux holds user identity information initially attached to the first process of the containers in Linux Note that the actual running identity can be changed if the process has enough privilege to do so a name LinuxContainerUser a LinuxContainerUser represents user identity information in Linux containers initContainerStatuses user linux gid int64 required GID is the primary gid initially attached to the first process in the container initContainerStatuses user linux uid int64 required UID is the primary uid initially attached to the first process in the container initContainerStatuses user linux supplementalGroups int64 Atomic will be replaced during a merge SupplementalGroups are the supplemental groups initially attached to the first process in the container initContainerStatuses volumeMounts VolumeMountStatus Patch strategy merge on key mountPath Map unique values on key mountPath will be kept during a merge Status of volume mounts a name VolumeMountStatus a VolumeMountStatus shows status of volume mounts initContainerStatuses volumeMounts mountPath string required MountPath corresponds to the original VolumeMount initContainerStatuses volumeMounts name string required Name corresponds to the name of the original VolumeMount initContainerStatuses volumeMounts readOnly boolean ReadOnly corresponds to the original VolumeMount initContainerStatuses volumeMounts recursiveReadOnly string RecursiveReadOnly must be set to Disabled Enabled or unspecified for non readonly mounts An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled depending on the mount result containerStatuses ContainerStatus Atomic will be replaced during a merge The list has one entry per container in the manifest More info https kubernetes io docs concepts workloads pods pod lifecycle pod and container status a name ContainerStatus a ContainerStatus contains details for the current status of this container containerStatuses allocatedResources map string a href Quantity a AllocatedResources represents the compute resources allocated for this container by the node Kubelet sets this value to Container Resources Requests upon successful pod admission and after successfully admitting desired pod resize containerStatuses allocatedResourcesStatus ResourceStatus Patch strategy merge on key name Map unique values on key name will be kept during a merge AllocatedResourcesStatus represents the status of various resources allocated for this Pod a name ResourceStatus a containerStatuses allocatedResourcesStatus name string required Name of the resource Must be unique within the pod and match one of the resources from the pod spec containerStatuses allocatedResourcesStatus resources ResourceHealth Map unique values on key resourceID will be kept during a merge List of unique Resources health Each element in the list contains an unique resource ID and resource health At a minimum ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod See ResourceID type for it s definition a name ResourceHealth a ResourceHealth represents the health of a resource It has the latest device health information This is a part of KEP https kep k8s io 4680 and historical health changes are planned to be added in future iterations of a KEP containerStatuses allocatedResourcesStatus resources resourceID string required ResourceID is the unique identifier of the resource See the ResourceID type for more information containerStatuses allocatedResourcesStatus resources health string Health of the resource can be one of Healthy operates as normal Unhealthy reported unhealthy We consider this a temporary health issue since we do not have a mechanism today to distinguish temporary and permanent issues Unknown The status cannot be determined For example Device Plugin got unregistered and hasn t been re registered since In future we may want to introduce the PermanentlyUnhealthy Status containerStatuses containerID string ContainerID is the ID of the container in the format type container id Where type is a container runtime identifier returned from Version call of CRI API for example containerd containerStatuses image string required Image is the name of container image that the container is running The container image may not match the image used in the PodSpec as it may have been resolved by the runtime More info https kubernetes io docs concepts containers images containerStatuses imageID string required ImageID is the image ID of the container s image The image ID may not match the image ID of the image used in the PodSpec as it may have been resolved by the runtime containerStatuses lastState ContainerState LastTerminationState holds the last termination state of the container to help debug container crashes and restarts This field is not populated if the container is still running and RestartCount is 0 a name ContainerState a ContainerState holds a possible state of container Only one of its members may be specified If none of them is specified the default one is ContainerStateWaiting containerStatuses lastState running ContainerStateRunning Details about a running container a name ContainerStateRunning a ContainerStateRunning is a running state of a container containerStatuses lastState running startedAt Time Time at which the container was last re started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers containerStatuses lastState terminated ContainerStateTerminated Details about a terminated container a name ContainerStateTerminated a ContainerStateTerminated is a terminated state of a container containerStatuses lastState terminated containerID string Container s ID in the format type container id containerStatuses lastState terminated exitCode int32 required Exit status from the last termination of the container containerStatuses lastState terminated startedAt Time Time at which previous execution of the container started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers containerStatuses lastState terminated finishedAt Time Time at which the container last terminated a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers containerStatuses lastState terminated message string Message regarding the last termination of the container containerStatuses lastState terminated reason string brief reason from the last termination of the container containerStatuses lastState terminated signal int32 Signal from the last termination of the container containerStatuses lastState waiting ContainerStateWaiting Details about a waiting container a name ContainerStateWaiting a ContainerStateWaiting is a waiting state of a container containerStatuses lastState waiting message string Message regarding why the container is not yet running containerStatuses lastState waiting reason string brief reason the container is not yet running containerStatuses name string required Name is a DNS LABEL representing the unique name of the container Each container in a pod must have a unique name across all container types Cannot be updated containerStatuses ready boolean required Ready specifies whether the container is currently passing its readiness check The value will change as readiness probes keep executing If no readiness probes are specified this field defaults to true once the container is fully started see Started field The value is typically used to determine whether a container is ready to accept traffic containerStatuses resources ResourceRequirements Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized a name ResourceRequirements a ResourceRequirements describes the compute resource requirements containerStatuses resources claims ResourceClaim Map unique values on key name will be kept during a merge Claims lists the names of resources defined in spec resourceClaims that are used by this container This is an alpha field and requires enabling the DynamicResourceAllocation feature gate This field is immutable It can only be set for containers a name ResourceClaim a ResourceClaim references one entry in PodSpec ResourceClaims containerStatuses resources claims name string required Name must match the name of one entry in pod spec resourceClaims of the Pod where this field is used It makes that resource available inside a container containerStatuses resources claims request string Request is the name chosen for a request in the referenced claim If empty everything from the claim is made available otherwise only the result of this request containerStatuses resources limits map string a href Quantity a Limits describes the maximum amount of compute resources allowed More info https kubernetes io docs concepts configuration manage resources containers containerStatuses resources requests map string a href Quantity a Requests describes the minimum amount of compute resources required If Requests is omitted for a container it defaults to Limits if that is explicitly specified otherwise to an implementation defined value Requests cannot exceed Limits More info https kubernetes io docs concepts configuration manage resources containers containerStatuses restartCount int32 required RestartCount holds the number of times the container has been restarted Kubelet makes an effort to always increment the value but there are cases when the state may be lost due to node restarts and then the value may be reset to 0 The value is never negative containerStatuses started boolean Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe Initialized as false becomes true after startupProbe is considered successful Resets to false when the container is restarted or if kubelet loses state temporarily In both cases startup probes will run again Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook The null value must be treated the same as false containerStatuses state ContainerState State holds details about the container s current condition a name ContainerState a ContainerState holds a possible state of container Only one of its members may be specified If none of them is specified the default one is ContainerStateWaiting containerStatuses state running ContainerStateRunning Details about a running container a name ContainerStateRunning a ContainerStateRunning is a running state of a container containerStatuses state running startedAt Time Time at which the container was last re started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers containerStatuses state terminated ContainerStateTerminated Details about a terminated container a name ContainerStateTerminated a ContainerStateTerminated is a terminated state of a container containerStatuses state terminated containerID string Container s ID in the format type container id containerStatuses state terminated exitCode int32 required Exit status from the last termination of the container containerStatuses state terminated startedAt Time Time at which previous execution of the container started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers containerStatuses state terminated finishedAt Time Time at which the container last terminated a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers containerStatuses state terminated message string Message regarding the last termination of the container containerStatuses state terminated reason string brief reason from the last termination of the container containerStatuses state terminated signal int32 Signal from the last termination of the container containerStatuses state waiting ContainerStateWaiting Details about a waiting container a name ContainerStateWaiting a ContainerStateWaiting is a waiting state of a container containerStatuses state waiting message string Message regarding why the container is not yet running containerStatuses state waiting reason string brief reason the container is not yet running containerStatuses user ContainerUser User represents user identity information initially attached to the first process of the container a name ContainerUser a ContainerUser represents user identity information containerStatuses user linux LinuxContainerUser Linux holds user identity information initially attached to the first process of the containers in Linux Note that the actual running identity can be changed if the process has enough privilege to do so a name LinuxContainerUser a LinuxContainerUser represents user identity information in Linux containers containerStatuses user linux gid int64 required GID is the primary gid initially attached to the first process in the container containerStatuses user linux uid int64 required UID is the primary uid initially attached to the first process in the container containerStatuses user linux supplementalGroups int64 Atomic will be replaced during a merge SupplementalGroups are the supplemental groups initially attached to the first process in the container containerStatuses volumeMounts VolumeMountStatus Patch strategy merge on key mountPath Map unique values on key mountPath will be kept during a merge Status of volume mounts a name VolumeMountStatus a VolumeMountStatus shows status of volume mounts containerStatuses volumeMounts mountPath string required MountPath corresponds to the original VolumeMount containerStatuses volumeMounts name string required Name corresponds to the name of the original VolumeMount containerStatuses volumeMounts readOnly boolean ReadOnly corresponds to the original VolumeMount containerStatuses volumeMounts recursiveReadOnly string RecursiveReadOnly must be set to Disabled Enabled or unspecified for non readonly mounts An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled depending on the mount result ephemeralContainerStatuses ContainerStatus Atomic will be replaced during a merge Status for any ephemeral containers that have run in this pod a name ContainerStatus a ContainerStatus contains details for the current status of this container ephemeralContainerStatuses allocatedResources map string a href Quantity a AllocatedResources represents the compute resources allocated for this container by the node Kubelet sets this value to Container Resources Requests upon successful pod admission and after successfully admitting desired pod resize ephemeralContainerStatuses allocatedResourcesStatus ResourceStatus Patch strategy merge on key name Map unique values on key name will be kept during a merge AllocatedResourcesStatus represents the status of various resources allocated for this Pod a name ResourceStatus a ephemeralContainerStatuses allocatedResourcesStatus name string required Name of the resource Must be unique within the pod and match one of the resources from the pod spec ephemeralContainerStatuses allocatedResourcesStatus resources ResourceHealth Map unique values on key resourceID will be kept during a merge List of unique Resources health Each element in the list contains an unique resource ID and resource health At a minimum ResourceID must uniquely identify the Resource allocated to the Pod on the Node for the lifetime of a Pod See ResourceID type for it s definition a name ResourceHealth a ResourceHealth represents the health of a resource It has the latest device health information This is a part of KEP https kep k8s io 4680 and historical health changes are planned to be added in future iterations of a KEP ephemeralContainerStatuses allocatedResourcesStatus resources resourceID string required ResourceID is the unique identifier of the resource See the ResourceID type for more information ephemeralContainerStatuses allocatedResourcesStatus resources health string Health of the resource can be one of Healthy operates as normal Unhealthy reported unhealthy We consider this a temporary health issue since we do not have a mechanism today to distinguish temporary and permanent issues Unknown The status cannot be determined For example Device Plugin got unregistered and hasn t been re registered since In future we may want to introduce the PermanentlyUnhealthy Status ephemeralContainerStatuses containerID string ContainerID is the ID of the container in the format type container id Where type is a container runtime identifier returned from Version call of CRI API for example containerd ephemeralContainerStatuses image string required Image is the name of container image that the container is running The container image may not match the image used in the PodSpec as it may have been resolved by the runtime More info https kubernetes io docs concepts containers images ephemeralContainerStatuses imageID string required ImageID is the image ID of the container s image The image ID may not match the image ID of the image used in the PodSpec as it may have been resolved by the runtime ephemeralContainerStatuses lastState ContainerState LastTerminationState holds the last termination state of the container to help debug container crashes and restarts This field is not populated if the container is still running and RestartCount is 0 a name ContainerState a ContainerState holds a possible state of container Only one of its members may be specified If none of them is specified the default one is ContainerStateWaiting ephemeralContainerStatuses lastState running ContainerStateRunning Details about a running container a name ContainerStateRunning a ContainerStateRunning is a running state of a container ephemeralContainerStatuses lastState running startedAt Time Time at which the container was last re started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers ephemeralContainerStatuses lastState terminated ContainerStateTerminated Details about a terminated container a name ContainerStateTerminated a ContainerStateTerminated is a terminated state of a container ephemeralContainerStatuses lastState terminated containerID string Container s ID in the format type container id ephemeralContainerStatuses lastState terminated exitCode int32 required Exit status from the last termination of the container ephemeralContainerStatuses lastState terminated startedAt Time Time at which previous execution of the container started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers ephemeralContainerStatuses lastState terminated finishedAt Time Time at which the container last terminated a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers ephemeralContainerStatuses lastState terminated message string Message regarding the last termination of the container ephemeralContainerStatuses lastState terminated reason string brief reason from the last termination of the container ephemeralContainerStatuses lastState terminated signal int32 Signal from the last termination of the container ephemeralContainerStatuses lastState waiting ContainerStateWaiting Details about a waiting container a name ContainerStateWaiting a ContainerStateWaiting is a waiting state of a container ephemeralContainerStatuses lastState waiting message string Message regarding why the container is not yet running ephemeralContainerStatuses lastState waiting reason string brief reason the container is not yet running ephemeralContainerStatuses name string required Name is a DNS LABEL representing the unique name of the container Each container in a pod must have a unique name across all container types Cannot be updated ephemeralContainerStatuses ready boolean required Ready specifies whether the container is currently passing its readiness check The value will change as readiness probes keep executing If no readiness probes are specified this field defaults to true once the container is fully started see Started field The value is typically used to determine whether a container is ready to accept traffic ephemeralContainerStatuses resources ResourceRequirements Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized a name ResourceRequirements a ResourceRequirements describes the compute resource requirements ephemeralContainerStatuses resources claims ResourceClaim Map unique values on key name will be kept during a merge Claims lists the names of resources defined in spec resourceClaims that are used by this container This is an alpha field and requires enabling the DynamicResourceAllocation feature gate This field is immutable It can only be set for containers a name ResourceClaim a ResourceClaim references one entry in PodSpec ResourceClaims ephemeralContainerStatuses resources claims name string required Name must match the name of one entry in pod spec resourceClaims of the Pod where this field is used It makes that resource available inside a container ephemeralContainerStatuses resources claims request string Request is the name chosen for a request in the referenced claim If empty everything from the claim is made available otherwise only the result of this request ephemeralContainerStatuses resources limits map string a href Quantity a Limits describes the maximum amount of compute resources allowed More info https kubernetes io docs concepts configuration manage resources containers ephemeralContainerStatuses resources requests map string a href Quantity a Requests describes the minimum amount of compute resources required If Requests is omitted for a container it defaults to Limits if that is explicitly specified otherwise to an implementation defined value Requests cannot exceed Limits More info https kubernetes io docs concepts configuration manage resources containers ephemeralContainerStatuses restartCount int32 required RestartCount holds the number of times the container has been restarted Kubelet makes an effort to always increment the value but there are cases when the state may be lost due to node restarts and then the value may be reset to 0 The value is never negative ephemeralContainerStatuses started boolean Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe Initialized as false becomes true after startupProbe is considered successful Resets to false when the container is restarted or if kubelet loses state temporarily In both cases startup probes will run again Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook The null value must be treated the same as false ephemeralContainerStatuses state ContainerState State holds details about the container s current condition a name ContainerState a ContainerState holds a possible state of container Only one of its members may be specified If none of them is specified the default one is ContainerStateWaiting ephemeralContainerStatuses state running ContainerStateRunning Details about a running container a name ContainerStateRunning a ContainerStateRunning is a running state of a container ephemeralContainerStatuses state running startedAt Time Time at which the container was last re started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers ephemeralContainerStatuses state terminated ContainerStateTerminated Details about a terminated container a name ContainerStateTerminated a ContainerStateTerminated is a terminated state of a container ephemeralContainerStatuses state terminated containerID string Container s ID in the format type container id ephemeralContainerStatuses state terminated exitCode int32 required Exit status from the last termination of the container ephemeralContainerStatuses state terminated startedAt Time Time at which previous execution of the container started a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers ephemeralContainerStatuses state terminated finishedAt Time Time at which the container last terminated a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers ephemeralContainerStatuses state terminated message string Message regarding the last termination of the container ephemeralContainerStatuses state terminated reason string brief reason from the last termination of the container ephemeralContainerStatuses state terminated signal int32 Signal from the last termination of the container ephemeralContainerStatuses state waiting ContainerStateWaiting Details about a waiting container a name ContainerStateWaiting a ContainerStateWaiting is a waiting state of a container ephemeralContainerStatuses state waiting message string Message regarding why the container is not yet running ephemeralContainerStatuses state waiting reason string brief reason the container is not yet running ephemeralContainerStatuses user ContainerUser User represents user identity information initially attached to the first process of the container a name ContainerUser a ContainerUser represents user identity information ephemeralContainerStatuses user linux LinuxContainerUser Linux holds user identity information initially attached to the first process of the containers in Linux Note that the actual running identity can be changed if the process has enough privilege to do so a name LinuxContainerUser a LinuxContainerUser represents user identity information in Linux containers ephemeralContainerStatuses user linux gid int64 required GID is the primary gid initially attached to the first process in the container ephemeralContainerStatuses user linux uid int64 required UID is the primary uid initially attached to the first process in the container ephemeralContainerStatuses user linux supplementalGroups int64 Atomic will be replaced during a merge SupplementalGroups are the supplemental groups initially attached to the first process in the container ephemeralContainerStatuses volumeMounts VolumeMountStatus Patch strategy merge on key mountPath Map unique values on key mountPath will be kept during a merge Status of volume mounts a name VolumeMountStatus a VolumeMountStatus shows status of volume mounts ephemeralContainerStatuses volumeMounts mountPath string required MountPath corresponds to the original VolumeMount ephemeralContainerStatuses volumeMounts name string required Name corresponds to the name of the original VolumeMount ephemeralContainerStatuses volumeMounts readOnly boolean ReadOnly corresponds to the original VolumeMount ephemeralContainerStatuses volumeMounts recursiveReadOnly string RecursiveReadOnly must be set to Disabled Enabled or unspecified for non readonly mounts An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled depending on the mount result resourceClaimStatuses PodResourceClaimStatus Patch strategies retainKeys merge on key name Map unique values on key name will be kept during a merge Status of resource claims a name PodResourceClaimStatus a PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim which references a ResourceClaimTemplate It stores the generated name for the corresponding ResourceClaim resourceClaimStatuses name string required Name uniquely identifies this resource claim inside the pod This must match the name of an entry in pod spec resourceClaims which implies that the string must be a DNS LABEL resourceClaimStatuses resourceClaimName string ResourceClaimName is the name of the ResourceClaim that was generated for the Pod in the namespace of the Pod If this is unset then generating a ResourceClaim was not necessary The pod spec resourceClaims entry can be ignored in this case resize string Status of resources resize desired for pod s containers It is empty if no resources resize is pending Any changes to container resources will automatically set this to Proposed PodList PodList PodList is a list of Pods hr items a href Pod a required List of pods More info https git k8s io community contributors devel sig architecture api conventions md apiVersion string APIVersion defines the versioned schema of this representation of an object Servers should convert recognized schemas to the latest internal value and may reject unrecognized values More info https git k8s io community contributors devel sig architecture api conventions md resources kind string Kind is a string value representing the REST resource this object represents Servers may infer this from the endpoint the client submits requests to Cannot be updated In CamelCase More info https git k8s io community contributors devel sig architecture api conventions md types kinds metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds Operations Operations hr get read the specified Pod HTTP Request GET api v1 namespaces namespace pods name Parameters name in path string required name of the Pod namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Pod a OK 401 Unauthorized get read ephemeralcontainers of the specified Pod HTTP Request GET api v1 namespaces namespace pods name ephemeralcontainers Parameters name in path string required name of the Pod namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Pod a OK 401 Unauthorized get read log of the specified Pod HTTP Request GET api v1 namespaces namespace pods name log Parameters name in path string required name of the Pod namespace in path string required a href namespace a container in query string The container for which to stream logs Defaults to only container if there is one container in the pod follow in query boolean Follow the log stream of the pod Defaults to false insecureSkipTLSVerifyBackend in query boolean insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to This will make the HTTPS connection between the apiserver and the backend insecure This means the apiserver cannot verify the log data it is receiving came from the real kubelet If the kubelet is configured to verify the apiserver s TLS credentials it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack e g an attacker could not intercept the actual log data coming from the real kubelet limitBytes in query integer If set the number of bytes to read from the server before terminating the log output This may not display a complete final line of logging and may return slightly more or slightly less than the specified limit pretty in query string a href pretty a previous in query boolean Return previous terminated container logs Defaults to false sinceSeconds in query integer A relative time in seconds before the current time from which to show logs If this value precedes the time a pod was started only logs since the pod start will be returned If this value is in the future no logs will be returned Only one of sinceSeconds or sinceTime may be specified tailLines in query integer If set the number of lines from the end of the logs to show If not specified logs are shown from the creation of the container or sinceSeconds or sinceTime timestamps in query boolean If true add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output Defaults to false Response 200 string OK 401 Unauthorized get read status of the specified Pod HTTP Request GET api v1 namespaces namespace pods name status Parameters name in path string required name of the Pod namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Pod a OK 401 Unauthorized list list or watch objects of kind Pod HTTP Request GET api v1 namespaces namespace pods Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PodList a OK 401 Unauthorized list list or watch objects of kind Pod HTTP Request GET api v1 pods Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PodList a OK 401 Unauthorized create create a Pod HTTP Request POST api v1 namespaces namespace pods Parameters namespace in path string required a href namespace a body a href Pod a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Pod a OK 201 a href Pod a Created 202 a href Pod a Accepted 401 Unauthorized update replace the specified Pod HTTP Request PUT api v1 namespaces namespace pods name Parameters name in path string required name of the Pod namespace in path string required a href namespace a body a href Pod a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Pod a OK 201 a href Pod a Created 401 Unauthorized update replace ephemeralcontainers of the specified Pod HTTP Request PUT api v1 namespaces namespace pods name ephemeralcontainers Parameters name in path string required name of the Pod namespace in path string required a href namespace a body a href Pod a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Pod a OK 201 a href Pod a Created 401 Unauthorized update replace status of the specified Pod HTTP Request PUT api v1 namespaces namespace pods name status Parameters name in path string required name of the Pod namespace in path string required a href namespace a body a href Pod a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Pod a OK 201 a href Pod a Created 401 Unauthorized patch partially update the specified Pod HTTP Request PATCH api v1 namespaces namespace pods name Parameters name in path string required name of the Pod namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Pod a OK 201 a href Pod a Created 401 Unauthorized patch partially update ephemeralcontainers of the specified Pod HTTP Request PATCH api v1 namespaces namespace pods name ephemeralcontainers Parameters name in path string required name of the Pod namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Pod a OK 201 a href Pod a Created 401 Unauthorized patch partially update status of the specified Pod HTTP Request PATCH api v1 namespaces namespace pods name status Parameters name in path string required name of the Pod namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Pod a OK 201 a href Pod a Created 401 Unauthorized delete delete a Pod HTTP Request DELETE api v1 namespaces namespace pods name Parameters name in path string required name of the Pod namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Pod a OK 202 a href Pod a Accepted 401 Unauthorized deletecollection delete collection of Pod HTTP Request DELETE api v1 namespaces namespace pods Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion v1 contenttype apireference title ReplicationController apimetadata weight 4 kind ReplicationController autogenerated true ReplicationController represents the configuration of a replication controller import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "ReplicationController"
content_type: "api_reference"
description: "ReplicationController represents the configuration of a replication controller."
title: "ReplicationController"
weight: 4
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## ReplicationController {#ReplicationController}
ReplicationController represents the configuration of a replication controller.
<hr>
- **apiVersion**: v1
- **kind**: ReplicationController
- **metadata** (<a href="">ObjectMeta</a>)
If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">ReplicationControllerSpec</a>)
Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">ReplicationControllerStatus</a>)
Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## ReplicationControllerSpec {#ReplicationControllerSpec}
ReplicationControllerSpec is the specification of a replication controller.
<hr>
- **selector** (map[string]string)
Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **template** (<a href="">PodTemplateSpec</a>)
Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. The only allowed template.spec.restartPolicy value is "Always". More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
- **replicas** (int32)
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
- **minReadySeconds** (int32)
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
## ReplicationControllerStatus {#ReplicationControllerStatus}
ReplicationControllerStatus represents the current status of a replication controller.
<hr>
- **replicas** (int32), required
Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
- **availableReplicas** (int32)
The number of available replicas (ready for at least minReadySeconds) for this replication controller.
- **readyReplicas** (int32)
The number of ready replicas for this replication controller.
- **fullyLabeledReplicas** (int32)
The number of pods that have labels matching the labels of the pod template of the replication controller.
- **conditions** ([]ReplicationControllerCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Represents the latest available observations of a replication controller's current state.
<a name="ReplicationControllerCondition"></a>
*ReplicationControllerCondition describes the state of a replication controller at a certain point.*
- **conditions.status** (string), required
Status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
Type of replication controller condition.
- **conditions.lastTransitionTime** (Time)
The last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
A human readable message indicating details about the transition.
- **conditions.reason** (string)
The reason for the condition's last transition.
- **observedGeneration** (int64)
ObservedGeneration reflects the generation of the most recently observed replication controller.
## ReplicationControllerList {#ReplicationControllerList}
ReplicationControllerList is a collection of replication controllers.
<hr>
- **apiVersion**: v1
- **kind**: ReplicationControllerList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">ReplicationController</a>), required
List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
## Operations {#Operations}
<hr>
### `get` read the specified ReplicationController
#### HTTP Request
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ReplicationController
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicationController</a>): OK
401: Unauthorized
### `get` read status of the specified ReplicationController
#### HTTP Request
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ReplicationController
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicationController</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ReplicationController
#### HTTP Request
GET /api/v1/namespaces/{namespace}/replicationcontrollers
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ReplicationControllerList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ReplicationController
#### HTTP Request
GET /api/v1/replicationcontrollers
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ReplicationControllerList</a>): OK
401: Unauthorized
### `create` create a ReplicationController
#### HTTP Request
POST /api/v1/namespaces/{namespace}/replicationcontrollers
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ReplicationController</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicationController</a>): OK
201 (<a href="">ReplicationController</a>): Created
202 (<a href="">ReplicationController</a>): Accepted
401: Unauthorized
### `update` replace the specified ReplicationController
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ReplicationController
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ReplicationController</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicationController</a>): OK
201 (<a href="">ReplicationController</a>): Created
401: Unauthorized
### `update` replace status of the specified ReplicationController
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ReplicationController
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ReplicationController</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicationController</a>): OK
201 (<a href="">ReplicationController</a>): Created
401: Unauthorized
### `patch` partially update the specified ReplicationController
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ReplicationController
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicationController</a>): OK
201 (<a href="">ReplicationController</a>): Created
401: Unauthorized
### `patch` partially update status of the specified ReplicationController
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ReplicationController
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ReplicationController</a>): OK
201 (<a href="">ReplicationController</a>): Created
401: Unauthorized
### `delete` delete a ReplicationController
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ReplicationController
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ReplicationController
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind ReplicationController content type api reference description ReplicationController represents the configuration of a replication controller title ReplicationController weight 4 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 apiVersion v1 import k8s io api core v1 ReplicationController ReplicationController ReplicationController represents the configuration of a replication controller hr apiVersion v1 kind ReplicationController metadata a href ObjectMeta a If the Labels of a ReplicationController are empty they are defaulted to be the same as the Pod s that the replication controller manages Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href ReplicationControllerSpec a Spec defines the specification of the desired behavior of the replication controller More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href ReplicationControllerStatus a Status is the most recently observed status of the replication controller This data may be out of date by some window of time Populated by the system Read only More info https git k8s io community contributors devel sig architecture api conventions md spec and status ReplicationControllerSpec ReplicationControllerSpec ReplicationControllerSpec is the specification of a replication controller hr selector map string string Selector is a label query over pods that should match the Replicas count If Selector is empty it is defaulted to the labels present on the Pod template Label keys and values that must match in order to be controlled by this replication controller if empty defaulted to labels on Pod template More info https kubernetes io docs concepts overview working with objects labels label selectors template a href PodTemplateSpec a Template is the object that describes the pod that will be created if insufficient replicas are detected This takes precedence over a TemplateRef The only allowed template spec restartPolicy value is Always More info https kubernetes io docs concepts workloads controllers replicationcontroller pod template replicas int32 Replicas is the number of desired replicas This is a pointer to distinguish between explicit zero and unspecified Defaults to 1 More info https kubernetes io docs concepts workloads controllers replicationcontroller what is a replicationcontroller minReadySeconds int32 Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available Defaults to 0 pod will be considered available as soon as it is ready ReplicationControllerStatus ReplicationControllerStatus ReplicationControllerStatus represents the current status of a replication controller hr replicas int32 required Replicas is the most recently observed number of replicas More info https kubernetes io docs concepts workloads controllers replicationcontroller what is a replicationcontroller availableReplicas int32 The number of available replicas ready for at least minReadySeconds for this replication controller readyReplicas int32 The number of ready replicas for this replication controller fullyLabeledReplicas int32 The number of pods that have labels matching the labels of the pod template of the replication controller conditions ReplicationControllerCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge Represents the latest available observations of a replication controller s current state a name ReplicationControllerCondition a ReplicationControllerCondition describes the state of a replication controller at a certain point conditions status string required Status of the condition one of True False Unknown conditions type string required Type of replication controller condition conditions lastTransitionTime Time The last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string A human readable message indicating details about the transition conditions reason string The reason for the condition s last transition observedGeneration int64 ObservedGeneration reflects the generation of the most recently observed replication controller ReplicationControllerList ReplicationControllerList ReplicationControllerList is a collection of replication controllers hr apiVersion v1 kind ReplicationControllerList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href ReplicationController a required List of replication controllers More info https kubernetes io docs concepts workloads controllers replicationcontroller Operations Operations hr get read the specified ReplicationController HTTP Request GET api v1 namespaces namespace replicationcontrollers name Parameters name in path string required name of the ReplicationController namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ReplicationController a OK 401 Unauthorized get read status of the specified ReplicationController HTTP Request GET api v1 namespaces namespace replicationcontrollers name status Parameters name in path string required name of the ReplicationController namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ReplicationController a OK 401 Unauthorized list list or watch objects of kind ReplicationController HTTP Request GET api v1 namespaces namespace replicationcontrollers Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ReplicationControllerList a OK 401 Unauthorized list list or watch objects of kind ReplicationController HTTP Request GET api v1 replicationcontrollers Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ReplicationControllerList a OK 401 Unauthorized create create a ReplicationController HTTP Request POST api v1 namespaces namespace replicationcontrollers Parameters namespace in path string required a href namespace a body a href ReplicationController a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ReplicationController a OK 201 a href ReplicationController a Created 202 a href ReplicationController a Accepted 401 Unauthorized update replace the specified ReplicationController HTTP Request PUT api v1 namespaces namespace replicationcontrollers name Parameters name in path string required name of the ReplicationController namespace in path string required a href namespace a body a href ReplicationController a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ReplicationController a OK 201 a href ReplicationController a Created 401 Unauthorized update replace status of the specified ReplicationController HTTP Request PUT api v1 namespaces namespace replicationcontrollers name status Parameters name in path string required name of the ReplicationController namespace in path string required a href namespace a body a href ReplicationController a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ReplicationController a OK 201 a href ReplicationController a Created 401 Unauthorized patch partially update the specified ReplicationController HTTP Request PATCH api v1 namespaces namespace replicationcontrollers name Parameters name in path string required name of the ReplicationController namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ReplicationController a OK 201 a href ReplicationController a Created 401 Unauthorized patch partially update status of the specified ReplicationController HTTP Request PATCH api v1 namespaces namespace replicationcontrollers name status Parameters name in path string required name of the ReplicationController namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ReplicationController a OK 201 a href ReplicationController a Created 401 Unauthorized delete delete a ReplicationController HTTP Request DELETE api v1 namespaces namespace replicationcontrollers name Parameters name in path string required name of the ReplicationController namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ReplicationController HTTP Request DELETE api v1 namespaces namespace replicationcontrollers Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion apps v1 contenttype apireference kind ControllerRevision weight 8 apimetadata title ControllerRevision autogenerated true import k8s io api apps v1 ControllerRevision implements an immutable snapshot of state data | ---
api_metadata:
apiVersion: "apps/v1"
import: "k8s.io/api/apps/v1"
kind: "ControllerRevision"
content_type: "api_reference"
description: "ControllerRevision implements an immutable snapshot of state data."
title: "ControllerRevision"
weight: 8
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.
-->
`apiVersion: apps/v1`
`import "k8s.io/api/apps/v1"`
## ControllerRevision {#ControllerRevision}
ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
<hr>
- **apiVersion**: apps/v1
- **kind**: ControllerRevision
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **revision** (int64), required
Revision indicates the revision of the state represented by Data.
- **data** (RawExtension)
Data is the serialized representation of the state.
<a name="RawExtension"></a>
*RawExtension is used to hold extensions in external versions.
To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.
// Internal package:
type MyAPIObject struct {
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.Object `json:"myPlugin"`
}
type PluginA struct {
AOption string `json:"aOption"`
}
// External package:
type MyAPIObject struct {
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.RawExtension `json:"myPlugin"`
}
type PluginA struct {
AOption string `json:"aOption"`
}
// On the wire, the JSON will look something like this:
{
"kind":"MyAPIObject",
"apiVersion":"v1",
"myPlugin": {
"kind":"PluginA",
"aOption":"foo",
},
}
So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)*
## ControllerRevisionList {#ControllerRevisionList}
ControllerRevisionList is a resource containing a list of ControllerRevision objects.
<hr>
- **apiVersion**: apps/v1
- **kind**: ControllerRevisionList
- **metadata** (<a href="">ListMeta</a>)
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">ControllerRevision</a>), required
Items is the list of ControllerRevisions
## Operations {#Operations}
<hr>
### `get` read the specified ControllerRevision
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ControllerRevision
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ControllerRevision</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ControllerRevision
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ControllerRevisionList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ControllerRevision
#### HTTP Request
GET /apis/apps/v1/controllerrevisions
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ControllerRevisionList</a>): OK
401: Unauthorized
### `create` create a ControllerRevision
#### HTTP Request
POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ControllerRevision</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ControllerRevision</a>): OK
201 (<a href="">ControllerRevision</a>): Created
202 (<a href="">ControllerRevision</a>): Accepted
401: Unauthorized
### `update` replace the specified ControllerRevision
#### HTTP Request
PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ControllerRevision
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ControllerRevision</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ControllerRevision</a>): OK
201 (<a href="">ControllerRevision</a>): Created
401: Unauthorized
### `patch` partially update the specified ControllerRevision
#### HTTP Request
PATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ControllerRevision
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ControllerRevision</a>): OK
201 (<a href="">ControllerRevision</a>): Created
401: Unauthorized
### `delete` delete a ControllerRevision
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ControllerRevision
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ControllerRevision
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion apps v1 import k8s io api apps v1 kind ControllerRevision content type api reference description ControllerRevision implements an immutable snapshot of state data title ControllerRevision weight 8 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 apiVersion apps v1 import k8s io api apps v1 ControllerRevision ControllerRevision ControllerRevision implements an immutable snapshot of state data Clients are responsible for serializing and deserializing the objects that contain their internal state Once a ControllerRevision has been successfully created it can not be updated The API Server will fail validation of all requests that attempt to mutate the Data field ControllerRevisions may however be deleted Note that due to its use by both the DaemonSet and StatefulSet controllers for update and rollback this object is beta However it may be subject to name and representation changes in future releases and clients should not depend on its stability It is primarily for internal use by controllers hr apiVersion apps v1 kind ControllerRevision metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata revision int64 required Revision indicates the revision of the state represented by Data data RawExtension Data is the serialized representation of the state a name RawExtension a RawExtension is used to hold extensions in external versions To use this make a field which has RawExtension as its type in your external versioned struct and Object in your internal struct You also need to register your various plugin types Internal package type MyAPIObject struct runtime TypeMeta json inline MyPlugin runtime Object json myPlugin type PluginA struct AOption string json aOption External package type MyAPIObject struct runtime TypeMeta json inline MyPlugin runtime RawExtension json myPlugin type PluginA struct AOption string json aOption On the wire the JSON will look something like this kind MyAPIObject apiVersion v1 myPlugin kind PluginA aOption foo So what happens Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject That causes the raw JSON to be stored but not unpacked The next step is to copy using pkg conversion into the internal struct The runtime package s DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension turning it into the correct object type and storing it in the Object TODO In the case where the object is of an unknown type a runtime Unknown object will be created and stored ControllerRevisionList ControllerRevisionList ControllerRevisionList is a resource containing a list of ControllerRevision objects hr apiVersion apps v1 kind ControllerRevisionList metadata a href ListMeta a More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href ControllerRevision a required Items is the list of ControllerRevisions Operations Operations hr get read the specified ControllerRevision HTTP Request GET apis apps v1 namespaces namespace controllerrevisions name Parameters name in path string required name of the ControllerRevision namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ControllerRevision a OK 401 Unauthorized list list or watch objects of kind ControllerRevision HTTP Request GET apis apps v1 namespaces namespace controllerrevisions Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ControllerRevisionList a OK 401 Unauthorized list list or watch objects of kind ControllerRevision HTTP Request GET apis apps v1 controllerrevisions Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ControllerRevisionList a OK 401 Unauthorized create create a ControllerRevision HTTP Request POST apis apps v1 namespaces namespace controllerrevisions Parameters namespace in path string required a href namespace a body a href ControllerRevision a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ControllerRevision a OK 201 a href ControllerRevision a Created 202 a href ControllerRevision a Accepted 401 Unauthorized update replace the specified ControllerRevision HTTP Request PUT apis apps v1 namespaces namespace controllerrevisions name Parameters name in path string required name of the ControllerRevision namespace in path string required a href namespace a body a href ControllerRevision a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ControllerRevision a OK 201 a href ControllerRevision a Created 401 Unauthorized patch partially update the specified ControllerRevision HTTP Request PATCH apis apps v1 namespaces namespace controllerrevisions name Parameters name in path string required name of the ControllerRevision namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ControllerRevision a OK 201 a href ControllerRevision a Created 401 Unauthorized delete delete a ControllerRevision HTTP Request DELETE apis apps v1 namespaces namespace controllerrevisions name Parameters name in path string required name of the ControllerRevision namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ControllerRevision HTTP Request DELETE apis apps v1 namespaces namespace controllerrevisions Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference Binding ties one object to another for example a pod is bound to a node by a scheduler apiVersion v1 weight 2 contenttype apireference apimetadata title Binding autogenerated true kind Binding import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "Binding"
content_type: "api_reference"
description: "Binding ties one object to another; for example, a pod is bound to a node by a scheduler."
title: "Binding"
weight: 2
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## Binding {#Binding}
Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.
<hr>
- **apiVersion**: v1
- **kind**: Binding
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **target** (<a href="">ObjectReference</a>), required
The target object that you want to bind to the standard object.
## Operations {#Operations}
<hr>
### `create` create a Binding
#### HTTP Request
POST /api/v1/namespaces/{namespace}/bindings
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Binding</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Binding</a>): OK
201 (<a href="">Binding</a>): Created
202 (<a href="">Binding</a>): Accepted
401: Unauthorized
### `create` create binding of a Pod
#### HTTP Request
POST /api/v1/namespaces/{namespace}/pods/{name}/binding
#### Parameters
- **name** (*in path*): string, required
name of the Binding
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Binding</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Binding</a>): OK
201 (<a href="">Binding</a>): Created
202 (<a href="">Binding</a>): Accepted
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind Binding content type api reference description Binding ties one object to another for example a pod is bound to a node by a scheduler title Binding weight 2 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 apiVersion v1 import k8s io api core v1 Binding Binding Binding ties one object to another for example a pod is bound to a node by a scheduler Deprecated in 1 7 please use the bindings subresource of pods instead hr apiVersion v1 kind Binding metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata target a href ObjectReference a required The target object that you want to bind to the standard object Operations Operations hr create create a Binding HTTP Request POST api v1 namespaces namespace bindings Parameters namespace in path string required a href namespace a body a href Binding a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Binding a OK 201 a href Binding a Created 202 a href Binding a Accepted 401 Unauthorized create create binding of a Pod HTTP Request POST api v1 namespaces namespace pods name binding Parameters name in path string required name of the Binding namespace in path string required a href namespace a body a href Binding a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Binding a OK 201 a href Binding a Created 202 a href Binding a Accepted 401 Unauthorized |
kubernetes reference weight 6 apiVersion apps v1 contenttype apireference kind Deployment apimetadata autogenerated true import k8s io api apps v1 title Deployment Deployment enables declarative updates for Pods and ReplicaSets | ---
api_metadata:
apiVersion: "apps/v1"
import: "k8s.io/api/apps/v1"
kind: "Deployment"
content_type: "api_reference"
description: "Deployment enables declarative updates for Pods and ReplicaSets."
title: "Deployment"
weight: 6
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.
-->
`apiVersion: apps/v1`
`import "k8s.io/api/apps/v1"`
## Deployment {#Deployment}
Deployment enables declarative updates for Pods and ReplicaSets.
<hr>
- **apiVersion**: apps/v1
- **kind**: Deployment
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">DeploymentSpec</a>)
Specification of the desired behavior of the Deployment.
- **status** (<a href="">DeploymentStatus</a>)
Most recently observed status of the Deployment.
## DeploymentSpec {#DeploymentSpec}
DeploymentSpec is the specification of the desired behavior of the Deployment.
<hr>
- **selector** (<a href="">LabelSelector</a>), required
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
- **template** (<a href="">PodTemplateSpec</a>), required
Template describes the pods that will be created. The only allowed template.spec.restartPolicy value is "Always".
- **replicas** (int32)
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
- **minReadySeconds** (int32)
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
- **strategy** (DeploymentStrategy)
*Patch strategy: retainKeys*
The deployment strategy to use to replace existing pods with new ones.
<a name="DeploymentStrategy"></a>
*DeploymentStrategy describes how to replace existing pods with new ones.*
- **strategy.type** (string)
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
- **strategy.rollingUpdate** (RollingUpdateDeployment)
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
<a name="RollingUpdateDeployment"></a>
*Spec to control the desired behavior of rolling update.*
- **strategy.rollingUpdate.maxSurge** (IntOrString)
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **strategy.rollingUpdate.maxUnavailable** (IntOrString)
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **revisionHistoryLimit** (int32)
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
- **progressDeadlineSeconds** (int32)
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
- **paused** (boolean)
Indicates that the deployment is paused.
## DeploymentStatus {#DeploymentStatus}
DeploymentStatus is the most recently observed status of the Deployment.
<hr>
- **replicas** (int32)
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
- **availableReplicas** (int32)
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
- **readyReplicas** (int32)
readyReplicas is the number of pods targeted by this Deployment with a Ready Condition.
- **unavailableReplicas** (int32)
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
- **updatedReplicas** (int32)
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
- **collisionCount** (int32)
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
- **conditions** ([]DeploymentCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Represents the latest available observations of a deployment's current state.
<a name="DeploymentCondition"></a>
*DeploymentCondition describes the state of a deployment at a certain point.*
- **conditions.status** (string), required
Status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
Type of deployment condition.
- **conditions.lastTransitionTime** (Time)
Last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.lastUpdateTime** (Time)
The last time this condition was updated.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
A human readable message indicating details about the transition.
- **conditions.reason** (string)
The reason for the condition's last transition.
- **observedGeneration** (int64)
The generation observed by the deployment controller.
## DeploymentList {#DeploymentList}
DeploymentList is a list of Deployments.
<hr>
- **apiVersion**: apps/v1
- **kind**: DeploymentList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata.
- **items** ([]<a href="">Deployment</a>), required
Items is the list of Deployments.
## Operations {#Operations}
<hr>
### `get` read the specified Deployment
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Deployment
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Deployment</a>): OK
401: Unauthorized
### `get` read status of the specified Deployment
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Deployment
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Deployment</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Deployment
#### HTTP Request
GET /apis/apps/v1/namespaces/{namespace}/deployments
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">DeploymentList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Deployment
#### HTTP Request
GET /apis/apps/v1/deployments
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">DeploymentList</a>): OK
401: Unauthorized
### `create` create a Deployment
#### HTTP Request
POST /apis/apps/v1/namespaces/{namespace}/deployments
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Deployment</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Deployment</a>): OK
201 (<a href="">Deployment</a>): Created
202 (<a href="">Deployment</a>): Accepted
401: Unauthorized
### `update` replace the specified Deployment
#### HTTP Request
PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Deployment
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Deployment</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Deployment</a>): OK
201 (<a href="">Deployment</a>): Created
401: Unauthorized
### `update` replace status of the specified Deployment
#### HTTP Request
PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Deployment
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Deployment</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Deployment</a>): OK
201 (<a href="">Deployment</a>): Created
401: Unauthorized
### `patch` partially update the specified Deployment
#### HTTP Request
PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Deployment
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Deployment</a>): OK
201 (<a href="">Deployment</a>): Created
401: Unauthorized
### `patch` partially update status of the specified Deployment
#### HTTP Request
PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Deployment
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Deployment</a>): OK
201 (<a href="">Deployment</a>): Created
401: Unauthorized
### `delete` delete a Deployment
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/deployments/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Deployment
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Deployment
#### HTTP Request
DELETE /apis/apps/v1/namespaces/{namespace}/deployments
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion apps v1 import k8s io api apps v1 kind Deployment content type api reference description Deployment enables declarative updates for Pods and ReplicaSets title Deployment weight 6 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 apiVersion apps v1 import k8s io api apps v1 Deployment Deployment Deployment enables declarative updates for Pods and ReplicaSets hr apiVersion apps v1 kind Deployment metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href DeploymentSpec a Specification of the desired behavior of the Deployment status a href DeploymentStatus a Most recently observed status of the Deployment DeploymentSpec DeploymentSpec DeploymentSpec is the specification of the desired behavior of the Deployment hr selector a href LabelSelector a required Label selector for pods Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment It must match the pod template s labels template a href PodTemplateSpec a required Template describes the pods that will be created The only allowed template spec restartPolicy value is Always replicas int32 Number of desired pods This is a pointer to distinguish between explicit zero and not specified Defaults to 1 minReadySeconds int32 Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available Defaults to 0 pod will be considered available as soon as it is ready strategy DeploymentStrategy Patch strategy retainKeys The deployment strategy to use to replace existing pods with new ones a name DeploymentStrategy a DeploymentStrategy describes how to replace existing pods with new ones strategy type string Type of deployment Can be Recreate or RollingUpdate Default is RollingUpdate strategy rollingUpdate RollingUpdateDeployment Rolling update config params Present only if DeploymentStrategyType RollingUpdate a name RollingUpdateDeployment a Spec to control the desired behavior of rolling update strategy rollingUpdate maxSurge IntOrString The maximum number of pods that can be scheduled above the desired number of pods Value can be an absolute number ex 5 or a percentage of desired pods ex 10 This can not be 0 if MaxUnavailable is 0 Absolute number is calculated from percentage by rounding up Defaults to 25 Example when this is set to 30 the new ReplicaSet can be scaled up immediately when the rolling update starts such that the total number of old and new pods do not exceed 130 of desired pods Once old pods have been killed new ReplicaSet can be scaled up further ensuring that total number of pods running at any time during the update is at most 130 of desired pods a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number strategy rollingUpdate maxUnavailable IntOrString The maximum number of pods that can be unavailable during the update Value can be an absolute number ex 5 or a percentage of desired pods ex 10 Absolute number is calculated from percentage by rounding down This can not be 0 if MaxSurge is 0 Defaults to 25 Example when this is set to 30 the old ReplicaSet can be scaled down to 70 of desired pods immediately when the rolling update starts Once new pods are ready old ReplicaSet can be scaled down further followed by scaling up the new ReplicaSet ensuring that the total number of pods available at all times during the update is at least 70 of desired pods a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number revisionHistoryLimit int32 The number of old ReplicaSets to retain to allow rollback This is a pointer to distinguish between explicit zero and not specified Defaults to 10 progressDeadlineSeconds int32 The maximum time in seconds for a deployment to make progress before it is considered to be failed The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status Note that progress will not be estimated during the time a deployment is paused Defaults to 600s paused boolean Indicates that the deployment is paused DeploymentStatus DeploymentStatus DeploymentStatus is the most recently observed status of the Deployment hr replicas int32 Total number of non terminated pods targeted by this deployment their labels match the selector availableReplicas int32 Total number of available pods ready for at least minReadySeconds targeted by this deployment readyReplicas int32 readyReplicas is the number of pods targeted by this Deployment with a Ready Condition unavailableReplicas int32 Total number of unavailable pods targeted by this deployment This is the total number of pods that are still required for the deployment to have 100 available capacity They may either be pods that are running but not yet available or pods that still have not been created updatedReplicas int32 Total number of non terminated pods targeted by this deployment that have the desired template spec collisionCount int32 Count of hash collisions for the Deployment The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet conditions DeploymentCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge Represents the latest available observations of a deployment s current state a name DeploymentCondition a DeploymentCondition describes the state of a deployment at a certain point conditions status string required Status of the condition one of True False Unknown conditions type string required Type of deployment condition conditions lastTransitionTime Time Last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions lastUpdateTime Time The last time this condition was updated a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string A human readable message indicating details about the transition conditions reason string The reason for the condition s last transition observedGeneration int64 The generation observed by the deployment controller DeploymentList DeploymentList DeploymentList is a list of Deployments hr apiVersion apps v1 kind DeploymentList metadata a href ListMeta a Standard list metadata items a href Deployment a required Items is the list of Deployments Operations Operations hr get read the specified Deployment HTTP Request GET apis apps v1 namespaces namespace deployments name Parameters name in path string required name of the Deployment namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Deployment a OK 401 Unauthorized get read status of the specified Deployment HTTP Request GET apis apps v1 namespaces namespace deployments name status Parameters name in path string required name of the Deployment namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Deployment a OK 401 Unauthorized list list or watch objects of kind Deployment HTTP Request GET apis apps v1 namespaces namespace deployments Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href DeploymentList a OK 401 Unauthorized list list or watch objects of kind Deployment HTTP Request GET apis apps v1 deployments Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href DeploymentList a OK 401 Unauthorized create create a Deployment HTTP Request POST apis apps v1 namespaces namespace deployments Parameters namespace in path string required a href namespace a body a href Deployment a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Deployment a OK 201 a href Deployment a Created 202 a href Deployment a Accepted 401 Unauthorized update replace the specified Deployment HTTP Request PUT apis apps v1 namespaces namespace deployments name Parameters name in path string required name of the Deployment namespace in path string required a href namespace a body a href Deployment a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Deployment a OK 201 a href Deployment a Created 401 Unauthorized update replace status of the specified Deployment HTTP Request PUT apis apps v1 namespaces namespace deployments name status Parameters name in path string required name of the Deployment namespace in path string required a href namespace a body a href Deployment a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Deployment a OK 201 a href Deployment a Created 401 Unauthorized patch partially update the specified Deployment HTTP Request PATCH apis apps v1 namespaces namespace deployments name Parameters name in path string required name of the Deployment namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Deployment a OK 201 a href Deployment a Created 401 Unauthorized patch partially update status of the specified Deployment HTTP Request PATCH apis apps v1 namespaces namespace deployments name status Parameters name in path string required name of the Deployment namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Deployment a OK 201 a href Deployment a Created 401 Unauthorized delete delete a Deployment HTTP Request DELETE apis apps v1 namespaces namespace deployments name Parameters name in path string required name of the Deployment namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of Deployment HTTP Request DELETE apis apps v1 namespaces namespace deployments Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference PriorityClass defines mapping from a priority class name to the priority integer value title PriorityClass contenttype apireference import k8s io api scheduling v1 apimetadata kind PriorityClass autogenerated true weight 14 apiVersion scheduling k8s io v1 | ---
api_metadata:
apiVersion: "scheduling.k8s.io/v1"
import: "k8s.io/api/scheduling/v1"
kind: "PriorityClass"
content_type: "api_reference"
description: "PriorityClass defines mapping from a priority class name to the priority integer value."
title: "PriorityClass"
weight: 14
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.
-->
`apiVersion: scheduling.k8s.io/v1`
`import "k8s.io/api/scheduling/v1"`
## PriorityClass {#PriorityClass}
PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.
<hr>
- **apiVersion**: scheduling.k8s.io/v1
- **kind**: PriorityClass
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **value** (int32), required
value represents the integer value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.
- **description** (string)
description is an arbitrary string that usually provides guidelines on when this priority class should be used.
- **globalDefault** (boolean)
globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.
- **preemptionPolicy** (string)
preemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
## PriorityClassList {#PriorityClassList}
PriorityClassList is a collection of priority classes.
<hr>
- **apiVersion**: scheduling.k8s.io/v1
- **kind**: PriorityClassList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">PriorityClass</a>), required
items is the list of PriorityClasses
## Operations {#Operations}
<hr>
### `get` read the specified PriorityClass
#### HTTP Request
GET /apis/scheduling.k8s.io/v1/priorityclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PriorityClass
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityClass</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PriorityClass
#### HTTP Request
GET /apis/scheduling.k8s.io/v1/priorityclasses
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PriorityClassList</a>): OK
401: Unauthorized
### `create` create a PriorityClass
#### HTTP Request
POST /apis/scheduling.k8s.io/v1/priorityclasses
#### Parameters
- **body**: <a href="">PriorityClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityClass</a>): OK
201 (<a href="">PriorityClass</a>): Created
202 (<a href="">PriorityClass</a>): Accepted
401: Unauthorized
### `update` replace the specified PriorityClass
#### HTTP Request
PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PriorityClass
- **body**: <a href="">PriorityClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityClass</a>): OK
201 (<a href="">PriorityClass</a>): Created
401: Unauthorized
### `patch` partially update the specified PriorityClass
#### HTTP Request
PATCH /apis/scheduling.k8s.io/v1/priorityclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PriorityClass
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityClass</a>): OK
201 (<a href="">PriorityClass</a>): Created
401: Unauthorized
### `delete` delete a PriorityClass
#### HTTP Request
DELETE /apis/scheduling.k8s.io/v1/priorityclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PriorityClass
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of PriorityClass
#### HTTP Request
DELETE /apis/scheduling.k8s.io/v1/priorityclasses
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion scheduling k8s io v1 import k8s io api scheduling v1 kind PriorityClass content type api reference description PriorityClass defines mapping from a priority class name to the priority integer value title PriorityClass weight 14 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 apiVersion scheduling k8s io v1 import k8s io api scheduling v1 PriorityClass PriorityClass PriorityClass defines mapping from a priority class name to the priority integer value The value can be any valid integer hr apiVersion scheduling k8s io v1 kind PriorityClass metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata value int32 required value represents the integer value of this priority class This is the actual priority that pods receive when they have the name of this class in their pod spec description string description is an arbitrary string that usually provides guidelines on when this priority class should be used globalDefault boolean globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class Only one PriorityClass can be marked as globalDefault However if more than one PriorityClasses exists with their globalDefault field set to true the smallest value of such global default PriorityClasses will be used as the default priority preemptionPolicy string preemptionPolicy is the Policy for preempting pods with lower priority One of Never PreemptLowerPriority Defaults to PreemptLowerPriority if unset PriorityClassList PriorityClassList PriorityClassList is a collection of priority classes hr apiVersion scheduling k8s io v1 kind PriorityClassList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href PriorityClass a required items is the list of PriorityClasses Operations Operations hr get read the specified PriorityClass HTTP Request GET apis scheduling k8s io v1 priorityclasses name Parameters name in path string required name of the PriorityClass pretty in query string a href pretty a Response 200 a href PriorityClass a OK 401 Unauthorized list list or watch objects of kind PriorityClass HTTP Request GET apis scheduling k8s io v1 priorityclasses Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PriorityClassList a OK 401 Unauthorized create create a PriorityClass HTTP Request POST apis scheduling k8s io v1 priorityclasses Parameters body a href PriorityClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PriorityClass a OK 201 a href PriorityClass a Created 202 a href PriorityClass a Accepted 401 Unauthorized update replace the specified PriorityClass HTTP Request PUT apis scheduling k8s io v1 priorityclasses name Parameters name in path string required name of the PriorityClass body a href PriorityClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PriorityClass a OK 201 a href PriorityClass a Created 401 Unauthorized patch partially update the specified PriorityClass HTTP Request PATCH apis scheduling k8s io v1 priorityclasses name Parameters name in path string required name of the PriorityClass body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PriorityClass a OK 201 a href PriorityClass a Created 401 Unauthorized delete delete a PriorityClass HTTP Request DELETE apis scheduling k8s io v1 priorityclasses name Parameters name in path string required name of the PriorityClass body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of PriorityClass HTTP Request DELETE apis scheduling k8s io v1 priorityclasses Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title DeviceClass v1alpha3 kind DeviceClass weight 2 DeviceClass is a vendor or admin provided resource that contains device configuration and selectors contenttype apireference apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 apimetadata autogenerated true | ---
api_metadata:
apiVersion: "resource.k8s.io/v1alpha3"
import: "k8s.io/api/resource/v1alpha3"
kind: "DeviceClass"
content_type: "api_reference"
description: "DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors."
title: "DeviceClass v1alpha3"
weight: 2
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.
-->
`apiVersion: resource.k8s.io/v1alpha3`
`import "k8s.io/api/resource/v1alpha3"`
## DeviceClass {#DeviceClass}
DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors. It can be referenced in the device requests of a claim to apply these presets. Cluster scoped.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: DeviceClass
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata
- **spec** (<a href="">DeviceClassSpec</a>), required
Spec defines what can be allocated and how to configure it.
This is mutable. Consumers have to be prepared for classes changing at any time, either because they get updated or replaced. Claim allocations are done once based on whatever was set in classes at the time of allocation.
Changing the spec automatically increments the metadata.generation number.
## DeviceClassSpec {#DeviceClassSpec}
DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it.
<hr>
- **config** ([]DeviceClassConfiguration)
*Atomic: will be replaced during a merge*
Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver.
They are passed to the driver, but are not considered while allocating the claim.
<a name="DeviceClassConfiguration"></a>
*DeviceClassConfiguration is used in DeviceClass.*
- **config.opaque** (OpaqueDeviceConfiguration)
Opaque provides driver-specific configuration parameters.
<a name="OpaqueDeviceConfiguration"></a>
*OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.*
- **config.opaque.driver** (string), required
Driver is used to determine which kubelet plugin needs to be passed these configuration parameters.
An admission policy provided by the driver developer could use this to decide whether it needs to validate them.
Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.
- **config.opaque.parameters** (RawExtension), required
Parameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" + "apiVersion" for Kubernetes types), with conversion between different versions.
<a name="RawExtension"></a>
*RawExtension is used to hold extensions in external versions.
To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.
// Internal package:
type MyAPIObject struct {
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.Object `json:"myPlugin"`
}
type PluginA struct {
AOption string `json:"aOption"`
}
// External package:
type MyAPIObject struct {
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.RawExtension `json:"myPlugin"`
}
type PluginA struct {
AOption string `json:"aOption"`
}
// On the wire, the JSON will look something like this:
{
"kind":"MyAPIObject",
"apiVersion":"v1",
"myPlugin": {
"kind":"PluginA",
"aOption":"foo",
},
}
So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)*
- **selectors** ([]DeviceSelector)
*Atomic: will be replaced during a merge*
Each selector must be satisfied by a device which is claimed via this class.
<a name="DeviceSelector"></a>
*DeviceSelector must have exactly one field set.*
- **selectors.cel** (CELDeviceSelector)
CEL contains a CEL expression for selecting a device.
<a name="CELDeviceSelector"></a>
*CELDeviceSelector contains a CEL expression for selecting a device.*
- **selectors.cel.expression** (string), required
Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other result is an error and causes allocation of devices to abort.
The expression's input is an object named "device", which carries the following properties:
- driver (string): the name of the driver which defines this device.
- attributes (map[string]object): the device's attributes, grouped by prefix
(e.g. device.attributes["dra.example.com"] evaluates to an object with all
of the attributes which were prefixed by "dra.example.com".
- capacity (map[string]object): the device's capacities, grouped by prefix.
Example: Consider a device with driver="dra.example.com", which exposes two attributes named "model" and "ext.example.com/family" and which exposes one capacity named "modules". This input to this expression would have the following fields:
device.driver
device.attributes["dra.example.com"].model
device.attributes["ext.example.com"].family
device.capacity["dra.example.com"].modules
The device.driver field can be used to check for a specific driver, either as a high-level precondition (i.e. you only want to consider devices from this driver) or as part of a multi-clause expression that is meant to consider devices from different drivers.
The value type of each attribute is defined by the device definition, and users who write these expressions must consult the documentation for their specific drivers. The value type of each capacity is Quantity.
If an unknown prefix is used as a lookup in either device.attributes or device.capacity, an empty map will be returned. Any reference to an unknown field will cause an evaluation error and allocation to abort.
A robust expression should check for the existence of attributes before referencing them.
For ease of use, the cel.bind() function is enabled, and can be used to simplify expressions that access multiple attributes with the same domain. For example:
cel.bind(dra, device.attributes["dra.example.com"], dra.someBool && dra.anotherBool)
- **suitableNodes** (NodeSelector)
Only nodes matching the selector will be considered by the scheduler when trying to find a Node that fits a Pod when that Pod uses a claim that has not been allocated yet *and* that claim gets allocated through a control plane controller. It is ignored when the claim does not use a control plane controller for allocation.
Setting this field is optional. If unset, all Nodes are candidates.
This is an alpha field and requires enabling the DRAControlPlaneController feature gate.
<a name="NodeSelector"></a>
*A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.*
- **suitableNodes.nodeSelectorTerms** ([]NodeSelectorTerm), required
*Atomic: will be replaced during a merge*
Required. A list of node selector terms. The terms are ORed.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **suitableNodes.nodeSelectorTerms.matchExpressions** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's labels.
- **suitableNodes.nodeSelectorTerms.matchFields** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's fields.
## DeviceClassList {#DeviceClassList}
DeviceClassList is a collection of classes.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha3
- **kind**: DeviceClassList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata
- **items** ([]<a href="">DeviceClass</a>), required
Items is the list of resource classes.
## Operations {#Operations}
<hr>
### `get` read the specified DeviceClass
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/deviceclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the DeviceClass
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DeviceClass</a>): OK
401: Unauthorized
### `list` list or watch objects of kind DeviceClass
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha3/deviceclasses
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">DeviceClassList</a>): OK
401: Unauthorized
### `create` create a DeviceClass
#### HTTP Request
POST /apis/resource.k8s.io/v1alpha3/deviceclasses
#### Parameters
- **body**: <a href="">DeviceClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DeviceClass</a>): OK
201 (<a href="">DeviceClass</a>): Created
202 (<a href="">DeviceClass</a>): Accepted
401: Unauthorized
### `update` replace the specified DeviceClass
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha3/deviceclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the DeviceClass
- **body**: <a href="">DeviceClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DeviceClass</a>): OK
201 (<a href="">DeviceClass</a>): Created
401: Unauthorized
### `patch` partially update the specified DeviceClass
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha3/deviceclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the DeviceClass
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">DeviceClass</a>): OK
201 (<a href="">DeviceClass</a>): Created
401: Unauthorized
### `delete` delete a DeviceClass
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/deviceclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the DeviceClass
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">DeviceClass</a>): OK
202 (<a href="">DeviceClass</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of DeviceClass
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha3/deviceclasses
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 kind DeviceClass content type api reference description DeviceClass is a vendor or admin provided resource that contains device configuration and selectors title DeviceClass v1alpha3 weight 2 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 apiVersion resource k8s io v1alpha3 import k8s io api resource v1alpha3 DeviceClass DeviceClass DeviceClass is a vendor or admin provided resource that contains device configuration and selectors It can be referenced in the device requests of a claim to apply these presets Cluster scoped This is an alpha type and requires enabling the DynamicResourceAllocation feature gate hr apiVersion resource k8s io v1alpha3 kind DeviceClass metadata a href ObjectMeta a Standard object metadata spec a href DeviceClassSpec a required Spec defines what can be allocated and how to configure it This is mutable Consumers have to be prepared for classes changing at any time either because they get updated or replaced Claim allocations are done once based on whatever was set in classes at the time of allocation Changing the spec automatically increments the metadata generation number DeviceClassSpec DeviceClassSpec DeviceClassSpec is used in a DeviceClass to define what can be allocated and how to configure it hr config DeviceClassConfiguration Atomic will be replaced during a merge Config defines configuration parameters that apply to each device that is claimed via this class Some classses may potentially be satisfied by multiple drivers so each instance of a vendor configuration applies to exactly one driver They are passed to the driver but are not considered while allocating the claim a name DeviceClassConfiguration a DeviceClassConfiguration is used in DeviceClass config opaque OpaqueDeviceConfiguration Opaque provides driver specific configuration parameters a name OpaqueDeviceConfiguration a OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor config opaque driver string required Driver is used to determine which kubelet plugin needs to be passed these configuration parameters An admission policy provided by the driver developer could use this to decide whether it needs to validate them Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver config opaque parameters RawExtension required Parameters can contain arbitrary data It is the responsibility of the driver developer to handle validation and versioning Typically this includes self identification and a version kind apiVersion for Kubernetes types with conversion between different versions a name RawExtension a RawExtension is used to hold extensions in external versions To use this make a field which has RawExtension as its type in your external versioned struct and Object in your internal struct You also need to register your various plugin types Internal package type MyAPIObject struct runtime TypeMeta json inline MyPlugin runtime Object json myPlugin type PluginA struct AOption string json aOption External package type MyAPIObject struct runtime TypeMeta json inline MyPlugin runtime RawExtension json myPlugin type PluginA struct AOption string json aOption On the wire the JSON will look something like this kind MyAPIObject apiVersion v1 myPlugin kind PluginA aOption foo So what happens Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject That causes the raw JSON to be stored but not unpacked The next step is to copy using pkg conversion into the internal struct The runtime package s DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension turning it into the correct object type and storing it in the Object TODO In the case where the object is of an unknown type a runtime Unknown object will be created and stored selectors DeviceSelector Atomic will be replaced during a merge Each selector must be satisfied by a device which is claimed via this class a name DeviceSelector a DeviceSelector must have exactly one field set selectors cel CELDeviceSelector CEL contains a CEL expression for selecting a device a name CELDeviceSelector a CELDeviceSelector contains a CEL expression for selecting a device selectors cel expression string required Expression is a CEL expression which evaluates a single device It must evaluate to true when the device under consideration satisfies the desired criteria and false when it does not Any other result is an error and causes allocation of devices to abort The expression s input is an object named device which carries the following properties driver string the name of the driver which defines this device attributes map string object the device s attributes grouped by prefix e g device attributes dra example com evaluates to an object with all of the attributes which were prefixed by dra example com capacity map string object the device s capacities grouped by prefix Example Consider a device with driver dra example com which exposes two attributes named model and ext example com family and which exposes one capacity named modules This input to this expression would have the following fields device driver device attributes dra example com model device attributes ext example com family device capacity dra example com modules The device driver field can be used to check for a specific driver either as a high level precondition i e you only want to consider devices from this driver or as part of a multi clause expression that is meant to consider devices from different drivers The value type of each attribute is defined by the device definition and users who write these expressions must consult the documentation for their specific drivers The value type of each capacity is Quantity If an unknown prefix is used as a lookup in either device attributes or device capacity an empty map will be returned Any reference to an unknown field will cause an evaluation error and allocation to abort A robust expression should check for the existence of attributes before referencing them For ease of use the cel bind function is enabled and can be used to simplify expressions that access multiple attributes with the same domain For example cel bind dra device attributes dra example com dra someBool dra anotherBool suitableNodes NodeSelector Only nodes matching the selector will be considered by the scheduler when trying to find a Node that fits a Pod when that Pod uses a claim that has not been allocated yet and that claim gets allocated through a control plane controller It is ignored when the claim does not use a control plane controller for allocation Setting this field is optional If unset all Nodes are candidates This is an alpha field and requires enabling the DRAControlPlaneController feature gate a name NodeSelector a A node selector represents the union of the results of one or more label queries over a set of nodes that is it represents the OR of the selectors represented by the node selector terms suitableNodes nodeSelectorTerms NodeSelectorTerm required Atomic will be replaced during a merge Required A list of node selector terms The terms are ORed a name NodeSelectorTerm a A null or empty node selector term matches no objects The requirements of them are ANDed The TopologySelectorTerm type implements a subset of the NodeSelectorTerm suitableNodes nodeSelectorTerms matchExpressions a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s labels suitableNodes nodeSelectorTerms matchFields a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s fields DeviceClassList DeviceClassList DeviceClassList is a collection of classes hr apiVersion resource k8s io v1alpha3 kind DeviceClassList metadata a href ListMeta a Standard list metadata items a href DeviceClass a required Items is the list of resource classes Operations Operations hr get read the specified DeviceClass HTTP Request GET apis resource k8s io v1alpha3 deviceclasses name Parameters name in path string required name of the DeviceClass pretty in query string a href pretty a Response 200 a href DeviceClass a OK 401 Unauthorized list list or watch objects of kind DeviceClass HTTP Request GET apis resource k8s io v1alpha3 deviceclasses Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href DeviceClassList a OK 401 Unauthorized create create a DeviceClass HTTP Request POST apis resource k8s io v1alpha3 deviceclasses Parameters body a href DeviceClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href DeviceClass a OK 201 a href DeviceClass a Created 202 a href DeviceClass a Accepted 401 Unauthorized update replace the specified DeviceClass HTTP Request PUT apis resource k8s io v1alpha3 deviceclasses name Parameters name in path string required name of the DeviceClass body a href DeviceClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href DeviceClass a OK 201 a href DeviceClass a Created 401 Unauthorized patch partially update the specified DeviceClass HTTP Request PATCH apis resource k8s io v1alpha3 deviceclasses name Parameters name in path string required name of the DeviceClass body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href DeviceClass a OK 201 a href DeviceClass a Created 401 Unauthorized delete delete a DeviceClass HTTP Request DELETE apis resource k8s io v1alpha3 deviceclasses name Parameters name in path string required name of the DeviceClass body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href DeviceClass a OK 202 a href DeviceClass a Accepted 401 Unauthorized deletecollection delete collection of DeviceClass HTTP Request DELETE apis resource k8s io v1alpha3 deviceclasses Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind CustomResourceDefinition apiVersion apiextensions k8s io v1 import k8s io apiextensions apiserver pkg apis apiextensions v1 title CustomResourceDefinition contenttype apireference CustomResourceDefinition represents a resource that should be exposed on the API server apimetadata autogenerated true weight 1 | ---
api_metadata:
apiVersion: "apiextensions.k8s.io/v1"
import: "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
kind: "CustomResourceDefinition"
content_type: "api_reference"
description: "CustomResourceDefinition represents a resource that should be exposed on the API server."
title: "CustomResourceDefinition"
weight: 1
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.
-->
`apiVersion: apiextensions.k8s.io/v1`
`import "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"`
## CustomResourceDefinition {#CustomResourceDefinition}
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format \<.spec.name>.\<.spec.group>.
<hr>
- **apiVersion**: apiextensions.k8s.io/v1
- **kind**: CustomResourceDefinition
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">CustomResourceDefinitionSpec</a>), required
spec describes how the user wants the resources to appear
- **status** (<a href="">CustomResourceDefinitionStatus</a>)
status indicates the actual state of the CustomResourceDefinition
## CustomResourceDefinitionSpec {#CustomResourceDefinitionSpec}
CustomResourceDefinitionSpec describes how a user wants their resource to appear
<hr>
- **group** (string), required
group is the API group of the defined custom resource. The custom resources are served under `/apis/\<group>/...`. Must match the name of the CustomResourceDefinition (in the form `\<names.plural>.\<group>`).
- **names** (CustomResourceDefinitionNames), required
names specify the resource and kind names for the custom resource.
<a name="CustomResourceDefinitionNames"></a>
*CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition*
- **names.kind** (string), required
kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.
- **names.plural** (string), required
plural is the plural name of the resource to serve. The custom resources are served under `/apis/\<group>/\<version>/.../\<plural>`. Must match the name of the CustomResourceDefinition (in the form `\<names.plural>.\<group>`). Must be all lowercase.
- **names.categories** ([]string)
*Atomic: will be replaced during a merge*
categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
- **names.listKind** (string)
listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".
- **names.shortNames** ([]string)
*Atomic: will be replaced during a merge*
shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get \<shortname>`. It must be all lowercase.
- **names.singular** (string)
singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.
- **scope** (string), required
scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`.
- **versions** ([]CustomResourceDefinitionVersion), required
*Atomic: will be replaced during a merge*
versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
<a name="CustomResourceDefinitionVersion"></a>
*CustomResourceDefinitionVersion describes a version for CRD.*
- **versions.name** (string), required
name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis/\<group>/\<version>/...` if `served` is true.
- **versions.served** (boolean), required
served is a flag enabling/disabling this version from being served via REST APIs
- **versions.storage** (boolean), required
storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
- **versions.additionalPrinterColumns** ([]CustomResourceColumnDefinition)
*Atomic: will be replaced during a merge*
additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used.
<a name="CustomResourceColumnDefinition"></a>
*CustomResourceColumnDefinition specifies a column for server side printing.*
- **versions.additionalPrinterColumns.jsonPath** (string), required
jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.
- **versions.additionalPrinterColumns.name** (string), required
name is a human readable name for the column.
- **versions.additionalPrinterColumns.type** (string), required
type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
- **versions.additionalPrinterColumns.description** (string)
description is a human readable description of this column.
- **versions.additionalPrinterColumns.format** (string)
format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
- **versions.additionalPrinterColumns.priority** (int32)
priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.
- **versions.deprecated** (boolean)
deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
- **versions.deprecationWarning** (string)
deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists.
- **versions.schema** (CustomResourceValidation)
schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
<a name="CustomResourceValidation"></a>
*CustomResourceValidation is a list of validation methods for CustomResources.*
- **versions.schema.openAPIV3Schema** (<a href="">JSONSchemaProps</a>)
openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
- **versions.selectableFields** ([]SelectableField)
*Atomic: will be replaced during a merge*
selectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors
<a name="SelectableField"></a>
*SelectableField specifies the JSON path of a field that may be used with field selectors.*
- **versions.selectableFields.jsonPath** (string), required
jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.
- **versions.subresources** (CustomResourceSubresources)
subresources specify what subresources this version of the defined custom resource have.
<a name="CustomResourceSubresources"></a>
*CustomResourceSubresources defines the status and scale subresources for CustomResources.*
- **versions.subresources.scale** (CustomResourceSubresourceScale)
scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.
<a name="CustomResourceSubresourceScale"></a>
*CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.*
- **versions.subresources.scale.specReplicasPath** (string), required
specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET.
- **versions.subresources.scale.statusReplicasPath** (string), required
statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0.
- **versions.subresources.scale.labelSelectorPath** (string)
labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string.
- **versions.subresources.status** (CustomResourceSubresourceStatus)
status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.
<a name="CustomResourceSubresourceStatus"></a>
*CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza*
- **conversion** (CustomResourceConversion)
conversion defines conversion settings for the CRD.
<a name="CustomResourceConversion"></a>
*CustomResourceConversion describes how to convert different versions of a CR.*
- **conversion.strategy** (string), required
strategy specifies how custom resources are converted between versions. Allowed values are: - `"None"`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `"Webhook"`: API Server will call to an external webhook to do the conversion. Additional information
is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set.
- **conversion.webhook** (WebhookConversion)
webhook describes how to call the conversion webhook. Required when `strategy` is set to `"Webhook"`.
<a name="WebhookConversion"></a>
*WebhookConversion describes how to call a conversion webhook*
- **conversion.webhook.conversionReviewVersions** ([]string), required
*Atomic: will be replaced during a merge*
conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail.
- **conversion.webhook.clientConfig** (WebhookClientConfig)
clientConfig is the instructions for how to call the webhook if strategy is `Webhook`.
<a name="WebhookClientConfig"></a>
*WebhookClientConfig contains the information to make a TLS connection with the webhook.*
- **conversion.webhook.clientConfig.caBundle** ([]byte)
caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
- **conversion.webhook.clientConfig.service** (ServiceReference)
service is a reference to the service for this webhook. Either service or url must be specified.
If the webhook is running within the cluster, then you should use `service`.
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
- **conversion.webhook.clientConfig.service.name** (string), required
name is the name of the service. Required
- **conversion.webhook.clientConfig.service.namespace** (string), required
namespace is the namespace of the service. Required
- **conversion.webhook.clientConfig.service.path** (string)
path is an optional URL path at which the webhook will be contacted.
- **conversion.webhook.clientConfig.service.port** (int32)
port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
- **conversion.webhook.clientConfig.url** (string)
url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.
The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- **preserveUnknownFields** (boolean)
preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning for details.
## JSONSchemaProps {#JSONSchemaProps}
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
<hr>
- **$ref** (string)
- **$schema** (string)
- **additionalItems** (JSONSchemaPropsOrBool)
<a name="JSONSchemaPropsOrBool"></a>
*JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.*
- **additionalProperties** (JSONSchemaPropsOrBool)
<a name="JSONSchemaPropsOrBool"></a>
*JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.*
- **allOf** ([]<a href="">JSONSchemaProps</a>)
*Atomic: will be replaced during a merge*
- **anyOf** ([]<a href="">JSONSchemaProps</a>)
*Atomic: will be replaced during a merge*
- **default** (JSON)
default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
<a name="JSON"></a>
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
- **definitions** (map[string]<a href="">JSONSchemaProps</a>)
- **dependencies** (map[string]JSONSchemaPropsOrStringArray)
<a name="JSONSchemaPropsOrStringArray"></a>
*JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.*
- **description** (string)
- **enum** ([]JSON)
*Atomic: will be replaced during a merge*
<a name="JSON"></a>
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
- **example** (JSON)
<a name="JSON"></a>
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
- **exclusiveMaximum** (boolean)
- **exclusiveMinimum** (boolean)
- **externalDocs** (ExternalDocumentation)
<a name="ExternalDocumentation"></a>
*ExternalDocumentation allows referencing an external resource for extended documentation.*
- **externalDocs.description** (string)
- **externalDocs.url** (string)
- **format** (string)
format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
- **id** (string)
- **items** (JSONSchemaPropsOrArray)
<a name="JSONSchemaPropsOrArray"></a>
*JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.*
- **maxItems** (int64)
- **maxLength** (int64)
- **maxProperties** (int64)
- **maximum** (double)
- **minItems** (int64)
- **minLength** (int64)
- **minProperties** (int64)
- **minimum** (double)
- **multipleOf** (double)
- **not** (<a href="">JSONSchemaProps</a>)
- **nullable** (boolean)
- **oneOf** ([]<a href="">JSONSchemaProps</a>)
*Atomic: will be replaced during a merge*
- **pattern** (string)
- **patternProperties** (map[string]<a href="">JSONSchemaProps</a>)
- **properties** (map[string]<a href="">JSONSchemaProps</a>)
- **required** ([]string)
*Atomic: will be replaced during a merge*
- **title** (string)
- **type** (string)
- **uniqueItems** (boolean)
- **x-kubernetes-embedded-resource** (boolean)
x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
- **x-kubernetes-int-or-string** (boolean)
x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:
1) anyOf:
- type: integer
- type: string
2) allOf:
- anyOf:
- type: integer
- type: string
- ... zero or more
- **x-kubernetes-list-map-keys** ([]string)
*Atomic: will be replaced during a merge*
x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map.
This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).
The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
- **x-kubernetes-list-type** (string)
x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:
1) `atomic`: the list is treated as a single entity, like a scalar.
Atomic lists will be entirely replaced when updated. This extension
may be used on any type of list (struct, scalar, ...).
2) `set`:
Sets are lists that must not have multiple items with the same value. Each
value must be a scalar, an object with x-kubernetes-map-type `atomic` or an
array with x-kubernetes-list-type `atomic`.
3) `map`:
These lists are like maps in that their elements have a non-index key
used to identify them. Order is preserved upon merge. The map tag
must only be used on a list with elements of type object.
Defaults to atomic for arrays.
- **x-kubernetes-map-type** (string)
x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:
1) `granular`:
These maps are actual maps (key-value pairs) and each fields are independent
from each other (they can each be manipulated by separate actors). This is
the default behaviour for all maps.
2) `atomic`: the list is treated as a single entity, like a scalar.
Atomic maps will be entirely replaced when updated.
- **x-kubernetes-preserve-unknown-fields** (boolean)
x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.
- **x-kubernetes-validations** ([]ValidationRule)
*Patch strategy: merge on key `rule`*
*Map: unique values on key rule will be kept during a merge*
x-kubernetes-validations describes a list of validation rules written in the CEL expression language.
<a name="ValidationRule"></a>
*ValidationRule describes a validation rule written in the CEL expression language.*
- **x-kubernetes-validations.rule** (string), required
Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The `self` variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual \<= self.spec.maxDesired"}
If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via `self.field` and field presence can be checked via `has(self.field)`. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via `self[mapKey]`, map containment can be checked via `mapKey in self` and all entries of the map are accessible via CEL macros and functions such as `self.all(...)`. If the Rule is scoped to an array, the elements of the array are accessible via `self[i]` and also by macros and functions. If the Rule is scoped to a scalar, `self` is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority \< 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value \< 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"}
The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.
Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:
- A schema with no type and x-kubernetes-preserve-unknown-fields set to true
- An array where the items schema is of an "unknown type"
- An object where the additionalProperties schema is of an "unknown type"
Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:
"true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if",
"import", "let", "loop", "package", "namespace", "return".
Examples:
- Rule accessing a property named "namespace": {"rule": "self.__namespace__ > 0"}
- Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"}
- Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"}
Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and
non-intersecting elements in `Y` are appended, retaining their partial order.
- 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values
are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with
non-intersecting keys are appended, retaining their partial order.
If `rule` makes use of the `oldSelf` variable it is implicitly a `transition rule`.
By default, the `oldSelf` variable is the same type as `self`. When `optionalOldSelf` is true, the `oldSelf` variable is a CEL optional
variable whose value() is the same type as `self`.
See the documentation for the `optionalOldSelf` field for details.
Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting `optionalOldSelf` to true.
- **x-kubernetes-validations.fieldPath** (string)
fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to [JSONPath support in Kubernetes](https://kubernetes.io/docs/reference/kubectl/jsonpath/) for more info. Numeric index of array is not supported. For field name which contains special characters, use `['specialName']` to refer the field name. e.g. for attribute `foo.34$` appears in a list `testList`, the fieldPath could be set to `.testList['foo.34$']`
- **x-kubernetes-validations.message** (string)
Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
- **x-kubernetes-validations.messageExpression** (string)
MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"
- **x-kubernetes-validations.optionalOldSelf** (boolean)
optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.
When enabled `oldSelf` will be a CEL optional whose value will be `None` if there is no old value, or when the object is initially created.
You may check for presence of oldSelf using `oldSelf.hasValue()` and unwrap it after checking using `oldSelf.value()`. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypes
May not be set unless `oldSelf` is used in `rule`.
- **x-kubernetes-validations.reason** (string)
reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
## CustomResourceDefinitionStatus {#CustomResourceDefinitionStatus}
CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition
<hr>
- **acceptedNames** (CustomResourceDefinitionNames)
acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.
<a name="CustomResourceDefinitionNames"></a>
*CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition*
- **acceptedNames.kind** (string), required
kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.
- **acceptedNames.plural** (string), required
plural is the plural name of the resource to serve. The custom resources are served under `/apis/\<group>/\<version>/.../\<plural>`. Must match the name of the CustomResourceDefinition (in the form `\<names.plural>.\<group>`). Must be all lowercase.
- **acceptedNames.categories** ([]string)
*Atomic: will be replaced during a merge*
categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
- **acceptedNames.listKind** (string)
listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".
- **acceptedNames.shortNames** ([]string)
*Atomic: will be replaced during a merge*
shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get \<shortname>`. It must be all lowercase.
- **acceptedNames.singular** (string)
singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.
- **conditions** ([]CustomResourceDefinitionCondition)
*Map: unique values on key type will be kept during a merge*
conditions indicate state for particular aspects of a CustomResourceDefinition
<a name="CustomResourceDefinitionCondition"></a>
*CustomResourceDefinitionCondition contains details for the current condition of this pod.*
- **conditions.status** (string), required
status is the status of the condition. Can be True, False, Unknown.
- **conditions.type** (string), required
type is the type of the condition. Types include Established, NamesAccepted and Terminating.
- **conditions.lastTransitionTime** (Time)
lastTransitionTime last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
message is a human-readable message indicating details about last transition.
- **conditions.reason** (string)
reason is a unique, one-word, CamelCase reason for the condition's last transition.
- **storedVersions** ([]string)
*Atomic: will be replaced during a merge*
storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from `spec.versions` while they exist in this list.
## CustomResourceDefinitionList {#CustomResourceDefinitionList}
CustomResourceDefinitionList is a list of CustomResourceDefinition objects.
<hr>
- **items** ([]<a href="">CustomResourceDefinition</a>), required
items list individual CustomResourceDefinition objects
- **apiVersion** (string)
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (<a href="">ListMeta</a>)
Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
## Operations {#Operations}
<hr>
### `get` read the specified CustomResourceDefinition
#### HTTP Request
GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CustomResourceDefinition
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CustomResourceDefinition</a>): OK
401: Unauthorized
### `get` read status of the specified CustomResourceDefinition
#### HTTP Request
GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CustomResourceDefinition
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CustomResourceDefinition</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CustomResourceDefinition
#### HTTP Request
GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">CustomResourceDefinitionList</a>): OK
401: Unauthorized
### `create` create a CustomResourceDefinition
#### HTTP Request
POST /apis/apiextensions.k8s.io/v1/customresourcedefinitions
#### Parameters
- **body**: <a href="">CustomResourceDefinition</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CustomResourceDefinition</a>): OK
201 (<a href="">CustomResourceDefinition</a>): Created
202 (<a href="">CustomResourceDefinition</a>): Accepted
401: Unauthorized
### `update` replace the specified CustomResourceDefinition
#### HTTP Request
PUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CustomResourceDefinition
- **body**: <a href="">CustomResourceDefinition</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CustomResourceDefinition</a>): OK
201 (<a href="">CustomResourceDefinition</a>): Created
401: Unauthorized
### `update` replace status of the specified CustomResourceDefinition
#### HTTP Request
PUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CustomResourceDefinition
- **body**: <a href="">CustomResourceDefinition</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CustomResourceDefinition</a>): OK
201 (<a href="">CustomResourceDefinition</a>): Created
401: Unauthorized
### `patch` partially update the specified CustomResourceDefinition
#### HTTP Request
PATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CustomResourceDefinition
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CustomResourceDefinition</a>): OK
201 (<a href="">CustomResourceDefinition</a>): Created
401: Unauthorized
### `patch` partially update status of the specified CustomResourceDefinition
#### HTTP Request
PATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CustomResourceDefinition
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CustomResourceDefinition</a>): OK
201 (<a href="">CustomResourceDefinition</a>): Created
401: Unauthorized
### `delete` delete a CustomResourceDefinition
#### HTTP Request
DELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CustomResourceDefinition
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of CustomResourceDefinition
#### HTTP Request
DELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion apiextensions k8s io v1 import k8s io apiextensions apiserver pkg apis apiextensions v1 kind CustomResourceDefinition content type api reference description CustomResourceDefinition represents a resource that should be exposed on the API server title CustomResourceDefinition weight 1 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 apiVersion apiextensions k8s io v1 import k8s io apiextensions apiserver pkg apis apiextensions v1 CustomResourceDefinition CustomResourceDefinition CustomResourceDefinition represents a resource that should be exposed on the API server Its name MUST be in the format spec name spec group hr apiVersion apiextensions k8s io v1 kind CustomResourceDefinition metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href CustomResourceDefinitionSpec a required spec describes how the user wants the resources to appear status a href CustomResourceDefinitionStatus a status indicates the actual state of the CustomResourceDefinition CustomResourceDefinitionSpec CustomResourceDefinitionSpec CustomResourceDefinitionSpec describes how a user wants their resource to appear hr group string required group is the API group of the defined custom resource The custom resources are served under apis group Must match the name of the CustomResourceDefinition in the form names plural group names CustomResourceDefinitionNames required names specify the resource and kind names for the custom resource a name CustomResourceDefinitionNames a CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition names kind string required kind is the serialized kind of the resource It is normally CamelCase and singular Custom resource instances will use this value as the kind attribute in API calls names plural string required plural is the plural name of the resource to serve The custom resources are served under apis group version plural Must match the name of the CustomResourceDefinition in the form names plural group Must be all lowercase names categories string Atomic will be replaced during a merge categories is a list of grouped resources this custom resource belongs to e g all This is published in API discovery documents and used by clients to support invocations like kubectl get all names listKind string listKind is the serialized kind of the list for this resource Defaults to kind List names shortNames string Atomic will be replaced during a merge shortNames are short names for the resource exposed in API discovery documents and used by clients to support invocations like kubectl get shortname It must be all lowercase names singular string singular is the singular name of the resource It must be all lowercase Defaults to lowercased kind scope string required scope indicates whether the defined custom resource is cluster or namespace scoped Allowed values are Cluster and Namespaced versions CustomResourceDefinitionVersion required Atomic will be replaced during a merge versions is the list of all API versions of the defined custom resource Version names are used to compute the order in which served versions are listed in API discovery If the version string is kube like it will sort above non kube like version strings which are ordered lexicographically Kube like versions start with a v then are followed by a number the major version then optionally the string alpha or beta and another number the minor version These are sorted first by GA beta alpha where GA is a version with no suffix such as beta or alpha and then by comparing major version then minor version An example sorted list of versions v10 v2 v1 v11beta2 v10beta3 v3beta1 v12alpha1 v11alpha2 foo1 foo10 a name CustomResourceDefinitionVersion a CustomResourceDefinitionVersion describes a version for CRD versions name string required name is the version name e g v1 v2beta1 etc The custom resources are served under this version at apis group version if served is true versions served boolean required served is a flag enabling disabling this version from being served via REST APIs versions storage boolean required storage indicates this version should be used when persisting custom resources to storage There must be exactly one version with storage true versions additionalPrinterColumns CustomResourceColumnDefinition Atomic will be replaced during a merge additionalPrinterColumns specifies additional columns returned in Table output See https kubernetes io docs reference using api api concepts receiving resources as tables for details If no columns are specified a single column displaying the age of the custom resource is used a name CustomResourceColumnDefinition a CustomResourceColumnDefinition specifies a column for server side printing versions additionalPrinterColumns jsonPath string required jsonPath is a simple JSON path i e with array notation which is evaluated against each custom resource to produce the value for this column versions additionalPrinterColumns name string required name is a human readable name for the column versions additionalPrinterColumns type string required type is an OpenAPI type definition for this column See https github com OAI OpenAPI Specification blob master versions 2 0 md data types for details versions additionalPrinterColumns description string description is a human readable description of this column versions additionalPrinterColumns format string format is an optional OpenAPI type definition for this column The name format is applied to the primary identifier column to assist in clients identifying column is the resource name See https github com OAI OpenAPI Specification blob master versions 2 0 md data types for details versions additionalPrinterColumns priority int32 priority is an integer defining the relative importance of this column compared to others Lower numbers are considered higher priority Columns that may be omitted in limited space scenarios should be given a priority greater than 0 versions deprecated boolean deprecated indicates this version of the custom resource API is deprecated When set to true API requests to this version receive a warning header in the server response Defaults to false versions deprecationWarning string deprecationWarning overrides the default warning returned to API clients May only be set when deprecated is true The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability if one exists versions schema CustomResourceValidation schema describes the schema used for validation pruning and defaulting of this version of the custom resource a name CustomResourceValidation a CustomResourceValidation is a list of validation methods for CustomResources versions schema openAPIV3Schema a href JSONSchemaProps a openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning versions selectableFields SelectableField Atomic will be replaced during a merge selectableFields specifies paths to fields that may be used as field selectors A maximum of 8 selectable fields are allowed See https kubernetes io docs concepts overview working with objects field selectors a name SelectableField a SelectableField specifies the JSON path of a field that may be used with field selectors versions selectableFields jsonPath string required jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value Only JSON paths without the array notation are allowed Must point to a field of type string boolean or integer Types with enum values and strings with formats are allowed If jsonPath refers to absent field in a resource the jsonPath evaluates to an empty string Must not point to metdata fields Required versions subresources CustomResourceSubresources subresources specify what subresources this version of the defined custom resource have a name CustomResourceSubresources a CustomResourceSubresources defines the status and scale subresources for CustomResources versions subresources scale CustomResourceSubresourceScale scale indicates the custom resource should serve a scale subresource that returns an autoscaling v1 Scale object a name CustomResourceSubresourceScale a CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources versions subresources scale specReplicasPath string required specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale spec replicas Only JSON paths without the array notation are allowed Must be a JSON Path under spec If there is no value under the given path in the custom resource the scale subresource will return an error on GET versions subresources scale statusReplicasPath string required statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale status replicas Only JSON paths without the array notation are allowed Must be a JSON Path under status If there is no value under the given path in the custom resource the status replicas value in the scale subresource will default to 0 versions subresources scale labelSelectorPath string labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale status selector Only JSON paths without the array notation are allowed Must be a JSON Path under status or spec Must be set to work with HorizontalPodAutoscaler The field pointed by this JSON path must be a string field not a complex selector struct which contains a serialized label selector in string form More info https kubernetes io docs tasks access kubernetes api custom resources custom resource definitions scale subresource If there is no value under the given path in the custom resource the status selector value in the scale subresource will default to the empty string versions subresources status CustomResourceSubresourceStatus status indicates the custom resource should serve a status subresource When enabled 1 requests to the custom resource primary endpoint ignore changes to the status stanza of the object 2 requests to the custom resource status subresource ignore changes to anything other than the status stanza of the object a name CustomResourceSubresourceStatus a CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources Status is represented by the status JSON path inside of a CustomResource When set exposes a status subresource for the custom resource PUT requests to the status subresource take a custom resource object and ignore changes to anything except the status stanza PUT POST PATCH requests to the custom resource ignore changes to the status stanza conversion CustomResourceConversion conversion defines conversion settings for the CRD a name CustomResourceConversion a CustomResourceConversion describes how to convert different versions of a CR conversion strategy string required strategy specifies how custom resources are converted between versions Allowed values are None The converter only change the apiVersion and would not touch any other field in the custom resource Webhook API Server will call to an external webhook to do the conversion Additional information is needed for this option This requires spec preserveUnknownFields to be false and spec conversion webhook to be set conversion webhook WebhookConversion webhook describes how to call the conversion webhook Required when strategy is set to Webhook a name WebhookConversion a WebhookConversion describes how to call a conversion webhook conversion webhook conversionReviewVersions string required Atomic will be replaced during a merge conversionReviewVersions is an ordered list of preferred ConversionReview versions the Webhook expects The API server will use the first version in the list which it supports If none of the versions specified in this list are supported by API server conversion will fail for the custom resource If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server calls to the webhook will fail conversion webhook clientConfig WebhookClientConfig clientConfig is the instructions for how to call the webhook if strategy is Webhook a name WebhookClientConfig a WebhookClientConfig contains the information to make a TLS connection with the webhook conversion webhook clientConfig caBundle byte caBundle is a PEM encoded CA bundle which will be used to validate the webhook s server certificate If unspecified system trust roots on the apiserver are used conversion webhook clientConfig service ServiceReference service is a reference to the service for this webhook Either service or url must be specified If the webhook is running within the cluster then you should use service a name ServiceReference a ServiceReference holds a reference to Service legacy k8s io conversion webhook clientConfig service name string required name is the name of the service Required conversion webhook clientConfig service namespace string required namespace is the namespace of the service Required conversion webhook clientConfig service path string path is an optional URL path at which the webhook will be contacted conversion webhook clientConfig service port int32 port is an optional service port at which the webhook will be contacted port should be a valid port number 1 65535 inclusive Defaults to 443 for backward compatibility conversion webhook clientConfig url string url gives the location of the webhook in standard URL form scheme host port path Exactly one of url or service must be specified The host should not refer to a service running in the cluster use the service field instead The host might be resolved via external DNS in some apiservers e g kube apiserver cannot resolve in cluster DNS as that would be a layering violation host may also be an IP address Please note that using localhost or 127 0 0 1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook Such installs are likely to be non portable i e not easy to turn up in a new cluster The scheme must be https the URL must begin with https A path is optional and if present may be any string permissible in a URL You may use the path to pass an arbitrary string to the webhook for example a cluster identifier Attempting to use a user or basic auth e g user password is not allowed Fragments and query parameters are not allowed either preserveUnknownFields boolean preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage apiVersion kind metadata and known fields inside metadata are always preserved This field is deprecated in favor of setting x preserve unknown fields to true in spec versions schema openAPIV3Schema See https kubernetes io docs tasks extend kubernetes custom resources custom resource definitions field pruning for details JSONSchemaProps JSONSchemaProps JSONSchemaProps is a JSON Schema following Specification Draft 4 http json schema org hr ref string schema string additionalItems JSONSchemaPropsOrBool a name JSONSchemaPropsOrBool a JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value Defaults to true for the boolean property additionalProperties JSONSchemaPropsOrBool a name JSONSchemaPropsOrBool a JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value Defaults to true for the boolean property allOf a href JSONSchemaProps a Atomic will be replaced during a merge anyOf a href JSONSchemaProps a Atomic will be replaced during a merge default JSON default is a default value for undefined object fields Defaulting is a beta feature under the CustomResourceDefaulting feature gate Defaulting requires spec preserveUnknownFields to be false a name JSON a JSON represents any valid JSON value These types are supported bool int64 float64 string interface map string interface and nil definitions map string a href JSONSchemaProps a dependencies map string JSONSchemaPropsOrStringArray a name JSONSchemaPropsOrStringArray a JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array description string enum JSON Atomic will be replaced during a merge a name JSON a JSON represents any valid JSON value These types are supported bool int64 float64 string interface map string interface and nil example JSON a name JSON a JSON represents any valid JSON value These types are supported bool int64 float64 string interface map string interface and nil exclusiveMaximum boolean exclusiveMinimum boolean externalDocs ExternalDocumentation a name ExternalDocumentation a ExternalDocumentation allows referencing an external resource for extended documentation externalDocs description string externalDocs url string format string format is an OpenAPI v3 format string Unknown formats are ignored The following formats are validated bsonobjectid a bson object ID i e a 24 characters hex string uri an URI as parsed by Golang net url ParseRequestURI email an email address as parsed by Golang net mail ParseAddress hostname a valid representation for an Internet host name as defined by RFC 1034 section 3 1 RFC1034 ipv4 an IPv4 IP as parsed by Golang net ParseIP ipv6 an IPv6 IP as parsed by Golang net ParseIP cidr a CIDR as parsed by Golang net ParseCIDR mac a MAC address as parsed by Golang net ParseMAC uuid an UUID that allows uppercase defined by the regex i 0 9a f 8 0 9a f 4 0 9a f 4 0 9a f 4 0 9a f 12 uuid3 an UUID3 that allows uppercase defined by the regex i 0 9a f 8 0 9a f 4 3 0 9a f 3 0 9a f 4 0 9a f 12 uuid4 an UUID4 that allows uppercase defined by the regex i 0 9a f 8 0 9a f 4 4 0 9a f 3 89ab 0 9a f 3 0 9a f 12 uuid5 an UUID5 that allows uppercase defined by the regex i 0 9a f 8 0 9a f 4 5 0 9a f 3 89ab 0 9a f 3 0 9a f 12 isbn an ISBN10 or ISBN13 number string like 0321751043 or 978 0321751041 isbn10 an ISBN10 number string like 0321751043 isbn13 an ISBN13 number string like 978 0321751041 creditcard a credit card number defined by the regex 4 0 9 12 0 9 3 5 1 5 0 9 14 6 011 5 0 9 0 9 0 9 12 3 47 0 9 13 3 0 0 5 68 0 9 0 9 11 2131 1800 35 d 3 d 11 with any non digit characters mixed in ssn a U S social security number following the regex d 3 d 2 d 4 hexcolor an hexadecimal color code like FFFFFF following the regex 0 9a fA F 3 0 9a fA F 6 rgbcolor an RGB color code like rgb like rgb 255 255 2559 byte base64 encoded binary data password any kind of string date a date string like 2006 01 02 as defined by full date in RFC3339 duration a duration string like 22 ns as parsed by Golang time ParseDuration or compatible with Scala duration format datetime a date time string like 2014 12 15T19 30 20 000Z as defined by date time in RFC3339 id string items JSONSchemaPropsOrArray a name JSONSchemaPropsOrArray a JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps Mainly here for serialization purposes maxItems int64 maxLength int64 maxProperties int64 maximum double minItems int64 minLength int64 minProperties int64 minimum double multipleOf double not a href JSONSchemaProps a nullable boolean oneOf a href JSONSchemaProps a Atomic will be replaced during a merge pattern string patternProperties map string a href JSONSchemaProps a properties map string a href JSONSchemaProps a required string Atomic will be replaced during a merge title string type string uniqueItems boolean x kubernetes embedded resource boolean x kubernetes embedded resource defines that the value is an embedded Kubernetes runtime Object with TypeMeta and ObjectMeta The type must be object It is allowed to further restrict the embedded object kind apiVersion and metadata are validated automatically x kubernetes preserve unknown fields is allowed to be true but does not have to be if the object is fully specified up to kind apiVersion metadata x kubernetes int or string boolean x kubernetes int or string specifies that this value is either an integer or a string If this is true an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns 1 anyOf type integer type string 2 allOf anyOf type integer type string zero or more x kubernetes list map keys string Atomic will be replaced during a merge x kubernetes list map keys annotates an array with the x kubernetes list type map by specifying the keys used as the index of the map This tag MUST only be used on lists that have the x kubernetes list type extension set to map Also the values specified for this attribute must be a scalar typed field of the child structure no nesting is supported The properties specified must either be required or have a default value to ensure those properties are present for all list items x kubernetes list type string x kubernetes list type annotates an array to further describe its topology This extension must only be used on lists and may have 3 possible values 1 atomic the list is treated as a single entity like a scalar Atomic lists will be entirely replaced when updated This extension may be used on any type of list struct scalar 2 set Sets are lists that must not have multiple items with the same value Each value must be a scalar an object with x kubernetes map type atomic or an array with x kubernetes list type atomic 3 map These lists are like maps in that their elements have a non index key used to identify them Order is preserved upon merge The map tag must only be used on a list with elements of type object Defaults to atomic for arrays x kubernetes map type string x kubernetes map type annotates an object to further describe its topology This extension must only be used when type is object and may have 2 possible values 1 granular These maps are actual maps key value pairs and each fields are independent from each other they can each be manipulated by separate actors This is the default behaviour for all maps 2 atomic the list is treated as a single entity like a scalar Atomic maps will be entirely replaced when updated x kubernetes preserve unknown fields boolean x kubernetes preserve unknown fields stops the API server decoding step from pruning fields which are not specified in the validation schema This affects fields recursively but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema This can either be true or undefined False is forbidden x kubernetes validations ValidationRule Patch strategy merge on key rule Map unique values on key rule will be kept during a merge x kubernetes validations describes a list of validation rules written in the CEL expression language a name ValidationRule a ValidationRule describes a validation rule written in the CEL expression language x kubernetes validations rule string required Rule represents the expression which will be evaluated by CEL ref https github com google cel spec The Rule is scoped to the location of the x kubernetes validations extension in the schema The self variable in the CEL expression is bound to the scoped value Example Rule scoped to the root of a resource with a status subresource rule self status actual self spec maxDesired If the Rule is scoped to an object with properties the accessible properties of the object are field selectable via self field and field presence can be checked via has self field Null valued fields are treated as absent fields in CEL expressions If the Rule is scoped to an object with additionalProperties i e a map the value of the map are accessible via self mapKey map containment can be checked via mapKey in self and all entries of the map are accessible via CEL macros and functions such as self all If the Rule is scoped to an array the elements of the array are accessible via self i and also by macros and functions If the Rule is scoped to a scalar self is bound to the scalar value Examples Rule scoped to a map of objects rule self components Widget priority 10 Rule scoped to a list of integers rule self values all value value 0 value 100 Rule scoped to a string value rule self startsWith kube The apiVersion kind metadata name and metadata generateName are always accessible from the root of the object and from any x kubernetes embedded resource annotated objects No other metadata properties are accessible Unknown data preserved in custom resources via x kubernetes preserve unknown fields is not accessible in CEL expressions This includes Unknown field values that are preserved by object schemas with x kubernetes preserve unknown fields Object properties where the property schema is of an unknown type An unknown type is recursively defined as A schema with no type and x kubernetes preserve unknown fields set to true An array where the items schema is of an unknown type An object where the additionalProperties schema is of an unknown type Only property names of the form a zA Z a zA Z0 9 are accessible Accessible property names are escaped according to the following rules when accessed in the expression escapes to underscores escapes to dot escapes to dash escapes to slash Property names that exactly match a CEL RESERVED keyword escape to keyword The keywords are true false null in as break const continue else for function if import let loop package namespace return Examples Rule accessing a property named namespace rule self namespace 0 Rule accessing a property named x prop rule self x dash prop 0 Rule accessing a property named redact d rule self redact underscores d 0 Equality on arrays with x kubernetes list type of set or map ignores element order i e 1 2 2 1 Concatenation on arrays with x kubernetes list type use the semantics of the list type set X Y performs a union where the array positions of all elements in X are preserved and non intersecting elements in Y are appended retaining their partial order map X Y performs a merge where the array positions of all keys in X are preserved but the values are overwritten by values in Y when the key sets of X and Y intersect Elements in Y with non intersecting keys are appended retaining their partial order If rule makes use of the oldSelf variable it is implicitly a transition rule By default the oldSelf variable is the same type as self When optionalOldSelf is true the oldSelf variable is a CEL optional variable whose value is the same type as self See the documentation for the optionalOldSelf field for details Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found You can opt a transition rule into unconditional evaluation by setting optionalOldSelf to true x kubernetes validations fieldPath string fieldPath represents the field path returned when the validation fails It must be a relative JSON path i e with array notation scoped to the location of this x kubernetes validations extension in the schema and refer to an existing field e g when validation checks if a specific attribute foo under a map testMap the fieldPath could be set to testMap foo If the validation checks two lists must have unique attributes the fieldPath could be set to either of the list e g testList It does not support list numeric index It supports child operation to refer to an existing field currently Refer to JSONPath support in Kubernetes https kubernetes io docs reference kubectl jsonpath for more info Numeric index of array is not supported For field name which contains special characters use specialName to refer the field name e g for attribute foo 34 appears in a list testList the fieldPath could be set to testList foo 34 x kubernetes validations message string Message represents the message displayed when validation fails The message is required if the Rule contains line breaks The message must not contain line breaks If unset the message is failed rule Rule e g must be a URL with the host matching spec host x kubernetes validations messageExpression string MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails Since messageExpression is used as a failure message it must evaluate to a string If both message and messageExpression are present on a rule then messageExpression will be used if validation fails If messageExpression results in a runtime error the runtime error is logged and the validation failure message is produced as if the messageExpression field were unset If messageExpression evaluates to an empty string a string with only spaces or a string that contains line breaks then the validation failure message will also be produced as if the messageExpression field were unset and the fact that messageExpression produced an empty string string with only spaces string with line breaks will be logged messageExpression has access to all the same variables as the rule the only difference is the return type Example x must be less than max string self max x kubernetes validations optionalOldSelf boolean optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created or if the old object is missing the value When enabled oldSelf will be a CEL optional whose value will be None if there is no old value or when the object is initially created You may check for presence of oldSelf using oldSelf hasValue and unwrap it after checking using oldSelf value Check the CEL documentation for Optional types for more information https pkg go dev github com google cel go cel OptionalTypes May not be set unless oldSelf is used in rule x kubernetes validations reason string reason provides a machine readable validation failure reason that is returned to the caller when a request fails this validation rule The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule The currently supported reasons are FieldValueInvalid FieldValueForbidden FieldValueRequired FieldValueDuplicate If not set default to use FieldValueInvalid All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid CustomResourceDefinitionStatus CustomResourceDefinitionStatus CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition hr acceptedNames CustomResourceDefinitionNames acceptedNames are the names that are actually being used to serve discovery They may be different than the names in spec a name CustomResourceDefinitionNames a CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition acceptedNames kind string required kind is the serialized kind of the resource It is normally CamelCase and singular Custom resource instances will use this value as the kind attribute in API calls acceptedNames plural string required plural is the plural name of the resource to serve The custom resources are served under apis group version plural Must match the name of the CustomResourceDefinition in the form names plural group Must be all lowercase acceptedNames categories string Atomic will be replaced during a merge categories is a list of grouped resources this custom resource belongs to e g all This is published in API discovery documents and used by clients to support invocations like kubectl get all acceptedNames listKind string listKind is the serialized kind of the list for this resource Defaults to kind List acceptedNames shortNames string Atomic will be replaced during a merge shortNames are short names for the resource exposed in API discovery documents and used by clients to support invocations like kubectl get shortname It must be all lowercase acceptedNames singular string singular is the singular name of the resource It must be all lowercase Defaults to lowercased kind conditions CustomResourceDefinitionCondition Map unique values on key type will be kept during a merge conditions indicate state for particular aspects of a CustomResourceDefinition a name CustomResourceDefinitionCondition a CustomResourceDefinitionCondition contains details for the current condition of this pod conditions status string required status is the status of the condition Can be True False Unknown conditions type string required type is the type of the condition Types include Established NamesAccepted and Terminating conditions lastTransitionTime Time lastTransitionTime last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string message is a human readable message indicating details about last transition conditions reason string reason is a unique one word CamelCase reason for the condition s last transition storedVersions string Atomic will be replaced during a merge storedVersions lists all versions of CustomResources that were ever persisted Tracking these versions allows a migration path for stored versions in etcd The field is mutable so a migration controller can finish a migration to another version ensuring no old objects are left in storage and then remove the rest of the versions from this list Versions may not be removed from spec versions while they exist in this list CustomResourceDefinitionList CustomResourceDefinitionList CustomResourceDefinitionList is a list of CustomResourceDefinition objects hr items a href CustomResourceDefinition a required items list individual CustomResourceDefinition objects apiVersion string APIVersion defines the versioned schema of this representation of an object Servers should convert recognized schemas to the latest internal value and may reject unrecognized values More info https git k8s io community contributors devel sig architecture api conventions md resources kind string Kind is a string value representing the REST resource this object represents Servers may infer this from the endpoint the client submits requests to Cannot be updated In CamelCase More info https git k8s io community contributors devel sig architecture api conventions md types kinds metadata a href ListMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata Operations Operations hr get read the specified CustomResourceDefinition HTTP Request GET apis apiextensions k8s io v1 customresourcedefinitions name Parameters name in path string required name of the CustomResourceDefinition pretty in query string a href pretty a Response 200 a href CustomResourceDefinition a OK 401 Unauthorized get read status of the specified CustomResourceDefinition HTTP Request GET apis apiextensions k8s io v1 customresourcedefinitions name status Parameters name in path string required name of the CustomResourceDefinition pretty in query string a href pretty a Response 200 a href CustomResourceDefinition a OK 401 Unauthorized list list or watch objects of kind CustomResourceDefinition HTTP Request GET apis apiextensions k8s io v1 customresourcedefinitions Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href CustomResourceDefinitionList a OK 401 Unauthorized create create a CustomResourceDefinition HTTP Request POST apis apiextensions k8s io v1 customresourcedefinitions Parameters body a href CustomResourceDefinition a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CustomResourceDefinition a OK 201 a href CustomResourceDefinition a Created 202 a href CustomResourceDefinition a Accepted 401 Unauthorized update replace the specified CustomResourceDefinition HTTP Request PUT apis apiextensions k8s io v1 customresourcedefinitions name Parameters name in path string required name of the CustomResourceDefinition body a href CustomResourceDefinition a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CustomResourceDefinition a OK 201 a href CustomResourceDefinition a Created 401 Unauthorized update replace status of the specified CustomResourceDefinition HTTP Request PUT apis apiextensions k8s io v1 customresourcedefinitions name status Parameters name in path string required name of the CustomResourceDefinition body a href CustomResourceDefinition a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CustomResourceDefinition a OK 201 a href CustomResourceDefinition a Created 401 Unauthorized patch partially update the specified CustomResourceDefinition HTTP Request PATCH apis apiextensions k8s io v1 customresourcedefinitions name Parameters name in path string required name of the CustomResourceDefinition body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CustomResourceDefinition a OK 201 a href CustomResourceDefinition a Created 401 Unauthorized patch partially update status of the specified CustomResourceDefinition HTTP Request PATCH apis apiextensions k8s io v1 customresourcedefinitions name status Parameters name in path string required name of the CustomResourceDefinition body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CustomResourceDefinition a OK 201 a href CustomResourceDefinition a Created 401 Unauthorized delete delete a CustomResourceDefinition HTTP Request DELETE apis apiextensions k8s io v1 customresourcedefinitions name Parameters name in path string required name of the CustomResourceDefinition body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of CustomResourceDefinition HTTP Request DELETE apis apiextensions k8s io v1 customresourcedefinitions Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference contenttype apireference apiVersion admissionregistration k8s io v1 kind ValidatingWebhookConfiguration apimetadata title ValidatingWebhookConfiguration weight 4 autogenerated true import k8s io api admissionregistration v1 ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it | ---
api_metadata:
apiVersion: "admissionregistration.k8s.io/v1"
import: "k8s.io/api/admissionregistration/v1"
kind: "ValidatingWebhookConfiguration"
content_type: "api_reference"
description: "ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it."
title: "ValidatingWebhookConfiguration"
weight: 4
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.
-->
`apiVersion: admissionregistration.k8s.io/v1`
`import "k8s.io/api/admissionregistration/v1"`
## ValidatingWebhookConfiguration {#ValidatingWebhookConfiguration}
ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.
<hr>
- **apiVersion**: admissionregistration.k8s.io/v1
- **kind**: ValidatingWebhookConfiguration
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- **webhooks** ([]ValidatingWebhook)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
Webhooks is a list of webhooks and the affected resources and operations.
<a name="ValidatingWebhook"></a>
*ValidatingWebhook describes an admission webhook and the resources and operations it applies to.*
- **webhooks.admissionReviewVersions** ([]string), required
*Atomic: will be replaced during a merge*
AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy.
- **webhooks.clientConfig** (WebhookClientConfig), required
ClientConfig defines how to communicate with the hook. Required
<a name="WebhookClientConfig"></a>
*WebhookClientConfig contains the information to make a TLS connection with the webhook*
- **webhooks.clientConfig.caBundle** ([]byte)
`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
- **webhooks.clientConfig.service** (ServiceReference)
`service` is a reference to the service for this webhook. Either `service` or `url` must be specified.
If the webhook is running within the cluster, then you should use `service`.
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
- **webhooks.clientConfig.service.name** (string), required
`name` is the name of the service. Required
- **webhooks.clientConfig.service.namespace** (string), required
`namespace` is the namespace of the service. Required
- **webhooks.clientConfig.service.path** (string)
`path` is an optional URL path which will be sent in any request to this service.
- **webhooks.clientConfig.service.port** (int32)
If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
- **webhooks.clientConfig.url** (string)
`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.
The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- **webhooks.name** (string), required
The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
- **webhooks.sideEffects** (string), required
SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
- **webhooks.failurePolicy** (string)
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
- **webhooks.matchConditions** ([]MatchCondition)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.
The exact matching logic is (in order):
1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.
2. If ALL matchConditions evaluate to TRUE, the webhook is called.
3. If any matchCondition evaluates to an error (but none are FALSE):
- If failurePolicy=Fail, reject the request
- If failurePolicy=Ignore, the error is ignored and the webhook is skipped
<a name="MatchCondition"></a>
*MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.*
- **webhooks.matchConditions.expression** (string), required
Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:
'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Required.
- **webhooks.matchConditions.name** (string), required
Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')
Required.
- **webhooks.matchPolicy** (string)
matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".
- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook.
- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook.
Defaults to "Equivalent"
- **webhooks.namespaceSelector** (<a href="">LabelSelector</a>)
NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook.
For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "runlevel",
"operator": "NotIn",
"values": [
"0",
"1"
]
}
]
}
If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "environment",
"operator": "In",
"values": [
"prod",
"staging"
]
}
]
}
See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors.
Default to the empty LabelSelector, which matches everything.
- **webhooks.objectSelector** (<a href="">LabelSelector</a>)
ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
- **webhooks.rules** ([]RuleWithOperations)
*Atomic: will be replaced during a merge*
Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.
<a name="RuleWithOperations"></a>
*RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.*
- **webhooks.rules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **webhooks.rules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **webhooks.timeoutSeconds** (int32)
TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds.
## ValidatingWebhookConfigurationList {#ValidatingWebhookConfigurationList}
ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration.
<hr>
- **items** ([]<a href="">ValidatingWebhookConfiguration</a>), required
List of ValidatingWebhookConfiguration.
- **apiVersion** (string)
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
## Operations {#Operations}
<hr>
### `get` read the specified ValidatingWebhookConfiguration
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingWebhookConfiguration
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingWebhookConfiguration</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ValidatingWebhookConfiguration
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ValidatingWebhookConfigurationList</a>): OK
401: Unauthorized
### `create` create a ValidatingWebhookConfiguration
#### HTTP Request
POST /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations
#### Parameters
- **body**: <a href="">ValidatingWebhookConfiguration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingWebhookConfiguration</a>): OK
201 (<a href="">ValidatingWebhookConfiguration</a>): Created
202 (<a href="">ValidatingWebhookConfiguration</a>): Accepted
401: Unauthorized
### `update` replace the specified ValidatingWebhookConfiguration
#### HTTP Request
PUT /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingWebhookConfiguration
- **body**: <a href="">ValidatingWebhookConfiguration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingWebhookConfiguration</a>): OK
201 (<a href="">ValidatingWebhookConfiguration</a>): Created
401: Unauthorized
### `patch` partially update the specified ValidatingWebhookConfiguration
#### HTTP Request
PATCH /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingWebhookConfiguration
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingWebhookConfiguration</a>): OK
201 (<a href="">ValidatingWebhookConfiguration</a>): Created
401: Unauthorized
### `delete` delete a ValidatingWebhookConfiguration
#### HTTP Request
DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingWebhookConfiguration
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ValidatingWebhookConfiguration
#### HTTP Request
DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion admissionregistration k8s io v1 import k8s io api admissionregistration v1 kind ValidatingWebhookConfiguration content type api reference description ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it title ValidatingWebhookConfiguration weight 4 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 apiVersion admissionregistration k8s io v1 import k8s io api admissionregistration v1 ValidatingWebhookConfiguration ValidatingWebhookConfiguration ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it hr apiVersion admissionregistration k8s io v1 kind ValidatingWebhookConfiguration metadata a href ObjectMeta a Standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata webhooks ValidatingWebhook Patch strategy merge on key name Map unique values on key name will be kept during a merge Webhooks is a list of webhooks and the affected resources and operations a name ValidatingWebhook a ValidatingWebhook describes an admission webhook and the resources and operations it applies to webhooks admissionReviewVersions string required Atomic will be replaced during a merge AdmissionReviewVersions is an ordered list of preferred AdmissionReview versions the Webhook expects API server will try to use first version in the list which it supports If none of the versions specified in this list supported by API server validation will fail for this object If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server calls to the webhook will fail and be subject to the failure policy webhooks clientConfig WebhookClientConfig required ClientConfig defines how to communicate with the hook Required a name WebhookClientConfig a WebhookClientConfig contains the information to make a TLS connection with the webhook webhooks clientConfig caBundle byte caBundle is a PEM encoded CA bundle which will be used to validate the webhook s server certificate If unspecified system trust roots on the apiserver are used webhooks clientConfig service ServiceReference service is a reference to the service for this webhook Either service or url must be specified If the webhook is running within the cluster then you should use service a name ServiceReference a ServiceReference holds a reference to Service legacy k8s io webhooks clientConfig service name string required name is the name of the service Required webhooks clientConfig service namespace string required namespace is the namespace of the service Required webhooks clientConfig service path string path is an optional URL path which will be sent in any request to this service webhooks clientConfig service port int32 If specified the port on the service that hosting webhook Default to 443 for backward compatibility port should be a valid port number 1 65535 inclusive webhooks clientConfig url string url gives the location of the webhook in standard URL form scheme host port path Exactly one of url or service must be specified The host should not refer to a service running in the cluster use the service field instead The host might be resolved via external DNS in some apiservers e g kube apiserver cannot resolve in cluster DNS as that would be a layering violation host may also be an IP address Please note that using localhost or 127 0 0 1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook Such installs are likely to be non portable i e not easy to turn up in a new cluster The scheme must be https the URL must begin with https A path is optional and if present may be any string permissible in a URL You may use the path to pass an arbitrary string to the webhook for example a cluster identifier Attempting to use a user or basic auth e g user password is not allowed Fragments and query parameters are not allowed either webhooks name string required The name of the admission webhook Name should be fully qualified e g imagepolicy kubernetes io where imagepolicy is the name of the webhook and kubernetes io is the name of the organization Required webhooks sideEffects string required SideEffects states whether this webhook has side effects Acceptable values are None NoneOnDryRun webhooks created via v1beta1 may also specify Some or Unknown Webhooks with side effects MUST implement a reconciliation system since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone Requests with the dryRun attribute will be auto rejected if they match a webhook with sideEffects Unknown or Some webhooks failurePolicy string FailurePolicy defines how unrecognized errors from the admission endpoint are handled allowed values are Ignore or Fail Defaults to Fail webhooks matchConditions MatchCondition Patch strategy merge on key name Map unique values on key name will be kept during a merge MatchConditions is a list of conditions that must be met for a request to be sent to this webhook Match conditions filter requests that have already been matched by the rules namespaceSelector and objectSelector An empty list of matchConditions matches all requests There are a maximum of 64 match conditions allowed The exact matching logic is in order 1 If ANY matchCondition evaluates to FALSE the webhook is skipped 2 If ALL matchConditions evaluate to TRUE the webhook is called 3 If any matchCondition evaluates to an error but none are FALSE If failurePolicy Fail reject the request If failurePolicy Ignore the error is ignored and the webhook is skipped a name MatchCondition a MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook webhooks matchConditions expression string required Expression represents the expression which will be evaluated by CEL Must evaluate to bool CEL expressions have access to the contents of the AdmissionRequest and Authorizer organized into CEL variables object The object from the incoming request The value is null for DELETE requests oldObject The existing object The value is null for CREATE requests request Attributes of the admission request pkg apis admission types go AdmissionRequest authorizer A CEL Authorizer May be used to perform authorization checks for the principal user or service account of the request See https pkg go dev k8s io apiserver pkg cel library Authz authorizer requestResource A CEL ResourceCheck constructed from the authorizer and configured with the request resource Documentation on CEL https kubernetes io docs reference using api cel Required webhooks matchConditions name string required Name is an identifier for this match condition used for strategic merging of MatchConditions as well as providing an identifier for logging purposes A good name should be descriptive of the associated expression Name must be a qualified name consisting of alphanumeric characters or and must start and end with an alphanumeric character e g MyName or my name or 123 abc regex used for validation is A Za z0 9 A Za z0 9 A Za z0 9 with an optional DNS subdomain prefix and e g example com MyName Required webhooks matchPolicy string matchPolicy defines how the rules list is used to match incoming requests Allowed values are Exact or Equivalent Exact match a request only if it exactly matches a specified rule For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 but rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would not be sent to the webhook Equivalent match a request if modifies a resource listed in rules even via another API group or version For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 and rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would be converted to apps v1 and sent to the webhook Defaults to Equivalent webhooks namespaceSelector a href LabelSelector a NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector If the object itself is a namespace the matching is performed on object metadata labels If the object is another cluster scoped resource it never skips the webhook For example to run the webhook on any objects whose namespace is not associated with runlevel of 0 or 1 you will set the selector as follows namespaceSelector matchExpressions key runlevel operator NotIn values 0 1 If instead you want to only run the webhook on any objects whose namespace is associated with the environment of prod or staging you will set the selector as follows namespaceSelector matchExpressions key environment operator In values prod staging See https kubernetes io docs concepts overview working with objects labels for more examples of label selectors Default to the empty LabelSelector which matches everything webhooks objectSelector a href LabelSelector a ObjectSelector decides whether to run the webhook based on if the object has matching labels objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook and is considered to match if either object matches the selector A null object oldObject in the case of create or newObject in the case of delete or an object that cannot have labels like a DeploymentRollback or a PodProxyOptions object is not considered to match Use the object selector only if the webhook is opt in because end users may skip the admission webhook by setting the labels Default to the empty LabelSelector which matches everything webhooks rules RuleWithOperations Atomic will be replaced during a merge Rules describes what operations on what resources subresources the webhook cares about The webhook cares about an operation if it matches any Rule However in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects a name RuleWithOperations a RuleWithOperations is a tuple of Operations and Resources It is recommended to make sure that all the tuple expansions are valid webhooks rules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required webhooks rules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required webhooks rules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required webhooks rules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required webhooks rules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is webhooks timeoutSeconds int32 TimeoutSeconds specifies the timeout for this webhook After the timeout passes the webhook call will be ignored or the API call will fail based on the failure policy The timeout value must be between 1 and 30 seconds Default to 10 seconds ValidatingWebhookConfigurationList ValidatingWebhookConfigurationList ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration hr items a href ValidatingWebhookConfiguration a required List of ValidatingWebhookConfiguration apiVersion string APIVersion defines the versioned schema of this representation of an object Servers should convert recognized schemas to the latest internal value and may reject unrecognized values More info https git k8s io community contributors devel sig architecture api conventions md resources kind string Kind is a string value representing the REST resource this object represents Servers may infer this from the endpoint the client submits requests to Cannot be updated In CamelCase More info https git k8s io community contributors devel sig architecture api conventions md types kinds metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds Operations Operations hr get read the specified ValidatingWebhookConfiguration HTTP Request GET apis admissionregistration k8s io v1 validatingwebhookconfigurations name Parameters name in path string required name of the ValidatingWebhookConfiguration pretty in query string a href pretty a Response 200 a href ValidatingWebhookConfiguration a OK 401 Unauthorized list list or watch objects of kind ValidatingWebhookConfiguration HTTP Request GET apis admissionregistration k8s io v1 validatingwebhookconfigurations Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ValidatingWebhookConfigurationList a OK 401 Unauthorized create create a ValidatingWebhookConfiguration HTTP Request POST apis admissionregistration k8s io v1 validatingwebhookconfigurations Parameters body a href ValidatingWebhookConfiguration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ValidatingWebhookConfiguration a OK 201 a href ValidatingWebhookConfiguration a Created 202 a href ValidatingWebhookConfiguration a Accepted 401 Unauthorized update replace the specified ValidatingWebhookConfiguration HTTP Request PUT apis admissionregistration k8s io v1 validatingwebhookconfigurations name Parameters name in path string required name of the ValidatingWebhookConfiguration body a href ValidatingWebhookConfiguration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ValidatingWebhookConfiguration a OK 201 a href ValidatingWebhookConfiguration a Created 401 Unauthorized patch partially update the specified ValidatingWebhookConfiguration HTTP Request PATCH apis admissionregistration k8s io v1 validatingwebhookconfigurations name Parameters name in path string required name of the ValidatingWebhookConfiguration body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ValidatingWebhookConfiguration a OK 201 a href ValidatingWebhookConfiguration a Created 401 Unauthorized delete delete a ValidatingWebhookConfiguration HTTP Request DELETE apis admissionregistration k8s io v1 validatingwebhookconfigurations name Parameters name in path string required name of the ValidatingWebhookConfiguration body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ValidatingWebhookConfiguration HTTP Request DELETE apis admissionregistration k8s io v1 validatingwebhookconfigurations Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object kind MutatingWebhookConfiguration title MutatingWebhookConfiguration contenttype apireference apiVersion admissionregistration k8s io v1 apimetadata weight 3 autogenerated true import k8s io api admissionregistration v1 | ---
api_metadata:
apiVersion: "admissionregistration.k8s.io/v1"
import: "k8s.io/api/admissionregistration/v1"
kind: "MutatingWebhookConfiguration"
content_type: "api_reference"
description: "MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object."
title: "MutatingWebhookConfiguration"
weight: 3
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.
-->
`apiVersion: admissionregistration.k8s.io/v1`
`import "k8s.io/api/admissionregistration/v1"`
## MutatingWebhookConfiguration {#MutatingWebhookConfiguration}
MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.
<hr>
- **apiVersion**: admissionregistration.k8s.io/v1
- **kind**: MutatingWebhookConfiguration
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- **webhooks** ([]MutatingWebhook)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
Webhooks is a list of webhooks and the affected resources and operations.
<a name="MutatingWebhook"></a>
*MutatingWebhook describes an admission webhook and the resources and operations it applies to.*
- **webhooks.admissionReviewVersions** ([]string), required
*Atomic: will be replaced during a merge*
AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy.
- **webhooks.clientConfig** (WebhookClientConfig), required
ClientConfig defines how to communicate with the hook. Required
<a name="WebhookClientConfig"></a>
*WebhookClientConfig contains the information to make a TLS connection with the webhook*
- **webhooks.clientConfig.caBundle** ([]byte)
`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
- **webhooks.clientConfig.service** (ServiceReference)
`service` is a reference to the service for this webhook. Either `service` or `url` must be specified.
If the webhook is running within the cluster, then you should use `service`.
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
- **webhooks.clientConfig.service.name** (string), required
`name` is the name of the service. Required
- **webhooks.clientConfig.service.namespace** (string), required
`namespace` is the namespace of the service. Required
- **webhooks.clientConfig.service.path** (string)
`path` is an optional URL path which will be sent in any request to this service.
- **webhooks.clientConfig.service.port** (int32)
If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
- **webhooks.clientConfig.url** (string)
`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.
The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- **webhooks.name** (string), required
The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
- **webhooks.sideEffects** (string), required
SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
- **webhooks.failurePolicy** (string)
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
- **webhooks.matchConditions** ([]MatchCondition)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.
The exact matching logic is (in order):
1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.
2. If ALL matchConditions evaluate to TRUE, the webhook is called.
3. If any matchCondition evaluates to an error (but none are FALSE):
- If failurePolicy=Fail, reject the request
- If failurePolicy=Ignore, the error is ignored and the webhook is skipped
<a name="MatchCondition"></a>
*MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.*
- **webhooks.matchConditions.expression** (string), required
Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:
'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Required.
- **webhooks.matchConditions.name** (string), required
Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')
Required.
- **webhooks.matchPolicy** (string)
matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".
- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook.
- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook.
Defaults to "Equivalent"
- **webhooks.namespaceSelector** (<a href="">LabelSelector</a>)
NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook.
For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "runlevel",
"operator": "NotIn",
"values": [
"0",
"1"
]
}
]
}
If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "environment",
"operator": "In",
"values": [
"prod",
"staging"
]
}
]
}
See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors.
Default to the empty LabelSelector, which matches everything.
- **webhooks.objectSelector** (<a href="">LabelSelector</a>)
ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
- **webhooks.reinvocationPolicy** (string)
reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded".
Never: the webhook will not be called more than once in a single admission evaluation.
IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead.
Defaults to "Never".
- **webhooks.rules** ([]RuleWithOperations)
*Atomic: will be replaced during a merge*
Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.
<a name="RuleWithOperations"></a>
*RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.*
- **webhooks.rules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **webhooks.rules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **webhooks.timeoutSeconds** (int32)
TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds.
## MutatingWebhookConfigurationList {#MutatingWebhookConfigurationList}
MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration.
<hr>
- **apiVersion**: admissionregistration.k8s.io/v1
- **kind**: MutatingWebhookConfigurationList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">MutatingWebhookConfiguration</a>), required
List of MutatingWebhookConfiguration.
## Operations {#Operations}
<hr>
### `get` read the specified MutatingWebhookConfiguration
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the MutatingWebhookConfiguration
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">MutatingWebhookConfiguration</a>): OK
401: Unauthorized
### `list` list or watch objects of kind MutatingWebhookConfiguration
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">MutatingWebhookConfigurationList</a>): OK
401: Unauthorized
### `create` create a MutatingWebhookConfiguration
#### HTTP Request
POST /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations
#### Parameters
- **body**: <a href="">MutatingWebhookConfiguration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">MutatingWebhookConfiguration</a>): OK
201 (<a href="">MutatingWebhookConfiguration</a>): Created
202 (<a href="">MutatingWebhookConfiguration</a>): Accepted
401: Unauthorized
### `update` replace the specified MutatingWebhookConfiguration
#### HTTP Request
PUT /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the MutatingWebhookConfiguration
- **body**: <a href="">MutatingWebhookConfiguration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">MutatingWebhookConfiguration</a>): OK
201 (<a href="">MutatingWebhookConfiguration</a>): Created
401: Unauthorized
### `patch` partially update the specified MutatingWebhookConfiguration
#### HTTP Request
PATCH /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the MutatingWebhookConfiguration
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">MutatingWebhookConfiguration</a>): OK
201 (<a href="">MutatingWebhookConfiguration</a>): Created
401: Unauthorized
### `delete` delete a MutatingWebhookConfiguration
#### HTTP Request
DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the MutatingWebhookConfiguration
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of MutatingWebhookConfiguration
#### HTTP Request
DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion admissionregistration k8s io v1 import k8s io api admissionregistration v1 kind MutatingWebhookConfiguration content type api reference description MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object title MutatingWebhookConfiguration weight 3 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 apiVersion admissionregistration k8s io v1 import k8s io api admissionregistration v1 MutatingWebhookConfiguration MutatingWebhookConfiguration MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object hr apiVersion admissionregistration k8s io v1 kind MutatingWebhookConfiguration metadata a href ObjectMeta a Standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata webhooks MutatingWebhook Patch strategy merge on key name Map unique values on key name will be kept during a merge Webhooks is a list of webhooks and the affected resources and operations a name MutatingWebhook a MutatingWebhook describes an admission webhook and the resources and operations it applies to webhooks admissionReviewVersions string required Atomic will be replaced during a merge AdmissionReviewVersions is an ordered list of preferred AdmissionReview versions the Webhook expects API server will try to use first version in the list which it supports If none of the versions specified in this list supported by API server validation will fail for this object If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server calls to the webhook will fail and be subject to the failure policy webhooks clientConfig WebhookClientConfig required ClientConfig defines how to communicate with the hook Required a name WebhookClientConfig a WebhookClientConfig contains the information to make a TLS connection with the webhook webhooks clientConfig caBundle byte caBundle is a PEM encoded CA bundle which will be used to validate the webhook s server certificate If unspecified system trust roots on the apiserver are used webhooks clientConfig service ServiceReference service is a reference to the service for this webhook Either service or url must be specified If the webhook is running within the cluster then you should use service a name ServiceReference a ServiceReference holds a reference to Service legacy k8s io webhooks clientConfig service name string required name is the name of the service Required webhooks clientConfig service namespace string required namespace is the namespace of the service Required webhooks clientConfig service path string path is an optional URL path which will be sent in any request to this service webhooks clientConfig service port int32 If specified the port on the service that hosting webhook Default to 443 for backward compatibility port should be a valid port number 1 65535 inclusive webhooks clientConfig url string url gives the location of the webhook in standard URL form scheme host port path Exactly one of url or service must be specified The host should not refer to a service running in the cluster use the service field instead The host might be resolved via external DNS in some apiservers e g kube apiserver cannot resolve in cluster DNS as that would be a layering violation host may also be an IP address Please note that using localhost or 127 0 0 1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook Such installs are likely to be non portable i e not easy to turn up in a new cluster The scheme must be https the URL must begin with https A path is optional and if present may be any string permissible in a URL You may use the path to pass an arbitrary string to the webhook for example a cluster identifier Attempting to use a user or basic auth e g user password is not allowed Fragments and query parameters are not allowed either webhooks name string required The name of the admission webhook Name should be fully qualified e g imagepolicy kubernetes io where imagepolicy is the name of the webhook and kubernetes io is the name of the organization Required webhooks sideEffects string required SideEffects states whether this webhook has side effects Acceptable values are None NoneOnDryRun webhooks created via v1beta1 may also specify Some or Unknown Webhooks with side effects MUST implement a reconciliation system since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone Requests with the dryRun attribute will be auto rejected if they match a webhook with sideEffects Unknown or Some webhooks failurePolicy string FailurePolicy defines how unrecognized errors from the admission endpoint are handled allowed values are Ignore or Fail Defaults to Fail webhooks matchConditions MatchCondition Patch strategy merge on key name Map unique values on key name will be kept during a merge MatchConditions is a list of conditions that must be met for a request to be sent to this webhook Match conditions filter requests that have already been matched by the rules namespaceSelector and objectSelector An empty list of matchConditions matches all requests There are a maximum of 64 match conditions allowed The exact matching logic is in order 1 If ANY matchCondition evaluates to FALSE the webhook is skipped 2 If ALL matchConditions evaluate to TRUE the webhook is called 3 If any matchCondition evaluates to an error but none are FALSE If failurePolicy Fail reject the request If failurePolicy Ignore the error is ignored and the webhook is skipped a name MatchCondition a MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook webhooks matchConditions expression string required Expression represents the expression which will be evaluated by CEL Must evaluate to bool CEL expressions have access to the contents of the AdmissionRequest and Authorizer organized into CEL variables object The object from the incoming request The value is null for DELETE requests oldObject The existing object The value is null for CREATE requests request Attributes of the admission request pkg apis admission types go AdmissionRequest authorizer A CEL Authorizer May be used to perform authorization checks for the principal user or service account of the request See https pkg go dev k8s io apiserver pkg cel library Authz authorizer requestResource A CEL ResourceCheck constructed from the authorizer and configured with the request resource Documentation on CEL https kubernetes io docs reference using api cel Required webhooks matchConditions name string required Name is an identifier for this match condition used for strategic merging of MatchConditions as well as providing an identifier for logging purposes A good name should be descriptive of the associated expression Name must be a qualified name consisting of alphanumeric characters or and must start and end with an alphanumeric character e g MyName or my name or 123 abc regex used for validation is A Za z0 9 A Za z0 9 A Za z0 9 with an optional DNS subdomain prefix and e g example com MyName Required webhooks matchPolicy string matchPolicy defines how the rules list is used to match incoming requests Allowed values are Exact or Equivalent Exact match a request only if it exactly matches a specified rule For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 but rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would not be sent to the webhook Equivalent match a request if modifies a resource listed in rules even via another API group or version For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 and rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would be converted to apps v1 and sent to the webhook Defaults to Equivalent webhooks namespaceSelector a href LabelSelector a NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector If the object itself is a namespace the matching is performed on object metadata labels If the object is another cluster scoped resource it never skips the webhook For example to run the webhook on any objects whose namespace is not associated with runlevel of 0 or 1 you will set the selector as follows namespaceSelector matchExpressions key runlevel operator NotIn values 0 1 If instead you want to only run the webhook on any objects whose namespace is associated with the environment of prod or staging you will set the selector as follows namespaceSelector matchExpressions key environment operator In values prod staging See https kubernetes io docs concepts overview working with objects labels for more examples of label selectors Default to the empty LabelSelector which matches everything webhooks objectSelector a href LabelSelector a ObjectSelector decides whether to run the webhook based on if the object has matching labels objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook and is considered to match if either object matches the selector A null object oldObject in the case of create or newObject in the case of delete or an object that cannot have labels like a DeploymentRollback or a PodProxyOptions object is not considered to match Use the object selector only if the webhook is opt in because end users may skip the admission webhook by setting the labels Default to the empty LabelSelector which matches everything webhooks reinvocationPolicy string reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation Allowed values are Never and IfNeeded Never the webhook will not be called more than once in a single admission evaluation IfNeeded the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call Webhooks that specify this option must be idempotent able to process objects they previously admitted Note the number of additional invocations is not guaranteed to be exactly one if additional invocations result in further modifications to the object webhooks are not guaranteed to be invoked again webhooks that use this option may be reordered to minimize the number of additional invocations to validate an object after all mutations are guaranteed complete use a validating admission webhook instead Defaults to Never webhooks rules RuleWithOperations Atomic will be replaced during a merge Rules describes what operations on what resources subresources the webhook cares about The webhook cares about an operation if it matches any Rule However in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects a name RuleWithOperations a RuleWithOperations is a tuple of Operations and Resources It is recommended to make sure that all the tuple expansions are valid webhooks rules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required webhooks rules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required webhooks rules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required webhooks rules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required webhooks rules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is webhooks timeoutSeconds int32 TimeoutSeconds specifies the timeout for this webhook After the timeout passes the webhook call will be ignored or the API call will fail based on the failure policy The timeout value must be between 1 and 30 seconds Default to 10 seconds MutatingWebhookConfigurationList MutatingWebhookConfigurationList MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration hr apiVersion admissionregistration k8s io v1 kind MutatingWebhookConfigurationList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href MutatingWebhookConfiguration a required List of MutatingWebhookConfiguration Operations Operations hr get read the specified MutatingWebhookConfiguration HTTP Request GET apis admissionregistration k8s io v1 mutatingwebhookconfigurations name Parameters name in path string required name of the MutatingWebhookConfiguration pretty in query string a href pretty a Response 200 a href MutatingWebhookConfiguration a OK 401 Unauthorized list list or watch objects of kind MutatingWebhookConfiguration HTTP Request GET apis admissionregistration k8s io v1 mutatingwebhookconfigurations Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href MutatingWebhookConfigurationList a OK 401 Unauthorized create create a MutatingWebhookConfiguration HTTP Request POST apis admissionregistration k8s io v1 mutatingwebhookconfigurations Parameters body a href MutatingWebhookConfiguration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href MutatingWebhookConfiguration a OK 201 a href MutatingWebhookConfiguration a Created 202 a href MutatingWebhookConfiguration a Accepted 401 Unauthorized update replace the specified MutatingWebhookConfiguration HTTP Request PUT apis admissionregistration k8s io v1 mutatingwebhookconfigurations name Parameters name in path string required name of the MutatingWebhookConfiguration body a href MutatingWebhookConfiguration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href MutatingWebhookConfiguration a OK 201 a href MutatingWebhookConfiguration a Created 401 Unauthorized patch partially update the specified MutatingWebhookConfiguration HTTP Request PATCH apis admissionregistration k8s io v1 mutatingwebhookconfigurations name Parameters name in path string required name of the MutatingWebhookConfiguration body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href MutatingWebhookConfiguration a OK 201 a href MutatingWebhookConfiguration a Created 401 Unauthorized delete delete a MutatingWebhookConfiguration HTTP Request DELETE apis admissionregistration k8s io v1 mutatingwebhookconfigurations name Parameters name in path string required name of the MutatingWebhookConfiguration body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of MutatingWebhookConfiguration HTTP Request DELETE apis admissionregistration k8s io v1 mutatingwebhookconfigurations Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference autogenerated true import k8s io api certificates v1alpha1 weight 5 apiVersion certificates k8s io v1alpha1 contenttype apireference ClusterTrustBundle is a cluster scoped container for X apimetadata title ClusterTrustBundle v1alpha1 kind ClusterTrustBundle | ---
api_metadata:
apiVersion: "certificates.k8s.io/v1alpha1"
import: "k8s.io/api/certificates/v1alpha1"
kind: "ClusterTrustBundle"
content_type: "api_reference"
description: "ClusterTrustBundle is a cluster-scoped container for X."
title: "ClusterTrustBundle v1alpha1"
weight: 5
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.
-->
`apiVersion: certificates.k8s.io/v1alpha1`
`import "k8s.io/api/certificates/v1alpha1"`
## ClusterTrustBundle {#ClusterTrustBundle}
ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates).
ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the `clusterTrustBundle` projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to.
It can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle.
<hr>
- **apiVersion**: certificates.k8s.io/v1alpha1
- **kind**: ClusterTrustBundle
- **metadata** (<a href="">ObjectMeta</a>)
metadata contains the object metadata.
- **spec** (<a href="">ClusterTrustBundleSpec</a>), required
spec contains the signer (if any) and trust anchors.
## ClusterTrustBundleSpec {#ClusterTrustBundleSpec}
ClusterTrustBundleSpec contains the signer and trust anchors.
<hr>
- **trustBundle** (string), required
trustBundle contains the individual X.509 trust anchors for this bundle, as PEM bundle of PEM-wrapped, DER-formatted X.509 certificates.
The data must consist only of PEM certificate blocks that parse as valid X.509 certificates. Each certificate must include a basic constraints extension with the CA bit set. The API server will reject objects that contain duplicate certificates, or that use PEM block headers.
Users of ClusterTrustBundles, including Kubelet, are free to reorder and deduplicate certificate blocks in this file according to their own logic, as well as to drop PEM block headers and inter-block data.
- **signerName** (string)
signerName indicates the associated signer, if any.
In order to create or update a ClusterTrustBundle that sets signerName, you must have the following cluster-scoped permission: group=certificates.k8s.io resource=signers resourceName=\<the signer name> verb=attest.
If signerName is not empty, then the ClusterTrustBundle object must be named with the signer name as a prefix (translating slashes to colons). For example, for the signer name `example.com/foo`, valid ClusterTrustBundle object names include `example.com:foo:abc` and `example.com:foo:v1`.
If signerName is empty, then the ClusterTrustBundle object's name must not have such a prefix.
List/watch requests for ClusterTrustBundles can filter on this field using a `spec.signerName=NAME` field selector.
## ClusterTrustBundleList {#ClusterTrustBundleList}
ClusterTrustBundleList is a collection of ClusterTrustBundle objects
<hr>
- **apiVersion**: certificates.k8s.io/v1alpha1
- **kind**: ClusterTrustBundleList
- **metadata** (<a href="">ListMeta</a>)
metadata contains the list metadata.
- **items** ([]<a href="">ClusterTrustBundle</a>), required
items is a collection of ClusterTrustBundle objects
## Operations {#Operations}
<hr>
### `get` read the specified ClusterTrustBundle
#### HTTP Request
GET /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterTrustBundle
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterTrustBundle</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ClusterTrustBundle
#### HTTP Request
GET /apis/certificates.k8s.io/v1alpha1/clustertrustbundles
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ClusterTrustBundleList</a>): OK
401: Unauthorized
### `create` create a ClusterTrustBundle
#### HTTP Request
POST /apis/certificates.k8s.io/v1alpha1/clustertrustbundles
#### Parameters
- **body**: <a href="">ClusterTrustBundle</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterTrustBundle</a>): OK
201 (<a href="">ClusterTrustBundle</a>): Created
202 (<a href="">ClusterTrustBundle</a>): Accepted
401: Unauthorized
### `update` replace the specified ClusterTrustBundle
#### HTTP Request
PUT /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterTrustBundle
- **body**: <a href="">ClusterTrustBundle</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterTrustBundle</a>): OK
201 (<a href="">ClusterTrustBundle</a>): Created
401: Unauthorized
### `patch` partially update the specified ClusterTrustBundle
#### HTTP Request
PATCH /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterTrustBundle
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ClusterTrustBundle</a>): OK
201 (<a href="">ClusterTrustBundle</a>): Created
401: Unauthorized
### `delete` delete a ClusterTrustBundle
#### HTTP Request
DELETE /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterTrustBundle
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ClusterTrustBundle
#### HTTP Request
DELETE /apis/certificates.k8s.io/v1alpha1/clustertrustbundles
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion certificates k8s io v1alpha1 import k8s io api certificates v1alpha1 kind ClusterTrustBundle content type api reference description ClusterTrustBundle is a cluster scoped container for X title ClusterTrustBundle v1alpha1 weight 5 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 apiVersion certificates k8s io v1alpha1 import k8s io api certificates v1alpha1 ClusterTrustBundle ClusterTrustBundle ClusterTrustBundle is a cluster scoped container for X 509 trust anchors root certificates ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster because they can be mounted by pods using the clusterTrustBundle projection All service accounts have read access to ClusterTrustBundles by default Users who only have namespace level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to It can be optionally associated with a particular assigner in which case it contains one valid set of trust anchors for that signer Signers may have multiple associated ClusterTrustBundles each is an independent set of trust anchors for that signer Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle hr apiVersion certificates k8s io v1alpha1 kind ClusterTrustBundle metadata a href ObjectMeta a metadata contains the object metadata spec a href ClusterTrustBundleSpec a required spec contains the signer if any and trust anchors ClusterTrustBundleSpec ClusterTrustBundleSpec ClusterTrustBundleSpec contains the signer and trust anchors hr trustBundle string required trustBundle contains the individual X 509 trust anchors for this bundle as PEM bundle of PEM wrapped DER formatted X 509 certificates The data must consist only of PEM certificate blocks that parse as valid X 509 certificates Each certificate must include a basic constraints extension with the CA bit set The API server will reject objects that contain duplicate certificates or that use PEM block headers Users of ClusterTrustBundles including Kubelet are free to reorder and deduplicate certificate blocks in this file according to their own logic as well as to drop PEM block headers and inter block data signerName string signerName indicates the associated signer if any In order to create or update a ClusterTrustBundle that sets signerName you must have the following cluster scoped permission group certificates k8s io resource signers resourceName the signer name verb attest If signerName is not empty then the ClusterTrustBundle object must be named with the signer name as a prefix translating slashes to colons For example for the signer name example com foo valid ClusterTrustBundle object names include example com foo abc and example com foo v1 If signerName is empty then the ClusterTrustBundle object s name must not have such a prefix List watch requests for ClusterTrustBundles can filter on this field using a spec signerName NAME field selector ClusterTrustBundleList ClusterTrustBundleList ClusterTrustBundleList is a collection of ClusterTrustBundle objects hr apiVersion certificates k8s io v1alpha1 kind ClusterTrustBundleList metadata a href ListMeta a metadata contains the list metadata items a href ClusterTrustBundle a required items is a collection of ClusterTrustBundle objects Operations Operations hr get read the specified ClusterTrustBundle HTTP Request GET apis certificates k8s io v1alpha1 clustertrustbundles name Parameters name in path string required name of the ClusterTrustBundle pretty in query string a href pretty a Response 200 a href ClusterTrustBundle a OK 401 Unauthorized list list or watch objects of kind ClusterTrustBundle HTTP Request GET apis certificates k8s io v1alpha1 clustertrustbundles Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ClusterTrustBundleList a OK 401 Unauthorized create create a ClusterTrustBundle HTTP Request POST apis certificates k8s io v1alpha1 clustertrustbundles Parameters body a href ClusterTrustBundle a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ClusterTrustBundle a OK 201 a href ClusterTrustBundle a Created 202 a href ClusterTrustBundle a Accepted 401 Unauthorized update replace the specified ClusterTrustBundle HTTP Request PUT apis certificates k8s io v1alpha1 clustertrustbundles name Parameters name in path string required name of the ClusterTrustBundle body a href ClusterTrustBundle a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ClusterTrustBundle a OK 201 a href ClusterTrustBundle a Created 401 Unauthorized patch partially update the specified ClusterTrustBundle HTTP Request PATCH apis certificates k8s io v1alpha1 clustertrustbundles name Parameters name in path string required name of the ClusterTrustBundle body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ClusterTrustBundle a OK 201 a href ClusterTrustBundle a Created 401 Unauthorized delete delete a ClusterTrustBundle HTTP Request DELETE apis certificates k8s io v1alpha1 clustertrustbundles name Parameters name in path string required name of the ClusterTrustBundle body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ClusterTrustBundle HTTP Request DELETE apis certificates k8s io v1alpha1 clustertrustbundles Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference ServiceAccount binds together a name understood by users and perhaps by peripheral systems for an identity a principal that can be authenticated and authorized a set of secrets apiVersion v1 kind ServiceAccount contenttype apireference apimetadata title ServiceAccount autogenerated true weight 1 import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "ServiceAccount"
content_type: "api_reference"
description: "ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets."
title: "ServiceAccount"
weight: 1
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## ServiceAccount {#ServiceAccount}
ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets
<hr>
- **apiVersion**: v1
- **kind**: ServiceAccount
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **automountServiceAccountToken** (boolean)
AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
- **imagePullSecrets** ([]<a href="">LocalObjectReference</a>)
*Atomic: will be replaced during a merge*
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
- **secrets** ([]<a href="">ObjectReference</a>)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret
## ServiceAccountList {#ServiceAccountList}
ServiceAccountList is a list of ServiceAccount objects
<hr>
- **apiVersion**: v1
- **kind**: ServiceAccountList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">ServiceAccount</a>), required
List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
## Operations {#Operations}
<hr>
### `get` read the specified ServiceAccount
#### HTTP Request
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ServiceAccount
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceAccount</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ServiceAccount
#### HTTP Request
GET /api/v1/namespaces/{namespace}/serviceaccounts
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ServiceAccountList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ServiceAccount
#### HTTP Request
GET /api/v1/serviceaccounts
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ServiceAccountList</a>): OK
401: Unauthorized
### `create` create a ServiceAccount
#### HTTP Request
POST /api/v1/namespaces/{namespace}/serviceaccounts
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ServiceAccount</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceAccount</a>): OK
201 (<a href="">ServiceAccount</a>): Created
202 (<a href="">ServiceAccount</a>): Accepted
401: Unauthorized
### `update` replace the specified ServiceAccount
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ServiceAccount
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ServiceAccount</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceAccount</a>): OK
201 (<a href="">ServiceAccount</a>): Created
401: Unauthorized
### `patch` partially update the specified ServiceAccount
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ServiceAccount
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceAccount</a>): OK
201 (<a href="">ServiceAccount</a>): Created
401: Unauthorized
### `delete` delete a ServiceAccount
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ServiceAccount
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">ServiceAccount</a>): OK
202 (<a href="">ServiceAccount</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ServiceAccount
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/serviceaccounts
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind ServiceAccount content type api reference description ServiceAccount binds together a name understood by users and perhaps by peripheral systems for an identity a principal that can be authenticated and authorized a set of secrets title ServiceAccount weight 1 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 apiVersion v1 import k8s io api core v1 ServiceAccount ServiceAccount ServiceAccount binds together a name understood by users and perhaps by peripheral systems for an identity a principal that can be authenticated and authorized a set of secrets hr apiVersion v1 kind ServiceAccount metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata automountServiceAccountToken boolean AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted Can be overridden at the pod level imagePullSecrets a href LocalObjectReference a Atomic will be replaced during a merge ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod but ImagePullSecrets are only accessed by the kubelet More info https kubernetes io docs concepts containers images specifying imagepullsecrets on a pod secrets a href ObjectReference a Patch strategy merge on key name Map unique values on key name will be kept during a merge Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use Pods are only limited to this list if this service account has a kubernetes io enforce mountable secrets annotation set to true This field should not be used to find auto generated service account token secrets for use outside of pods Instead tokens can be requested directly using the TokenRequest API or service account token secrets can be manually created More info https kubernetes io docs concepts configuration secret ServiceAccountList ServiceAccountList ServiceAccountList is a list of ServiceAccount objects hr apiVersion v1 kind ServiceAccountList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href ServiceAccount a required List of ServiceAccounts More info https kubernetes io docs tasks configure pod container configure service account Operations Operations hr get read the specified ServiceAccount HTTP Request GET api v1 namespaces namespace serviceaccounts name Parameters name in path string required name of the ServiceAccount namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ServiceAccount a OK 401 Unauthorized list list or watch objects of kind ServiceAccount HTTP Request GET api v1 namespaces namespace serviceaccounts Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ServiceAccountList a OK 401 Unauthorized list list or watch objects of kind ServiceAccount HTTP Request GET api v1 serviceaccounts Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ServiceAccountList a OK 401 Unauthorized create create a ServiceAccount HTTP Request POST api v1 namespaces namespace serviceaccounts Parameters namespace in path string required a href namespace a body a href ServiceAccount a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ServiceAccount a OK 201 a href ServiceAccount a Created 202 a href ServiceAccount a Accepted 401 Unauthorized update replace the specified ServiceAccount HTTP Request PUT api v1 namespaces namespace serviceaccounts name Parameters name in path string required name of the ServiceAccount namespace in path string required a href namespace a body a href ServiceAccount a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ServiceAccount a OK 201 a href ServiceAccount a Created 401 Unauthorized patch partially update the specified ServiceAccount HTTP Request PATCH api v1 namespaces namespace serviceaccounts name Parameters name in path string required name of the ServiceAccount namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ServiceAccount a OK 201 a href ServiceAccount a Created 401 Unauthorized delete delete a ServiceAccount HTTP Request DELETE api v1 namespaces namespace serviceaccounts name Parameters name in path string required name of the ServiceAccount namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href ServiceAccount a OK 202 a href ServiceAccount a Accepted 401 Unauthorized deletecollection delete collection of ServiceAccount HTTP Request DELETE api v1 namespaces namespace serviceaccounts Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference TokenRequest requests a token for a given service account weight 2 title TokenRequest contenttype apireference import k8s io api authentication v1 apimetadata apiVersion authentication k8s io v1 autogenerated true kind TokenRequest | ---
api_metadata:
apiVersion: "authentication.k8s.io/v1"
import: "k8s.io/api/authentication/v1"
kind: "TokenRequest"
content_type: "api_reference"
description: "TokenRequest requests a token for a given service account."
title: "TokenRequest"
weight: 2
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.
-->
`apiVersion: authentication.k8s.io/v1`
`import "k8s.io/api/authentication/v1"`
## TokenRequest {#TokenRequest}
TokenRequest requests a token for a given service account.
<hr>
- **apiVersion**: authentication.k8s.io/v1
- **kind**: TokenRequest
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">TokenRequestSpec</a>), required
Spec holds information about the request being evaluated
- **status** (<a href="">TokenRequestStatus</a>)
Status is filled in by the server and indicates whether the token can be authenticated.
## TokenRequestSpec {#TokenRequestSpec}
TokenRequestSpec contains client provided parameters of a token request.
<hr>
- **audiences** ([]string), required
*Atomic: will be replaced during a merge*
Audiences are the intendend audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.
- **boundObjectRef** (BoundObjectReference)
BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation.
<a name="BoundObjectReference"></a>
*BoundObjectReference is a reference to an object that a token is bound to.*
- **boundObjectRef.apiVersion** (string)
API version of the referent.
- **boundObjectRef.kind** (string)
Kind of the referent. Valid kinds are 'Pod' and 'Secret'.
- **boundObjectRef.name** (string)
Name of the referent.
- **boundObjectRef.uid** (string)
UID of the referent.
- **expirationSeconds** (int64)
ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response.
## TokenRequestStatus {#TokenRequestStatus}
TokenRequestStatus is the result of a token request.
<hr>
- **expirationTimestamp** (Time), required
ExpirationTimestamp is the time of expiration of the returned token.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **token** (string), required
Token is the opaque bearer token.
## Operations {#Operations}
<hr>
### `create` create token of a ServiceAccount
#### HTTP Request
POST /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token
#### Parameters
- **name** (*in path*): string, required
name of the TokenRequest
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">TokenRequest</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">TokenRequest</a>): OK
201 (<a href="">TokenRequest</a>): Created
202 (<a href="">TokenRequest</a>): Accepted
401: Unauthorized
| kubernetes reference | api metadata apiVersion authentication k8s io v1 import k8s io api authentication v1 kind TokenRequest content type api reference description TokenRequest requests a token for a given service account title TokenRequest weight 2 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 apiVersion authentication k8s io v1 import k8s io api authentication v1 TokenRequest TokenRequest TokenRequest requests a token for a given service account hr apiVersion authentication k8s io v1 kind TokenRequest metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href TokenRequestSpec a required Spec holds information about the request being evaluated status a href TokenRequestStatus a Status is filled in by the server and indicates whether the token can be authenticated TokenRequestSpec TokenRequestSpec TokenRequestSpec contains client provided parameters of a token request hr audiences string required Atomic will be replaced during a merge Audiences are the intendend audiences of the token A recipient of a token must identify themself with an identifier in the list of audiences of the token and otherwise should reject the token A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences boundObjectRef BoundObjectReference BoundObjectRef is a reference to an object that the token will be bound to The token will only be valid for as long as the bound object exists NOTE The API server s TokenReview endpoint will validate the BoundObjectRef but other audiences may not Keep ExpirationSeconds small if you want prompt revocation a name BoundObjectReference a BoundObjectReference is a reference to an object that a token is bound to boundObjectRef apiVersion string API version of the referent boundObjectRef kind string Kind of the referent Valid kinds are Pod and Secret boundObjectRef name string Name of the referent boundObjectRef uid string UID of the referent expirationSeconds int64 ExpirationSeconds is the requested duration of validity of the request The token issuer may return a token with a different validity duration so a client needs to check the expiration field in a response TokenRequestStatus TokenRequestStatus TokenRequestStatus is the result of a token request hr expirationTimestamp Time required ExpirationTimestamp is the time of expiration of the returned token a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers token string required Token is the opaque bearer token Operations Operations hr create create token of a ServiceAccount HTTP Request POST api v1 namespaces namespace serviceaccounts name token Parameters name in path string required name of the TokenRequest namespace in path string required a href namespace a body a href TokenRequest a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href TokenRequest a OK 201 a href TokenRequest a Created 202 a href TokenRequest a Accepted 401 Unauthorized |
kubernetes reference import k8s io api certificates v1 kind CertificateSigningRequest contenttype apireference CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request and having it asynchronously approved and issued title CertificateSigningRequest weight 4 apimetadata apiVersion certificates k8s io v1 autogenerated true | ---
api_metadata:
apiVersion: "certificates.k8s.io/v1"
import: "k8s.io/api/certificates/v1"
kind: "CertificateSigningRequest"
content_type: "api_reference"
description: "CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued."
title: "CertificateSigningRequest"
weight: 4
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.
-->
`apiVersion: certificates.k8s.io/v1`
`import "k8s.io/api/certificates/v1"`
## CertificateSigningRequest {#CertificateSigningRequest}
CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued.
Kubelets use this API to obtain:
1. client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client-kubelet" signerName).
2. serving certificates for TLS endpoints kube-apiserver can connect to securely (with the "kubernetes.io/kubelet-serving" signerName).
This API can be used to request client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client" signerName), or to obtain certificates from custom non-Kubernetes signers.
<hr>
- **apiVersion**: certificates.k8s.io/v1
- **kind**: CertificateSigningRequest
- **metadata** (<a href="">ObjectMeta</a>)
- **spec** (<a href="">CertificateSigningRequestSpec</a>), required
spec contains the certificate request, and is immutable after creation. Only the request, signerName, expirationSeconds, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users.
- **status** (<a href="">CertificateSigningRequestStatus</a>)
status contains information about whether the request is approved or denied, and the certificate issued by the signer, or the failure condition indicating signer failure.
## CertificateSigningRequestSpec {#CertificateSigningRequestSpec}
CertificateSigningRequestSpec contains the certificate request.
<hr>
- **request** ([]byte), required
*Atomic: will be replaced during a merge*
request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded.
- **signerName** (string), required
signerName indicates the requested signer, and is a qualified name.
List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector.
Well-known Kubernetes signers are:
1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver.
Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager.
2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver.
Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager.
3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely.
Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager.
More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers
Custom signerNames can also be specified. The signer defines:
1. Trust distribution: how trust (CA bundles) are distributed.
2. Permitted subjects: and behavior when a disallowed subject is requested.
3. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested.
4. Required, permitted, or forbidden key usages / extended key usages.
5. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin.
6. Whether or not requests for CA certificates are allowed.
- **expirationSeconds** (int32)
expirationSeconds is the requested duration of validity of the issued certificate. The certificate signer may issue a certificate with a different validity duration so a client must check the delta between the notBefore and and notAfter fields in the issued certificate to determine the actual duration.
The v1.22+ in-tree implementations of the well-known Kubernetes signers will honor this field as long as the requested duration is not greater than the maximum duration they will honor per the --cluster-signing-duration CLI flag to the Kubernetes controller manager.
Certificate signers may not honor this field for various reasons:
1. Old signer that is unaware of the field (such as the in-tree
implementations prior to v1.22)
2. Signer whose configured maximum is shorter than the requested duration
3. Signer whose configured minimum is longer than the requested duration
The minimum valid value for expirationSeconds is 600, i.e. 10 minutes.
- **extra** (map[string][]string)
extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
- **groups** ([]string)
*Atomic: will be replaced during a merge*
groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
- **uid** (string)
uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
- **usages** ([]string)
*Atomic: will be replaced during a merge*
usages specifies a set of key usages requested in the issued certificate.
Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth".
Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth".
Valid values are:
"signing", "digital signature", "content commitment",
"key encipherment", "key agreement", "data encipherment",
"cert sign", "crl sign", "encipher only", "decipher only", "any",
"server auth", "client auth",
"code signing", "email protection", "s/mime",
"ipsec end system", "ipsec tunnel", "ipsec user",
"timestamping", "ocsp signing", "microsoft sgc", "netscape sgc"
- **username** (string)
username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
## CertificateSigningRequestStatus {#CertificateSigningRequestStatus}
CertificateSigningRequestStatus contains conditions used to indicate approved/denied/failed status of the request, and the issued certificate.
<hr>
- **certificate** ([]byte)
*Atomic: will be replaced during a merge*
certificate is populated with an issued certificate by the signer after an Approved condition is present. This field is set via the /status subresource. Once populated, this field is immutable.
If the certificate signing request is denied, a condition of type "Denied" is added and this field remains empty. If the signer cannot issue the certificate, a condition of type "Failed" is added and this field remains empty.
Validation requirements:
1. certificate must contain one or more PEM blocks.
2. All PEM blocks must have the "CERTIFICATE" label, contain no headers, and the encoded data
must be a BER-encoded ASN.1 Certificate structure as described in section 4 of RFC5280.
3. Non-PEM content may appear before or after the "CERTIFICATE" PEM blocks and is unvalidated,
to allow for explanatory text as described in section 5.2 of RFC7468.
If more than one PEM block is present, and the definition of the requested spec.signerName does not indicate otherwise, the first block is the issued certificate, and subsequent blocks should be treated as intermediate certificates and presented in TLS handshakes.
The certificate is encoded in PEM format.
When serialized as JSON or YAML, the data is additionally base64-encoded, so it consists of:
base64(
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
)
- **conditions** ([]CertificateSigningRequestCondition)
*Map: unique values on key type will be kept during a merge*
conditions applied to the request. Known conditions are "Approved", "Denied", and "Failed".
<a name="CertificateSigningRequestCondition"></a>
*CertificateSigningRequestCondition describes a condition of a CertificateSigningRequest object*
- **conditions.status** (string), required
status of the condition, one of True, False, Unknown. Approved, Denied, and Failed conditions may not be "False" or "Unknown".
- **conditions.type** (string), required
type of the condition. Known conditions are "Approved", "Denied", and "Failed".
An "Approved" condition is added via the /approval subresource, indicating the request was approved and should be issued by the signer.
A "Denied" condition is added via the /approval subresource, indicating the request was denied and should not be issued by the signer.
A "Failed" condition is added via the /status subresource, indicating the signer failed to issue the certificate.
Approved and Denied conditions are mutually exclusive. Approved, Denied, and Failed conditions cannot be removed once added.
Only one condition of a given type is allowed.
- **conditions.lastTransitionTime** (Time)
lastTransitionTime is the time the condition last transitioned from one status to another. If unset, when a new condition type is added or an existing condition's status is changed, the server defaults this to the current time.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.lastUpdateTime** (Time)
lastUpdateTime is the time of the last update to this condition
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
message contains a human readable message with details about the request state
- **conditions.reason** (string)
reason indicates a brief reason for the request state
## CertificateSigningRequestList {#CertificateSigningRequestList}
CertificateSigningRequestList is a collection of CertificateSigningRequest objects
<hr>
- **apiVersion**: certificates.k8s.io/v1
- **kind**: CertificateSigningRequestList
- **metadata** (<a href="">ListMeta</a>)
- **items** ([]<a href="">CertificateSigningRequest</a>), required
items is a collection of CertificateSigningRequest objects
## Operations {#Operations}
<hr>
### `get` read the specified CertificateSigningRequest
#### HTTP Request
GET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
401: Unauthorized
### `get` read approval of the specified CertificateSigningRequest
#### HTTP Request
GET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
401: Unauthorized
### `get` read status of the specified CertificateSigningRequest
#### HTTP Request
GET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CertificateSigningRequest
#### HTTP Request
GET /apis/certificates.k8s.io/v1/certificatesigningrequests
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">CertificateSigningRequestList</a>): OK
401: Unauthorized
### `create` create a CertificateSigningRequest
#### HTTP Request
POST /apis/certificates.k8s.io/v1/certificatesigningrequests
#### Parameters
- **body**: <a href="">CertificateSigningRequest</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
201 (<a href="">CertificateSigningRequest</a>): Created
202 (<a href="">CertificateSigningRequest</a>): Accepted
401: Unauthorized
### `update` replace the specified CertificateSigningRequest
#### HTTP Request
PUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **body**: <a href="">CertificateSigningRequest</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
201 (<a href="">CertificateSigningRequest</a>): Created
401: Unauthorized
### `update` replace approval of the specified CertificateSigningRequest
#### HTTP Request
PUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **body**: <a href="">CertificateSigningRequest</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
201 (<a href="">CertificateSigningRequest</a>): Created
401: Unauthorized
### `update` replace status of the specified CertificateSigningRequest
#### HTTP Request
PUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **body**: <a href="">CertificateSigningRequest</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
201 (<a href="">CertificateSigningRequest</a>): Created
401: Unauthorized
### `patch` partially update the specified CertificateSigningRequest
#### HTTP Request
PATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
201 (<a href="">CertificateSigningRequest</a>): Created
401: Unauthorized
### `patch` partially update approval of the specified CertificateSigningRequest
#### HTTP Request
PATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
201 (<a href="">CertificateSigningRequest</a>): Created
401: Unauthorized
### `patch` partially update status of the specified CertificateSigningRequest
#### HTTP Request
PATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CertificateSigningRequest</a>): OK
201 (<a href="">CertificateSigningRequest</a>): Created
401: Unauthorized
### `delete` delete a CertificateSigningRequest
#### HTTP Request
DELETE /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CertificateSigningRequest
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of CertificateSigningRequest
#### HTTP Request
DELETE /apis/certificates.k8s.io/v1/certificatesigningrequests
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion certificates k8s io v1 import k8s io api certificates v1 kind CertificateSigningRequest content type api reference description CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request and having it asynchronously approved and issued title CertificateSigningRequest weight 4 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 apiVersion certificates k8s io v1 import k8s io api certificates v1 CertificateSigningRequest CertificateSigningRequest CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request and having it asynchronously approved and issued Kubelets use this API to obtain 1 client certificates to authenticate to kube apiserver with the kubernetes io kube apiserver client kubelet signerName 2 serving certificates for TLS endpoints kube apiserver can connect to securely with the kubernetes io kubelet serving signerName This API can be used to request client certificates to authenticate to kube apiserver with the kubernetes io kube apiserver client signerName or to obtain certificates from custom non Kubernetes signers hr apiVersion certificates k8s io v1 kind CertificateSigningRequest metadata a href ObjectMeta a spec a href CertificateSigningRequestSpec a required spec contains the certificate request and is immutable after creation Only the request signerName expirationSeconds and usages fields can be set on creation Other fields are derived by Kubernetes and cannot be modified by users status a href CertificateSigningRequestStatus a status contains information about whether the request is approved or denied and the certificate issued by the signer or the failure condition indicating signer failure CertificateSigningRequestSpec CertificateSigningRequestSpec CertificateSigningRequestSpec contains the certificate request hr request byte required Atomic will be replaced during a merge request contains an x509 certificate signing request encoded in a CERTIFICATE REQUEST PEM block When serialized as JSON or YAML the data is additionally base64 encoded signerName string required signerName indicates the requested signer and is a qualified name List watch requests for CertificateSigningRequests can filter on this field using a spec signerName NAME fieldSelector Well known Kubernetes signers are 1 kubernetes io kube apiserver client issues client certificates that can be used to authenticate to kube apiserver Requests for this signer are never auto approved by kube controller manager can be issued by the csrsigning controller in kube controller manager 2 kubernetes io kube apiserver client kubelet issues client certificates that kubelets use to authenticate to kube apiserver Requests for this signer can be auto approved by the csrapproving controller in kube controller manager and can be issued by the csrsigning controller in kube controller manager 3 kubernetes io kubelet serving issues serving certificates that kubelets use to serve TLS endpoints which kube apiserver can connect to securely Requests for this signer are never auto approved by kube controller manager and can be issued by the csrsigning controller in kube controller manager More details are available at https k8s io docs reference access authn authz certificate signing requests kubernetes signers Custom signerNames can also be specified The signer defines 1 Trust distribution how trust CA bundles are distributed 2 Permitted subjects and behavior when a disallowed subject is requested 3 Required permitted or forbidden x509 extensions in the request including whether subjectAltNames are allowed which types restrictions on allowed values and behavior when a disallowed extension is requested 4 Required permitted or forbidden key usages extended key usages 5 Expiration certificate lifetime whether it is fixed by the signer configurable by the admin 6 Whether or not requests for CA certificates are allowed expirationSeconds int32 expirationSeconds is the requested duration of validity of the issued certificate The certificate signer may issue a certificate with a different validity duration so a client must check the delta between the notBefore and and notAfter fields in the issued certificate to determine the actual duration The v1 22 in tree implementations of the well known Kubernetes signers will honor this field as long as the requested duration is not greater than the maximum duration they will honor per the cluster signing duration CLI flag to the Kubernetes controller manager Certificate signers may not honor this field for various reasons 1 Old signer that is unaware of the field such as the in tree implementations prior to v1 22 2 Signer whose configured maximum is shorter than the requested duration 3 Signer whose configured minimum is longer than the requested duration The minimum valid value for expirationSeconds is 600 i e 10 minutes extra map string string extra contains extra attributes of the user that created the CertificateSigningRequest Populated by the API server on creation and immutable groups string Atomic will be replaced during a merge groups contains group membership of the user that created the CertificateSigningRequest Populated by the API server on creation and immutable uid string uid contains the uid of the user that created the CertificateSigningRequest Populated by the API server on creation and immutable usages string Atomic will be replaced during a merge usages specifies a set of key usages requested in the issued certificate Requests for TLS client certificates typically request digital signature key encipherment client auth Requests for TLS serving certificates typically request key encipherment digital signature server auth Valid values are signing digital signature content commitment key encipherment key agreement data encipherment cert sign crl sign encipher only decipher only any server auth client auth code signing email protection s mime ipsec end system ipsec tunnel ipsec user timestamping ocsp signing microsoft sgc netscape sgc username string username contains the name of the user that created the CertificateSigningRequest Populated by the API server on creation and immutable CertificateSigningRequestStatus CertificateSigningRequestStatus CertificateSigningRequestStatus contains conditions used to indicate approved denied failed status of the request and the issued certificate hr certificate byte Atomic will be replaced during a merge certificate is populated with an issued certificate by the signer after an Approved condition is present This field is set via the status subresource Once populated this field is immutable If the certificate signing request is denied a condition of type Denied is added and this field remains empty If the signer cannot issue the certificate a condition of type Failed is added and this field remains empty Validation requirements 1 certificate must contain one or more PEM blocks 2 All PEM blocks must have the CERTIFICATE label contain no headers and the encoded data must be a BER encoded ASN 1 Certificate structure as described in section 4 of RFC5280 3 Non PEM content may appear before or after the CERTIFICATE PEM blocks and is unvalidated to allow for explanatory text as described in section 5 2 of RFC7468 If more than one PEM block is present and the definition of the requested spec signerName does not indicate otherwise the first block is the issued certificate and subsequent blocks should be treated as intermediate certificates and presented in TLS handshakes The certificate is encoded in PEM format When serialized as JSON or YAML the data is additionally base64 encoded so it consists of base64 BEGIN CERTIFICATE END CERTIFICATE conditions CertificateSigningRequestCondition Map unique values on key type will be kept during a merge conditions applied to the request Known conditions are Approved Denied and Failed a name CertificateSigningRequestCondition a CertificateSigningRequestCondition describes a condition of a CertificateSigningRequest object conditions status string required status of the condition one of True False Unknown Approved Denied and Failed conditions may not be False or Unknown conditions type string required type of the condition Known conditions are Approved Denied and Failed An Approved condition is added via the approval subresource indicating the request was approved and should be issued by the signer A Denied condition is added via the approval subresource indicating the request was denied and should not be issued by the signer A Failed condition is added via the status subresource indicating the signer failed to issue the certificate Approved and Denied conditions are mutually exclusive Approved Denied and Failed conditions cannot be removed once added Only one condition of a given type is allowed conditions lastTransitionTime Time lastTransitionTime is the time the condition last transitioned from one status to another If unset when a new condition type is added or an existing condition s status is changed the server defaults this to the current time a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions lastUpdateTime Time lastUpdateTime is the time of the last update to this condition a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string message contains a human readable message with details about the request state conditions reason string reason indicates a brief reason for the request state CertificateSigningRequestList CertificateSigningRequestList CertificateSigningRequestList is a collection of CertificateSigningRequest objects hr apiVersion certificates k8s io v1 kind CertificateSigningRequestList metadata a href ListMeta a items a href CertificateSigningRequest a required items is a collection of CertificateSigningRequest objects Operations Operations hr get read the specified CertificateSigningRequest HTTP Request GET apis certificates k8s io v1 certificatesigningrequests name Parameters name in path string required name of the CertificateSigningRequest pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 401 Unauthorized get read approval of the specified CertificateSigningRequest HTTP Request GET apis certificates k8s io v1 certificatesigningrequests name approval Parameters name in path string required name of the CertificateSigningRequest pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 401 Unauthorized get read status of the specified CertificateSigningRequest HTTP Request GET apis certificates k8s io v1 certificatesigningrequests name status Parameters name in path string required name of the CertificateSigningRequest pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 401 Unauthorized list list or watch objects of kind CertificateSigningRequest HTTP Request GET apis certificates k8s io v1 certificatesigningrequests Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href CertificateSigningRequestList a OK 401 Unauthorized create create a CertificateSigningRequest HTTP Request POST apis certificates k8s io v1 certificatesigningrequests Parameters body a href CertificateSigningRequest a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 201 a href CertificateSigningRequest a Created 202 a href CertificateSigningRequest a Accepted 401 Unauthorized update replace the specified CertificateSigningRequest HTTP Request PUT apis certificates k8s io v1 certificatesigningrequests name Parameters name in path string required name of the CertificateSigningRequest body a href CertificateSigningRequest a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 201 a href CertificateSigningRequest a Created 401 Unauthorized update replace approval of the specified CertificateSigningRequest HTTP Request PUT apis certificates k8s io v1 certificatesigningrequests name approval Parameters name in path string required name of the CertificateSigningRequest body a href CertificateSigningRequest a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 201 a href CertificateSigningRequest a Created 401 Unauthorized update replace status of the specified CertificateSigningRequest HTTP Request PUT apis certificates k8s io v1 certificatesigningrequests name status Parameters name in path string required name of the CertificateSigningRequest body a href CertificateSigningRequest a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 201 a href CertificateSigningRequest a Created 401 Unauthorized patch partially update the specified CertificateSigningRequest HTTP Request PATCH apis certificates k8s io v1 certificatesigningrequests name Parameters name in path string required name of the CertificateSigningRequest body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 201 a href CertificateSigningRequest a Created 401 Unauthorized patch partially update approval of the specified CertificateSigningRequest HTTP Request PATCH apis certificates k8s io v1 certificatesigningrequests name approval Parameters name in path string required name of the CertificateSigningRequest body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 201 a href CertificateSigningRequest a Created 401 Unauthorized patch partially update status of the specified CertificateSigningRequest HTTP Request PATCH apis certificates k8s io v1 certificatesigningrequests name status Parameters name in path string required name of the CertificateSigningRequest body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CertificateSigningRequest a OK 201 a href CertificateSigningRequest a Created 401 Unauthorized delete delete a CertificateSigningRequest HTTP Request DELETE apis certificates k8s io v1 certificatesigningrequests name Parameters name in path string required name of the CertificateSigningRequest body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of CertificateSigningRequest HTTP Request DELETE apis certificates k8s io v1 certificatesigningrequests Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind SelfSubjectReview weight 6 contenttype apireference import k8s io api authentication v1 SelfSubjectReview contains the user information that the kube apiserver has about the user making this request apimetadata title SelfSubjectReview apiVersion authentication k8s io v1 autogenerated true | ---
api_metadata:
apiVersion: "authentication.k8s.io/v1"
import: "k8s.io/api/authentication/v1"
kind: "SelfSubjectReview"
content_type: "api_reference"
description: "SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request."
title: "SelfSubjectReview"
weight: 6
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.
-->
`apiVersion: authentication.k8s.io/v1`
`import "k8s.io/api/authentication/v1"`
## SelfSubjectReview {#SelfSubjectReview}
SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase.
<hr>
- **apiVersion**: authentication.k8s.io/v1
- **kind**: SelfSubjectReview
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **status** (<a href="">SelfSubjectReviewStatus</a>)
Status is filled in by the server with the user attributes.
## SelfSubjectReviewStatus {#SelfSubjectReviewStatus}
SelfSubjectReviewStatus is filled by the kube-apiserver and sent back to a user.
<hr>
- **userInfo** (UserInfo)
User attributes of the user making this request.
<a name="UserInfo"></a>
*UserInfo holds the information about the user needed to implement the user.Info interface.*
- **userInfo.extra** (map[string][]string)
Any additional information provided by the authenticator.
- **userInfo.groups** ([]string)
*Atomic: will be replaced during a merge*
The names of groups this user is a part of.
- **userInfo.uid** (string)
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
- **userInfo.username** (string)
The name that uniquely identifies this user among all active users.
## Operations {#Operations}
<hr>
### `create` create a SelfSubjectReview
#### HTTP Request
POST /apis/authentication.k8s.io/v1/selfsubjectreviews
#### Parameters
- **body**: <a href="">SelfSubjectReview</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">SelfSubjectReview</a>): OK
201 (<a href="">SelfSubjectReview</a>): Created
202 (<a href="">SelfSubjectReview</a>): Accepted
401: Unauthorized
| kubernetes reference | api metadata apiVersion authentication k8s io v1 import k8s io api authentication v1 kind SelfSubjectReview content type api reference description SelfSubjectReview contains the user information that the kube apiserver has about the user making this request title SelfSubjectReview weight 6 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 apiVersion authentication k8s io v1 import k8s io api authentication v1 SelfSubjectReview SelfSubjectReview SelfSubjectReview contains the user information that the kube apiserver has about the user making this request When using impersonation users will receive the user info of the user being impersonated If impersonation or request header authentication is used any extra keys will have their case ignored and returned as lowercase hr apiVersion authentication k8s io v1 kind SelfSubjectReview metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata status a href SelfSubjectReviewStatus a Status is filled in by the server with the user attributes SelfSubjectReviewStatus SelfSubjectReviewStatus SelfSubjectReviewStatus is filled by the kube apiserver and sent back to a user hr userInfo UserInfo User attributes of the user making this request a name UserInfo a UserInfo holds the information about the user needed to implement the user Info interface userInfo extra map string string Any additional information provided by the authenticator userInfo groups string Atomic will be replaced during a merge The names of groups this user is a part of userInfo uid string A unique value that identifies this user across time If this user is deleted and another user by the same name is added they will have different UIDs userInfo username string The name that uniquely identifies this user among all active users Operations Operations hr create create a SelfSubjectReview HTTP Request POST apis authentication k8s io v1 selfsubjectreviews Parameters body a href SelfSubjectReview a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href SelfSubjectReview a OK 201 a href SelfSubjectReview a Created 202 a href SelfSubjectReview a Accepted 401 Unauthorized |
kubernetes reference kind TokenReview contenttype apireference title TokenReview import k8s io api authentication v1 weight 3 apimetadata apiVersion authentication k8s io v1 TokenReview attempts to authenticate a token to a known user autogenerated true | ---
api_metadata:
apiVersion: "authentication.k8s.io/v1"
import: "k8s.io/api/authentication/v1"
kind: "TokenReview"
content_type: "api_reference"
description: "TokenReview attempts to authenticate a token to a known user."
title: "TokenReview"
weight: 3
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.
-->
`apiVersion: authentication.k8s.io/v1`
`import "k8s.io/api/authentication/v1"`
## TokenReview {#TokenReview}
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
<hr>
- **apiVersion**: authentication.k8s.io/v1
- **kind**: TokenReview
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">TokenReviewSpec</a>), required
Spec holds information about the request being evaluated
- **status** (<a href="">TokenReviewStatus</a>)
Status is filled in by the server and indicates whether the request can be authenticated.
## TokenReviewSpec {#TokenReviewSpec}
TokenReviewSpec is a description of the token authentication request.
<hr>
- **audiences** ([]string)
*Atomic: will be replaced during a merge*
Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver.
- **token** (string)
Token is the opaque bearer token.
## TokenReviewStatus {#TokenReviewStatus}
TokenReviewStatus is the result of the token authentication request.
<hr>
- **audiences** ([]string)
*Atomic: will be replaced during a merge*
Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server.
- **authenticated** (boolean)
Authenticated indicates that the token was associated with a known user.
- **error** (string)
Error indicates that the token couldn't be checked
- **user** (UserInfo)
User is the UserInfo associated with the provided token.
<a name="UserInfo"></a>
*UserInfo holds the information about the user needed to implement the user.Info interface.*
- **user.extra** (map[string][]string)
Any additional information provided by the authenticator.
- **user.groups** ([]string)
*Atomic: will be replaced during a merge*
The names of groups this user is a part of.
- **user.uid** (string)
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
- **user.username** (string)
The name that uniquely identifies this user among all active users.
## Operations {#Operations}
<hr>
### `create` create a TokenReview
#### HTTP Request
POST /apis/authentication.k8s.io/v1/tokenreviews
#### Parameters
- **body**: <a href="">TokenReview</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">TokenReview</a>): OK
201 (<a href="">TokenReview</a>): Created
202 (<a href="">TokenReview</a>): Accepted
401: Unauthorized
| kubernetes reference | api metadata apiVersion authentication k8s io v1 import k8s io api authentication v1 kind TokenReview content type api reference description TokenReview attempts to authenticate a token to a known user title TokenReview weight 3 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 apiVersion authentication k8s io v1 import k8s io api authentication v1 TokenReview TokenReview TokenReview attempts to authenticate a token to a known user Note TokenReview requests may be cached by the webhook token authenticator plugin in the kube apiserver hr apiVersion authentication k8s io v1 kind TokenReview metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href TokenReviewSpec a required Spec holds information about the request being evaluated status a href TokenReviewStatus a Status is filled in by the server and indicates whether the request can be authenticated TokenReviewSpec TokenReviewSpec TokenReviewSpec is a description of the token authentication request hr audiences string Atomic will be replaced during a merge Audiences is a list of the identifiers that the resource server presented with the token identifies as Audience aware token authenticators will verify that the token was intended for at least one of the audiences in this list If no audiences are provided the audience will default to the audience of the Kubernetes apiserver token string Token is the opaque bearer token TokenReviewStatus TokenReviewStatus TokenReviewStatus is the result of the token authentication request hr audiences string Atomic will be replaced during a merge Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token s audiences A client of the TokenReview API that sets the spec audiences field should validate that a compatible audience identifier is returned in the status audiences field to ensure that the TokenReview server is audience aware If a TokenReview returns an empty status audience field where status authenticated is true the token is valid against the audience of the Kubernetes API server authenticated boolean Authenticated indicates that the token was associated with a known user error string Error indicates that the token couldn t be checked user UserInfo User is the UserInfo associated with the provided token a name UserInfo a UserInfo holds the information about the user needed to implement the user Info interface user extra map string string Any additional information provided by the authenticator user groups string Atomic will be replaced during a merge The names of groups this user is a part of user uid string A unique value that identifies this user across time If this user is deleted and another user by the same name is added they will have different UIDs user username string The name that uniquely identifies this user among all active users Operations Operations hr create create a TokenReview HTTP Request POST apis authentication k8s io v1 tokenreviews Parameters body a href TokenReview a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href TokenReview a OK 201 a href TokenReview a Created 202 a href TokenReview a Accepted 401 Unauthorized |
kubernetes reference apiVersion node k8s io v1 title RuntimeClass RuntimeClass defines a class of container runtime supported in the cluster contenttype apireference kind RuntimeClass apimetadata autogenerated true weight 9 import k8s io api node v1 | ---
api_metadata:
apiVersion: "node.k8s.io/v1"
import: "k8s.io/api/node/v1"
kind: "RuntimeClass"
content_type: "api_reference"
description: "RuntimeClass defines a class of container runtime supported in the cluster."
title: "RuntimeClass"
weight: 9
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.
-->
`apiVersion: node.k8s.io/v1`
`import "k8s.io/api/node/v1"`
## RuntimeClass {#RuntimeClass}
RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/
<hr>
- **apiVersion**: node.k8s.io/v1
- **kind**: RuntimeClass
- **metadata** (<a href="">ObjectMeta</a>)
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **handler** (string), required
handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable.
- **overhead** (Overhead)
overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see
https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/
<a name="Overhead"></a>
*Overhead structure represents the resource overhead associated with running a pod.*
- **overhead.podFixed** (map[string]<a href="">Quantity</a>)
podFixed represents the fixed resource overhead associated with running a pod.
- **scheduling** (Scheduling)
scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes.
<a name="Scheduling"></a>
*Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass.*
- **scheduling.nodeSelector** (map[string]string)
nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission.
- **scheduling.tolerations** ([]Toleration)
*Atomic: will be replaced during a merge*
tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass.
<a name="Toleration"></a>
*The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.*
- **scheduling.tolerations.key** (string)
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
- **scheduling.tolerations.operator** (string)
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
- **scheduling.tolerations.value** (string)
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
- **scheduling.tolerations.effect** (string)
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- **scheduling.tolerations.tolerationSeconds** (int64)
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
## RuntimeClassList {#RuntimeClassList}
RuntimeClassList is a list of RuntimeClass objects.
<hr>
- **apiVersion**: node.k8s.io/v1
- **kind**: RuntimeClassList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">RuntimeClass</a>), required
items is a list of schema objects.
## Operations {#Operations}
<hr>
### `get` read the specified RuntimeClass
#### HTTP Request
GET /apis/node.k8s.io/v1/runtimeclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the RuntimeClass
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">RuntimeClass</a>): OK
401: Unauthorized
### `list` list or watch objects of kind RuntimeClass
#### HTTP Request
GET /apis/node.k8s.io/v1/runtimeclasses
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">RuntimeClassList</a>): OK
401: Unauthorized
### `create` create a RuntimeClass
#### HTTP Request
POST /apis/node.k8s.io/v1/runtimeclasses
#### Parameters
- **body**: <a href="">RuntimeClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">RuntimeClass</a>): OK
201 (<a href="">RuntimeClass</a>): Created
202 (<a href="">RuntimeClass</a>): Accepted
401: Unauthorized
### `update` replace the specified RuntimeClass
#### HTTP Request
PUT /apis/node.k8s.io/v1/runtimeclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the RuntimeClass
- **body**: <a href="">RuntimeClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">RuntimeClass</a>): OK
201 (<a href="">RuntimeClass</a>): Created
401: Unauthorized
### `patch` partially update the specified RuntimeClass
#### HTTP Request
PATCH /apis/node.k8s.io/v1/runtimeclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the RuntimeClass
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">RuntimeClass</a>): OK
201 (<a href="">RuntimeClass</a>): Created
401: Unauthorized
### `delete` delete a RuntimeClass
#### HTTP Request
DELETE /apis/node.k8s.io/v1/runtimeclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the RuntimeClass
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of RuntimeClass
#### HTTP Request
DELETE /apis/node.k8s.io/v1/runtimeclasses
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion node k8s io v1 import k8s io api node v1 kind RuntimeClass content type api reference description RuntimeClass defines a class of container runtime supported in the cluster title RuntimeClass weight 9 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 apiVersion node k8s io v1 import k8s io api node v1 RuntimeClass RuntimeClass RuntimeClass defines a class of container runtime supported in the cluster The RuntimeClass is used to determine which container runtime is used to run all containers in a pod RuntimeClasses are manually defined by a user or cluster provisioner and referenced in the PodSpec The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod For more details see https kubernetes io docs concepts containers runtime class hr apiVersion node k8s io v1 kind RuntimeClass metadata a href ObjectMeta a More info https git k8s io community contributors devel sig architecture api conventions md metadata handler string required handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class The possible values are specific to the node CRI configuration It is assumed that all handlers are available on every node and handlers of the same name are equivalent on every node For example a handler called runc might specify that the runc OCI runtime using native Linux containers will be used to run the containers in a pod The Handler must be lowercase conform to the DNS Label RFC 1123 requirements and is immutable overhead Overhead overhead represents the resource overhead associated with running a pod for a given RuntimeClass For more details see https kubernetes io docs concepts scheduling eviction pod overhead a name Overhead a Overhead structure represents the resource overhead associated with running a pod overhead podFixed map string a href Quantity a podFixed represents the fixed resource overhead associated with running a pod scheduling Scheduling scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it If scheduling is nil this RuntimeClass is assumed to be supported by all nodes a name Scheduling a Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass scheduling nodeSelector map string string nodeSelector lists labels that must be present on nodes that support this RuntimeClass Pods using this RuntimeClass can only be scheduled to a node matched by this selector The RuntimeClass nodeSelector is merged with a pod s existing nodeSelector Any conflicts will cause the pod to be rejected in admission scheduling tolerations Toleration Atomic will be replaced during a merge tolerations are appended excluding duplicates to pods running with this RuntimeClass during admission effectively unioning the set of nodes tolerated by the pod and the RuntimeClass a name Toleration a The pod this Toleration is attached to tolerates any taint that matches the triple key value effect using the matching operator operator scheduling tolerations key string Key is the taint key that the toleration applies to Empty means match all taint keys If the key is empty operator must be Exists this combination means to match all values and all keys scheduling tolerations operator string Operator represents a key s relationship to the value Valid operators are Exists and Equal Defaults to Equal Exists is equivalent to wildcard for value so that a pod can tolerate all taints of a particular category scheduling tolerations value string Value is the taint value the toleration matches to If the operator is Exists the value should be empty otherwise just a regular string scheduling tolerations effect string Effect indicates the taint effect to match Empty means match all taint effects When specified allowed values are NoSchedule PreferNoSchedule and NoExecute scheduling tolerations tolerationSeconds int64 TolerationSeconds represents the period of time the toleration which must be of effect NoExecute otherwise this field is ignored tolerates the taint By default it is not set which means tolerate the taint forever do not evict Zero and negative values will be treated as 0 evict immediately by the system RuntimeClassList RuntimeClassList RuntimeClassList is a list of RuntimeClass objects hr apiVersion node k8s io v1 kind RuntimeClassList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href RuntimeClass a required items is a list of schema objects Operations Operations hr get read the specified RuntimeClass HTTP Request GET apis node k8s io v1 runtimeclasses name Parameters name in path string required name of the RuntimeClass pretty in query string a href pretty a Response 200 a href RuntimeClass a OK 401 Unauthorized list list or watch objects of kind RuntimeClass HTTP Request GET apis node k8s io v1 runtimeclasses Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href RuntimeClassList a OK 401 Unauthorized create create a RuntimeClass HTTP Request POST apis node k8s io v1 runtimeclasses Parameters body a href RuntimeClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href RuntimeClass a OK 201 a href RuntimeClass a Created 202 a href RuntimeClass a Accepted 401 Unauthorized update replace the specified RuntimeClass HTTP Request PUT apis node k8s io v1 runtimeclasses name Parameters name in path string required name of the RuntimeClass body a href RuntimeClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href RuntimeClass a OK 201 a href RuntimeClass a Created 401 Unauthorized patch partially update the specified RuntimeClass HTTP Request PATCH apis node k8s io v1 runtimeclasses name Parameters name in path string required name of the RuntimeClass body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href RuntimeClass a OK 201 a href RuntimeClass a Created 401 Unauthorized delete delete a RuntimeClass HTTP Request DELETE apis node k8s io v1 runtimeclasses name Parameters name in path string required name of the RuntimeClass body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of RuntimeClass HTTP Request DELETE apis node k8s io v1 runtimeclasses Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title Node apiVersion v1 Node is a worker node in Kubernetes contenttype apireference weight 8 apimetadata kind Node autogenerated true import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "Node"
content_type: "api_reference"
description: "Node is a worker node in Kubernetes."
title: "Node"
weight: 8
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## Node {#Node}
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).
<hr>
- **apiVersion**: v1
- **kind**: Node
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">NodeSpec</a>)
Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">NodeStatus</a>)
Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## NodeSpec {#NodeSpec}
NodeSpec describes the attributes that a node is created with.
<hr>
- **configSource** (NodeConfigSource)
Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. This feature is removed.
<a name="NodeConfigSource"></a>
*NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22*
- **configSource.configMap** (ConfigMapNodeConfigSource)
ConfigMap is a reference to a Node's ConfigMap
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration*
- **configSource.configMap.kubeletConfigKey** (string), required
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
- **configSource.configMap.name** (string), required
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
- **configSource.configMap.namespace** (string), required
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
- **configSource.configMap.resourceVersion** (string)
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **configSource.configMap.uid** (string)
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **externalID** (string)
Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
- **podCIDR** (string)
PodCIDR represents the pod IP range assigned to the node.
- **podCIDRs** ([]string)
*Set: unique values will be kept during a merge*
podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6.
- **providerID** (string)
ID of the node assigned by the cloud provider in the format: \<ProviderName>://\<ProviderSpecificNodeID>
- **taints** ([]Taint)
*Atomic: will be replaced during a merge*
If specified, the node's taints.
<a name="Taint"></a>
*The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.*
- **taints.effect** (string), required
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
- **taints.key** (string), required
Required. The taint key to be applied to a node.
- **taints.timeAdded** (Time)
TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **taints.value** (string)
The taint value corresponding to the taint key.
- **unschedulable** (boolean)
Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration
## NodeStatus {#NodeStatus}
NodeStatus is information about the current status of a node.
<hr>
- **addresses** ([]NodeAddress)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP).
<a name="NodeAddress"></a>
*NodeAddress contains information for the node's address.*
- **addresses.address** (string), required
The node address.
- **addresses.type** (string), required
Node address type, one of Hostname, ExternalIP or InternalIP.
- **allocatable** (map[string]<a href="">Quantity</a>)
Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
- **capacity** (map[string]<a href="">Quantity</a>)
Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/reference/node/node-status/#capacity
- **conditions** ([]NodeCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
<a name="NodeCondition"></a>
*NodeCondition contains condition information for a node.*
- **conditions.status** (string), required
Status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
Type of node condition.
- **conditions.lastHeartbeatTime** (Time)
Last time we got an update on a given condition.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.lastTransitionTime** (Time)
Last time the condition transit from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
Human readable message indicating details about last transition.
- **conditions.reason** (string)
(brief) reason for the condition's last transition.
- **config** (NodeConfigStatus)
Status of the config assigned to the node via the dynamic Kubelet config feature.
<a name="NodeConfigStatus"></a>
*NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.*
- **config.active** (NodeConfigSource)
Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error.
<a name="NodeConfigSource"></a>
*NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22*
- **config.active.configMap** (ConfigMapNodeConfigSource)
ConfigMap is a reference to a Node's ConfigMap
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration*
- **config.active.configMap.kubeletConfigKey** (string), required
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
- **config.active.configMap.name** (string), required
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
- **config.active.configMap.namespace** (string), required
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
- **config.active.configMap.resourceVersion** (string)
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.active.configMap.uid** (string)
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.assigned** (NodeConfigSource)
Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned.
<a name="NodeConfigSource"></a>
*NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22*
- **config.assigned.configMap** (ConfigMapNodeConfigSource)
ConfigMap is a reference to a Node's ConfigMap
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration*
- **config.assigned.configMap.kubeletConfigKey** (string), required
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
- **config.assigned.configMap.name** (string), required
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
- **config.assigned.configMap.namespace** (string), required
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
- **config.assigned.configMap.resourceVersion** (string)
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.assigned.configMap.uid** (string)
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.error** (string)
Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions.
- **config.lastKnownGood** (NodeConfigSource)
LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node's method of determining config stability and correctness, as this may change or become configurable in the future.
<a name="NodeConfigSource"></a>
*NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22*
- **config.lastKnownGood.configMap** (ConfigMapNodeConfigSource)
ConfigMap is a reference to a Node's ConfigMap
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration*
- **config.lastKnownGood.configMap.kubeletConfigKey** (string), required
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
- **config.lastKnownGood.configMap.name** (string), required
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
- **config.lastKnownGood.configMap.namespace** (string), required
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
- **config.lastKnownGood.configMap.resourceVersion** (string)
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.lastKnownGood.configMap.uid** (string)
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **daemonEndpoints** (NodeDaemonEndpoints)
Endpoints of daemons running on the Node.
<a name="NodeDaemonEndpoints"></a>
*NodeDaemonEndpoints lists ports opened by daemons running on the Node.*
- **daemonEndpoints.kubeletEndpoint** (DaemonEndpoint)
Endpoint on which Kubelet is listening.
<a name="DaemonEndpoint"></a>
*DaemonEndpoint contains information about a single Daemon endpoint.*
- **daemonEndpoints.kubeletEndpoint.Port** (int32), required
Port number of the given endpoint.
- **features** (NodeFeatures)
Features describes the set of features implemented by the CRI implementation.
<a name="NodeFeatures"></a>
*NodeFeatures describes the set of features implemented by the CRI implementation. The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers.*
- **features.supplementalGroupsPolicy** (boolean)
SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser.
- **images** ([]ContainerImage)
*Atomic: will be replaced during a merge*
List of container images on this node
<a name="ContainerImage"></a>
*Describe a container image*
- **images.names** ([]string)
*Atomic: will be replaced during a merge*
Names by which this image is known. e.g. ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"]
- **images.sizeBytes** (int64)
The size of the image in bytes.
- **nodeInfo** (NodeSystemInfo)
Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info
<a name="NodeSystemInfo"></a>
*NodeSystemInfo is a set of ids/uuids to uniquely identify the node.*
- **nodeInfo.architecture** (string), required
The Architecture reported by the node
- **nodeInfo.bootID** (string), required
Boot ID reported by the node.
- **nodeInfo.containerRuntimeVersion** (string), required
ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).
- **nodeInfo.kernelVersion** (string), required
Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
- **nodeInfo.kubeProxyVersion** (string), required
Deprecated: KubeProxy Version reported by the node.
- **nodeInfo.kubeletVersion** (string), required
Kubelet Version reported by the node.
- **nodeInfo.machineID** (string), required
MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
- **nodeInfo.operatingSystem** (string), required
The Operating System reported by the node
- **nodeInfo.osImage** (string), required
OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
- **nodeInfo.systemUUID** (string), required
SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid
- **phase** (string)
NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
- **runtimeHandlers** ([]NodeRuntimeHandler)
*Atomic: will be replaced during a merge*
The available runtime handlers.
<a name="NodeRuntimeHandler"></a>
*NodeRuntimeHandler is a set of runtime handler information.*
- **runtimeHandlers.features** (NodeRuntimeHandlerFeatures)
Supported features.
<a name="NodeRuntimeHandlerFeatures"></a>
*NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.*
- **runtimeHandlers.features.recursiveReadOnlyMounts** (boolean)
RecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts.
- **runtimeHandlers.features.userNamespaces** (boolean)
UserNamespaces is set to true if the runtime handler supports UserNamespaces, including for volumes.
- **runtimeHandlers.name** (string)
Runtime handler name. Empty for the default runtime handler.
- **volumesAttached** ([]AttachedVolume)
*Atomic: will be replaced during a merge*
List of volumes that are attached to the node.
<a name="AttachedVolume"></a>
*AttachedVolume describes a volume attached to a node*
- **volumesAttached.devicePath** (string), required
DevicePath represents the device path where the volume should be available
- **volumesAttached.name** (string), required
Name of the attached volume
- **volumesInUse** ([]string)
*Atomic: will be replaced during a merge*
List of attachable volumes in use (mounted) by the node.
## NodeList {#NodeList}
NodeList is the whole list of all Nodes which have been registered with master.
<hr>
- **apiVersion**: v1
- **kind**: NodeList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">Node</a>), required
List of nodes
## Operations {#Operations}
<hr>
### `get` read the specified Node
#### HTTP Request
GET /api/v1/nodes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Node
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Node</a>): OK
401: Unauthorized
### `get` read status of the specified Node
#### HTTP Request
GET /api/v1/nodes/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Node
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Node</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Node
#### HTTP Request
GET /api/v1/nodes
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">NodeList</a>): OK
401: Unauthorized
### `create` create a Node
#### HTTP Request
POST /api/v1/nodes
#### Parameters
- **body**: <a href="">Node</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Node</a>): OK
201 (<a href="">Node</a>): Created
202 (<a href="">Node</a>): Accepted
401: Unauthorized
### `update` replace the specified Node
#### HTTP Request
PUT /api/v1/nodes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Node
- **body**: <a href="">Node</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Node</a>): OK
201 (<a href="">Node</a>): Created
401: Unauthorized
### `update` replace status of the specified Node
#### HTTP Request
PUT /api/v1/nodes/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Node
- **body**: <a href="">Node</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Node</a>): OK
201 (<a href="">Node</a>): Created
401: Unauthorized
### `patch` partially update the specified Node
#### HTTP Request
PATCH /api/v1/nodes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Node
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Node</a>): OK
201 (<a href="">Node</a>): Created
401: Unauthorized
### `patch` partially update status of the specified Node
#### HTTP Request
PATCH /api/v1/nodes/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Node
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Node</a>): OK
201 (<a href="">Node</a>): Created
401: Unauthorized
### `delete` delete a Node
#### HTTP Request
DELETE /api/v1/nodes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Node
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Node
#### HTTP Request
DELETE /api/v1/nodes
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind Node content type api reference description Node is a worker node in Kubernetes title Node weight 8 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 apiVersion v1 import k8s io api core v1 Node Node Node is a worker node in Kubernetes Each node will have a unique identifier in the cache i e in etcd hr apiVersion v1 kind Node metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href NodeSpec a Spec defines the behavior of a node https git k8s io community contributors devel sig architecture api conventions md spec and status status a href NodeStatus a Most recently observed status of the node Populated by the system Read only More info https git k8s io community contributors devel sig architecture api conventions md spec and status NodeSpec NodeSpec NodeSpec describes the attributes that a node is created with hr configSource NodeConfigSource Deprecated Previously used to specify the source of the node s configuration for the DynamicKubeletConfig feature This feature is removed a name NodeConfigSource a NodeConfigSource specifies a source of node configuration Exactly one subfield excluding metadata must be non nil This API is deprecated since 1 22 configSource configMap ConfigMapNodeConfigSource ConfigMap is a reference to a Node s ConfigMap a name ConfigMapNodeConfigSource a ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node This API is deprecated since 1 22 https git k8s io enhancements keps sig node 281 dynamic kubelet configuration configSource configMap kubeletConfigKey string required KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases configSource configMap name string required Name is the metadata name of the referenced ConfigMap This field is required in all cases configSource configMap namespace string required Namespace is the metadata namespace of the referenced ConfigMap This field is required in all cases configSource configMap resourceVersion string ResourceVersion is the metadata ResourceVersion of the referenced ConfigMap This field is forbidden in Node Spec and required in Node Status configSource configMap uid string UID is the metadata UID of the referenced ConfigMap This field is forbidden in Node Spec and required in Node Status externalID string Deprecated Not all kubelets will set this field Remove field after 1 13 see https issues k8s io 61966 podCIDR string PodCIDR represents the pod IP range assigned to the node podCIDRs string Set unique values will be kept during a merge podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node If this field is specified the 0th entry must match the podCIDR field It may contain at most 1 value for each of IPv4 and IPv6 providerID string ID of the node assigned by the cloud provider in the format ProviderName ProviderSpecificNodeID taints Taint Atomic will be replaced during a merge If specified the node s taints a name Taint a The node this Taint is attached to has the effect on any pod that does not tolerate the Taint taints effect string required Required The effect of the taint on pods that do not tolerate the taint Valid effects are NoSchedule PreferNoSchedule and NoExecute taints key string required Required The taint key to be applied to a node taints timeAdded Time TimeAdded represents the time at which the taint was added It is only written for NoExecute taints a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers taints value string The taint value corresponding to the taint key unschedulable boolean Unschedulable controls node schedulability of new pods By default node is schedulable More info https kubernetes io docs concepts nodes node manual node administration NodeStatus NodeStatus NodeStatus is information about the current status of a node hr addresses NodeAddress Patch strategy merge on key type Map unique values on key type will be kept during a merge List of addresses reachable to the node Queried from cloud provider if available More info https kubernetes io docs concepts nodes node addresses Note This field is declared as mergeable but the merge key is not sufficiently unique which can cause data corruption when it is merged Callers should instead use a full replacement patch See https pr k8s io 79391 for an example Consumers should assume that addresses can change during the lifetime of a Node However there are some exceptions where this may not be possible such as Pods that inherit a Node s address in its own status or consumers of the downward API status hostIP a name NodeAddress a NodeAddress contains information for the node s address addresses address string required The node address addresses type string required Node address type one of Hostname ExternalIP or InternalIP allocatable map string a href Quantity a Allocatable represents the resources of a node that are available for scheduling Defaults to Capacity capacity map string a href Quantity a Capacity represents the total resources of a node More info https kubernetes io docs reference node node status capacity conditions NodeCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge Conditions is an array of current observed node conditions More info https kubernetes io docs concepts nodes node condition a name NodeCondition a NodeCondition contains condition information for a node conditions status string required Status of the condition one of True False Unknown conditions type string required Type of node condition conditions lastHeartbeatTime Time Last time we got an update on a given condition a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions lastTransitionTime Time Last time the condition transit from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string Human readable message indicating details about last transition conditions reason string brief reason for the condition s last transition config NodeConfigStatus Status of the config assigned to the node via the dynamic Kubelet config feature a name NodeConfigStatus a NodeConfigStatus describes the status of the config assigned by Node Spec ConfigSource config active NodeConfigSource Active reports the checkpointed config the node is actively using Active will represent either the current version of the Assigned config or the current LastKnownGood config depending on whether attempting to use the Assigned config results in an error a name NodeConfigSource a NodeConfigSource specifies a source of node configuration Exactly one subfield excluding metadata must be non nil This API is deprecated since 1 22 config active configMap ConfigMapNodeConfigSource ConfigMap is a reference to a Node s ConfigMap a name ConfigMapNodeConfigSource a ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node This API is deprecated since 1 22 https git k8s io enhancements keps sig node 281 dynamic kubelet configuration config active configMap kubeletConfigKey string required KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases config active configMap name string required Name is the metadata name of the referenced ConfigMap This field is required in all cases config active configMap namespace string required Namespace is the metadata namespace of the referenced ConfigMap This field is required in all cases config active configMap resourceVersion string ResourceVersion is the metadata ResourceVersion of the referenced ConfigMap This field is forbidden in Node Spec and required in Node Status config active configMap uid string UID is the metadata UID of the referenced ConfigMap This field is forbidden in Node Spec and required in Node Status config assigned NodeConfigSource Assigned reports the checkpointed config the node will try to use When Node Spec ConfigSource is updated the node checkpoints the associated config payload to local disk along with a record indicating intended config The node refers to this record to choose its config checkpoint and reports this record in Assigned Assigned only updates in the status after the record has been checkpointed to disk When the Kubelet is restarted it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned a name NodeConfigSource a NodeConfigSource specifies a source of node configuration Exactly one subfield excluding metadata must be non nil This API is deprecated since 1 22 config assigned configMap ConfigMapNodeConfigSource ConfigMap is a reference to a Node s ConfigMap a name ConfigMapNodeConfigSource a ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node This API is deprecated since 1 22 https git k8s io enhancements keps sig node 281 dynamic kubelet configuration config assigned configMap kubeletConfigKey string required KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases config assigned configMap name string required Name is the metadata name of the referenced ConfigMap This field is required in all cases config assigned configMap namespace string required Namespace is the metadata namespace of the referenced ConfigMap This field is required in all cases config assigned configMap resourceVersion string ResourceVersion is the metadata ResourceVersion of the referenced ConfigMap This field is forbidden in Node Spec and required in Node Status config assigned configMap uid string UID is the metadata UID of the referenced ConfigMap This field is forbidden in Node Spec and required in Node Status config error string Error describes any problems reconciling the Spec ConfigSource to the Active config Errors may occur for example attempting to checkpoint Spec ConfigSource to the local Assigned record attempting to checkpoint the payload associated with Spec ConfigSource attempting to load or validate the Assigned config etc Errors may occur at different points while syncing config Earlier errors e g download or checkpointing errors will not result in a rollback to LastKnownGood and may resolve across Kubelet retries Later errors e g loading or validating a checkpointed config will result in a rollback to LastKnownGood In the latter case it is usually possible to resolve the error by fixing the config assigned in Spec ConfigSource You can find additional information for debugging by searching the error message in the Kubelet log Error is a human readable description of the error state machines can check whether or not Error is empty but should not rely on the stability of the Error text across Kubelet versions config lastKnownGood NodeConfigSource LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct This is currently implemented as a 10 minute soak period starting when the local record of Assigned config is updated If the Assigned config is Active at the end of this period it becomes the LastKnownGood Note that if Spec ConfigSource is reset to nil use local defaults the LastKnownGood is also immediately reset to nil because the local default config is always assumed good You should not make assumptions about the node s method of determining config stability and correctness as this may change or become configurable in the future a name NodeConfigSource a NodeConfigSource specifies a source of node configuration Exactly one subfield excluding metadata must be non nil This API is deprecated since 1 22 config lastKnownGood configMap ConfigMapNodeConfigSource ConfigMap is a reference to a Node s ConfigMap a name ConfigMapNodeConfigSource a ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node This API is deprecated since 1 22 https git k8s io enhancements keps sig node 281 dynamic kubelet configuration config lastKnownGood configMap kubeletConfigKey string required KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases config lastKnownGood configMap name string required Name is the metadata name of the referenced ConfigMap This field is required in all cases config lastKnownGood configMap namespace string required Namespace is the metadata namespace of the referenced ConfigMap This field is required in all cases config lastKnownGood configMap resourceVersion string ResourceVersion is the metadata ResourceVersion of the referenced ConfigMap This field is forbidden in Node Spec and required in Node Status config lastKnownGood configMap uid string UID is the metadata UID of the referenced ConfigMap This field is forbidden in Node Spec and required in Node Status daemonEndpoints NodeDaemonEndpoints Endpoints of daemons running on the Node a name NodeDaemonEndpoints a NodeDaemonEndpoints lists ports opened by daemons running on the Node daemonEndpoints kubeletEndpoint DaemonEndpoint Endpoint on which Kubelet is listening a name DaemonEndpoint a DaemonEndpoint contains information about a single Daemon endpoint daemonEndpoints kubeletEndpoint Port int32 required Port number of the given endpoint features NodeFeatures Features describes the set of features implemented by the CRI implementation a name NodeFeatures a NodeFeatures describes the set of features implemented by the CRI implementation The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers features supplementalGroupsPolicy boolean SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser images ContainerImage Atomic will be replaced during a merge List of container images on this node a name ContainerImage a Describe a container image images names string Atomic will be replaced during a merge Names by which this image is known e g kubernetes example hyperkube v1 0 7 cloud vendor registry example cloud vendor hyperkube v1 0 7 images sizeBytes int64 The size of the image in bytes nodeInfo NodeSystemInfo Set of ids uuids to uniquely identify the node More info https kubernetes io docs concepts nodes node info a name NodeSystemInfo a NodeSystemInfo is a set of ids uuids to uniquely identify the node nodeInfo architecture string required The Architecture reported by the node nodeInfo bootID string required Boot ID reported by the node nodeInfo containerRuntimeVersion string required ContainerRuntime Version reported by the node through runtime remote API e g containerd 1 4 2 nodeInfo kernelVersion string required Kernel Version reported by the node from uname r e g 3 16 0 0 bpo 4 amd64 nodeInfo kubeProxyVersion string required Deprecated KubeProxy Version reported by the node nodeInfo kubeletVersion string required Kubelet Version reported by the node nodeInfo machineID string required MachineID reported by the node For unique machine identification in the cluster this field is preferred Learn more from man 5 machine id http man7 org linux man pages man5 machine id 5 html nodeInfo operatingSystem string required The Operating System reported by the node nodeInfo osImage string required OS Image reported by the node from etc os release e g Debian GNU Linux 7 wheezy nodeInfo systemUUID string required SystemUUID reported by the node For unique machine identification MachineID is preferred This field is specific to Red Hat hosts https access redhat com documentation en us red hat subscription management 1 html rhsm uuid phase string NodePhase is the recently observed lifecycle phase of the node More info https kubernetes io docs concepts nodes node phase The field is never populated and now is deprecated runtimeHandlers NodeRuntimeHandler Atomic will be replaced during a merge The available runtime handlers a name NodeRuntimeHandler a NodeRuntimeHandler is a set of runtime handler information runtimeHandlers features NodeRuntimeHandlerFeatures Supported features a name NodeRuntimeHandlerFeatures a NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler runtimeHandlers features recursiveReadOnlyMounts boolean RecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts runtimeHandlers features userNamespaces boolean UserNamespaces is set to true if the runtime handler supports UserNamespaces including for volumes runtimeHandlers name string Runtime handler name Empty for the default runtime handler volumesAttached AttachedVolume Atomic will be replaced during a merge List of volumes that are attached to the node a name AttachedVolume a AttachedVolume describes a volume attached to a node volumesAttached devicePath string required DevicePath represents the device path where the volume should be available volumesAttached name string required Name of the attached volume volumesInUse string Atomic will be replaced during a merge List of attachable volumes in use mounted by the node NodeList NodeList NodeList is the whole list of all Nodes which have been registered with master hr apiVersion v1 kind NodeList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href Node a required List of nodes Operations Operations hr get read the specified Node HTTP Request GET api v1 nodes name Parameters name in path string required name of the Node pretty in query string a href pretty a Response 200 a href Node a OK 401 Unauthorized get read status of the specified Node HTTP Request GET api v1 nodes name status Parameters name in path string required name of the Node pretty in query string a href pretty a Response 200 a href Node a OK 401 Unauthorized list list or watch objects of kind Node HTTP Request GET api v1 nodes Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href NodeList a OK 401 Unauthorized create create a Node HTTP Request POST api v1 nodes Parameters body a href Node a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Node a OK 201 a href Node a Created 202 a href Node a Accepted 401 Unauthorized update replace the specified Node HTTP Request PUT api v1 nodes name Parameters name in path string required name of the Node body a href Node a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Node a OK 201 a href Node a Created 401 Unauthorized update replace status of the specified Node HTTP Request PUT api v1 nodes name status Parameters name in path string required name of the Node body a href Node a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Node a OK 201 a href Node a Created 401 Unauthorized patch partially update the specified Node HTTP Request PATCH api v1 nodes name Parameters name in path string required name of the Node body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Node a OK 201 a href Node a Created 401 Unauthorized patch partially update status of the specified Node HTTP Request PATCH api v1 nodes name status Parameters name in path string required name of the Node body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Node a OK 201 a href Node a Created 401 Unauthorized delete delete a Node HTTP Request DELETE api v1 nodes name Parameters name in path string required name of the Node body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of Node HTTP Request DELETE api v1 nodes Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference weight 7 apiVersion v1 contenttype apireference title Namespace apimetadata kind Namespace autogenerated true Namespace provides a scope for Names import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "Namespace"
content_type: "api_reference"
description: "Namespace provides a scope for Names."
title: "Namespace"
weight: 7
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## Namespace {#Namespace}
Namespace provides a scope for Names. Use of multiple namespaces is optional.
<hr>
- **apiVersion**: v1
- **kind**: Namespace
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">NamespaceSpec</a>)
Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">NamespaceStatus</a>)
Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## NamespaceSpec {#NamespaceSpec}
NamespaceSpec describes the attributes on a Namespace.
<hr>
- **finalizers** ([]string)
*Atomic: will be replaced during a merge*
Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
## NamespaceStatus {#NamespaceStatus}
NamespaceStatus is information about the current status of a Namespace.
<hr>
- **conditions** ([]NamespaceCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Represents the latest available observations of a namespace's current state.
<a name="NamespaceCondition"></a>
*NamespaceCondition contains details about state of namespace.*
- **conditions.status** (string), required
Status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
Type of namespace controller condition.
- **conditions.lastTransitionTime** (Time)
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
- **conditions.reason** (string)
- **phase** (string)
Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
## NamespaceList {#NamespaceList}
NamespaceList is a list of Namespaces.
<hr>
- **apiVersion**: v1
- **kind**: NamespaceList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">Namespace</a>), required
Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
## Operations {#Operations}
<hr>
### `get` read the specified Namespace
#### HTTP Request
GET /api/v1/namespaces/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Namespace
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Namespace</a>): OK
401: Unauthorized
### `get` read status of the specified Namespace
#### HTTP Request
GET /api/v1/namespaces/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Namespace
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Namespace</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Namespace
#### HTTP Request
GET /api/v1/namespaces
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">NamespaceList</a>): OK
401: Unauthorized
### `create` create a Namespace
#### HTTP Request
POST /api/v1/namespaces
#### Parameters
- **body**: <a href="">Namespace</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Namespace</a>): OK
201 (<a href="">Namespace</a>): Created
202 (<a href="">Namespace</a>): Accepted
401: Unauthorized
### `update` replace the specified Namespace
#### HTTP Request
PUT /api/v1/namespaces/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Namespace
- **body**: <a href="">Namespace</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Namespace</a>): OK
201 (<a href="">Namespace</a>): Created
401: Unauthorized
### `update` replace finalize of the specified Namespace
#### HTTP Request
PUT /api/v1/namespaces/{name}/finalize
#### Parameters
- **name** (*in path*): string, required
name of the Namespace
- **body**: <a href="">Namespace</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Namespace</a>): OK
201 (<a href="">Namespace</a>): Created
401: Unauthorized
### `update` replace status of the specified Namespace
#### HTTP Request
PUT /api/v1/namespaces/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Namespace
- **body**: <a href="">Namespace</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Namespace</a>): OK
201 (<a href="">Namespace</a>): Created
401: Unauthorized
### `patch` partially update the specified Namespace
#### HTTP Request
PATCH /api/v1/namespaces/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Namespace
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Namespace</a>): OK
201 (<a href="">Namespace</a>): Created
401: Unauthorized
### `patch` partially update status of the specified Namespace
#### HTTP Request
PATCH /api/v1/namespaces/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Namespace
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Namespace</a>): OK
201 (<a href="">Namespace</a>): Created
401: Unauthorized
### `delete` delete a Namespace
#### HTTP Request
DELETE /api/v1/namespaces/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Namespace
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind Namespace content type api reference description Namespace provides a scope for Names title Namespace weight 7 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 apiVersion v1 import k8s io api core v1 Namespace Namespace Namespace provides a scope for Names Use of multiple namespaces is optional hr apiVersion v1 kind Namespace metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href NamespaceSpec a Spec defines the behavior of the Namespace More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href NamespaceStatus a Status describes the current status of a Namespace More info https git k8s io community contributors devel sig architecture api conventions md spec and status NamespaceSpec NamespaceSpec NamespaceSpec describes the attributes on a Namespace hr finalizers string Atomic will be replaced during a merge Finalizers is an opaque list of values that must be empty to permanently remove object from storage More info https kubernetes io docs tasks administer cluster namespaces NamespaceStatus NamespaceStatus NamespaceStatus is information about the current status of a Namespace hr conditions NamespaceCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge Represents the latest available observations of a namespace s current state a name NamespaceCondition a NamespaceCondition contains details about state of namespace conditions status string required Status of the condition one of True False Unknown conditions type string required Type of namespace controller condition conditions lastTransitionTime Time a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string conditions reason string phase string Phase is the current lifecycle phase of the namespace More info https kubernetes io docs tasks administer cluster namespaces NamespaceList NamespaceList NamespaceList is a list of Namespaces hr apiVersion v1 kind NamespaceList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href Namespace a required Items is the list of Namespace objects in the list More info https kubernetes io docs concepts overview working with objects namespaces Operations Operations hr get read the specified Namespace HTTP Request GET api v1 namespaces name Parameters name in path string required name of the Namespace pretty in query string a href pretty a Response 200 a href Namespace a OK 401 Unauthorized get read status of the specified Namespace HTTP Request GET api v1 namespaces name status Parameters name in path string required name of the Namespace pretty in query string a href pretty a Response 200 a href Namespace a OK 401 Unauthorized list list or watch objects of kind Namespace HTTP Request GET api v1 namespaces Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href NamespaceList a OK 401 Unauthorized create create a Namespace HTTP Request POST api v1 namespaces Parameters body a href Namespace a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Namespace a OK 201 a href Namespace a Created 202 a href Namespace a Accepted 401 Unauthorized update replace the specified Namespace HTTP Request PUT api v1 namespaces name Parameters name in path string required name of the Namespace body a href Namespace a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Namespace a OK 201 a href Namespace a Created 401 Unauthorized update replace finalize of the specified Namespace HTTP Request PUT api v1 namespaces name finalize Parameters name in path string required name of the Namespace body a href Namespace a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Namespace a OK 201 a href Namespace a Created 401 Unauthorized update replace status of the specified Namespace HTTP Request PUT api v1 namespaces name status Parameters name in path string required name of the Namespace body a href Namespace a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Namespace a OK 201 a href Namespace a Created 401 Unauthorized patch partially update the specified Namespace HTTP Request PATCH api v1 namespaces name Parameters name in path string required name of the Namespace body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Namespace a OK 201 a href Namespace a Created 401 Unauthorized patch partially update status of the specified Namespace HTTP Request PATCH api v1 namespaces name status Parameters name in path string required name of the Namespace body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Namespace a OK 201 a href Namespace a Created 401 Unauthorized delete delete a Namespace HTTP Request DELETE api v1 namespaces name Parameters name in path string required name of the Namespace body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized |
kubernetes reference import k8s io api networking v1beta1 IPAddress represents a single IP of a single IP Family contenttype apireference title IPAddress v1beta1 apiVersion networking k8s io v1beta1 apimetadata kind IPAddress weight 4 autogenerated true | ---
api_metadata:
apiVersion: "networking.k8s.io/v1beta1"
import: "k8s.io/api/networking/v1beta1"
kind: "IPAddress"
content_type: "api_reference"
description: "IPAddress represents a single IP of a single IP Family."
title: "IPAddress v1beta1"
weight: 4
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.
-->
`apiVersion: networking.k8s.io/v1beta1`
`import "k8s.io/api/networking/v1beta1"`
## IPAddress {#IPAddress}
IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1
<hr>
- **apiVersion**: networking.k8s.io/v1beta1
- **kind**: IPAddress
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">IPAddressSpec</a>)
spec is the desired state of the IPAddress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## IPAddressSpec {#IPAddressSpec}
IPAddressSpec describe the attributes in an IP Address.
<hr>
- **parentRef** (ParentReference), required
ParentRef references the resource that an IPAddress is attached to. An IPAddress must reference a parent object.
<a name="ParentReference"></a>
*ParentReference describes a reference to a parent object.*
- **parentRef.name** (string), required
Name is the name of the object being referenced.
- **parentRef.resource** (string), required
Resource is the resource of the object being referenced.
- **parentRef.group** (string)
Group is the group of the object being referenced.
- **parentRef.namespace** (string)
Namespace is the namespace of the object being referenced.
## IPAddressList {#IPAddressList}
IPAddressList contains a list of IPAddress.
<hr>
- **apiVersion**: networking.k8s.io/v1beta1
- **kind**: IPAddressList
- **metadata** (<a href="">ListMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">IPAddress</a>), required
items is the list of IPAddresses.
## Operations {#Operations}
<hr>
### `get` read the specified IPAddress
#### HTTP Request
GET /apis/networking.k8s.io/v1beta1/ipaddresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IPAddress
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">IPAddress</a>): OK
401: Unauthorized
### `list` list or watch objects of kind IPAddress
#### HTTP Request
GET /apis/networking.k8s.io/v1beta1/ipaddresses
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">IPAddressList</a>): OK
401: Unauthorized
### `create` create an IPAddress
#### HTTP Request
POST /apis/networking.k8s.io/v1beta1/ipaddresses
#### Parameters
- **body**: <a href="">IPAddress</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">IPAddress</a>): OK
201 (<a href="">IPAddress</a>): Created
202 (<a href="">IPAddress</a>): Accepted
401: Unauthorized
### `update` replace the specified IPAddress
#### HTTP Request
PUT /apis/networking.k8s.io/v1beta1/ipaddresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IPAddress
- **body**: <a href="">IPAddress</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">IPAddress</a>): OK
201 (<a href="">IPAddress</a>): Created
401: Unauthorized
### `patch` partially update the specified IPAddress
#### HTTP Request
PATCH /apis/networking.k8s.io/v1beta1/ipaddresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IPAddress
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">IPAddress</a>): OK
201 (<a href="">IPAddress</a>): Created
401: Unauthorized
### `delete` delete an IPAddress
#### HTTP Request
DELETE /apis/networking.k8s.io/v1beta1/ipaddresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IPAddress
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of IPAddress
#### HTTP Request
DELETE /apis/networking.k8s.io/v1beta1/ipaddresses
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion networking k8s io v1beta1 import k8s io api networking v1beta1 kind IPAddress content type api reference description IPAddress represents a single IP of a single IP Family title IPAddress v1beta1 weight 4 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 apiVersion networking k8s io v1beta1 import k8s io api networking v1beta1 IPAddress IPAddress IPAddress represents a single IP of a single IP Family The object is designed to be used by APIs that operate on IP addresses The object is used by the Service core API for allocation of IP addresses An IP address can be represented in different formats to guarantee the uniqueness of the IP the name of the object is the IP address in canonical format four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6 Valid 192 168 1 5 or 2001 db8 1 or 2001 db8 aaaa bbbb cccc dddd eeee 1 Invalid 10 01 2 3 or 2001 db8 0 0 0 1 hr apiVersion networking k8s io v1beta1 kind IPAddress metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href IPAddressSpec a spec is the desired state of the IPAddress More info https git k8s io community contributors devel sig architecture api conventions md spec and status IPAddressSpec IPAddressSpec IPAddressSpec describe the attributes in an IP Address hr parentRef ParentReference required ParentRef references the resource that an IPAddress is attached to An IPAddress must reference a parent object a name ParentReference a ParentReference describes a reference to a parent object parentRef name string required Name is the name of the object being referenced parentRef resource string required Resource is the resource of the object being referenced parentRef group string Group is the group of the object being referenced parentRef namespace string Namespace is the namespace of the object being referenced IPAddressList IPAddressList IPAddressList contains a list of IPAddress hr apiVersion networking k8s io v1beta1 kind IPAddressList metadata a href ListMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href IPAddress a required items is the list of IPAddresses Operations Operations hr get read the specified IPAddress HTTP Request GET apis networking k8s io v1beta1 ipaddresses name Parameters name in path string required name of the IPAddress pretty in query string a href pretty a Response 200 a href IPAddress a OK 401 Unauthorized list list or watch objects of kind IPAddress HTTP Request GET apis networking k8s io v1beta1 ipaddresses Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href IPAddressList a OK 401 Unauthorized create create an IPAddress HTTP Request POST apis networking k8s io v1beta1 ipaddresses Parameters body a href IPAddress a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href IPAddress a OK 201 a href IPAddress a Created 202 a href IPAddress a Accepted 401 Unauthorized update replace the specified IPAddress HTTP Request PUT apis networking k8s io v1beta1 ipaddresses name Parameters name in path string required name of the IPAddress body a href IPAddress a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href IPAddress a OK 201 a href IPAddress a Created 401 Unauthorized patch partially update the specified IPAddress HTTP Request PATCH apis networking k8s io v1beta1 ipaddresses name Parameters name in path string required name of the IPAddress body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href IPAddress a OK 201 a href IPAddress a Created 401 Unauthorized delete delete an IPAddress HTTP Request DELETE apis networking k8s io v1beta1 ipaddresses name Parameters name in path string required name of the IPAddress body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of IPAddress HTTP Request DELETE apis networking k8s io v1beta1 ipaddresses Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference weight 6 apiVersion coordination k8s io v1alpha1 contenttype apireference import k8s io api coordination v1alpha1 kind LeaseCandidate apimetadata LeaseCandidate defines a candidate for a Lease object title LeaseCandidate v1alpha1 autogenerated true | ---
api_metadata:
apiVersion: "coordination.k8s.io/v1alpha1"
import: "k8s.io/api/coordination/v1alpha1"
kind: "LeaseCandidate"
content_type: "api_reference"
description: "LeaseCandidate defines a candidate for a Lease object."
title: "LeaseCandidate v1alpha1"
weight: 6
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.
-->
`apiVersion: coordination.k8s.io/v1alpha1`
`import "k8s.io/api/coordination/v1alpha1"`
## LeaseCandidate {#LeaseCandidate}
LeaseCandidate defines a candidate for a Lease object. Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.
<hr>
- **apiVersion**: coordination.k8s.io/v1alpha1
- **kind**: LeaseCandidate
- **metadata** (<a href="">ObjectMeta</a>)
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">LeaseCandidateSpec</a>)
spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## LeaseCandidateSpec {#LeaseCandidateSpec}
LeaseCandidateSpec is a specification of a Lease.
<hr>
- **leaseName** (string), required
LeaseName is the name of the lease for which this candidate is contending. This field is immutable.
- **preferredStrategies** ([]string), required
*Atomic: will be replaced during a merge*
PreferredStrategies indicates the list of strategies for picking the leader for coordinated leader election. The list is ordered, and the first strategy supersedes all other strategies. The list is used by coordinated leader election to make a decision about the final election strategy. This follows as - If all clients have strategy X as the first element in this list, strategy X will be used. - If a candidate has strategy [X] and another candidate has strategy [Y, X], Y supersedes X and strategy Y
will be used.
- If a candidate has strategy [X, Y] and another candidate has strategy [Y, X], this is a user error and leader
election will not operate the Lease until resolved.
(Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled.
- **binaryVersion** (string)
BinaryVersion is the binary version. It must be in a semver format without leading `v`. This field is required when strategy is "OldestEmulationVersion"
- **emulationVersion** (string)
EmulationVersion is the emulation version. It must be in a semver format without leading `v`. EmulationVersion must be less than or equal to BinaryVersion. This field is required when strategy is "OldestEmulationVersion"
- **pingTime** (MicroTime)
PingTime is the last time that the server has requested the LeaseCandidate to renew. It is only done during leader election to check if any LeaseCandidates have become ineligible. When PingTime is updated, the LeaseCandidate will respond by updating RenewTime.
<a name="MicroTime"></a>
*MicroTime is version of Time with microsecond level precision.*
- **renewTime** (MicroTime)
RenewTime is the time that the LeaseCandidate was last updated. Any time a Lease needs to do leader election, the PingTime field is updated to signal to the LeaseCandidate that they should update the RenewTime. Old LeaseCandidate objects are also garbage collected if it has been hours since the last renew. The PingTime field is updated regularly to prevent garbage collection for still active LeaseCandidates.
<a name="MicroTime"></a>
*MicroTime is version of Time with microsecond level precision.*
## LeaseCandidateList {#LeaseCandidateList}
LeaseCandidateList is a list of Lease objects.
<hr>
- **apiVersion**: coordination.k8s.io/v1alpha1
- **kind**: LeaseCandidateList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">LeaseCandidate</a>), required
items is a list of schema objects.
## Operations {#Operations}
<hr>
### `get` read the specified LeaseCandidate
#### HTTP Request
GET /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the LeaseCandidate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">LeaseCandidate</a>): OK
401: Unauthorized
### `list` list or watch objects of kind LeaseCandidate
#### HTTP Request
GET /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">LeaseCandidateList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind LeaseCandidate
#### HTTP Request
GET /apis/coordination.k8s.io/v1alpha1/leasecandidates
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">LeaseCandidateList</a>): OK
401: Unauthorized
### `create` create a LeaseCandidate
#### HTTP Request
POST /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">LeaseCandidate</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">LeaseCandidate</a>): OK
201 (<a href="">LeaseCandidate</a>): Created
202 (<a href="">LeaseCandidate</a>): Accepted
401: Unauthorized
### `update` replace the specified LeaseCandidate
#### HTTP Request
PUT /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the LeaseCandidate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">LeaseCandidate</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">LeaseCandidate</a>): OK
201 (<a href="">LeaseCandidate</a>): Created
401: Unauthorized
### `patch` partially update the specified LeaseCandidate
#### HTTP Request
PATCH /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the LeaseCandidate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">LeaseCandidate</a>): OK
201 (<a href="">LeaseCandidate</a>): Created
401: Unauthorized
### `delete` delete a LeaseCandidate
#### HTTP Request
DELETE /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name}
#### Parameters
- **name** (*in path*): string, required
name of the LeaseCandidate
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of LeaseCandidate
#### HTTP Request
DELETE /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion coordination k8s io v1alpha1 import k8s io api coordination v1alpha1 kind LeaseCandidate content type api reference description LeaseCandidate defines a candidate for a Lease object title LeaseCandidate v1alpha1 weight 6 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 apiVersion coordination k8s io v1alpha1 import k8s io api coordination v1alpha1 LeaseCandidate LeaseCandidate LeaseCandidate defines a candidate for a Lease object Candidates are created such that coordinated leader election will pick the best leader from the list of candidates hr apiVersion coordination k8s io v1alpha1 kind LeaseCandidate metadata a href ObjectMeta a More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href LeaseCandidateSpec a spec contains the specification of the Lease More info https git k8s io community contributors devel sig architecture api conventions md spec and status LeaseCandidateSpec LeaseCandidateSpec LeaseCandidateSpec is a specification of a Lease hr leaseName string required LeaseName is the name of the lease for which this candidate is contending This field is immutable preferredStrategies string required Atomic will be replaced during a merge PreferredStrategies indicates the list of strategies for picking the leader for coordinated leader election The list is ordered and the first strategy supersedes all other strategies The list is used by coordinated leader election to make a decision about the final election strategy This follows as If all clients have strategy X as the first element in this list strategy X will be used If a candidate has strategy X and another candidate has strategy Y X Y supersedes X and strategy Y will be used If a candidate has strategy X Y and another candidate has strategy Y X this is a user error and leader election will not operate the Lease until resolved Alpha Using this field requires the CoordinatedLeaderElection feature gate to be enabled binaryVersion string BinaryVersion is the binary version It must be in a semver format without leading v This field is required when strategy is OldestEmulationVersion emulationVersion string EmulationVersion is the emulation version It must be in a semver format without leading v EmulationVersion must be less than or equal to BinaryVersion This field is required when strategy is OldestEmulationVersion pingTime MicroTime PingTime is the last time that the server has requested the LeaseCandidate to renew It is only done during leader election to check if any LeaseCandidates have become ineligible When PingTime is updated the LeaseCandidate will respond by updating RenewTime a name MicroTime a MicroTime is version of Time with microsecond level precision renewTime MicroTime RenewTime is the time that the LeaseCandidate was last updated Any time a Lease needs to do leader election the PingTime field is updated to signal to the LeaseCandidate that they should update the RenewTime Old LeaseCandidate objects are also garbage collected if it has been hours since the last renew The PingTime field is updated regularly to prevent garbage collection for still active LeaseCandidates a name MicroTime a MicroTime is version of Time with microsecond level precision LeaseCandidateList LeaseCandidateList LeaseCandidateList is a list of Lease objects hr apiVersion coordination k8s io v1alpha1 kind LeaseCandidateList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href LeaseCandidate a required items is a list of schema objects Operations Operations hr get read the specified LeaseCandidate HTTP Request GET apis coordination k8s io v1alpha1 namespaces namespace leasecandidates name Parameters name in path string required name of the LeaseCandidate namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href LeaseCandidate a OK 401 Unauthorized list list or watch objects of kind LeaseCandidate HTTP Request GET apis coordination k8s io v1alpha1 namespaces namespace leasecandidates Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href LeaseCandidateList a OK 401 Unauthorized list list or watch objects of kind LeaseCandidate HTTP Request GET apis coordination k8s io v1alpha1 leasecandidates Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href LeaseCandidateList a OK 401 Unauthorized create create a LeaseCandidate HTTP Request POST apis coordination k8s io v1alpha1 namespaces namespace leasecandidates Parameters namespace in path string required a href namespace a body a href LeaseCandidate a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href LeaseCandidate a OK 201 a href LeaseCandidate a Created 202 a href LeaseCandidate a Accepted 401 Unauthorized update replace the specified LeaseCandidate HTTP Request PUT apis coordination k8s io v1alpha1 namespaces namespace leasecandidates name Parameters name in path string required name of the LeaseCandidate namespace in path string required a href namespace a body a href LeaseCandidate a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href LeaseCandidate a OK 201 a href LeaseCandidate a Created 401 Unauthorized patch partially update the specified LeaseCandidate HTTP Request PATCH apis coordination k8s io v1alpha1 namespaces namespace leasecandidates name Parameters name in path string required name of the LeaseCandidate namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href LeaseCandidate a OK 201 a href LeaseCandidate a Created 401 Unauthorized delete delete a LeaseCandidate HTTP Request DELETE apis coordination k8s io v1alpha1 namespaces namespace leasecandidates name Parameters name in path string required name of the LeaseCandidate namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of LeaseCandidate HTTP Request DELETE apis coordination k8s io v1alpha1 namespaces namespace leasecandidates Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title ServiceCIDR v1beta1 kind ServiceCIDR import k8s io api networking v1beta1 contenttype apireference apiVersion networking k8s io v1beta1 weight 10 ServiceCIDR defines a range of IP addresses using CIDR format e apimetadata autogenerated true | ---
api_metadata:
apiVersion: "networking.k8s.io/v1beta1"
import: "k8s.io/api/networking/v1beta1"
kind: "ServiceCIDR"
content_type: "api_reference"
description: "ServiceCIDR defines a range of IP addresses using CIDR format (e."
title: "ServiceCIDR v1beta1"
weight: 10
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.
-->
`apiVersion: networking.k8s.io/v1beta1`
`import "k8s.io/api/networking/v1beta1"`
## ServiceCIDR {#ServiceCIDR}
ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64). This range is used to allocate ClusterIPs to Service objects.
<hr>
- **apiVersion**: networking.k8s.io/v1beta1
- **kind**: ServiceCIDR
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">ServiceCIDRSpec</a>)
spec is the desired state of the ServiceCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">ServiceCIDRStatus</a>)
status represents the current state of the ServiceCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## ServiceCIDRSpec {#ServiceCIDRSpec}
ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services.
<hr>
- **cidrs** ([]string)
*Atomic: will be replaced during a merge*
CIDRs defines the IP blocks in CIDR notation (e.g. "192.168.0.0/24" or "2001:db8::/64") from which to assign service cluster IPs. Max of two CIDRs is allowed, one of each IP family. This field is immutable.
## ServiceCIDRStatus {#ServiceCIDRStatus}
ServiceCIDRStatus describes the current state of the ServiceCIDR.
<hr>
- **conditions** ([]Condition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
conditions holds an array of metav1.Condition that describe the state of the ServiceCIDR. Current service state
<a name="Condition"></a>
*Condition contains details for one aspect of the current state of this API Resource.*
- **conditions.lastTransitionTime** (Time), required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string), required
message is a human readable message indicating details about the transition. This may be an empty string.
- **conditions.reason** (string), required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
- **conditions.status** (string), required
status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
type of condition in CamelCase or in foo.example.com/CamelCase.
- **conditions.observedGeneration** (int64)
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
## ServiceCIDRList {#ServiceCIDRList}
ServiceCIDRList contains a list of ServiceCIDR objects.
<hr>
- **apiVersion**: networking.k8s.io/v1beta1
- **kind**: ServiceCIDRList
- **metadata** (<a href="">ListMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">ServiceCIDR</a>), required
items is the list of ServiceCIDRs.
## Operations {#Operations}
<hr>
### `get` read the specified ServiceCIDR
#### HTTP Request
GET /apis/networking.k8s.io/v1beta1/servicecidrs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ServiceCIDR
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceCIDR</a>): OK
401: Unauthorized
### `get` read status of the specified ServiceCIDR
#### HTTP Request
GET /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ServiceCIDR
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceCIDR</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ServiceCIDR
#### HTTP Request
GET /apis/networking.k8s.io/v1beta1/servicecidrs
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ServiceCIDRList</a>): OK
401: Unauthorized
### `create` create a ServiceCIDR
#### HTTP Request
POST /apis/networking.k8s.io/v1beta1/servicecidrs
#### Parameters
- **body**: <a href="">ServiceCIDR</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceCIDR</a>): OK
201 (<a href="">ServiceCIDR</a>): Created
202 (<a href="">ServiceCIDR</a>): Accepted
401: Unauthorized
### `update` replace the specified ServiceCIDR
#### HTTP Request
PUT /apis/networking.k8s.io/v1beta1/servicecidrs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ServiceCIDR
- **body**: <a href="">ServiceCIDR</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceCIDR</a>): OK
201 (<a href="">ServiceCIDR</a>): Created
401: Unauthorized
### `update` replace status of the specified ServiceCIDR
#### HTTP Request
PUT /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ServiceCIDR
- **body**: <a href="">ServiceCIDR</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceCIDR</a>): OK
201 (<a href="">ServiceCIDR</a>): Created
401: Unauthorized
### `patch` partially update the specified ServiceCIDR
#### HTTP Request
PATCH /apis/networking.k8s.io/v1beta1/servicecidrs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ServiceCIDR
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceCIDR</a>): OK
201 (<a href="">ServiceCIDR</a>): Created
401: Unauthorized
### `patch` partially update status of the specified ServiceCIDR
#### HTTP Request
PATCH /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ServiceCIDR
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ServiceCIDR</a>): OK
201 (<a href="">ServiceCIDR</a>): Created
401: Unauthorized
### `delete` delete a ServiceCIDR
#### HTTP Request
DELETE /apis/networking.k8s.io/v1beta1/servicecidrs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ServiceCIDR
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ServiceCIDR
#### HTTP Request
DELETE /apis/networking.k8s.io/v1beta1/servicecidrs
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion networking k8s io v1beta1 import k8s io api networking v1beta1 kind ServiceCIDR content type api reference description ServiceCIDR defines a range of IP addresses using CIDR format e title ServiceCIDR v1beta1 weight 10 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 apiVersion networking k8s io v1beta1 import k8s io api networking v1beta1 ServiceCIDR ServiceCIDR ServiceCIDR defines a range of IP addresses using CIDR format e g 192 168 0 0 24 or 2001 db2 64 This range is used to allocate ClusterIPs to Service objects hr apiVersion networking k8s io v1beta1 kind ServiceCIDR metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href ServiceCIDRSpec a spec is the desired state of the ServiceCIDR More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href ServiceCIDRStatus a status represents the current state of the ServiceCIDR More info https git k8s io community contributors devel sig architecture api conventions md spec and status ServiceCIDRSpec ServiceCIDRSpec ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services hr cidrs string Atomic will be replaced during a merge CIDRs defines the IP blocks in CIDR notation e g 192 168 0 0 24 or 2001 db8 64 from which to assign service cluster IPs Max of two CIDRs is allowed one of each IP family This field is immutable ServiceCIDRStatus ServiceCIDRStatus ServiceCIDRStatus describes the current state of the ServiceCIDR hr conditions Condition Patch strategy merge on key type Map unique values on key type will be kept during a merge conditions holds an array of metav1 Condition that describe the state of the ServiceCIDR Current service state a name Condition a Condition contains details for one aspect of the current state of this API Resource conditions lastTransitionTime Time required lastTransitionTime is the last time the condition transitioned from one status to another This should be when the underlying condition changed If that is not known then using the time when the API field changed is acceptable a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string required message is a human readable message indicating details about the transition This may be an empty string conditions reason string required reason contains a programmatic identifier indicating the reason for the condition s last transition Producers of specific condition types may define expected values and meanings for this field and whether the values are considered a guaranteed API The value should be a CamelCase string This field may not be empty conditions status string required status of the condition one of True False Unknown conditions type string required type of condition in CamelCase or in foo example com CamelCase conditions observedGeneration int64 observedGeneration represents the metadata generation that the condition was set based upon For instance if metadata generation is currently 12 but the status conditions x observedGeneration is 9 the condition is out of date with respect to the current state of the instance ServiceCIDRList ServiceCIDRList ServiceCIDRList contains a list of ServiceCIDR objects hr apiVersion networking k8s io v1beta1 kind ServiceCIDRList metadata a href ListMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href ServiceCIDR a required items is the list of ServiceCIDRs Operations Operations hr get read the specified ServiceCIDR HTTP Request GET apis networking k8s io v1beta1 servicecidrs name Parameters name in path string required name of the ServiceCIDR pretty in query string a href pretty a Response 200 a href ServiceCIDR a OK 401 Unauthorized get read status of the specified ServiceCIDR HTTP Request GET apis networking k8s io v1beta1 servicecidrs name status Parameters name in path string required name of the ServiceCIDR pretty in query string a href pretty a Response 200 a href ServiceCIDR a OK 401 Unauthorized list list or watch objects of kind ServiceCIDR HTTP Request GET apis networking k8s io v1beta1 servicecidrs Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ServiceCIDRList a OK 401 Unauthorized create create a ServiceCIDR HTTP Request POST apis networking k8s io v1beta1 servicecidrs Parameters body a href ServiceCIDR a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ServiceCIDR a OK 201 a href ServiceCIDR a Created 202 a href ServiceCIDR a Accepted 401 Unauthorized update replace the specified ServiceCIDR HTTP Request PUT apis networking k8s io v1beta1 servicecidrs name Parameters name in path string required name of the ServiceCIDR body a href ServiceCIDR a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ServiceCIDR a OK 201 a href ServiceCIDR a Created 401 Unauthorized update replace status of the specified ServiceCIDR HTTP Request PUT apis networking k8s io v1beta1 servicecidrs name status Parameters name in path string required name of the ServiceCIDR body a href ServiceCIDR a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ServiceCIDR a OK 201 a href ServiceCIDR a Created 401 Unauthorized patch partially update the specified ServiceCIDR HTTP Request PATCH apis networking k8s io v1beta1 servicecidrs name Parameters name in path string required name of the ServiceCIDR body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ServiceCIDR a OK 201 a href ServiceCIDR a Created 401 Unauthorized patch partially update status of the specified ServiceCIDR HTTP Request PATCH apis networking k8s io v1beta1 servicecidrs name status Parameters name in path string required name of the ServiceCIDR body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ServiceCIDR a OK 201 a href ServiceCIDR a Created 401 Unauthorized delete delete a ServiceCIDR HTTP Request DELETE apis networking k8s io v1beta1 servicecidrs name Parameters name in path string required name of the ServiceCIDR body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ServiceCIDR HTTP Request DELETE apis networking k8s io v1beta1 servicecidrs Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference APIService represents a server for a particular GroupVersion title APIService kind APIService contenttype apireference import k8s io kube aggregator pkg apis apiregistration v1 apimetadata autogenerated true apiVersion apiregistration k8s io v1 weight 1 | ---
api_metadata:
apiVersion: "apiregistration.k8s.io/v1"
import: "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"
kind: "APIService"
content_type: "api_reference"
description: "APIService represents a server for a particular GroupVersion."
title: "APIService"
weight: 1
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.
-->
`apiVersion: apiregistration.k8s.io/v1`
`import "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"`
## APIService {#APIService}
APIService represents a server for a particular GroupVersion. Name must be "version.group".
<hr>
- **apiVersion**: apiregistration.k8s.io/v1
- **kind**: APIService
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">APIServiceSpec</a>)
Spec contains information for locating and communicating with a server
- **status** (<a href="">APIServiceStatus</a>)
Status contains derived information about an API server
## APIServiceSpec {#APIServiceSpec}
APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.
<hr>
- **groupPriorityMinimum** (int32), required
GroupPriorityMinimum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMinimum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
- **versionPriority** (int32), required
VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
- **caBundle** ([]byte)
*Atomic: will be replaced during a merge*
CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used.
- **group** (string)
Group is the API group name this server hosts
- **insecureSkipTLSVerify** (boolean)
InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
- **service** (ServiceReference)
Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
- **service.name** (string)
Name is the name of the service
- **service.namespace** (string)
Namespace is the namespace of the service
- **service.port** (int32)
If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
- **version** (string)
Version is the API version this server hosts. For example, "v1"
## APIServiceStatus {#APIServiceStatus}
APIServiceStatus contains derived information about an API server
<hr>
- **conditions** ([]APIServiceCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Current service state of apiService.
<a name="APIServiceCondition"></a>
*APIServiceCondition describes the state of an APIService at a particular point*
- **conditions.status** (string), required
Status is the status of the condition. Can be True, False, Unknown.
- **conditions.type** (string), required
Type is the type of the condition.
- **conditions.lastTransitionTime** (Time)
Last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
Human-readable message indicating details about last transition.
- **conditions.reason** (string)
Unique, one-word, CamelCase reason for the condition's last transition.
## APIServiceList {#APIServiceList}
APIServiceList is a list of APIService objects.
<hr>
- **apiVersion**: apiregistration.k8s.io/v1
- **kind**: APIServiceList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">APIService</a>), required
Items is the list of APIService
## Operations {#Operations}
<hr>
### `get` read the specified APIService
#### HTTP Request
GET /apis/apiregistration.k8s.io/v1/apiservices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the APIService
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">APIService</a>): OK
401: Unauthorized
### `get` read status of the specified APIService
#### HTTP Request
GET /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the APIService
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">APIService</a>): OK
401: Unauthorized
### `list` list or watch objects of kind APIService
#### HTTP Request
GET /apis/apiregistration.k8s.io/v1/apiservices
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">APIServiceList</a>): OK
401: Unauthorized
### `create` create an APIService
#### HTTP Request
POST /apis/apiregistration.k8s.io/v1/apiservices
#### Parameters
- **body**: <a href="">APIService</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">APIService</a>): OK
201 (<a href="">APIService</a>): Created
202 (<a href="">APIService</a>): Accepted
401: Unauthorized
### `update` replace the specified APIService
#### HTTP Request
PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the APIService
- **body**: <a href="">APIService</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">APIService</a>): OK
201 (<a href="">APIService</a>): Created
401: Unauthorized
### `update` replace status of the specified APIService
#### HTTP Request
PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the APIService
- **body**: <a href="">APIService</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">APIService</a>): OK
201 (<a href="">APIService</a>): Created
401: Unauthorized
### `patch` partially update the specified APIService
#### HTTP Request
PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the APIService
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">APIService</a>): OK
201 (<a href="">APIService</a>): Created
401: Unauthorized
### `patch` partially update status of the specified APIService
#### HTTP Request
PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the APIService
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">APIService</a>): OK
201 (<a href="">APIService</a>): Created
401: Unauthorized
### `delete` delete an APIService
#### HTTP Request
DELETE /apis/apiregistration.k8s.io/v1/apiservices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the APIService
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of APIService
#### HTTP Request
DELETE /apis/apiregistration.k8s.io/v1/apiservices
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion apiregistration k8s io v1 import k8s io kube aggregator pkg apis apiregistration v1 kind APIService content type api reference description APIService represents a server for a particular GroupVersion title APIService weight 1 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 apiVersion apiregistration k8s io v1 import k8s io kube aggregator pkg apis apiregistration v1 APIService APIService APIService represents a server for a particular GroupVersion Name must be version group hr apiVersion apiregistration k8s io v1 kind APIService metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href APIServiceSpec a Spec contains information for locating and communicating with a server status a href APIServiceStatus a Status contains derived information about an API server APIServiceSpec APIServiceSpec APIServiceSpec contains information for locating and communicating with a server Only https is supported though you are able to disable certificate verification hr groupPriorityMinimum int32 required GroupPriorityMinimum is the priority this group should have at least Higher priority means that the group is preferred by clients over lower priority ones Note that other versions of this group might specify even higher GroupPriorityMinimum values such that the whole group gets a higher priority The primary sort is based on GroupPriorityMinimum ordered highest number to lowest 20 before 10 The secondary sort is based on the alphabetical comparison of the name of the object v1 bar before v1 foo We d recommend something like k8s io except extensions at 18000 and PaaSes OpenShift Deis are recommended to be in the 2000s versionPriority int32 required VersionPriority controls the ordering of this API version inside of its group Must be greater than zero The primary sort is based on VersionPriority ordered highest to lowest 20 before 10 Since it s inside of a group the number can be small probably in the 10s In case of equal version priorities the version string will be used to compute the order inside a group If the version string is kube like it will sort above non kube like version strings which are ordered lexicographically Kube like versions start with a v then are followed by a number the major version then optionally the string alpha or beta and another number the minor version These are sorted first by GA beta alpha where GA is a version with no suffix such as beta or alpha and then by comparing major version then minor version An example sorted list of versions v10 v2 v1 v11beta2 v10beta3 v3beta1 v12alpha1 v11alpha2 foo1 foo10 caBundle byte Atomic will be replaced during a merge CABundle is a PEM encoded CA bundle which will be used to validate an API server s serving certificate If unspecified system trust roots on the apiserver are used group string Group is the API group name this server hosts insecureSkipTLSVerify boolean InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server This is strongly discouraged You should use the CABundle instead service ServiceReference Service is a reference to the service for this API server It must communicate on port 443 If the Service is nil that means the handling for the API groupversion is handled locally on this server The call will simply delegate to the normal handler chain to be fulfilled a name ServiceReference a ServiceReference holds a reference to Service legacy k8s io service name string Name is the name of the service service namespace string Namespace is the namespace of the service service port int32 If specified the port on the service that hosting webhook Default to 443 for backward compatibility port should be a valid port number 1 65535 inclusive version string Version is the API version this server hosts For example v1 APIServiceStatus APIServiceStatus APIServiceStatus contains derived information about an API server hr conditions APIServiceCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge Current service state of apiService a name APIServiceCondition a APIServiceCondition describes the state of an APIService at a particular point conditions status string required Status is the status of the condition Can be True False Unknown conditions type string required Type is the type of the condition conditions lastTransitionTime Time Last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string Human readable message indicating details about last transition conditions reason string Unique one word CamelCase reason for the condition s last transition APIServiceList APIServiceList APIServiceList is a list of APIService objects hr apiVersion apiregistration k8s io v1 kind APIServiceList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href APIService a required Items is the list of APIService Operations Operations hr get read the specified APIService HTTP Request GET apis apiregistration k8s io v1 apiservices name Parameters name in path string required name of the APIService pretty in query string a href pretty a Response 200 a href APIService a OK 401 Unauthorized get read status of the specified APIService HTTP Request GET apis apiregistration k8s io v1 apiservices name status Parameters name in path string required name of the APIService pretty in query string a href pretty a Response 200 a href APIService a OK 401 Unauthorized list list or watch objects of kind APIService HTTP Request GET apis apiregistration k8s io v1 apiservices Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href APIServiceList a OK 401 Unauthorized create create an APIService HTTP Request POST apis apiregistration k8s io v1 apiservices Parameters body a href APIService a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href APIService a OK 201 a href APIService a Created 202 a href APIService a Accepted 401 Unauthorized update replace the specified APIService HTTP Request PUT apis apiregistration k8s io v1 apiservices name Parameters name in path string required name of the APIService body a href APIService a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href APIService a OK 201 a href APIService a Created 401 Unauthorized update replace status of the specified APIService HTTP Request PUT apis apiregistration k8s io v1 apiservices name status Parameters name in path string required name of the APIService body a href APIService a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href APIService a OK 201 a href APIService a Created 401 Unauthorized patch partially update the specified APIService HTTP Request PATCH apis apiregistration k8s io v1 apiservices name Parameters name in path string required name of the APIService body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href APIService a OK 201 a href APIService a Created 401 Unauthorized patch partially update status of the specified APIService HTTP Request PATCH apis apiregistration k8s io v1 apiservices name status Parameters name in path string required name of the APIService body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href APIService a OK 201 a href APIService a Created 401 Unauthorized delete delete an APIService HTTP Request DELETE apis apiregistration k8s io v1 apiservices name Parameters name in path string required name of the APIService body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of APIService HTTP Request DELETE apis apiregistration k8s io v1 apiservices Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference autogenerated true weight 5 import k8s io api coordination v1 contenttype apireference Lease defines a lease concept apiVersion coordination k8s io v1 apimetadata kind Lease title Lease | ---
api_metadata:
apiVersion: "coordination.k8s.io/v1"
import: "k8s.io/api/coordination/v1"
kind: "Lease"
content_type: "api_reference"
description: "Lease defines a lease concept."
title: "Lease"
weight: 5
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.
-->
`apiVersion: coordination.k8s.io/v1`
`import "k8s.io/api/coordination/v1"`
## Lease {#Lease}
Lease defines a lease concept.
<hr>
- **apiVersion**: coordination.k8s.io/v1
- **kind**: Lease
- **metadata** (<a href="">ObjectMeta</a>)
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">LeaseSpec</a>)
spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## LeaseSpec {#LeaseSpec}
LeaseSpec is a specification of a Lease.
<hr>
- **acquireTime** (MicroTime)
acquireTime is a time when the current lease was acquired.
<a name="MicroTime"></a>
*MicroTime is version of Time with microsecond level precision.*
- **holderIdentity** (string)
holderIdentity contains the identity of the holder of a current lease. If Coordinated Leader Election is used, the holder identity must be equal to the elected LeaseCandidate.metadata.name field.
- **leaseDurationSeconds** (int32)
leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measured against the time of last observed renewTime.
- **leaseTransitions** (int32)
leaseTransitions is the number of transitions of a lease between holders.
- **preferredHolder** (string)
PreferredHolder signals to a lease holder that the lease has a more optimal holder and should be given up. This field can only be set if Strategy is also set.
- **renewTime** (MicroTime)
renewTime is a time when the current holder of a lease has last updated the lease.
<a name="MicroTime"></a>
*MicroTime is version of Time with microsecond level precision.*
- **strategy** (string)
Strategy indicates the strategy for picking the leader for coordinated leader election. If the field is not specified, there is no active coordination for this lease. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled.
## LeaseList {#LeaseList}
LeaseList is a list of Lease objects.
<hr>
- **apiVersion**: coordination.k8s.io/v1
- **kind**: LeaseList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">Lease</a>), required
items is a list of schema objects.
## Operations {#Operations}
<hr>
### `get` read the specified Lease
#### HTTP Request
GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Lease
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Lease</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Lease
#### HTTP Request
GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">LeaseList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Lease
#### HTTP Request
GET /apis/coordination.k8s.io/v1/leases
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">LeaseList</a>): OK
401: Unauthorized
### `create` create a Lease
#### HTTP Request
POST /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Lease</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Lease</a>): OK
201 (<a href="">Lease</a>): Created
202 (<a href="">Lease</a>): Accepted
401: Unauthorized
### `update` replace the specified Lease
#### HTTP Request
PUT /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Lease
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Lease</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Lease</a>): OK
201 (<a href="">Lease</a>): Created
401: Unauthorized
### `patch` partially update the specified Lease
#### HTTP Request
PATCH /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Lease
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Lease</a>): OK
201 (<a href="">Lease</a>): Created
401: Unauthorized
### `delete` delete a Lease
#### HTTP Request
DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Lease
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Lease
#### HTTP Request
DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion coordination k8s io v1 import k8s io api coordination v1 kind Lease content type api reference description Lease defines a lease concept title Lease weight 5 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 apiVersion coordination k8s io v1 import k8s io api coordination v1 Lease Lease Lease defines a lease concept hr apiVersion coordination k8s io v1 kind Lease metadata a href ObjectMeta a More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href LeaseSpec a spec contains the specification of the Lease More info https git k8s io community contributors devel sig architecture api conventions md spec and status LeaseSpec LeaseSpec LeaseSpec is a specification of a Lease hr acquireTime MicroTime acquireTime is a time when the current lease was acquired a name MicroTime a MicroTime is version of Time with microsecond level precision holderIdentity string holderIdentity contains the identity of the holder of a current lease If Coordinated Leader Election is used the holder identity must be equal to the elected LeaseCandidate metadata name field leaseDurationSeconds int32 leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it This is measured against the time of last observed renewTime leaseTransitions int32 leaseTransitions is the number of transitions of a lease between holders preferredHolder string PreferredHolder signals to a lease holder that the lease has a more optimal holder and should be given up This field can only be set if Strategy is also set renewTime MicroTime renewTime is a time when the current holder of a lease has last updated the lease a name MicroTime a MicroTime is version of Time with microsecond level precision strategy string Strategy indicates the strategy for picking the leader for coordinated leader election If the field is not specified there is no active coordination for this lease Alpha Using this field requires the CoordinatedLeaderElection feature gate to be enabled LeaseList LeaseList LeaseList is a list of Lease objects hr apiVersion coordination k8s io v1 kind LeaseList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href Lease a required items is a list of schema objects Operations Operations hr get read the specified Lease HTTP Request GET apis coordination k8s io v1 namespaces namespace leases name Parameters name in path string required name of the Lease namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Lease a OK 401 Unauthorized list list or watch objects of kind Lease HTTP Request GET apis coordination k8s io v1 namespaces namespace leases Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href LeaseList a OK 401 Unauthorized list list or watch objects of kind Lease HTTP Request GET apis coordination k8s io v1 leases Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href LeaseList a OK 401 Unauthorized create create a Lease HTTP Request POST apis coordination k8s io v1 namespaces namespace leases Parameters namespace in path string required a href namespace a body a href Lease a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Lease a OK 201 a href Lease a Created 202 a href Lease a Accepted 401 Unauthorized update replace the specified Lease HTTP Request PUT apis coordination k8s io v1 namespaces namespace leases name Parameters name in path string required name of the Lease namespace in path string required a href namespace a body a href Lease a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Lease a OK 201 a href Lease a Created 401 Unauthorized patch partially update the specified Lease HTTP Request PATCH apis coordination k8s io v1 namespaces namespace leases name Parameters name in path string required name of the Lease namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Lease a OK 201 a href Lease a Created 401 Unauthorized delete delete a Lease HTTP Request DELETE apis coordination k8s io v1 namespaces namespace leases name Parameters name in path string required name of the Lease namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of Lease HTTP Request DELETE apis coordination k8s io v1 namespaces namespace leases Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference Event is a report of an event somewhere in the cluster contenttype apireference import k8s io api events v1 title Event kind Event apiVersion events k8s io v1 apimetadata weight 3 autogenerated true | ---
api_metadata:
apiVersion: "events.k8s.io/v1"
import: "k8s.io/api/events/v1"
kind: "Event"
content_type: "api_reference"
description: "Event is a report of an event somewhere in the cluster."
title: "Event"
weight: 3
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.
-->
`apiVersion: events.k8s.io/v1`
`import "k8s.io/api/events/v1"`
## Event {#Event}
Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
<hr>
- **apiVersion**: events.k8s.io/v1
- **kind**: Event
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **eventTime** (MicroTime), required
eventTime is the time when this Event was first observed. It is required.
<a name="MicroTime"></a>
*MicroTime is version of Time with microsecond level precision.*
- **action** (string)
action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.
- **deprecatedCount** (int32)
deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
- **deprecatedFirstTimestamp** (Time)
deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **deprecatedLastTimestamp** (Time)
deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **deprecatedSource** (EventSource)
deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
<a name="EventSource"></a>
*EventSource contains information for an event.*
- **deprecatedSource.component** (string)
Component from which the event is generated.
- **deprecatedSource.host** (string)
Node name on which the event is generated.
- **note** (string)
note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
- **reason** (string)
reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters.
- **regarding** (<a href="">ObjectReference</a>)
regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
- **related** (<a href="">ObjectReference</a>)
related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
- **reportingController** (string)
reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events.
- **reportingInstance** (string)
reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters.
- **series** (EventSeries)
series is data about the Event series this event represents or nil if it's a singleton Event.
<a name="EventSeries"></a>
*EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations.*
- **series.count** (int32), required
count is the number of occurrences in this series up to the last heartbeat time.
- **series.lastObservedTime** (MicroTime), required
lastObservedTime is the time when last Event from the series was seen before last heartbeat.
<a name="MicroTime"></a>
*MicroTime is version of Time with microsecond level precision.*
- **type** (string)
type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events.
## EventList {#EventList}
EventList is a list of Event objects.
<hr>
- **apiVersion**: events.k8s.io/v1
- **kind**: EventList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">Event</a>), required
items is a list of schema objects.
## Operations {#Operations}
<hr>
### `get` read the specified Event
#### HTTP Request
GET /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Event
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Event</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Event
#### HTTP Request
GET /apis/events.k8s.io/v1/namespaces/{namespace}/events
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">EventList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Event
#### HTTP Request
GET /apis/events.k8s.io/v1/events
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">EventList</a>): OK
401: Unauthorized
### `create` create an Event
#### HTTP Request
POST /apis/events.k8s.io/v1/namespaces/{namespace}/events
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Event</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Event</a>): OK
201 (<a href="">Event</a>): Created
202 (<a href="">Event</a>): Accepted
401: Unauthorized
### `update` replace the specified Event
#### HTTP Request
PUT /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Event
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Event</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Event</a>): OK
201 (<a href="">Event</a>): Created
401: Unauthorized
### `patch` partially update the specified Event
#### HTTP Request
PATCH /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Event
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Event</a>): OK
201 (<a href="">Event</a>): Created
401: Unauthorized
### `delete` delete an Event
#### HTTP Request
DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Event
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Event
#### HTTP Request
DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion events k8s io v1 import k8s io api events v1 kind Event content type api reference description Event is a report of an event somewhere in the cluster title Event weight 3 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 apiVersion events k8s io v1 import k8s io api events v1 Event Event Event is a report of an event somewhere in the cluster It generally denotes some state change in the system Events have a limited retention time and triggers and messages may evolve with time Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger or the continued existence of events with that Reason Events should be treated as informative best effort supplemental data hr apiVersion events k8s io v1 kind Event metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata eventTime MicroTime required eventTime is the time when this Event was first observed It is required a name MicroTime a MicroTime is version of Time with microsecond level precision action string action is what action was taken failed regarding to the regarding object It is machine readable This field cannot be empty for new Events and it can have at most 128 characters deprecatedCount int32 deprecatedCount is the deprecated field assuring backward compatibility with core v1 Event type deprecatedFirstTimestamp Time deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core v1 Event type a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers deprecatedLastTimestamp Time deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core v1 Event type a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers deprecatedSource EventSource deprecatedSource is the deprecated field assuring backward compatibility with core v1 Event type a name EventSource a EventSource contains information for an event deprecatedSource component string Component from which the event is generated deprecatedSource host string Node name on which the event is generated note string note is a human readable description of the status of this operation Maximal length of the note is 1kB but libraries should be prepared to handle values up to 64kB reason string reason is why the action was taken It is human readable This field cannot be empty for new Events and it can have at most 128 characters regarding a href ObjectReference a regarding contains the object this Event is about In most cases it s an Object reporting controller implements e g ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object related a href ObjectReference a related is the optional secondary object for more complex actions E g when regarding object triggers a creation or deletion of related object reportingController string reportingController is the name of the controller that emitted this Event e g kubernetes io kubelet This field cannot be empty for new Events reportingInstance string reportingInstance is the ID of the controller instance e g kubelet xyzf This field cannot be empty for new Events and it can have at most 128 characters series EventSeries series is data about the Event series this event represents or nil if it s a singleton Event a name EventSeries a EventSeries contain information on series of events i e thing that was is happening continuously for some time How often to update the EventSeries is up to the event reporters The default event reporter in k8s io client go tools events event broadcaster go shows how this struct is updated on heartbeats and can guide customized reporter implementations series count int32 required count is the number of occurrences in this series up to the last heartbeat time series lastObservedTime MicroTime required lastObservedTime is the time when last Event from the series was seen before last heartbeat a name MicroTime a MicroTime is version of Time with microsecond level precision type string type is the type of this event Normal Warning new types could be added in the future It is machine readable This field cannot be empty for new Events EventList EventList EventList is a list of Event objects hr apiVersion events k8s io v1 kind EventList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href Event a required items is a list of schema objects Operations Operations hr get read the specified Event HTTP Request GET apis events k8s io v1 namespaces namespace events name Parameters name in path string required name of the Event namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Event a OK 401 Unauthorized list list or watch objects of kind Event HTTP Request GET apis events k8s io v1 namespaces namespace events Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href EventList a OK 401 Unauthorized list list or watch objects of kind Event HTTP Request GET apis events k8s io v1 events Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href EventList a OK 401 Unauthorized create create an Event HTTP Request POST apis events k8s io v1 namespaces namespace events Parameters namespace in path string required a href namespace a body a href Event a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Event a OK 201 a href Event a Created 202 a href Event a Accepted 401 Unauthorized update replace the specified Event HTTP Request PUT apis events k8s io v1 namespaces namespace events name Parameters name in path string required name of the Event namespace in path string required a href namespace a body a href Event a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Event a OK 201 a href Event a Created 401 Unauthorized patch partially update the specified Event HTTP Request PATCH apis events k8s io v1 namespaces namespace events name Parameters name in path string required name of the Event namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Event a OK 201 a href Event a Created 401 Unauthorized delete delete an Event HTTP Request DELETE apis events k8s io v1 namespaces namespace events name Parameters name in path string required name of the Event namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of Event HTTP Request DELETE apis events k8s io v1 namespaces namespace events Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion v1 weight 2 kind ComponentStatus title ComponentStatus contenttype apireference apimetadata autogenerated true ComponentStatus and ComponentStatusList holds the cluster validation info import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "ComponentStatus"
content_type: "api_reference"
description: "ComponentStatus (and ComponentStatusList) holds the cluster validation info."
title: "ComponentStatus"
weight: 2
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## ComponentStatus {#ComponentStatus}
ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+
<hr>
- **apiVersion**: v1
- **kind**: ComponentStatus
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **conditions** ([]ComponentCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
List of component conditions observed
<a name="ComponentCondition"></a>
*Information about the condition of a component.*
- **conditions.status** (string), required
Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
- **conditions.type** (string), required
Type of condition for a component. Valid value: "Healthy"
- **conditions.error** (string)
Condition error code for a component. For example, a health check error code.
- **conditions.message** (string)
Message about the condition for a component. For example, information about a health check.
## ComponentStatusList {#ComponentStatusList}
Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+
<hr>
- **apiVersion**: v1
- **kind**: ComponentStatusList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">ComponentStatus</a>), required
List of ComponentStatus objects.
## Operations {#Operations}
<hr>
### `get` read the specified ComponentStatus
#### HTTP Request
GET /api/v1/componentstatuses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ComponentStatus
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ComponentStatus</a>): OK
401: Unauthorized
### `list` list objects of kind ComponentStatus
#### HTTP Request
GET /api/v1/componentstatuses
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ComponentStatusList</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind ComponentStatus content type api reference description ComponentStatus and ComponentStatusList holds the cluster validation info title ComponentStatus weight 2 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 apiVersion v1 import k8s io api core v1 ComponentStatus ComponentStatus ComponentStatus and ComponentStatusList holds the cluster validation info Deprecated This API is deprecated in v1 19 hr apiVersion v1 kind ComponentStatus metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata conditions ComponentCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge List of component conditions observed a name ComponentCondition a Information about the condition of a component conditions status string required Status of the condition for a component Valid values for Healthy True False or Unknown conditions type string required Type of condition for a component Valid value Healthy conditions error string Condition error code for a component For example a health check error code conditions message string Message about the condition for a component For example information about a health check ComponentStatusList ComponentStatusList Status of all the conditions for the component as a list of ComponentStatus objects Deprecated This API is deprecated in v1 19 hr apiVersion v1 kind ComponentStatusList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href ComponentStatus a required List of ComponentStatus objects Operations Operations hr get read the specified ComponentStatus HTTP Request GET api v1 componentstatuses name Parameters name in path string required name of the ComponentStatus pretty in query string a href pretty a Response 200 a href ComponentStatus a OK 401 Unauthorized list list objects of kind ComponentStatus HTTP Request GET api v1 componentstatuses Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ComponentStatusList a OK 401 Unauthorized |
kubernetes reference kind Volume apiVersion contenttype apireference title Volume weight 10 Volume represents a named volume in a pod that may be accessed by any container in the pod apimetadata autogenerated true import k8s io api core v1 | ---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "Volume"
content_type: "api_reference"
description: "Volume represents a named volume in a pod that may be accessed by any container in the pod."
title: "Volume"
weight: 10
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.
-->
`import "k8s.io/api/core/v1"`
## Volume {#Volume}
Volume represents a named volume in a pod that may be accessed by any container in the pod.
<hr>
- **name** (string), required
name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
### Exposed Persistent volumes
- **persistentVolumeClaim** (PersistentVolumeClaimVolumeSource)
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
<a name="PersistentVolumeClaimVolumeSource"></a>
*PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).*
- **persistentVolumeClaim.claimName** (string), required
claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- **persistentVolumeClaim.readOnly** (boolean)
readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
### Projections
- **configMap** (ConfigMapVolumeSource)
configMap represents a configMap that should populate this volume
<a name="ConfigMapVolumeSource"></a>
*Adapts a ConfigMap into a volume.
The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.*
- **configMap.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **configMap.optional** (boolean)
optional specify whether the ConfigMap or its keys must be defined
- **configMap.defaultMode** (int32)
defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- **configMap.items** ([]<a href="">KeyToPath</a>)
*Atomic: will be replaced during a merge*
items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
- **secret** (SecretVolumeSource)
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
<a name="SecretVolumeSource"></a>
*Adapts a Secret into a volume.
The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.*
- **secret.secretName** (string)
secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- **secret.optional** (boolean)
optional field specify whether the Secret or its keys must be defined
- **secret.defaultMode** (int32)
defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- **secret.items** ([]<a href="">KeyToPath</a>)
*Atomic: will be replaced during a merge*
items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
- **downwardAPI** (DownwardAPIVolumeSource)
downwardAPI represents downward API about the pod that should populate this volume
<a name="DownwardAPIVolumeSource"></a>
*DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.*
- **downwardAPI.defaultMode** (int32)
Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- **downwardAPI.items** ([]<a href="">DownwardAPIVolumeFile</a>)
*Atomic: will be replaced during a merge*
Items is a list of downward API volume file
- **projected** (ProjectedVolumeSource)
projected items for all in one resources secrets, configmaps, and downward API
<a name="ProjectedVolumeSource"></a>
*Represents a projected volume source*
- **projected.defaultMode** (int32)
defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- **projected.sources** ([]VolumeProjection)
*Atomic: will be replaced during a merge*
sources is the list of volume projections. Each entry in this list handles one source.
<a name="VolumeProjection"></a>
*Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.*
- **projected.sources.clusterTrustBundle** (ClusterTrustBundleProjection)
ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file.
Alpha, gated by the ClusterTrustBundleProjection feature gate.
ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.
Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
<a name="ClusterTrustBundleProjection"></a>
*ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.*
- **projected.sources.clusterTrustBundle.path** (string), required
Relative path from the volume root to write the bundle.
- **projected.sources.clusterTrustBundle.labelSelector** (<a href="">LabelSelector</a>)
Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
- **projected.sources.clusterTrustBundle.name** (string)
Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
- **projected.sources.clusterTrustBundle.optional** (boolean)
If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.
- **projected.sources.clusterTrustBundle.signerName** (string)
Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.
- **projected.sources.configMap** (ConfigMapProjection)
configMap information about the configMap data to project
<a name="ConfigMapProjection"></a>
*Adapts a ConfigMap into a projected volume.
The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.*
- **projected.sources.configMap.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **projected.sources.configMap.optional** (boolean)
optional specify whether the ConfigMap or its keys must be defined
- **projected.sources.configMap.items** ([]<a href="">KeyToPath</a>)
*Atomic: will be replaced during a merge*
items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
- **projected.sources.downwardAPI** (DownwardAPIProjection)
downwardAPI information about the downwardAPI data to project
<a name="DownwardAPIProjection"></a>
*Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.*
- **projected.sources.downwardAPI.items** ([]<a href="">DownwardAPIVolumeFile</a>)
*Atomic: will be replaced during a merge*
Items is a list of DownwardAPIVolume file
- **projected.sources.secret** (SecretProjection)
secret information about the secret data to project
<a name="SecretProjection"></a>
*Adapts a secret into a projected volume.
The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.*
- **projected.sources.secret.name** (string)
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **projected.sources.secret.optional** (boolean)
optional field specify whether the Secret or its key must be defined
- **projected.sources.secret.items** ([]<a href="">KeyToPath</a>)
*Atomic: will be replaced during a merge*
items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
- **projected.sources.serviceAccountToken** (ServiceAccountTokenProjection)
serviceAccountToken is information about the serviceAccountToken data to project
<a name="ServiceAccountTokenProjection"></a>
*ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).*
- **projected.sources.serviceAccountToken.path** (string), required
path is the path relative to the mount point of the file to project the token into.
- **projected.sources.serviceAccountToken.audience** (string)
audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
- **projected.sources.serviceAccountToken.expirationSeconds** (int64)
expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
### Local / Temporary Directory
- **emptyDir** (EmptyDirVolumeSource)
emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
<a name="EmptyDirVolumeSource"></a>
*Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.*
- **emptyDir.medium** (string)
medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- **emptyDir.sizeLimit** (<a href="">Quantity</a>)
sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- **hostPath** (HostPathVolumeSource)
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
<a name="HostPathVolumeSource"></a>
*Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.*
- **hostPath.path** (string), required
path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- **hostPath.type** (string)
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
### Persistent volumes
- **awsElasticBlockStore** (AWSElasticBlockStoreVolumeSource)
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
<a name="AWSElasticBlockStoreVolumeSource"></a>
*Represents a Persistent Disk resource in AWS.
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.*
- **awsElasticBlockStore.volumeID** (string), required
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- **awsElasticBlockStore.fsType** (string)
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- **awsElasticBlockStore.partition** (int32)
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
- **awsElasticBlockStore.readOnly** (boolean)
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- **azureDisk** (AzureDiskVolumeSource)
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
<a name="AzureDiskVolumeSource"></a>
*AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.*
- **azureDisk.diskName** (string), required
diskName is the Name of the data disk in the blob storage
- **azureDisk.diskURI** (string), required
diskURI is the URI of data disk in the blob storage
- **azureDisk.cachingMode** (string)
cachingMode is the Host Caching mode: None, Read Only, Read Write.
- **azureDisk.fsType** (string)
fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **azureDisk.kind** (string)
kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
- **azureDisk.readOnly** (boolean)
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **azureFile** (AzureFileVolumeSource)
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
<a name="AzureFileVolumeSource"></a>
*AzureFile represents an Azure File Service mount on the host and bind mount to the pod.*
- **azureFile.secretName** (string), required
secretName is the name of secret that contains Azure Storage Account Name and Key
- **azureFile.shareName** (string), required
shareName is the azure share Name
- **azureFile.readOnly** (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **cephfs** (CephFSVolumeSource)
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
<a name="CephFSVolumeSource"></a>
*Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.*
- **cephfs.monitors** ([]string), required
*Atomic: will be replaced during a merge*
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cephfs.path** (string)
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- **cephfs.readOnly** (boolean)
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cephfs.secretFile** (string)
secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cephfs.secretRef** (<a href="">LocalObjectReference</a>)
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cephfs.user** (string)
user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cinder** (CinderVolumeSource)
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
<a name="CinderVolumeSource"></a>
*Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.*
- **cinder.volumeID** (string), required
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- **cinder.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- **cinder.readOnly** (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- **cinder.secretRef** (<a href="">LocalObjectReference</a>)
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
- **csi** (CSIVolumeSource)
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
<a name="CSIVolumeSource"></a>
*Represents a source location of a volume to mount, managed by an external CSI driver*
- **csi.driver** (string), required
driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
- **csi.fsType** (string)
fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
- **csi.nodePublishSecretRef** (<a href="">LocalObjectReference</a>)
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
- **csi.readOnly** (boolean)
readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
- **csi.volumeAttributes** (map[string]string)
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
- **ephemeral** (EphemeralVolumeSource)
ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.
Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity
tracking are needed,
c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through
a PersistentVolumeClaim (see EphemeralVolumeSource for more
information on the connection between this volume type
and PersistentVolumeClaim).
Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.
Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.
A pod can use both types of ephemeral volumes and persistent volumes at the same time.
<a name="EphemeralVolumeSource"></a>
*Represents an ephemeral volume that is handled by a normal storage driver.*
- **ephemeral.volumeClaimTemplate** (PersistentVolumeClaimTemplate)
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `\<pod name>-\<volume name>` where `\<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).
An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.
Required, must not be nil.
<a name="PersistentVolumeClaimTemplate"></a>
*PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.*
- **ephemeral.volumeClaimTemplate.spec** (<a href="">PersistentVolumeClaimSpec</a>), required
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
- **ephemeral.volumeClaimTemplate.metadata** (<a href="">ObjectMeta</a>)
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
- **fc** (FCVolumeSource)
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
<a name="FCVolumeSource"></a>
*Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.*
- **fc.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **fc.lun** (int32)
lun is Optional: FC target lun number
- **fc.readOnly** (boolean)
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **fc.targetWWNs** ([]string)
*Atomic: will be replaced during a merge*
targetWWNs is Optional: FC target worldwide names (WWNs)
- **fc.wwids** ([]string)
*Atomic: will be replaced during a merge*
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- **flexVolume** (FlexVolumeSource)
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
<a name="FlexVolumeSource"></a>
*FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.*
- **flexVolume.driver** (string), required
driver is the name of the driver to use for this volume.
- **flexVolume.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
- **flexVolume.options** (map[string]string)
options is Optional: this field holds extra command options if any.
- **flexVolume.readOnly** (boolean)
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **flexVolume.secretRef** (<a href="">LocalObjectReference</a>)
secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
- **flocker** (FlockerVolumeSource)
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
<a name="FlockerVolumeSource"></a>
*Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.*
- **flocker.datasetName** (string)
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
- **flocker.datasetUUID** (string)
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
- **gcePersistentDisk** (GCEPersistentDiskVolumeSource)
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
<a name="GCEPersistentDiskVolumeSource"></a>
*Represents a Persistent Disk resource in Google Compute Engine.
A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.*
- **gcePersistentDisk.pdName** (string), required
pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **gcePersistentDisk.fsType** (string)
fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **gcePersistentDisk.partition** (int32)
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **gcePersistentDisk.readOnly** (boolean)
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **glusterfs** (GlusterfsVolumeSource)
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
<a name="GlusterfsVolumeSource"></a>
*Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.*
- **glusterfs.endpoints** (string), required
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.path** (string), required
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.readOnly** (boolean)
readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **iscsi** (ISCSIVolumeSource)
iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
<a name="ISCSIVolumeSource"></a>
*Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.*
- **iscsi.iqn** (string), required
iqn is the target iSCSI Qualified Name.
- **iscsi.lun** (int32), required
lun represents iSCSI Target Lun number.
- **iscsi.targetPortal** (string), required
targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
- **iscsi.chapAuthDiscovery** (boolean)
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
- **iscsi.chapAuthSession** (boolean)
chapAuthSession defines whether support iSCSI Session CHAP authentication
- **iscsi.fsType** (string)
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- **iscsi.initiatorName** (string)
initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface \<target portal>:\<volume name> will be created for the connection.
- **iscsi.iscsiInterface** (string)
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
- **iscsi.portals** ([]string)
*Atomic: will be replaced during a merge*
portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
- **iscsi.readOnly** (boolean)
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
- **iscsi.secretRef** (<a href="">LocalObjectReference</a>)
secretRef is the CHAP Secret for iSCSI target and initiator authentication
- **image** (ImageVolumeSource)
image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:
- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath). The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
<a name="ImageVolumeSource"></a>
*ImageVolumeSource represents a image volume resource.*
- **image.pullPolicy** (string)
Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- **image.reference** (string)
Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
- **nfs** (NFSVolumeSource)
nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
<a name="NFSVolumeSource"></a>
*Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.*
- **nfs.path** (string), required
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- **nfs.server** (string), required
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- **nfs.readOnly** (boolean)
readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- **photonPersistentDisk** (PhotonPersistentDiskVolumeSource)
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
<a name="PhotonPersistentDiskVolumeSource"></a>
*Represents a Photon Controller persistent disk resource.*
- **photonPersistentDisk.pdID** (string), required
pdID is the ID that identifies Photon Controller persistent disk
- **photonPersistentDisk.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **portworxVolume** (PortworxVolumeSource)
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
<a name="PortworxVolumeSource"></a>
*PortworxVolumeSource represents a Portworx volume resource.*
- **portworxVolume.volumeID** (string), required
volumeID uniquely identifies a Portworx volume
- **portworxVolume.fsType** (string)
fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
- **portworxVolume.readOnly** (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **quobyte** (QuobyteVolumeSource)
quobyte represents a Quobyte mount on the host that shares a pod's lifetime
<a name="QuobyteVolumeSource"></a>
*Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.*
- **quobyte.registry** (string), required
registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
- **quobyte.volume** (string), required
volume is a string that references an already created Quobyte volume by name.
- **quobyte.group** (string)
group to map volume access to Default is no group
- **quobyte.readOnly** (boolean)
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
- **quobyte.tenant** (string)
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
- **quobyte.user** (string)
user to map volume access to Defaults to serivceaccount user
- **rbd** (RBDVolumeSource)
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
<a name="RBDVolumeSource"></a>
*Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.*
- **rbd.image** (string), required
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.monitors** ([]string), required
*Atomic: will be replaced during a merge*
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.fsType** (string)
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- **rbd.keyring** (string)
keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.pool** (string)
pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.readOnly** (boolean)
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.secretRef** (<a href="">LocalObjectReference</a>)
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.user** (string)
user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **scaleIO** (ScaleIOVolumeSource)
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
<a name="ScaleIOVolumeSource"></a>
*ScaleIOVolumeSource represents a persistent ScaleIO volume*
- **scaleIO.gateway** (string), required
gateway is the host address of the ScaleIO API Gateway.
- **scaleIO.secretRef** (<a href="">LocalObjectReference</a>), required
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
- **scaleIO.system** (string), required
system is the name of the storage system as configured in ScaleIO.
- **scaleIO.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
- **scaleIO.protectionDomain** (string)
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
- **scaleIO.readOnly** (boolean)
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **scaleIO.sslEnabled** (boolean)
sslEnabled Flag enable/disable SSL communication with Gateway, default false
- **scaleIO.storageMode** (string)
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
- **scaleIO.storagePool** (string)
storagePool is the ScaleIO Storage Pool associated with the protection domain.
- **scaleIO.volumeName** (string)
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
- **storageos** (StorageOSVolumeSource)
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
<a name="StorageOSVolumeSource"></a>
*Represents a StorageOS persistent volume resource.*
- **storageos.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **storageos.readOnly** (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **storageos.secretRef** (<a href="">LocalObjectReference</a>)
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
- **storageos.volumeName** (string)
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
- **storageos.volumeNamespace** (string)
volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
- **vsphereVolume** (VsphereVirtualDiskVolumeSource)
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
<a name="VsphereVirtualDiskVolumeSource"></a>
*Represents a vSphere volume resource.*
- **vsphereVolume.volumePath** (string), required
volumePath is the path that identifies vSphere volume vmdk
- **vsphereVolume.fsType** (string)
fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **vsphereVolume.storagePolicyID** (string)
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- **vsphereVolume.storagePolicyName** (string)
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
### Deprecated
- **gitRepo** (GitRepoVolumeSource)
gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
<a name="GitRepoVolumeSource"></a>
*Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.*
- **gitRepo.repository** (string), required
repository is the URL
- **gitRepo.directory** (string)
directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
- **gitRepo.revision** (string)
revision is the commit hash for the specified revision.
## DownwardAPIVolumeFile {#DownwardAPIVolumeFile}
DownwardAPIVolumeFile represents information to create the file containing the pod field
<hr>
- **path** (string), required
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
- **fieldRef** (<a href="">ObjectFieldSelector</a>)
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- **mode** (int32)
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
- **resourceFieldRef** (<a href="">ResourceFieldSelector</a>)
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
## KeyToPath {#KeyToPath}
Maps a string key to a path within a volume.
<hr>
- **key** (string), required
key is the key to project.
- **path** (string), required
path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
- **mode** (int32)
mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
| kubernetes reference | api metadata apiVersion import k8s io api core v1 kind Volume content type api reference description Volume represents a named volume in a pod that may be accessed by any container in the pod title Volume weight 10 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 import k8s io api core v1 Volume Volume Volume represents a named volume in a pod that may be accessed by any container in the pod hr name string required name of the volume Must be a DNS LABEL and unique within the pod More info https kubernetes io docs concepts overview working with objects names names Exposed Persistent volumes persistentVolumeClaim PersistentVolumeClaimVolumeSource persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace More info https kubernetes io docs concepts storage persistent volumes persistentvolumeclaims a name PersistentVolumeClaimVolumeSource a PersistentVolumeClaimVolumeSource references the user s PVC in the same namespace This volume finds the bound PV and mounts that volume for the pod A PersistentVolumeClaimVolumeSource is essentially a wrapper around another type of volume that is owned by someone else the system persistentVolumeClaim claimName string required claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume More info https kubernetes io docs concepts storage persistent volumes persistentvolumeclaims persistentVolumeClaim readOnly boolean readOnly Will force the ReadOnly setting in VolumeMounts Default false Projections configMap ConfigMapVolumeSource configMap represents a configMap that should populate this volume a name ConfigMapVolumeSource a Adapts a ConfigMap into a volume The contents of the target ConfigMap s Data field will be presented in a volume as files using the keys in the Data field as the file names unless the items element is populated with specific mappings of keys to paths ConfigMap volumes support ownership management and SELinux relabeling configMap name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names configMap optional boolean optional specify whether the ConfigMap or its keys must be defined configMap defaultMode int32 defaultMode is optional mode bits used to set permissions on created files by default Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511 YAML accepts both octal and decimal values JSON requires decimal values for mode bits Defaults to 0644 Directories within the path are not affected by this setting This might be in conflict with other options that affect the file mode like fsGroup and the result can be other mode bits set configMap items a href KeyToPath a Atomic will be replaced during a merge items if unspecified each key value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value If specified the listed keys will be projected into the specified paths and unlisted keys will not be present If a key is specified which is not present in the ConfigMap the volume setup will error unless it is marked optional Paths must be relative and may not contain the path or start with secret SecretVolumeSource secret represents a secret that should populate this volume More info https kubernetes io docs concepts storage volumes secret a name SecretVolumeSource a Adapts a Secret into a volume The contents of the target Secret s Data field will be presented in a volume as files using the keys in the Data field as the file names Secret volumes support ownership management and SELinux relabeling secret secretName string secretName is the name of the secret in the pod s namespace to use More info https kubernetes io docs concepts storage volumes secret secret optional boolean optional field specify whether the Secret or its keys must be defined secret defaultMode int32 defaultMode is Optional mode bits used to set permissions on created files by default Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511 YAML accepts both octal and decimal values JSON requires decimal values for mode bits Defaults to 0644 Directories within the path are not affected by this setting This might be in conflict with other options that affect the file mode like fsGroup and the result can be other mode bits set secret items a href KeyToPath a Atomic will be replaced during a merge items If unspecified each key value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value If specified the listed keys will be projected into the specified paths and unlisted keys will not be present If a key is specified which is not present in the Secret the volume setup will error unless it is marked optional Paths must be relative and may not contain the path or start with downwardAPI DownwardAPIVolumeSource downwardAPI represents downward API about the pod that should populate this volume a name DownwardAPIVolumeSource a DownwardAPIVolumeSource represents a volume containing downward API info Downward API volumes support ownership management and SELinux relabeling downwardAPI defaultMode int32 Optional mode bits to use on created files by default Must be a Optional mode bits used to set permissions on created files by default Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511 YAML accepts both octal and decimal values JSON requires decimal values for mode bits Defaults to 0644 Directories within the path are not affected by this setting This might be in conflict with other options that affect the file mode like fsGroup and the result can be other mode bits set downwardAPI items a href DownwardAPIVolumeFile a Atomic will be replaced during a merge Items is a list of downward API volume file projected ProjectedVolumeSource projected items for all in one resources secrets configmaps and downward API a name ProjectedVolumeSource a Represents a projected volume source projected defaultMode int32 defaultMode are the mode bits used to set permissions on created files by default Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511 YAML accepts both octal and decimal values JSON requires decimal values for mode bits Directories within the path are not affected by this setting This might be in conflict with other options that affect the file mode like fsGroup and the result can be other mode bits set projected sources VolumeProjection Atomic will be replaced during a merge sources is the list of volume projections Each entry in this list handles one source a name VolumeProjection a Projection that may be projected along with other supported volume types Exactly one of these fields must be set projected sources clusterTrustBundle ClusterTrustBundleProjection ClusterTrustBundle allows a pod to access the spec trustBundle field of ClusterTrustBundle objects in an auto updating file Alpha gated by the ClusterTrustBundleProjection feature gate ClusterTrustBundle objects can either be selected by name or by the combination of signer name and a label selector Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem Esoteric PEM features such as inter block comments and block headers are stripped Certificates are deduplicated The ordering of certificates within the file is arbitrary and Kubelet may change the order over time a name ClusterTrustBundleProjection a ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem projected sources clusterTrustBundle path string required Relative path from the volume root to write the bundle projected sources clusterTrustBundle labelSelector a href LabelSelector a Select all ClusterTrustBundles that match this label selector Only has effect if signerName is set Mutually exclusive with name If unset interpreted as match nothing If set but empty interpreted as match everything projected sources clusterTrustBundle name string Select a single ClusterTrustBundle by object name Mutually exclusive with signerName and labelSelector projected sources clusterTrustBundle optional boolean If true don t block pod startup if the referenced ClusterTrustBundle s aren t available If using name then the named ClusterTrustBundle is allowed not to exist If using signerName then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles projected sources clusterTrustBundle signerName string Select all ClusterTrustBundles that match this signer name Mutually exclusive with name The contents of all selected ClusterTrustBundles will be unified and deduplicated projected sources configMap ConfigMapProjection configMap information about the configMap data to project a name ConfigMapProjection a Adapts a ConfigMap into a projected volume The contents of the target ConfigMap s Data field will be presented in a projected volume as files using the keys in the Data field as the file names unless the items element is populated with specific mappings of keys to paths Note that this is identical to a configmap volume source without the default mode projected sources configMap name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names projected sources configMap optional boolean optional specify whether the ConfigMap or its keys must be defined projected sources configMap items a href KeyToPath a Atomic will be replaced during a merge items if unspecified each key value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value If specified the listed keys will be projected into the specified paths and unlisted keys will not be present If a key is specified which is not present in the ConfigMap the volume setup will error unless it is marked optional Paths must be relative and may not contain the path or start with projected sources downwardAPI DownwardAPIProjection downwardAPI information about the downwardAPI data to project a name DownwardAPIProjection a Represents downward API info for projecting into a projected volume Note that this is identical to a downwardAPI volume source without the default mode projected sources downwardAPI items a href DownwardAPIVolumeFile a Atomic will be replaced during a merge Items is a list of DownwardAPIVolume file projected sources secret SecretProjection secret information about the secret data to project a name SecretProjection a Adapts a secret into a projected volume The contents of the target Secret s Data field will be presented in a projected volume as files using the keys in the Data field as the file names Note that this is identical to a secret volume source without the default mode projected sources secret name string Name of the referent This field is effectively required but due to backwards compatibility is allowed to be empty Instances of this type with an empty value here are almost certainly wrong More info https kubernetes io docs concepts overview working with objects names names projected sources secret optional boolean optional field specify whether the Secret or its key must be defined projected sources secret items a href KeyToPath a Atomic will be replaced during a merge items if unspecified each key value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value If specified the listed keys will be projected into the specified paths and unlisted keys will not be present If a key is specified which is not present in the Secret the volume setup will error unless it is marked optional Paths must be relative and may not contain the path or start with projected sources serviceAccountToken ServiceAccountTokenProjection serviceAccountToken is information about the serviceAccountToken data to project a name ServiceAccountTokenProjection a ServiceAccountTokenProjection represents a projected service account token volume This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs Kubernetes API Server or otherwise projected sources serviceAccountToken path string required path is the path relative to the mount point of the file to project the token into projected sources serviceAccountToken audience string audience is the intended audience of the token A recipient of a token must identify itself with an identifier specified in the audience of the token and otherwise should reject the token The audience defaults to the identifier of the apiserver projected sources serviceAccountToken expirationSeconds int64 expirationSeconds is the requested duration of validity of the service account token As the token approaches expiration the kubelet volume plugin will proactively rotate the service account token The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours Defaults to 1 hour and must be at least 10 minutes Local Temporary Directory emptyDir EmptyDirVolumeSource emptyDir represents a temporary directory that shares a pod s lifetime More info https kubernetes io docs concepts storage volumes emptydir a name EmptyDirVolumeSource a Represents an empty directory for a pod Empty directory volumes support ownership management and SELinux relabeling emptyDir medium string medium represents what type of storage medium should back this directory The default is which means to use the node s default medium Must be an empty string default or Memory More info https kubernetes io docs concepts storage volumes emptydir emptyDir sizeLimit a href Quantity a sizeLimit is the total amount of local storage required for this EmptyDir volume The size limit is also applicable for memory medium The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod The default is nil which means that the limit is undefined More info https kubernetes io docs concepts storage volumes emptydir hostPath HostPathVolumeSource hostPath represents a pre existing file or directory on the host machine that is directly exposed to the container This is generally used for system agents or other privileged things that are allowed to see the host machine Most containers will NOT need this More info https kubernetes io docs concepts storage volumes hostpath a name HostPathVolumeSource a Represents a host path mapped into a pod Host path volumes do not support ownership management or SELinux relabeling hostPath path string required path of the directory on the host If the path is a symlink it will follow the link to the real path More info https kubernetes io docs concepts storage volumes hostpath hostPath type string type for HostPath Volume Defaults to More info https kubernetes io docs concepts storage volumes hostpath Persistent volumes awsElasticBlockStore AWSElasticBlockStoreVolumeSource awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet s host machine and then exposed to the pod More info https kubernetes io docs concepts storage volumes awselasticblockstore a name AWSElasticBlockStoreVolumeSource a Represents a Persistent Disk resource in AWS An AWS EBS disk must exist before mounting to a container The disk must also be in the same AWS zone as the kubelet An AWS EBS disk can only be mounted as read write once AWS EBS volumes support ownership management and SELinux relabeling awsElasticBlockStore volumeID string required volumeID is unique ID of the persistent disk resource in AWS Amazon EBS volume More info https kubernetes io docs concepts storage volumes awselasticblockstore awsElasticBlockStore fsType string fsType is the filesystem type of the volume that you want to mount Tip Ensure that the filesystem type is supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https kubernetes io docs concepts storage volumes awselasticblockstore awsElasticBlockStore partition int32 partition is the partition in the volume that you want to mount If omitted the default is to mount by volume name Examples For volume dev sda1 you specify the partition as 1 Similarly the volume partition for dev sda is 0 or you can leave the property empty awsElasticBlockStore readOnly boolean readOnly value true will force the readOnly setting in VolumeMounts More info https kubernetes io docs concepts storage volumes awselasticblockstore azureDisk AzureDiskVolumeSource azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod a name AzureDiskVolumeSource a AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod azureDisk diskName string required diskName is the Name of the data disk in the blob storage azureDisk diskURI string required diskURI is the URI of data disk in the blob storage azureDisk cachingMode string cachingMode is the Host Caching mode None Read Only Read Write azureDisk fsType string fsType is Filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified azureDisk kind string kind expected values are Shared multiple blob disks per storage account Dedicated single blob disk per storage account Managed azure managed data disk only in managed availability set defaults to shared azureDisk readOnly boolean readOnly Defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts azureFile AzureFileVolumeSource azureFile represents an Azure File Service mount on the host and bind mount to the pod a name AzureFileVolumeSource a AzureFile represents an Azure File Service mount on the host and bind mount to the pod azureFile secretName string required secretName is the name of secret that contains Azure Storage Account Name and Key azureFile shareName string required shareName is the azure share Name azureFile readOnly boolean readOnly defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts cephfs CephFSVolumeSource cephFS represents a Ceph FS mount on the host that shares a pod s lifetime a name CephFSVolumeSource a Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling cephfs monitors string required Atomic will be replaced during a merge monitors is Required Monitors is a collection of Ceph monitors More info https examples k8s io volumes cephfs README md how to use it cephfs path string path is Optional Used as the mounted root rather than the full Ceph tree default is cephfs readOnly boolean readOnly is Optional Defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts More info https examples k8s io volumes cephfs README md how to use it cephfs secretFile string secretFile is Optional SecretFile is the path to key ring for User default is etc ceph user secret More info https examples k8s io volumes cephfs README md how to use it cephfs secretRef a href LocalObjectReference a secretRef is Optional SecretRef is reference to the authentication secret for User default is empty More info https examples k8s io volumes cephfs README md how to use it cephfs user string user is optional User is the rados user name default is admin More info https examples k8s io volumes cephfs README md how to use it cinder CinderVolumeSource cinder represents a cinder volume attached and mounted on kubelets host machine More info https examples k8s io mysql cinder pd README md a name CinderVolumeSource a Represents a cinder volume resource in Openstack A Cinder volume must exist before mounting to a container The volume must also be in the same region as the kubelet Cinder volumes support ownership management and SELinux relabeling cinder volumeID string required volumeID used to identify the volume in cinder More info https examples k8s io mysql cinder pd README md cinder fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https examples k8s io mysql cinder pd README md cinder readOnly boolean readOnly defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts More info https examples k8s io mysql cinder pd README md cinder secretRef a href LocalObjectReference a secretRef is optional points to a secret object containing parameters used to connect to OpenStack csi CSIVolumeSource csi Container Storage Interface represents ephemeral storage that is handled by certain external CSI drivers Beta feature a name CSIVolumeSource a Represents a source location of a volume to mount managed by an external CSI driver csi driver string required driver is the name of the CSI driver that handles this volume Consult with your admin for the correct name as registered in the cluster csi fsType string fsType to mount Ex ext4 xfs ntfs If not provided the empty value is passed to the associated CSI driver which will determine the default filesystem to apply csi nodePublishSecretRef a href LocalObjectReference a nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls This field is optional and may be empty if no secret is required If the secret object contains more than one secret all secret references are passed csi readOnly boolean readOnly specifies a read only configuration for the volume Defaults to false read write csi volumeAttributes map string string volumeAttributes stores driver specific properties that are passed to the CSI driver Consult your driver s documentation for supported values ephemeral EphemeralVolumeSource ephemeral represents a volume that is handled by a cluster storage driver The volume s lifecycle is tied to the pod that defines it it will be created before the pod starts and deleted when the pod is removed Use this if a the volume is only needed while the pod runs b features of normal volumes like restoring from snapshot or capacity tracking are needed c the storage driver is specified through a storage class and d the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim Use PersistentVolumeClaim or one of the vendor specific APIs for volumes that persist for longer than the lifecycle of an individual pod Use CSI for light weight local ephemeral volumes if the CSI driver is meant to be used that way see the documentation of the driver for more information A pod can use both types of ephemeral volumes and persistent volumes at the same time a name EphemeralVolumeSource a Represents an ephemeral volume that is handled by a normal storage driver ephemeral volumeClaimTemplate PersistentVolumeClaimTemplate Will be used to create a stand alone PVC to provision the volume The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC i e the PVC will be deleted together with the pod The name of the PVC will be pod name volume name where volume name is the name from the PodSpec Volumes array entry Pod validation will reject the pod if the concatenated name is not valid for a PVC for example too long An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake Starting the pod is then blocked until the unrelated PVC is removed If such a pre created PVC is meant to be used by the pod the PVC has to updated with an owner reference to the pod once the pod exists Normally this should not be necessary but it may be useful when manually reconstructing a broken cluster This field is read only and no changes will be made by Kubernetes to the PVC after it has been created Required must not be nil a name PersistentVolumeClaimTemplate a PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource ephemeral volumeClaimTemplate spec a href PersistentVolumeClaimSpec a required The specification for the PersistentVolumeClaim The entire content is copied unchanged into the PVC that gets created from this template The same fields as in a PersistentVolumeClaim are also valid here ephemeral volumeClaimTemplate metadata a href ObjectMeta a May contain labels and annotations that will be copied into the PVC when creating it No other fields are allowed and will be rejected during validation fc FCVolumeSource fc represents a Fibre Channel resource that is attached to a kubelet s host machine and then exposed to the pod a name FCVolumeSource a Represents a Fibre Channel volume Fibre Channel volumes can only be mounted as read write once Fibre Channel volumes support ownership management and SELinux relabeling fc fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified fc lun int32 lun is Optional FC target lun number fc readOnly boolean readOnly is Optional Defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts fc targetWWNs string Atomic will be replaced during a merge targetWWNs is Optional FC target worldwide names WWNs fc wwids string Atomic will be replaced during a merge wwids Optional FC volume world wide identifiers wwids Either wwids or combination of targetWWNs and lun must be set but not both simultaneously flexVolume FlexVolumeSource flexVolume represents a generic volume resource that is provisioned attached using an exec based plugin a name FlexVolumeSource a FlexVolume represents a generic volume resource that is provisioned attached using an exec based plugin flexVolume driver string required driver is the name of the driver to use for this volume flexVolume fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs The default filesystem depends on FlexVolume script flexVolume options map string string options is Optional this field holds extra command options if any flexVolume readOnly boolean readOnly is Optional defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts flexVolume secretRef a href LocalObjectReference a secretRef is Optional secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts This may be empty if no secret object is specified If the secret object contains more than one secret all secrets are passed to the plugin scripts flocker FlockerVolumeSource flocker represents a Flocker volume attached to a kubelet s host machine This depends on the Flocker control service being running a name FlockerVolumeSource a Represents a Flocker volume mounted by the Flocker agent One and only one of datasetName and datasetUUID should be set Flocker volumes do not support ownership management or SELinux relabeling flocker datasetName string datasetName is Name of the dataset stored as metadata name on the dataset for Flocker should be considered as deprecated flocker datasetUUID string datasetUUID is the UUID of the dataset This is unique identifier of a Flocker dataset gcePersistentDisk GCEPersistentDiskVolumeSource gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet s host machine and then exposed to the pod More info https kubernetes io docs concepts storage volumes gcepersistentdisk a name GCEPersistentDiskVolumeSource a Represents a Persistent Disk resource in Google Compute Engine A GCE PD must exist before mounting to a container The disk must also be in the same GCE project and zone as the kubelet A GCE PD can only be mounted as read write once or read only many times GCE PDs support ownership management and SELinux relabeling gcePersistentDisk pdName string required pdName is unique name of the PD resource in GCE Used to identify the disk in GCE More info https kubernetes io docs concepts storage volumes gcepersistentdisk gcePersistentDisk fsType string fsType is filesystem type of the volume that you want to mount Tip Ensure that the filesystem type is supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https kubernetes io docs concepts storage volumes gcepersistentdisk gcePersistentDisk partition int32 partition is the partition in the volume that you want to mount If omitted the default is to mount by volume name Examples For volume dev sda1 you specify the partition as 1 Similarly the volume partition for dev sda is 0 or you can leave the property empty More info https kubernetes io docs concepts storage volumes gcepersistentdisk gcePersistentDisk readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts Defaults to false More info https kubernetes io docs concepts storage volumes gcepersistentdisk glusterfs GlusterfsVolumeSource glusterfs represents a Glusterfs mount on the host that shares a pod s lifetime More info https examples k8s io volumes glusterfs README md a name GlusterfsVolumeSource a Represents a Glusterfs mount that lasts the lifetime of a pod Glusterfs volumes do not support ownership management or SELinux relabeling glusterfs endpoints string required endpoints is the endpoint name that details Glusterfs topology More info https examples k8s io volumes glusterfs README md create a pod glusterfs path string required path is the Glusterfs volume path More info https examples k8s io volumes glusterfs README md create a pod glusterfs readOnly boolean readOnly here will force the Glusterfs volume to be mounted with read only permissions Defaults to false More info https examples k8s io volumes glusterfs README md create a pod iscsi ISCSIVolumeSource iscsi represents an ISCSI Disk resource that is attached to a kubelet s host machine and then exposed to the pod More info https examples k8s io volumes iscsi README md a name ISCSIVolumeSource a Represents an ISCSI disk ISCSI volumes can only be mounted as read write once ISCSI volumes support ownership management and SELinux relabeling iscsi iqn string required iqn is the target iSCSI Qualified Name iscsi lun int32 required lun represents iSCSI Target Lun number iscsi targetPortal string required targetPortal is iSCSI Target Portal The Portal is either an IP or ip addr port if the port is other than default typically TCP ports 860 and 3260 iscsi chapAuthDiscovery boolean chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication iscsi chapAuthSession boolean chapAuthSession defines whether support iSCSI Session CHAP authentication iscsi fsType string fsType is the filesystem type of the volume that you want to mount Tip Ensure that the filesystem type is supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https kubernetes io docs concepts storage volumes iscsi iscsi initiatorName string initiatorName is the custom iSCSI Initiator Name If initiatorName is specified with iscsiInterface simultaneously new iSCSI interface target portal volume name will be created for the connection iscsi iscsiInterface string iscsiInterface is the interface Name that uses an iSCSI transport Defaults to default tcp iscsi portals string Atomic will be replaced during a merge portals is the iSCSI Target Portal List The portal is either an IP or ip addr port if the port is other than default typically TCP ports 860 and 3260 iscsi readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts Defaults to false iscsi secretRef a href LocalObjectReference a secretRef is the CHAP Secret for iSCSI target and initiator authentication image ImageVolumeSource image represents an OCI object a container image or artifact pulled and mounted on the kubelet s host machine The volume is resolved at pod startup depending on which PullPolicy value is provided Always the kubelet always attempts to pull the reference Container creation will fail If the pull fails Never the kubelet never pulls the reference and only uses a local image or artifact Container creation will fail if the reference isn t present IfNotPresent the kubelet pulls if the reference isn t already present on disk Container creation will fail if the reference isn t present and the pull fails The volume gets re resolved if the pod gets deleted and recreated which means that new remote content will become available on pod recreation A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency Failures will be retried using normal volume backoff and will be reported on the pod reason and message The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field The OCI object gets mounted in a single directory spec containers volumeMounts mountPath by merging the manifest layers in the same way as for container images The volume will be mounted read only ro and non executable files noexec Sub path mounts for containers are not supported spec containers volumeMounts subpath The field spec securityContext fsGroupChangePolicy has no effect on this volume type a name ImageVolumeSource a ImageVolumeSource represents a image volume resource image pullPolicy string Policy for pulling OCI objects Possible values are Always the kubelet always attempts to pull the reference Container creation will fail If the pull fails Never the kubelet never pulls the reference and only uses a local image or artifact Container creation will fail if the reference isn t present IfNotPresent the kubelet pulls if the reference isn t already present on disk Container creation will fail if the reference isn t present and the pull fails Defaults to Always if latest tag is specified or IfNotPresent otherwise image reference string Required Image or artifact reference to be used Behaves in the same way as pod spec containers image Pull secrets will be assembled in the same way as for the container image by looking up node credentials SA image pull secrets and pod spec image pull secrets More info https kubernetes io docs concepts containers images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets nfs NFSVolumeSource nfs represents an NFS mount on the host that shares a pod s lifetime More info https kubernetes io docs concepts storage volumes nfs a name NFSVolumeSource a Represents an NFS mount that lasts the lifetime of a pod NFS volumes do not support ownership management or SELinux relabeling nfs path string required path that is exported by the NFS server More info https kubernetes io docs concepts storage volumes nfs nfs server string required server is the hostname or IP address of the NFS server More info https kubernetes io docs concepts storage volumes nfs nfs readOnly boolean readOnly here will force the NFS export to be mounted with read only permissions Defaults to false More info https kubernetes io docs concepts storage volumes nfs photonPersistentDisk PhotonPersistentDiskVolumeSource photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine a name PhotonPersistentDiskVolumeSource a Represents a Photon Controller persistent disk resource photonPersistentDisk pdID string required pdID is the ID that identifies Photon Controller persistent disk photonPersistentDisk fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified portworxVolume PortworxVolumeSource portworxVolume represents a portworx volume attached and mounted on kubelets host machine a name PortworxVolumeSource a PortworxVolumeSource represents a Portworx volume resource portworxVolume volumeID string required volumeID uniquely identifies a Portworx volume portworxVolume fsType string fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs Implicitly inferred to be ext4 if unspecified portworxVolume readOnly boolean readOnly defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts quobyte QuobyteVolumeSource quobyte represents a Quobyte mount on the host that shares a pod s lifetime a name QuobyteVolumeSource a Represents a Quobyte mount that lasts the lifetime of a pod Quobyte volumes do not support ownership management or SELinux relabeling quobyte registry string required registry represents a single or multiple Quobyte Registry services specified as a string as host port pair multiple entries are separated with commas which acts as the central registry for volumes quobyte volume string required volume is a string that references an already created Quobyte volume by name quobyte group string group to map volume access to Default is no group quobyte readOnly boolean readOnly here will force the Quobyte volume to be mounted with read only permissions Defaults to false quobyte tenant string tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes value is set by the plugin quobyte user string user to map volume access to Defaults to serivceaccount user rbd RBDVolumeSource rbd represents a Rados Block Device mount on the host that shares a pod s lifetime More info https examples k8s io volumes rbd README md a name RBDVolumeSource a Represents a Rados Block Device mount that lasts the lifetime of a pod RBD volumes support ownership management and SELinux relabeling rbd image string required image is the rados image name More info https examples k8s io volumes rbd README md how to use it rbd monitors string required Atomic will be replaced during a merge monitors is a collection of Ceph monitors More info https examples k8s io volumes rbd README md how to use it rbd fsType string fsType is the filesystem type of the volume that you want to mount Tip Ensure that the filesystem type is supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https kubernetes io docs concepts storage volumes rbd rbd keyring string keyring is the path to key ring for RBDUser Default is etc ceph keyring More info https examples k8s io volumes rbd README md how to use it rbd pool string pool is the rados pool name Default is rbd More info https examples k8s io volumes rbd README md how to use it rbd readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts Defaults to false More info https examples k8s io volumes rbd README md how to use it rbd secretRef a href LocalObjectReference a secretRef is name of the authentication secret for RBDUser If provided overrides keyring Default is nil More info https examples k8s io volumes rbd README md how to use it rbd user string user is the rados user name Default is admin More info https examples k8s io volumes rbd README md how to use it scaleIO ScaleIOVolumeSource scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes a name ScaleIOVolumeSource a ScaleIOVolumeSource represents a persistent ScaleIO volume scaleIO gateway string required gateway is the host address of the ScaleIO API Gateway scaleIO secretRef a href LocalObjectReference a required secretRef references to the secret for ScaleIO user and other sensitive information If this is not provided Login operation will fail scaleIO system string required system is the name of the storage system as configured in ScaleIO scaleIO fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Default is xfs scaleIO protectionDomain string protectionDomain is the name of the ScaleIO Protection Domain for the configured storage scaleIO readOnly boolean readOnly Defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts scaleIO sslEnabled boolean sslEnabled Flag enable disable SSL communication with Gateway default false scaleIO storageMode string storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned Default is ThinProvisioned scaleIO storagePool string storagePool is the ScaleIO Storage Pool associated with the protection domain scaleIO volumeName string volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source storageos StorageOSVolumeSource storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes a name StorageOSVolumeSource a Represents a StorageOS persistent volume resource storageos fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified storageos readOnly boolean readOnly defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts storageos secretRef a href LocalObjectReference a secretRef specifies the secret to use for obtaining the StorageOS API credentials If not specified default values will be attempted storageos volumeName string volumeName is the human readable name of the StorageOS volume Volume names are only unique within a namespace storageos volumeNamespace string volumeNamespace specifies the scope of the volume within StorageOS If no namespace is specified then the Pod s namespace will be used This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration Set VolumeName to any name to override the default behaviour Set to default if you are not using namespaces within StorageOS Namespaces that do not pre exist within StorageOS will be created vsphereVolume VsphereVirtualDiskVolumeSource vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine a name VsphereVirtualDiskVolumeSource a Represents a vSphere volume resource vsphereVolume volumePath string required volumePath is the path that identifies vSphere volume vmdk vsphereVolume fsType string fsType is filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified vsphereVolume storagePolicyID string storagePolicyID is the storage Policy Based Management SPBM profile ID associated with the StoragePolicyName vsphereVolume storagePolicyName string storagePolicyName is the storage Policy Based Management SPBM profile name Deprecated gitRepo GitRepoVolumeSource gitRepo represents a git repository at a particular revision DEPRECATED GitRepo is deprecated To provision a container with a git repo mount an EmptyDir into an InitContainer that clones the repo using git then mount the EmptyDir into the Pod s container a name GitRepoVolumeSource a Represents a volume that is populated with the contents of a git repository Git repo volumes do not support ownership management Git repo volumes support SELinux relabeling DEPRECATED GitRepo is deprecated To provision a container with a git repo mount an EmptyDir into an InitContainer that clones the repo using git then mount the EmptyDir into the Pod s container gitRepo repository string required repository is the URL gitRepo directory string directory is the target directory name Must not contain or start with If is supplied the volume directory will be the git repository Otherwise if specified the volume will contain the git repository in the subdirectory with the given name gitRepo revision string revision is the commit hash for the specified revision DownwardAPIVolumeFile DownwardAPIVolumeFile DownwardAPIVolumeFile represents information to create the file containing the pod field hr path string required Required Path is the relative path name of the file to be created Must not be absolute or contain the path Must be utf 8 encoded The first item of the relative path must not start with fieldRef a href ObjectFieldSelector a Required Selects a field of the pod only annotations labels name namespace and uid are supported mode int32 Optional mode bits used to set permissions on this file must be an octal value between 0000 and 0777 or a decimal value between 0 and 511 YAML accepts both octal and decimal values JSON requires decimal values for mode bits If not specified the volume defaultMode will be used This might be in conflict with other options that affect the file mode like fsGroup and the result can be other mode bits set resourceFieldRef a href ResourceFieldSelector a Selects a resource of the container only resources limits and requests limits cpu limits memory requests cpu and requests memory are currently supported KeyToPath KeyToPath Maps a string key to a path within a volume hr key string required key is the key to project path string required path is the relative path of the file to map the key to May not be an absolute path May not contain the path element May not start with the string mode int32 mode is Optional mode bits used to set permissions on this file Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511 YAML accepts both octal and decimal values JSON requires decimal values for mode bits If not specified the volume defaultMode will be used This might be in conflict with other options that affect the file mode like fsGroup and the result can be other mode bits set |
kubernetes reference title CSIStorageCapacity weight 5 contenttype apireference kind CSIStorageCapacity apimetadata apiVersion storage k8s io v1 CSIStorageCapacity stores the result of one CSI GetCapacity call autogenerated true import k8s io api storage v1 | ---
api_metadata:
apiVersion: "storage.k8s.io/v1"
import: "k8s.io/api/storage/v1"
kind: "CSIStorageCapacity"
content_type: "api_reference"
description: "CSIStorageCapacity stores the result of one CSI GetCapacity call."
title: "CSIStorageCapacity"
weight: 5
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.
-->
`apiVersion: storage.k8s.io/v1`
`import "k8s.io/api/storage/v1"`
## CSIStorageCapacity {#CSIStorageCapacity}
CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes.
For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123"
The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero
The producer of these objects can decide which approach is more suitable.
They are consumed by the kube-scheduler when a CSI driver opts into capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back to a comparison against the less precise Capacity. If that is also unset, the scheduler assumes that capacity is insufficient and tries some other node.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: CSIStorageCapacity
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. The name has no particular meaning. It must be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-\<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name.
Objects are namespaced.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **storageClassName** (string), required
storageClassName represents the name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
- **capacity** (<a href="">Quantity</a>)
capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable.
- **maximumVolumeSize** (<a href="">Quantity</a>)
maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.
- **nodeTopology** (<a href="">LabelSelector</a>)
nodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.
## CSIStorageCapacityList {#CSIStorageCapacityList}
CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: CSIStorageCapacityList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">CSIStorageCapacity</a>), required
items is the list of CSIStorageCapacity objects.
## Operations {#Operations}
<hr>
### `get` read the specified CSIStorageCapacity
#### HTTP Request
GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIStorageCapacity
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSIStorageCapacity</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CSIStorageCapacity
#### HTTP Request
GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">CSIStorageCapacityList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CSIStorageCapacity
#### HTTP Request
GET /apis/storage.k8s.io/v1/csistoragecapacities
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">CSIStorageCapacityList</a>): OK
401: Unauthorized
### `create` create a CSIStorageCapacity
#### HTTP Request
POST /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">CSIStorageCapacity</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSIStorageCapacity</a>): OK
201 (<a href="">CSIStorageCapacity</a>): Created
202 (<a href="">CSIStorageCapacity</a>): Accepted
401: Unauthorized
### `update` replace the specified CSIStorageCapacity
#### HTTP Request
PUT /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIStorageCapacity
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">CSIStorageCapacity</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSIStorageCapacity</a>): OK
201 (<a href="">CSIStorageCapacity</a>): Created
401: Unauthorized
### `patch` partially update the specified CSIStorageCapacity
#### HTTP Request
PATCH /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIStorageCapacity
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSIStorageCapacity</a>): OK
201 (<a href="">CSIStorageCapacity</a>): Created
401: Unauthorized
### `delete` delete a CSIStorageCapacity
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIStorageCapacity
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of CSIStorageCapacity
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion storage k8s io v1 import k8s io api storage v1 kind CSIStorageCapacity content type api reference description CSIStorageCapacity stores the result of one CSI GetCapacity call title CSIStorageCapacity weight 5 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 apiVersion storage k8s io v1 import k8s io api storage v1 CSIStorageCapacity CSIStorageCapacity CSIStorageCapacity stores the result of one CSI GetCapacity call For a given StorageClass this describes the available capacity in a particular topology segment This can be used when considering where to instantiate new PersistentVolumes For example this can express things like StorageClass standard has 1234 GiB available in topology kubernetes io zone us east1 StorageClass localssd has 10 GiB available in kubernetes io hostname knode abc123 The following three cases all imply that no capacity is available for a certain combination no object exists with suitable topology and storage class name such an object exists but the capacity is unset such an object exists but the capacity is zero The producer of these objects can decide which approach is more suitable They are consumed by the kube scheduler when a CSI driver opts into capacity aware scheduling with CSIDriverSpec StorageCapacity The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes If MaximumVolumeSize is unset it falls back to a comparison against the less precise Capacity If that is also unset the scheduler assumes that capacity is insufficient and tries some other node hr apiVersion storage k8s io v1 kind CSIStorageCapacity metadata a href ObjectMeta a Standard object s metadata The name has no particular meaning It must be a DNS subdomain dots allowed 253 characters To ensure that there are no conflicts with other CSI drivers on the cluster the recommendation is to use csisc uuid a generated name or a reverse domain name which ends with the unique CSI driver name Objects are namespaced More info https git k8s io community contributors devel sig architecture api conventions md metadata storageClassName string required storageClassName represents the name of the StorageClass that the reported capacity applies to It must meet the same requirements as the name of a StorageClass object non empty DNS subdomain If that object no longer exists the CSIStorageCapacity object is obsolete and should be removed by its creator This field is immutable capacity a href Quantity a capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields The semantic is currently CSI spec 1 2 defined as The available capacity in bytes of the storage that can be used to provision volumes If not set that information is currently unavailable maximumVolumeSize a href Quantity a maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields This is defined since CSI spec 1 4 0 as the largest size that may be used in a CreateVolumeRequest capacity range required bytes field to create a volume with the same parameters as those in GetCapacityRequest The corresponding value in the Kubernetes API is ResourceRequirements Requests in a volume claim nodeTopology a href LabelSelector a nodeTopology defines which nodes have access to the storage for which capacity was reported If not set the storage is not accessible from any node in the cluster If empty the storage is accessible from all nodes This field is immutable CSIStorageCapacityList CSIStorageCapacityList CSIStorageCapacityList is a collection of CSIStorageCapacity objects hr apiVersion storage k8s io v1 kind CSIStorageCapacityList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href CSIStorageCapacity a required items is the list of CSIStorageCapacity objects Operations Operations hr get read the specified CSIStorageCapacity HTTP Request GET apis storage k8s io v1 namespaces namespace csistoragecapacities name Parameters name in path string required name of the CSIStorageCapacity namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href CSIStorageCapacity a OK 401 Unauthorized list list or watch objects of kind CSIStorageCapacity HTTP Request GET apis storage k8s io v1 namespaces namespace csistoragecapacities Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href CSIStorageCapacityList a OK 401 Unauthorized list list or watch objects of kind CSIStorageCapacity HTTP Request GET apis storage k8s io v1 csistoragecapacities Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href CSIStorageCapacityList a OK 401 Unauthorized create create a CSIStorageCapacity HTTP Request POST apis storage k8s io v1 namespaces namespace csistoragecapacities Parameters namespace in path string required a href namespace a body a href CSIStorageCapacity a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CSIStorageCapacity a OK 201 a href CSIStorageCapacity a Created 202 a href CSIStorageCapacity a Accepted 401 Unauthorized update replace the specified CSIStorageCapacity HTTP Request PUT apis storage k8s io v1 namespaces namespace csistoragecapacities name Parameters name in path string required name of the CSIStorageCapacity namespace in path string required a href namespace a body a href CSIStorageCapacity a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CSIStorageCapacity a OK 201 a href CSIStorageCapacity a Created 401 Unauthorized patch partially update the specified CSIStorageCapacity HTTP Request PATCH apis storage k8s io v1 namespaces namespace csistoragecapacities name Parameters name in path string required name of the CSIStorageCapacity namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CSIStorageCapacity a OK 201 a href CSIStorageCapacity a Created 401 Unauthorized delete delete a CSIStorageCapacity HTTP Request DELETE apis storage k8s io v1 namespaces namespace csistoragecapacities name Parameters name in path string required name of the CSIStorageCapacity namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of CSIStorageCapacity HTTP Request DELETE apis storage k8s io v1 namespaces namespace csistoragecapacities Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion storage k8s io v1beta1 kind VolumeAttributesClass import k8s io api storage v1beta1 contenttype apireference VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver title VolumeAttributesClass v1beta1 apimetadata weight 12 autogenerated true | ---
api_metadata:
apiVersion: "storage.k8s.io/v1beta1"
import: "k8s.io/api/storage/v1beta1"
kind: "VolumeAttributesClass"
content_type: "api_reference"
description: "VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver."
title: "VolumeAttributesClass v1beta1"
weight: 12
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.
-->
`apiVersion: storage.k8s.io/v1beta1`
`import "k8s.io/api/storage/v1beta1"`
## VolumeAttributesClass {#VolumeAttributesClass}
VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver. The class can be specified during dynamic provisioning of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.
<hr>
- **apiVersion**: storage.k8s.io/v1beta1
- **kind**: VolumeAttributesClass
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **driverName** (string), required
Name of the CSI driver This field is immutable.
- **parameters** (map[string]string)
parameters hold volume attributes defined by the CSI driver. These values are opaque to the Kubernetes and are passed directly to the CSI driver. The underlying storage provider supports changing these attributes on an existing volume, however the parameters field itself is immutable. To invoke a volume update, a new VolumeAttributesClass should be created with new parameters, and the PersistentVolumeClaim should be updated to reference the new VolumeAttributesClass.
This field is required and must contain at least one key/value pair. The keys cannot be empty, and the maximum number of parameters is 512, with a cumulative max size of 256K. If the CSI driver rejects invalid parameters, the target PersistentVolumeClaim will be set to an "Infeasible" state in the modifyVolumeStatus field.
## VolumeAttributesClassList {#VolumeAttributesClassList}
VolumeAttributesClassList is a collection of VolumeAttributesClass objects.
<hr>
- **apiVersion**: storage.k8s.io/v1beta1
- **kind**: VolumeAttributesClassList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">VolumeAttributesClass</a>), required
items is the list of VolumeAttributesClass objects.
## Operations {#Operations}
<hr>
### `get` read the specified VolumeAttributesClass
#### HTTP Request
GET /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttributesClass
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttributesClass</a>): OK
401: Unauthorized
### `list` list or watch objects of kind VolumeAttributesClass
#### HTTP Request
GET /apis/storage.k8s.io/v1beta1/volumeattributesclasses
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">VolumeAttributesClassList</a>): OK
401: Unauthorized
### `create` create a VolumeAttributesClass
#### HTTP Request
POST /apis/storage.k8s.io/v1beta1/volumeattributesclasses
#### Parameters
- **body**: <a href="">VolumeAttributesClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttributesClass</a>): OK
201 (<a href="">VolumeAttributesClass</a>): Created
202 (<a href="">VolumeAttributesClass</a>): Accepted
401: Unauthorized
### `update` replace the specified VolumeAttributesClass
#### HTTP Request
PUT /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttributesClass
- **body**: <a href="">VolumeAttributesClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttributesClass</a>): OK
201 (<a href="">VolumeAttributesClass</a>): Created
401: Unauthorized
### `patch` partially update the specified VolumeAttributesClass
#### HTTP Request
PATCH /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttributesClass
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttributesClass</a>): OK
201 (<a href="">VolumeAttributesClass</a>): Created
401: Unauthorized
### `delete` delete a VolumeAttributesClass
#### HTTP Request
DELETE /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttributesClass
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">VolumeAttributesClass</a>): OK
202 (<a href="">VolumeAttributesClass</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of VolumeAttributesClass
#### HTTP Request
DELETE /apis/storage.k8s.io/v1beta1/volumeattributesclasses
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion storage k8s io v1beta1 import k8s io api storage v1beta1 kind VolumeAttributesClass content type api reference description VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver title VolumeAttributesClass v1beta1 weight 12 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 apiVersion storage k8s io v1beta1 import k8s io api storage v1beta1 VolumeAttributesClass VolumeAttributesClass VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver The class can be specified during dynamic provisioning of PersistentVolumeClaims and changed in the PersistentVolumeClaim spec after provisioning hr apiVersion storage k8s io v1beta1 kind VolumeAttributesClass metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata driverName string required Name of the CSI driver This field is immutable parameters map string string parameters hold volume attributes defined by the CSI driver These values are opaque to the Kubernetes and are passed directly to the CSI driver The underlying storage provider supports changing these attributes on an existing volume however the parameters field itself is immutable To invoke a volume update a new VolumeAttributesClass should be created with new parameters and the PersistentVolumeClaim should be updated to reference the new VolumeAttributesClass This field is required and must contain at least one key value pair The keys cannot be empty and the maximum number of parameters is 512 with a cumulative max size of 256K If the CSI driver rejects invalid parameters the target PersistentVolumeClaim will be set to an Infeasible state in the modifyVolumeStatus field VolumeAttributesClassList VolumeAttributesClassList VolumeAttributesClassList is a collection of VolumeAttributesClass objects hr apiVersion storage k8s io v1beta1 kind VolumeAttributesClassList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href VolumeAttributesClass a required items is the list of VolumeAttributesClass objects Operations Operations hr get read the specified VolumeAttributesClass HTTP Request GET apis storage k8s io v1beta1 volumeattributesclasses name Parameters name in path string required name of the VolumeAttributesClass pretty in query string a href pretty a Response 200 a href VolumeAttributesClass a OK 401 Unauthorized list list or watch objects of kind VolumeAttributesClass HTTP Request GET apis storage k8s io v1beta1 volumeattributesclasses Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href VolumeAttributesClassList a OK 401 Unauthorized create create a VolumeAttributesClass HTTP Request POST apis storage k8s io v1beta1 volumeattributesclasses Parameters body a href VolumeAttributesClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href VolumeAttributesClass a OK 201 a href VolumeAttributesClass a Created 202 a href VolumeAttributesClass a Accepted 401 Unauthorized update replace the specified VolumeAttributesClass HTTP Request PUT apis storage k8s io v1beta1 volumeattributesclasses name Parameters name in path string required name of the VolumeAttributesClass body a href VolumeAttributesClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href VolumeAttributesClass a OK 201 a href VolumeAttributesClass a Created 401 Unauthorized patch partially update the specified VolumeAttributesClass HTTP Request PATCH apis storage k8s io v1beta1 volumeattributesclasses name Parameters name in path string required name of the VolumeAttributesClass body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href VolumeAttributesClass a OK 201 a href VolumeAttributesClass a Created 401 Unauthorized delete delete a VolumeAttributesClass HTTP Request DELETE apis storage k8s io v1beta1 volumeattributesclasses name Parameters name in path string required name of the VolumeAttributesClass body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href VolumeAttributesClass a OK 202 a href VolumeAttributesClass a Accepted 401 Unauthorized deletecollection delete collection of VolumeAttributesClass HTTP Request DELETE apis storage k8s io v1beta1 volumeattributesclasses Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind PersistentVolume weight 7 apiVersion v1 contenttype apireference apimetadata autogenerated true PersistentVolume PV is a storage resource provisioned by an administrator title PersistentVolume import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "PersistentVolume"
content_type: "api_reference"
description: "PersistentVolume (PV) is a storage resource provisioned by an administrator."
title: "PersistentVolume"
weight: 7
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## PersistentVolume {#PersistentVolume}
PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
<hr>
- **apiVersion**: v1
- **kind**: PersistentVolume
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">PersistentVolumeSpec</a>)
spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
- **status** (<a href="">PersistentVolumeStatus</a>)
status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
## PersistentVolumeSpec {#PersistentVolumeSpec}
PersistentVolumeSpec is the specification of a persistent volume.
<hr>
- **accessModes** ([]string)
*Atomic: will be replaced during a merge*
accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
- **capacity** (map[string]<a href="">Quantity</a>)
capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
- **claimRef** (<a href="">ObjectReference</a>)
claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
- **mountOptions** ([]string)
*Atomic: will be replaced during a merge*
mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
- **nodeAffinity** (VolumeNodeAffinity)
nodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
<a name="VolumeNodeAffinity"></a>
*VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.*
- **nodeAffinity.required** (NodeSelector)
required specifies hard node constraints that must be met.
<a name="NodeSelector"></a>
*A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.*
- **nodeAffinity.required.nodeSelectorTerms** ([]NodeSelectorTerm), required
*Atomic: will be replaced during a merge*
Required. A list of node selector terms. The terms are ORed.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **nodeAffinity.required.nodeSelectorTerms.matchExpressions** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's labels.
- **nodeAffinity.required.nodeSelectorTerms.matchFields** ([]<a href="">NodeSelectorRequirement</a>)
*Atomic: will be replaced during a merge*
A list of node selector requirements by node's fields.
- **persistentVolumeReclaimPolicy** (string)
persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
- **storageClassName** (string)
storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
- **volumeAttributesClassName** (string)
Name of VolumeAttributesClass to which this persistent volume belongs. Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any VolumeAttributesClass. This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class. For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
- **volumeMode** (string)
volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.
### Local
- **hostPath** (HostPathVolumeSource)
hostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
<a name="HostPathVolumeSource"></a>
*Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.*
- **hostPath.path** (string), required
path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- **hostPath.type** (string)
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- **local** (LocalVolumeSource)
local represents directly-attached storage with node affinity
<a name="LocalVolumeSource"></a>
*Local represents directly-attached storage with node affinity (Beta feature)*
- **local.path** (string), required
path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
- **local.fsType** (string)
fsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified.
### Persistent volumes
- **awsElasticBlockStore** (AWSElasticBlockStoreVolumeSource)
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
<a name="AWSElasticBlockStoreVolumeSource"></a>
*Represents a Persistent Disk resource in AWS.
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.*
- **awsElasticBlockStore.volumeID** (string), required
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- **awsElasticBlockStore.fsType** (string)
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- **awsElasticBlockStore.partition** (int32)
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
- **awsElasticBlockStore.readOnly** (boolean)
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- **azureDisk** (AzureDiskVolumeSource)
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
<a name="AzureDiskVolumeSource"></a>
*AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.*
- **azureDisk.diskName** (string), required
diskName is the Name of the data disk in the blob storage
- **azureDisk.diskURI** (string), required
diskURI is the URI of data disk in the blob storage
- **azureDisk.cachingMode** (string)
cachingMode is the Host Caching mode: None, Read Only, Read Write.
- **azureDisk.fsType** (string)
fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **azureDisk.kind** (string)
kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
- **azureDisk.readOnly** (boolean)
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **azureFile** (AzureFilePersistentVolumeSource)
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
<a name="AzureFilePersistentVolumeSource"></a>
*AzureFile represents an Azure File Service mount on the host and bind mount to the pod.*
- **azureFile.secretName** (string), required
secretName is the name of secret that contains Azure Storage Account Name and Key
- **azureFile.shareName** (string), required
shareName is the azure Share Name
- **azureFile.readOnly** (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **azureFile.secretNamespace** (string)
secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
- **cephfs** (CephFSPersistentVolumeSource)
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
<a name="CephFSPersistentVolumeSource"></a>
*Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.*
- **cephfs.monitors** ([]string), required
*Atomic: will be replaced during a merge*
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cephfs.path** (string)
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- **cephfs.readOnly** (boolean)
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cephfs.secretFile** (string)
secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cephfs.secretRef** (SecretReference)
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **cephfs.secretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **cephfs.secretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **cephfs.user** (string)
user is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- **cinder** (CinderPersistentVolumeSource)
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
<a name="CinderPersistentVolumeSource"></a>
*Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.*
- **cinder.volumeID** (string), required
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- **cinder.fsType** (string)
fsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- **cinder.readOnly** (boolean)
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- **cinder.secretRef** (SecretReference)
secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **cinder.secretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **cinder.secretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **csi** (CSIPersistentVolumeSource)
csi represents storage that is handled by an external CSI driver (Beta feature).
<a name="CSIPersistentVolumeSource"></a>
*Represents storage that is managed by an external CSI volume driver (Beta feature)*
- **csi.driver** (string), required
driver is the name of the driver to use for this volume. Required.
- **csi.volumeHandle** (string), required
volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
- **csi.controllerExpandSecretRef** (SecretReference)
controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.controllerExpandSecretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **csi.controllerExpandSecretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **csi.controllerPublishSecretRef** (SecretReference)
controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.controllerPublishSecretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **csi.controllerPublishSecretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **csi.fsType** (string)
fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
- **csi.nodeExpandSecretRef** (SecretReference)
nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.nodeExpandSecretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **csi.nodeExpandSecretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **csi.nodePublishSecretRef** (SecretReference)
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.nodePublishSecretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **csi.nodePublishSecretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **csi.nodeStageSecretRef** (SecretReference)
nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.nodeStageSecretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **csi.nodeStageSecretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **csi.readOnly** (boolean)
readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
- **csi.volumeAttributes** (map[string]string)
volumeAttributes of the volume to publish.
- **fc** (FCVolumeSource)
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
<a name="FCVolumeSource"></a>
*Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.*
- **fc.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **fc.lun** (int32)
lun is Optional: FC target lun number
- **fc.readOnly** (boolean)
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **fc.targetWWNs** ([]string)
*Atomic: will be replaced during a merge*
targetWWNs is Optional: FC target worldwide names (WWNs)
- **fc.wwids** ([]string)
*Atomic: will be replaced during a merge*
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- **flexVolume** (FlexPersistentVolumeSource)
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
<a name="FlexPersistentVolumeSource"></a>
*FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.*
- **flexVolume.driver** (string), required
driver is the name of the driver to use for this volume.
- **flexVolume.fsType** (string)
fsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
- **flexVolume.options** (map[string]string)
options is Optional: this field holds extra command options if any.
- **flexVolume.readOnly** (boolean)
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **flexVolume.secretRef** (SecretReference)
secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **flexVolume.secretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **flexVolume.secretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **flocker** (FlockerVolumeSource)
flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
<a name="FlockerVolumeSource"></a>
*Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.*
- **flocker.datasetName** (string)
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
- **flocker.datasetUUID** (string)
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
- **gcePersistentDisk** (GCEPersistentDiskVolumeSource)
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
<a name="GCEPersistentDiskVolumeSource"></a>
*Represents a Persistent Disk resource in Google Compute Engine.
A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.*
- **gcePersistentDisk.pdName** (string), required
pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **gcePersistentDisk.fsType** (string)
fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **gcePersistentDisk.partition** (int32)
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **gcePersistentDisk.readOnly** (boolean)
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **glusterfs** (GlusterfsPersistentVolumeSource)
glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md
<a name="GlusterfsPersistentVolumeSource"></a>
*Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.*
- **glusterfs.endpoints** (string), required
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.path** (string), required
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.endpointsNamespace** (string)
endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.readOnly** (boolean)
readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **iscsi** (ISCSIPersistentVolumeSource)
iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
<a name="ISCSIPersistentVolumeSource"></a>
*ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.*
- **iscsi.iqn** (string), required
iqn is Target iSCSI Qualified Name.
- **iscsi.lun** (int32), required
lun is iSCSI Target Lun number.
- **iscsi.targetPortal** (string), required
targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
- **iscsi.chapAuthDiscovery** (boolean)
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
- **iscsi.chapAuthSession** (boolean)
chapAuthSession defines whether support iSCSI Session CHAP authentication
- **iscsi.fsType** (string)
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- **iscsi.initiatorName** (string)
initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface \<target portal>:\<volume name> will be created for the connection.
- **iscsi.iscsiInterface** (string)
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
- **iscsi.portals** ([]string)
*Atomic: will be replaced during a merge*
portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
- **iscsi.readOnly** (boolean)
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
- **iscsi.secretRef** (SecretReference)
secretRef is the CHAP Secret for iSCSI target and initiator authentication
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **iscsi.secretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **iscsi.secretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **nfs** (NFSVolumeSource)
nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
<a name="NFSVolumeSource"></a>
*Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.*
- **nfs.path** (string), required
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- **nfs.server** (string), required
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- **nfs.readOnly** (boolean)
readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- **photonPersistentDisk** (PhotonPersistentDiskVolumeSource)
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
<a name="PhotonPersistentDiskVolumeSource"></a>
*Represents a Photon Controller persistent disk resource.*
- **photonPersistentDisk.pdID** (string), required
pdID is the ID that identifies Photon Controller persistent disk
- **photonPersistentDisk.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **portworxVolume** (PortworxVolumeSource)
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
<a name="PortworxVolumeSource"></a>
*PortworxVolumeSource represents a Portworx volume resource.*
- **portworxVolume.volumeID** (string), required
volumeID uniquely identifies a Portworx volume
- **portworxVolume.fsType** (string)
fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
- **portworxVolume.readOnly** (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **quobyte** (QuobyteVolumeSource)
quobyte represents a Quobyte mount on the host that shares a pod's lifetime
<a name="QuobyteVolumeSource"></a>
*Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.*
- **quobyte.registry** (string), required
registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
- **quobyte.volume** (string), required
volume is a string that references an already created Quobyte volume by name.
- **quobyte.group** (string)
group to map volume access to Default is no group
- **quobyte.readOnly** (boolean)
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
- **quobyte.tenant** (string)
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
- **quobyte.user** (string)
user to map volume access to Defaults to serivceaccount user
- **rbd** (RBDPersistentVolumeSource)
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
<a name="RBDPersistentVolumeSource"></a>
*Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.*
- **rbd.image** (string), required
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.monitors** ([]string), required
*Atomic: will be replaced during a merge*
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.fsType** (string)
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- **rbd.keyring** (string)
keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.pool** (string)
pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.readOnly** (boolean)
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **rbd.secretRef** (SecretReference)
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **rbd.secretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **rbd.secretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **rbd.user** (string)
user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- **scaleIO** (ScaleIOPersistentVolumeSource)
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
<a name="ScaleIOPersistentVolumeSource"></a>
*ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume*
- **scaleIO.gateway** (string), required
gateway is the host address of the ScaleIO API Gateway.
- **scaleIO.secretRef** (SecretReference), required
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **scaleIO.secretRef.name** (string)
name is unique within a namespace to reference a secret resource.
- **scaleIO.secretRef.namespace** (string)
namespace defines the space within which the secret name must be unique.
- **scaleIO.system** (string), required
system is the name of the storage system as configured in ScaleIO.
- **scaleIO.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
- **scaleIO.protectionDomain** (string)
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
- **scaleIO.readOnly** (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **scaleIO.sslEnabled** (boolean)
sslEnabled is the flag to enable/disable SSL communication with Gateway, default false
- **scaleIO.storageMode** (string)
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
- **scaleIO.storagePool** (string)
storagePool is the ScaleIO Storage Pool associated with the protection domain.
- **scaleIO.volumeName** (string)
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
- **storageos** (StorageOSPersistentVolumeSource)
storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md
<a name="StorageOSPersistentVolumeSource"></a>
*Represents a StorageOS persistent volume resource.*
- **storageos.fsType** (string)
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **storageos.readOnly** (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- **storageos.secretRef** (<a href="">ObjectReference</a>)
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
- **storageos.volumeName** (string)
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
- **storageos.volumeNamespace** (string)
volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
- **vsphereVolume** (VsphereVirtualDiskVolumeSource)
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
<a name="VsphereVirtualDiskVolumeSource"></a>
*Represents a vSphere volume resource.*
- **vsphereVolume.volumePath** (string), required
volumePath is the path that identifies vSphere volume vmdk
- **vsphereVolume.fsType** (string)
fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- **vsphereVolume.storagePolicyID** (string)
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- **vsphereVolume.storagePolicyName** (string)
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
## PersistentVolumeStatus {#PersistentVolumeStatus}
PersistentVolumeStatus is the current status of a persistent volume.
<hr>
- **lastPhaseTransitionTime** (Time)
lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **message** (string)
message is a human-readable message indicating details about why the volume is in this state.
- **phase** (string)
phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
- **reason** (string)
reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
## PersistentVolumeList {#PersistentVolumeList}
PersistentVolumeList is a list of PersistentVolume items.
<hr>
- **apiVersion**: v1
- **kind**: PersistentVolumeList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">PersistentVolume</a>), required
items is a list of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
## Operations {#Operations}
<hr>
### `get` read the specified PersistentVolume
#### HTTP Request
GET /api/v1/persistentvolumes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolume
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolume</a>): OK
401: Unauthorized
### `get` read status of the specified PersistentVolume
#### HTTP Request
GET /api/v1/persistentvolumes/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolume
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolume</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PersistentVolume
#### HTTP Request
GET /api/v1/persistentvolumes
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PersistentVolumeList</a>): OK
401: Unauthorized
### `create` create a PersistentVolume
#### HTTP Request
POST /api/v1/persistentvolumes
#### Parameters
- **body**: <a href="">PersistentVolume</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolume</a>): OK
201 (<a href="">PersistentVolume</a>): Created
202 (<a href="">PersistentVolume</a>): Accepted
401: Unauthorized
### `update` replace the specified PersistentVolume
#### HTTP Request
PUT /api/v1/persistentvolumes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolume
- **body**: <a href="">PersistentVolume</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolume</a>): OK
201 (<a href="">PersistentVolume</a>): Created
401: Unauthorized
### `update` replace status of the specified PersistentVolume
#### HTTP Request
PUT /api/v1/persistentvolumes/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolume
- **body**: <a href="">PersistentVolume</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolume</a>): OK
201 (<a href="">PersistentVolume</a>): Created
401: Unauthorized
### `patch` partially update the specified PersistentVolume
#### HTTP Request
PATCH /api/v1/persistentvolumes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolume
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolume</a>): OK
201 (<a href="">PersistentVolume</a>): Created
401: Unauthorized
### `patch` partially update status of the specified PersistentVolume
#### HTTP Request
PATCH /api/v1/persistentvolumes/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolume
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolume</a>): OK
201 (<a href="">PersistentVolume</a>): Created
401: Unauthorized
### `delete` delete a PersistentVolume
#### HTTP Request
DELETE /api/v1/persistentvolumes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolume
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">PersistentVolume</a>): OK
202 (<a href="">PersistentVolume</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of PersistentVolume
#### HTTP Request
DELETE /api/v1/persistentvolumes
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind PersistentVolume content type api reference description PersistentVolume PV is a storage resource provisioned by an administrator title PersistentVolume weight 7 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 apiVersion v1 import k8s io api core v1 PersistentVolume PersistentVolume PersistentVolume PV is a storage resource provisioned by an administrator It is analogous to a node More info https kubernetes io docs concepts storage persistent volumes hr apiVersion v1 kind PersistentVolume metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href PersistentVolumeSpec a spec defines a specification of a persistent volume owned by the cluster Provisioned by an administrator More info https kubernetes io docs concepts storage persistent volumes persistent volumes status a href PersistentVolumeStatus a status represents the current information status for the persistent volume Populated by the system Read only More info https kubernetes io docs concepts storage persistent volumes persistent volumes PersistentVolumeSpec PersistentVolumeSpec PersistentVolumeSpec is the specification of a persistent volume hr accessModes string Atomic will be replaced during a merge accessModes contains all ways the volume can be mounted More info https kubernetes io docs concepts storage persistent volumes access modes capacity map string a href Quantity a capacity is the description of the persistent volume s resources and capacity More info https kubernetes io docs concepts storage persistent volumes capacity claimRef a href ObjectReference a claimRef is part of a bi directional binding between PersistentVolume and PersistentVolumeClaim Expected to be non nil when bound claim VolumeName is the authoritative bind between PV and PVC More info https kubernetes io docs concepts storage persistent volumes binding mountOptions string Atomic will be replaced during a merge mountOptions is the list of mount options e g ro soft Not validated mount will simply fail if one is invalid More info https kubernetes io docs concepts storage persistent volumes mount options nodeAffinity VolumeNodeAffinity nodeAffinity defines constraints that limit what nodes this volume can be accessed from This field influences the scheduling of pods that use this volume a name VolumeNodeAffinity a VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from nodeAffinity required NodeSelector required specifies hard node constraints that must be met a name NodeSelector a A node selector represents the union of the results of one or more label queries over a set of nodes that is it represents the OR of the selectors represented by the node selector terms nodeAffinity required nodeSelectorTerms NodeSelectorTerm required Atomic will be replaced during a merge Required A list of node selector terms The terms are ORed a name NodeSelectorTerm a A null or empty node selector term matches no objects The requirements of them are ANDed The TopologySelectorTerm type implements a subset of the NodeSelectorTerm nodeAffinity required nodeSelectorTerms matchExpressions a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s labels nodeAffinity required nodeSelectorTerms matchFields a href NodeSelectorRequirement a Atomic will be replaced during a merge A list of node selector requirements by node s fields persistentVolumeReclaimPolicy string persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim Valid options are Retain default for manually created PersistentVolumes Delete default for dynamically provisioned PersistentVolumes and Recycle deprecated Recycle must be supported by the volume plugin underlying this PersistentVolume More info https kubernetes io docs concepts storage persistent volumes reclaiming storageClassName string storageClassName is the name of StorageClass to which this persistent volume belongs Empty value means that this volume does not belong to any StorageClass volumeAttributesClassName string Name of VolumeAttributesClass to which this persistent volume belongs Empty value is not allowed When this field is not set it indicates that this volume does not belong to any VolumeAttributesClass This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class For an unbound PersistentVolume the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process This is a beta field and requires enabling VolumeAttributesClass feature off by default volumeMode string volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state Value of Filesystem is implied when not included in spec Local hostPath HostPathVolumeSource hostPath represents a directory on the host Provisioned by a developer or tester This is useful for single node development and testing only On host storage is not supported in any way and WILL NOT WORK in a multi node cluster More info https kubernetes io docs concepts storage volumes hostpath a name HostPathVolumeSource a Represents a host path mapped into a pod Host path volumes do not support ownership management or SELinux relabeling hostPath path string required path of the directory on the host If the path is a symlink it will follow the link to the real path More info https kubernetes io docs concepts storage volumes hostpath hostPath type string type for HostPath Volume Defaults to More info https kubernetes io docs concepts storage volumes hostpath local LocalVolumeSource local represents directly attached storage with node affinity a name LocalVolumeSource a Local represents directly attached storage with node affinity Beta feature local path string required path of the full path to the volume on the node It can be either a directory or block device disk partition local fsType string fsType is the filesystem type to mount It applies only when the Path is a block device Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs The default value is to auto select a filesystem if unspecified Persistent volumes awsElasticBlockStore AWSElasticBlockStoreVolumeSource awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet s host machine and then exposed to the pod More info https kubernetes io docs concepts storage volumes awselasticblockstore a name AWSElasticBlockStoreVolumeSource a Represents a Persistent Disk resource in AWS An AWS EBS disk must exist before mounting to a container The disk must also be in the same AWS zone as the kubelet An AWS EBS disk can only be mounted as read write once AWS EBS volumes support ownership management and SELinux relabeling awsElasticBlockStore volumeID string required volumeID is unique ID of the persistent disk resource in AWS Amazon EBS volume More info https kubernetes io docs concepts storage volumes awselasticblockstore awsElasticBlockStore fsType string fsType is the filesystem type of the volume that you want to mount Tip Ensure that the filesystem type is supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https kubernetes io docs concepts storage volumes awselasticblockstore awsElasticBlockStore partition int32 partition is the partition in the volume that you want to mount If omitted the default is to mount by volume name Examples For volume dev sda1 you specify the partition as 1 Similarly the volume partition for dev sda is 0 or you can leave the property empty awsElasticBlockStore readOnly boolean readOnly value true will force the readOnly setting in VolumeMounts More info https kubernetes io docs concepts storage volumes awselasticblockstore azureDisk AzureDiskVolumeSource azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod a name AzureDiskVolumeSource a AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod azureDisk diskName string required diskName is the Name of the data disk in the blob storage azureDisk diskURI string required diskURI is the URI of data disk in the blob storage azureDisk cachingMode string cachingMode is the Host Caching mode None Read Only Read Write azureDisk fsType string fsType is Filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified azureDisk kind string kind expected values are Shared multiple blob disks per storage account Dedicated single blob disk per storage account Managed azure managed data disk only in managed availability set defaults to shared azureDisk readOnly boolean readOnly Defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts azureFile AzureFilePersistentVolumeSource azureFile represents an Azure File Service mount on the host and bind mount to the pod a name AzureFilePersistentVolumeSource a AzureFile represents an Azure File Service mount on the host and bind mount to the pod azureFile secretName string required secretName is the name of secret that contains Azure Storage Account Name and Key azureFile shareName string required shareName is the azure Share Name azureFile readOnly boolean readOnly defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts azureFile secretNamespace string secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod cephfs CephFSPersistentVolumeSource cephFS represents a Ceph FS mount on the host that shares a pod s lifetime a name CephFSPersistentVolumeSource a Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling cephfs monitors string required Atomic will be replaced during a merge monitors is Required Monitors is a collection of Ceph monitors More info https examples k8s io volumes cephfs README md how to use it cephfs path string path is Optional Used as the mounted root rather than the full Ceph tree default is cephfs readOnly boolean readOnly is Optional Defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts More info https examples k8s io volumes cephfs README md how to use it cephfs secretFile string secretFile is Optional SecretFile is the path to key ring for User default is etc ceph user secret More info https examples k8s io volumes cephfs README md how to use it cephfs secretRef SecretReference secretRef is Optional SecretRef is reference to the authentication secret for User default is empty More info https examples k8s io volumes cephfs README md how to use it a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace cephfs secretRef name string name is unique within a namespace to reference a secret resource cephfs secretRef namespace string namespace defines the space within which the secret name must be unique cephfs user string user is Optional User is the rados user name default is admin More info https examples k8s io volumes cephfs README md how to use it cinder CinderPersistentVolumeSource cinder represents a cinder volume attached and mounted on kubelets host machine More info https examples k8s io mysql cinder pd README md a name CinderPersistentVolumeSource a Represents a cinder volume resource in Openstack A Cinder volume must exist before mounting to a container The volume must also be in the same region as the kubelet Cinder volumes support ownership management and SELinux relabeling cinder volumeID string required volumeID used to identify the volume in cinder More info https examples k8s io mysql cinder pd README md cinder fsType string fsType Filesystem type to mount Must be a filesystem type supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https examples k8s io mysql cinder pd README md cinder readOnly boolean readOnly is Optional Defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts More info https examples k8s io mysql cinder pd README md cinder secretRef SecretReference secretRef is Optional points to a secret object containing parameters used to connect to OpenStack a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace cinder secretRef name string name is unique within a namespace to reference a secret resource cinder secretRef namespace string namespace defines the space within which the secret name must be unique csi CSIPersistentVolumeSource csi represents storage that is handled by an external CSI driver Beta feature a name CSIPersistentVolumeSource a Represents storage that is managed by an external CSI volume driver Beta feature csi driver string required driver is the name of the driver to use for this volume Required csi volumeHandle string required volumeHandle is the unique volume name returned by the CSI volume plugin s CreateVolume to refer to the volume on all subsequent calls Required csi controllerExpandSecretRef SecretReference controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call This field is optional and may be empty if no secret is required If the secret object contains more than one secret all secrets are passed a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace csi controllerExpandSecretRef name string name is unique within a namespace to reference a secret resource csi controllerExpandSecretRef namespace string namespace defines the space within which the secret name must be unique csi controllerPublishSecretRef SecretReference controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls This field is optional and may be empty if no secret is required If the secret object contains more than one secret all secrets are passed a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace csi controllerPublishSecretRef name string name is unique within a namespace to reference a secret resource csi controllerPublishSecretRef namespace string namespace defines the space within which the secret name must be unique csi fsType string fsType to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs csi nodeExpandSecretRef SecretReference nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call This field is optional may be omitted if no secret is required If the secret object contains more than one secret all secrets are passed a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace csi nodeExpandSecretRef name string name is unique within a namespace to reference a secret resource csi nodeExpandSecretRef namespace string namespace defines the space within which the secret name must be unique csi nodePublishSecretRef SecretReference nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls This field is optional and may be empty if no secret is required If the secret object contains more than one secret all secrets are passed a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace csi nodePublishSecretRef name string name is unique within a namespace to reference a secret resource csi nodePublishSecretRef namespace string namespace defines the space within which the secret name must be unique csi nodeStageSecretRef SecretReference nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls This field is optional and may be empty if no secret is required If the secret object contains more than one secret all secrets are passed a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace csi nodeStageSecretRef name string name is unique within a namespace to reference a secret resource csi nodeStageSecretRef namespace string namespace defines the space within which the secret name must be unique csi readOnly boolean readOnly value to pass to ControllerPublishVolumeRequest Defaults to false read write csi volumeAttributes map string string volumeAttributes of the volume to publish fc FCVolumeSource fc represents a Fibre Channel resource that is attached to a kubelet s host machine and then exposed to the pod a name FCVolumeSource a Represents a Fibre Channel volume Fibre Channel volumes can only be mounted as read write once Fibre Channel volumes support ownership management and SELinux relabeling fc fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified fc lun int32 lun is Optional FC target lun number fc readOnly boolean readOnly is Optional Defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts fc targetWWNs string Atomic will be replaced during a merge targetWWNs is Optional FC target worldwide names WWNs fc wwids string Atomic will be replaced during a merge wwids Optional FC volume world wide identifiers wwids Either wwids or combination of targetWWNs and lun must be set but not both simultaneously flexVolume FlexPersistentVolumeSource flexVolume represents a generic volume resource that is provisioned attached using an exec based plugin a name FlexPersistentVolumeSource a FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned attached using an exec based plugin flexVolume driver string required driver is the name of the driver to use for this volume flexVolume fsType string fsType is the Filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs The default filesystem depends on FlexVolume script flexVolume options map string string options is Optional this field holds extra command options if any flexVolume readOnly boolean readOnly is Optional defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts flexVolume secretRef SecretReference secretRef is Optional SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts This may be empty if no secret object is specified If the secret object contains more than one secret all secrets are passed to the plugin scripts a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace flexVolume secretRef name string name is unique within a namespace to reference a secret resource flexVolume secretRef namespace string namespace defines the space within which the secret name must be unique flocker FlockerVolumeSource flocker represents a Flocker volume attached to a kubelet s host machine and exposed to the pod for its usage This depends on the Flocker control service being running a name FlockerVolumeSource a Represents a Flocker volume mounted by the Flocker agent One and only one of datasetName and datasetUUID should be set Flocker volumes do not support ownership management or SELinux relabeling flocker datasetName string datasetName is Name of the dataset stored as metadata name on the dataset for Flocker should be considered as deprecated flocker datasetUUID string datasetUUID is the UUID of the dataset This is unique identifier of a Flocker dataset gcePersistentDisk GCEPersistentDiskVolumeSource gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet s host machine and then exposed to the pod Provisioned by an admin More info https kubernetes io docs concepts storage volumes gcepersistentdisk a name GCEPersistentDiskVolumeSource a Represents a Persistent Disk resource in Google Compute Engine A GCE PD must exist before mounting to a container The disk must also be in the same GCE project and zone as the kubelet A GCE PD can only be mounted as read write once or read only many times GCE PDs support ownership management and SELinux relabeling gcePersistentDisk pdName string required pdName is unique name of the PD resource in GCE Used to identify the disk in GCE More info https kubernetes io docs concepts storage volumes gcepersistentdisk gcePersistentDisk fsType string fsType is filesystem type of the volume that you want to mount Tip Ensure that the filesystem type is supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https kubernetes io docs concepts storage volumes gcepersistentdisk gcePersistentDisk partition int32 partition is the partition in the volume that you want to mount If omitted the default is to mount by volume name Examples For volume dev sda1 you specify the partition as 1 Similarly the volume partition for dev sda is 0 or you can leave the property empty More info https kubernetes io docs concepts storage volumes gcepersistentdisk gcePersistentDisk readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts Defaults to false More info https kubernetes io docs concepts storage volumes gcepersistentdisk glusterfs GlusterfsPersistentVolumeSource glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod Provisioned by an admin More info https examples k8s io volumes glusterfs README md a name GlusterfsPersistentVolumeSource a Represents a Glusterfs mount that lasts the lifetime of a pod Glusterfs volumes do not support ownership management or SELinux relabeling glusterfs endpoints string required endpoints is the endpoint name that details Glusterfs topology More info https examples k8s io volumes glusterfs README md create a pod glusterfs path string required path is the Glusterfs volume path More info https examples k8s io volumes glusterfs README md create a pod glusterfs endpointsNamespace string endpointsNamespace is the namespace that contains Glusterfs endpoint If this field is empty the EndpointNamespace defaults to the same namespace as the bound PVC More info https examples k8s io volumes glusterfs README md create a pod glusterfs readOnly boolean readOnly here will force the Glusterfs volume to be mounted with read only permissions Defaults to false More info https examples k8s io volumes glusterfs README md create a pod iscsi ISCSIPersistentVolumeSource iscsi represents an ISCSI Disk resource that is attached to a kubelet s host machine and then exposed to the pod Provisioned by an admin a name ISCSIPersistentVolumeSource a ISCSIPersistentVolumeSource represents an ISCSI disk ISCSI volumes can only be mounted as read write once ISCSI volumes support ownership management and SELinux relabeling iscsi iqn string required iqn is Target iSCSI Qualified Name iscsi lun int32 required lun is iSCSI Target Lun number iscsi targetPortal string required targetPortal is iSCSI Target Portal The Portal is either an IP or ip addr port if the port is other than default typically TCP ports 860 and 3260 iscsi chapAuthDiscovery boolean chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication iscsi chapAuthSession boolean chapAuthSession defines whether support iSCSI Session CHAP authentication iscsi fsType string fsType is the filesystem type of the volume that you want to mount Tip Ensure that the filesystem type is supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https kubernetes io docs concepts storage volumes iscsi iscsi initiatorName string initiatorName is the custom iSCSI Initiator Name If initiatorName is specified with iscsiInterface simultaneously new iSCSI interface target portal volume name will be created for the connection iscsi iscsiInterface string iscsiInterface is the interface Name that uses an iSCSI transport Defaults to default tcp iscsi portals string Atomic will be replaced during a merge portals is the iSCSI Target Portal List The Portal is either an IP or ip addr port if the port is other than default typically TCP ports 860 and 3260 iscsi readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts Defaults to false iscsi secretRef SecretReference secretRef is the CHAP Secret for iSCSI target and initiator authentication a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace iscsi secretRef name string name is unique within a namespace to reference a secret resource iscsi secretRef namespace string namespace defines the space within which the secret name must be unique nfs NFSVolumeSource nfs represents an NFS mount on the host Provisioned by an admin More info https kubernetes io docs concepts storage volumes nfs a name NFSVolumeSource a Represents an NFS mount that lasts the lifetime of a pod NFS volumes do not support ownership management or SELinux relabeling nfs path string required path that is exported by the NFS server More info https kubernetes io docs concepts storage volumes nfs nfs server string required server is the hostname or IP address of the NFS server More info https kubernetes io docs concepts storage volumes nfs nfs readOnly boolean readOnly here will force the NFS export to be mounted with read only permissions Defaults to false More info https kubernetes io docs concepts storage volumes nfs photonPersistentDisk PhotonPersistentDiskVolumeSource photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine a name PhotonPersistentDiskVolumeSource a Represents a Photon Controller persistent disk resource photonPersistentDisk pdID string required pdID is the ID that identifies Photon Controller persistent disk photonPersistentDisk fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified portworxVolume PortworxVolumeSource portworxVolume represents a portworx volume attached and mounted on kubelets host machine a name PortworxVolumeSource a PortworxVolumeSource represents a Portworx volume resource portworxVolume volumeID string required volumeID uniquely identifies a Portworx volume portworxVolume fsType string fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs Implicitly inferred to be ext4 if unspecified portworxVolume readOnly boolean readOnly defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts quobyte QuobyteVolumeSource quobyte represents a Quobyte mount on the host that shares a pod s lifetime a name QuobyteVolumeSource a Represents a Quobyte mount that lasts the lifetime of a pod Quobyte volumes do not support ownership management or SELinux relabeling quobyte registry string required registry represents a single or multiple Quobyte Registry services specified as a string as host port pair multiple entries are separated with commas which acts as the central registry for volumes quobyte volume string required volume is a string that references an already created Quobyte volume by name quobyte group string group to map volume access to Default is no group quobyte readOnly boolean readOnly here will force the Quobyte volume to be mounted with read only permissions Defaults to false quobyte tenant string tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes value is set by the plugin quobyte user string user to map volume access to Defaults to serivceaccount user rbd RBDPersistentVolumeSource rbd represents a Rados Block Device mount on the host that shares a pod s lifetime More info https examples k8s io volumes rbd README md a name RBDPersistentVolumeSource a Represents a Rados Block Device mount that lasts the lifetime of a pod RBD volumes support ownership management and SELinux relabeling rbd image string required image is the rados image name More info https examples k8s io volumes rbd README md how to use it rbd monitors string required Atomic will be replaced during a merge monitors is a collection of Ceph monitors More info https examples k8s io volumes rbd README md how to use it rbd fsType string fsType is the filesystem type of the volume that you want to mount Tip Ensure that the filesystem type is supported by the host operating system Examples ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified More info https kubernetes io docs concepts storage volumes rbd rbd keyring string keyring is the path to key ring for RBDUser Default is etc ceph keyring More info https examples k8s io volumes rbd README md how to use it rbd pool string pool is the rados pool name Default is rbd More info https examples k8s io volumes rbd README md how to use it rbd readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts Defaults to false More info https examples k8s io volumes rbd README md how to use it rbd secretRef SecretReference secretRef is name of the authentication secret for RBDUser If provided overrides keyring Default is nil More info https examples k8s io volumes rbd README md how to use it a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace rbd secretRef name string name is unique within a namespace to reference a secret resource rbd secretRef namespace string namespace defines the space within which the secret name must be unique rbd user string user is the rados user name Default is admin More info https examples k8s io volumes rbd README md how to use it scaleIO ScaleIOPersistentVolumeSource scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes a name ScaleIOPersistentVolumeSource a ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume scaleIO gateway string required gateway is the host address of the ScaleIO API Gateway scaleIO secretRef SecretReference required secretRef references to the secret for ScaleIO user and other sensitive information If this is not provided Login operation will fail a name SecretReference a SecretReference represents a Secret Reference It has enough information to retrieve secret in any namespace scaleIO secretRef name string name is unique within a namespace to reference a secret resource scaleIO secretRef namespace string namespace defines the space within which the secret name must be unique scaleIO system string required system is the name of the storage system as configured in ScaleIO scaleIO fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Default is xfs scaleIO protectionDomain string protectionDomain is the name of the ScaleIO Protection Domain for the configured storage scaleIO readOnly boolean readOnly defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts scaleIO sslEnabled boolean sslEnabled is the flag to enable disable SSL communication with Gateway default false scaleIO storageMode string storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned Default is ThinProvisioned scaleIO storagePool string storagePool is the ScaleIO Storage Pool associated with the protection domain scaleIO volumeName string volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source storageos StorageOSPersistentVolumeSource storageOS represents a StorageOS volume that is attached to the kubelet s host machine and mounted into the pod More info https examples k8s io volumes storageos README md a name StorageOSPersistentVolumeSource a Represents a StorageOS persistent volume resource storageos fsType string fsType is the filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified storageos readOnly boolean readOnly defaults to false read write ReadOnly here will force the ReadOnly setting in VolumeMounts storageos secretRef a href ObjectReference a secretRef specifies the secret to use for obtaining the StorageOS API credentials If not specified default values will be attempted storageos volumeName string volumeName is the human readable name of the StorageOS volume Volume names are only unique within a namespace storageos volumeNamespace string volumeNamespace specifies the scope of the volume within StorageOS If no namespace is specified then the Pod s namespace will be used This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration Set VolumeName to any name to override the default behaviour Set to default if you are not using namespaces within StorageOS Namespaces that do not pre exist within StorageOS will be created vsphereVolume VsphereVirtualDiskVolumeSource vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine a name VsphereVirtualDiskVolumeSource a Represents a vSphere volume resource vsphereVolume volumePath string required volumePath is the path that identifies vSphere volume vmdk vsphereVolume fsType string fsType is filesystem type to mount Must be a filesystem type supported by the host operating system Ex ext4 xfs ntfs Implicitly inferred to be ext4 if unspecified vsphereVolume storagePolicyID string storagePolicyID is the storage Policy Based Management SPBM profile ID associated with the StoragePolicyName vsphereVolume storagePolicyName string storagePolicyName is the storage Policy Based Management SPBM profile name PersistentVolumeStatus PersistentVolumeStatus PersistentVolumeStatus is the current status of a persistent volume hr lastPhaseTransitionTime Time lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers message string message is a human readable message indicating details about why the volume is in this state phase string phase indicates if a volume is available bound to a claim or released by a claim More info https kubernetes io docs concepts storage persistent volumes phase reason string reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI PersistentVolumeList PersistentVolumeList PersistentVolumeList is a list of PersistentVolume items hr apiVersion v1 kind PersistentVolumeList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href PersistentVolume a required items is a list of persistent volumes More info https kubernetes io docs concepts storage persistent volumes Operations Operations hr get read the specified PersistentVolume HTTP Request GET api v1 persistentvolumes name Parameters name in path string required name of the PersistentVolume pretty in query string a href pretty a Response 200 a href PersistentVolume a OK 401 Unauthorized get read status of the specified PersistentVolume HTTP Request GET api v1 persistentvolumes name status Parameters name in path string required name of the PersistentVolume pretty in query string a href pretty a Response 200 a href PersistentVolume a OK 401 Unauthorized list list or watch objects of kind PersistentVolume HTTP Request GET api v1 persistentvolumes Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PersistentVolumeList a OK 401 Unauthorized create create a PersistentVolume HTTP Request POST api v1 persistentvolumes Parameters body a href PersistentVolume a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PersistentVolume a OK 201 a href PersistentVolume a Created 202 a href PersistentVolume a Accepted 401 Unauthorized update replace the specified PersistentVolume HTTP Request PUT api v1 persistentvolumes name Parameters name in path string required name of the PersistentVolume body a href PersistentVolume a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PersistentVolume a OK 201 a href PersistentVolume a Created 401 Unauthorized update replace status of the specified PersistentVolume HTTP Request PUT api v1 persistentvolumes name status Parameters name in path string required name of the PersistentVolume body a href PersistentVolume a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PersistentVolume a OK 201 a href PersistentVolume a Created 401 Unauthorized patch partially update the specified PersistentVolume HTTP Request PATCH api v1 persistentvolumes name Parameters name in path string required name of the PersistentVolume body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PersistentVolume a OK 201 a href PersistentVolume a Created 401 Unauthorized patch partially update status of the specified PersistentVolume HTTP Request PATCH api v1 persistentvolumes name status Parameters name in path string required name of the PersistentVolume body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PersistentVolume a OK 201 a href PersistentVolume a Created 401 Unauthorized delete delete a PersistentVolume HTTP Request DELETE api v1 persistentvolumes name Parameters name in path string required name of the PersistentVolume body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href PersistentVolume a OK 202 a href PersistentVolume a Accepted 401 Unauthorized deletecollection delete collection of PersistentVolume HTTP Request DELETE api v1 persistentvolumes Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion v1 kind ConfigMap title ConfigMap contenttype apireference ConfigMap holds configuration data for pods to consume apimetadata autogenerated true weight 1 import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "ConfigMap"
content_type: "api_reference"
description: "ConfigMap holds configuration data for pods to consume."
title: "ConfigMap"
weight: 1
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## ConfigMap {#ConfigMap}
ConfigMap holds configuration data for pods to consume.
<hr>
- **apiVersion**: v1
- **kind**: ConfigMap
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **binaryData** (map[string][]byte)
BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
- **data** (map[string]string)
Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
- **immutable** (boolean)
Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
## ConfigMapList {#ConfigMapList}
ConfigMapList is a resource containing a list of ConfigMap objects.
<hr>
- **apiVersion**: v1
- **kind**: ConfigMapList
- **metadata** (<a href="">ListMeta</a>)
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">ConfigMap</a>), required
Items is the list of ConfigMaps.
## Operations {#Operations}
<hr>
### `get` read the specified ConfigMap
#### HTTP Request
GET /api/v1/namespaces/{namespace}/configmaps/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ConfigMap
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ConfigMap</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ConfigMap
#### HTTP Request
GET /api/v1/namespaces/{namespace}/configmaps
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ConfigMapList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ConfigMap
#### HTTP Request
GET /api/v1/configmaps
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ConfigMapList</a>): OK
401: Unauthorized
### `create` create a ConfigMap
#### HTTP Request
POST /api/v1/namespaces/{namespace}/configmaps
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ConfigMap</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ConfigMap</a>): OK
201 (<a href="">ConfigMap</a>): Created
202 (<a href="">ConfigMap</a>): Accepted
401: Unauthorized
### `update` replace the specified ConfigMap
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/configmaps/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ConfigMap
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ConfigMap</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ConfigMap</a>): OK
201 (<a href="">ConfigMap</a>): Created
401: Unauthorized
### `patch` partially update the specified ConfigMap
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ConfigMap
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ConfigMap</a>): OK
201 (<a href="">ConfigMap</a>): Created
401: Unauthorized
### `delete` delete a ConfigMap
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ConfigMap
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ConfigMap
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/configmaps
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind ConfigMap content type api reference description ConfigMap holds configuration data for pods to consume title ConfigMap weight 1 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 apiVersion v1 import k8s io api core v1 ConfigMap ConfigMap ConfigMap holds configuration data for pods to consume hr apiVersion v1 kind ConfigMap metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata binaryData map string byte BinaryData contains the binary data Each key must consist of alphanumeric characters or BinaryData can contain byte sequences that are not in the UTF 8 range The keys stored in BinaryData must not overlap with the ones in the Data field this is enforced during validation process Using this field will require 1 10 apiserver and kubelet data map string string Data contains the configuration data Each key must consist of alphanumeric characters or Values with non UTF 8 byte sequences must use the BinaryData field The keys stored in Data must not overlap with the keys in the BinaryData field this is enforced during validation process immutable boolean Immutable if set to true ensures that data stored in the ConfigMap cannot be updated only object metadata can be modified If not set to true the field can be modified at any time Defaulted to nil ConfigMapList ConfigMapList ConfigMapList is a resource containing a list of ConfigMap objects hr apiVersion v1 kind ConfigMapList metadata a href ListMeta a More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href ConfigMap a required Items is the list of ConfigMaps Operations Operations hr get read the specified ConfigMap HTTP Request GET api v1 namespaces namespace configmaps name Parameters name in path string required name of the ConfigMap namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ConfigMap a OK 401 Unauthorized list list or watch objects of kind ConfigMap HTTP Request GET api v1 namespaces namespace configmaps Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ConfigMapList a OK 401 Unauthorized list list or watch objects of kind ConfigMap HTTP Request GET api v1 configmaps Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ConfigMapList a OK 401 Unauthorized create create a ConfigMap HTTP Request POST api v1 namespaces namespace configmaps Parameters namespace in path string required a href namespace a body a href ConfigMap a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ConfigMap a OK 201 a href ConfigMap a Created 202 a href ConfigMap a Accepted 401 Unauthorized update replace the specified ConfigMap HTTP Request PUT api v1 namespaces namespace configmaps name Parameters name in path string required name of the ConfigMap namespace in path string required a href namespace a body a href ConfigMap a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ConfigMap a OK 201 a href ConfigMap a Created 401 Unauthorized patch partially update the specified ConfigMap HTTP Request PATCH api v1 namespaces namespace configmaps name Parameters name in path string required name of the ConfigMap namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ConfigMap a OK 201 a href ConfigMap a Created 401 Unauthorized delete delete a ConfigMap HTTP Request DELETE api v1 namespaces namespace configmaps name Parameters name in path string required name of the ConfigMap namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ConfigMap HTTP Request DELETE api v1 namespaces namespace configmaps Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind Secret apiVersion v1 weight 2 contenttype apireference Secret holds secret data of a certain type apimetadata title Secret autogenerated true import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "Secret"
content_type: "api_reference"
description: "Secret holds secret data of a certain type."
title: "Secret"
weight: 2
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## Secret {#Secret}
Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.
<hr>
- **apiVersion**: v1
- **kind**: Secret
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **data** (map[string][]byte)
Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
- **immutable** (boolean)
Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
- **stringData** (map[string]string)
stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.
- **type** (string)
Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types
## SecretList {#SecretList}
SecretList is a list of Secret.
<hr>
- **apiVersion**: v1
- **kind**: SecretList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">Secret</a>), required
Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret
## Operations {#Operations}
<hr>
### `get` read the specified Secret
#### HTTP Request
GET /api/v1/namespaces/{namespace}/secrets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Secret
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Secret</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Secret
#### HTTP Request
GET /api/v1/namespaces/{namespace}/secrets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">SecretList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Secret
#### HTTP Request
GET /api/v1/secrets
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">SecretList</a>): OK
401: Unauthorized
### `create` create a Secret
#### HTTP Request
POST /api/v1/namespaces/{namespace}/secrets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Secret</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Secret</a>): OK
201 (<a href="">Secret</a>): Created
202 (<a href="">Secret</a>): Accepted
401: Unauthorized
### `update` replace the specified Secret
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/secrets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Secret
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Secret</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Secret</a>): OK
201 (<a href="">Secret</a>): Created
401: Unauthorized
### `patch` partially update the specified Secret
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Secret
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Secret</a>): OK
201 (<a href="">Secret</a>): Created
401: Unauthorized
### `delete` delete a Secret
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Secret
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Secret
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/secrets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind Secret content type api reference description Secret holds secret data of a certain type title Secret weight 2 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 apiVersion v1 import k8s io api core v1 Secret Secret Secret holds secret data of a certain type The total bytes of the values in the Data field must be less than MaxSecretSize bytes hr apiVersion v1 kind Secret metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata data map string byte Data contains the secret data Each key must consist of alphanumeric characters or The serialized form of the secret data is a base64 encoded string representing the arbitrary possibly non string data value here Described in https tools ietf org html rfc4648 section 4 immutable boolean Immutable if set to true ensures that data stored in the Secret cannot be updated only object metadata can be modified If not set to true the field can be modified at any time Defaulted to nil stringData map string string stringData allows specifying non binary secret data in string form It is provided as a write only input field for convenience All keys and values are merged into the data field on write overwriting any existing values The stringData field is never output when reading from the API type string Used to facilitate programmatic handling of secret data More info https kubernetes io docs concepts configuration secret secret types SecretList SecretList SecretList is a list of Secret hr apiVersion v1 kind SecretList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href Secret a required Items is a list of secret objects More info https kubernetes io docs concepts configuration secret Operations Operations hr get read the specified Secret HTTP Request GET api v1 namespaces namespace secrets name Parameters name in path string required name of the Secret namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Secret a OK 401 Unauthorized list list or watch objects of kind Secret HTTP Request GET api v1 namespaces namespace secrets Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href SecretList a OK 401 Unauthorized list list or watch objects of kind Secret HTTP Request GET api v1 secrets Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href SecretList a OK 401 Unauthorized create create a Secret HTTP Request POST api v1 namespaces namespace secrets Parameters namespace in path string required a href namespace a body a href Secret a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Secret a OK 201 a href Secret a Created 202 a href Secret a Accepted 401 Unauthorized update replace the specified Secret HTTP Request PUT api v1 namespaces namespace secrets name Parameters name in path string required name of the Secret namespace in path string required a href namespace a body a href Secret a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Secret a OK 201 a href Secret a Created 401 Unauthorized patch partially update the specified Secret HTTP Request PATCH api v1 namespaces namespace secrets name Parameters name in path string required name of the Secret namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Secret a OK 201 a href Secret a Created 401 Unauthorized delete delete a Secret HTTP Request DELETE api v1 namespaces namespace secrets name Parameters name in path string required name of the Secret namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of Secret HTTP Request DELETE api v1 namespaces namespace secrets Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference autogenerated true CSINode holds information about all CSI drivers installed on a node contenttype apireference apimetadata apiVersion storage k8s io v1 weight 4 title CSINode import k8s io api storage v1 kind CSINode | ---
api_metadata:
apiVersion: "storage.k8s.io/v1"
import: "k8s.io/api/storage/v1"
kind: "CSINode"
content_type: "api_reference"
description: "CSINode holds information about all CSI drivers installed on a node."
title: "CSINode"
weight: 4
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.
-->
`apiVersion: storage.k8s.io/v1`
`import "k8s.io/api/storage/v1"`
## CSINode {#CSINode}
CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: CSINode
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. metadata.name must be the Kubernetes node name.
- **spec** (<a href="">CSINodeSpec</a>), required
spec is the specification of CSINode
## CSINodeSpec {#CSINodeSpec}
CSINodeSpec holds information about the specification of all CSI drivers installed on a node
<hr>
- **drivers** ([]CSINodeDriver), required
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty.
<a name="CSINodeDriver"></a>
*CSINodeDriver holds information about the specification of one CSI driver installed on a node*
- **drivers.name** (string), required
name represents the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.
- **drivers.nodeID** (string), required
nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.
- **drivers.allocatable** (VolumeNodeResources)
allocatable represents the volume resources of a node that are available for scheduling. This field is beta.
<a name="VolumeNodeResources"></a>
*VolumeNodeResources is a set of resource limits for scheduling of volumes.*
- **drivers.allocatable.count** (int32)
count indicates the maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded.
- **drivers.topologyKeys** ([]string)
*Atomic: will be replaced during a merge*
topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.
## CSINodeList {#CSINodeList}
CSINodeList is a collection of CSINode objects.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: CSINodeList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">CSINode</a>), required
items is the list of CSINode
## Operations {#Operations}
<hr>
### `get` read the specified CSINode
#### HTTP Request
GET /apis/storage.k8s.io/v1/csinodes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSINode
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSINode</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CSINode
#### HTTP Request
GET /apis/storage.k8s.io/v1/csinodes
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">CSINodeList</a>): OK
401: Unauthorized
### `create` create a CSINode
#### HTTP Request
POST /apis/storage.k8s.io/v1/csinodes
#### Parameters
- **body**: <a href="">CSINode</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSINode</a>): OK
201 (<a href="">CSINode</a>): Created
202 (<a href="">CSINode</a>): Accepted
401: Unauthorized
### `update` replace the specified CSINode
#### HTTP Request
PUT /apis/storage.k8s.io/v1/csinodes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSINode
- **body**: <a href="">CSINode</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSINode</a>): OK
201 (<a href="">CSINode</a>): Created
401: Unauthorized
### `patch` partially update the specified CSINode
#### HTTP Request
PATCH /apis/storage.k8s.io/v1/csinodes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSINode
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSINode</a>): OK
201 (<a href="">CSINode</a>): Created
401: Unauthorized
### `delete` delete a CSINode
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/csinodes/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSINode
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">CSINode</a>): OK
202 (<a href="">CSINode</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of CSINode
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/csinodes
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion storage k8s io v1 import k8s io api storage v1 kind CSINode content type api reference description CSINode holds information about all CSI drivers installed on a node title CSINode weight 4 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 apiVersion storage k8s io v1 import k8s io api storage v1 CSINode CSINode CSINode holds information about all CSI drivers installed on a node CSI drivers do not need to create the CSINode object directly As long as they use the node driver registrar sidecar container the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration CSINode has the same name as a node If the object is missing it means either there are no CSI Drivers available on the node or the Kubelet version is low enough that it doesn t create this object CSINode has an OwnerReference that points to the corresponding node object hr apiVersion storage k8s io v1 kind CSINode metadata a href ObjectMeta a Standard object s metadata metadata name must be the Kubernetes node name spec a href CSINodeSpec a required spec is the specification of CSINode CSINodeSpec CSINodeSpec CSINodeSpec holds information about the specification of all CSI drivers installed on a node hr drivers CSINodeDriver required Patch strategy merge on key name Map unique values on key name will be kept during a merge drivers is a list of information of all CSI Drivers existing on a node If all drivers in the list are uninstalled this can become empty a name CSINodeDriver a CSINodeDriver holds information about the specification of one CSI driver installed on a node drivers name string required name represents the name of the CSI driver that this object refers to This MUST be the same name returned by the CSI GetPluginName call for that driver drivers nodeID string required nodeID of the node from the driver point of view This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes For example Kubernetes may refer to a given node as node1 but the storage system may refer to the same node as nodeA When Kubernetes issues a command to the storage system to attach a volume to a specific node it can use this field to refer to the node name using the ID that the storage system will understand e g nodeA instead of node1 This field is required drivers allocatable VolumeNodeResources allocatable represents the volume resources of a node that are available for scheduling This field is beta a name VolumeNodeResources a VolumeNodeResources is a set of resource limits for scheduling of volumes drivers allocatable count int32 count indicates the maximum number of unique volumes managed by the CSI driver that can be used on a node A volume that is both attached and mounted on a node is considered to be used once not twice The same rule applies for a unique volume that is shared among multiple pods on the same node If this field is not specified then the supported number of volumes on this node is unbounded drivers topologyKeys string Atomic will be replaced during a merge topologyKeys is the list of keys supported by the driver When a driver is initialized on a cluster it provides a set of topology keys that it understands e g company com zone company com region When a driver is initialized on a node it provides the same topology keys along with values Kubelet will expose these topology keys as labels on its own node object When Kubernetes does topology aware provisioning it can use this list to determine which labels it should retrieve from the node object and pass back to the driver It is possible for different nodes to use different topology keys This can be empty if driver does not support topology CSINodeList CSINodeList CSINodeList is a collection of CSINode objects hr apiVersion storage k8s io v1 kind CSINodeList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href CSINode a required items is the list of CSINode Operations Operations hr get read the specified CSINode HTTP Request GET apis storage k8s io v1 csinodes name Parameters name in path string required name of the CSINode pretty in query string a href pretty a Response 200 a href CSINode a OK 401 Unauthorized list list or watch objects of kind CSINode HTTP Request GET apis storage k8s io v1 csinodes Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href CSINodeList a OK 401 Unauthorized create create a CSINode HTTP Request POST apis storage k8s io v1 csinodes Parameters body a href CSINode a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CSINode a OK 201 a href CSINode a Created 202 a href CSINode a Accepted 401 Unauthorized update replace the specified CSINode HTTP Request PUT apis storage k8s io v1 csinodes name Parameters name in path string required name of the CSINode body a href CSINode a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CSINode a OK 201 a href CSINode a Created 401 Unauthorized patch partially update the specified CSINode HTTP Request PATCH apis storage k8s io v1 csinodes name Parameters name in path string required name of the CSINode body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CSINode a OK 201 a href CSINode a Created 401 Unauthorized delete delete a CSINode HTTP Request DELETE apis storage k8s io v1 csinodes name Parameters name in path string required name of the CSINode body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href CSINode a OK 202 a href CSINode a Accepted 401 Unauthorized deletecollection delete collection of CSINode HTTP Request DELETE apis storage k8s io v1 csinodes Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title StorageClass autogenerated true contenttype apireference kind StorageClass weight 8 apimetadata apiVersion storage k8s io v1 StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned import k8s io api storage v1 | ---
api_metadata:
apiVersion: "storage.k8s.io/v1"
import: "k8s.io/api/storage/v1"
kind: "StorageClass"
content_type: "api_reference"
description: "StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned."
title: "StorageClass"
weight: 8
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.
-->
`apiVersion: storage.k8s.io/v1`
`import "k8s.io/api/storage/v1"`
## StorageClass {#StorageClass}
StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: StorageClass
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **provisioner** (string), required
provisioner indicates the type of the provisioner.
- **allowVolumeExpansion** (boolean)
allowVolumeExpansion shows whether the storage class allow volume expand.
- **allowedTopologies** ([]TopologySelectorTerm)
*Atomic: will be replaced during a merge*
allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
<a name="TopologySelectorTerm"></a>
*A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.*
- **allowedTopologies.matchLabelExpressions** ([]TopologySelectorLabelRequirement)
*Atomic: will be replaced during a merge*
A list of topology selector requirements by labels.
<a name="TopologySelectorLabelRequirement"></a>
*A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.*
- **allowedTopologies.matchLabelExpressions.key** (string), required
The label key that the selector applies to.
- **allowedTopologies.matchLabelExpressions.values** ([]string), required
*Atomic: will be replaced during a merge*
An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
- **mountOptions** ([]string)
*Atomic: will be replaced during a merge*
mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
- **parameters** (map[string]string)
parameters holds the parameters for the provisioner that should create volumes of this storage class.
- **reclaimPolicy** (string)
reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.
- **volumeBindingMode** (string)
volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
## StorageClassList {#StorageClassList}
StorageClassList is a collection of storage classes.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: StorageClassList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">StorageClass</a>), required
items is the list of StorageClasses
## Operations {#Operations}
<hr>
### `get` read the specified StorageClass
#### HTTP Request
GET /apis/storage.k8s.io/v1/storageclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StorageClass
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageClass</a>): OK
401: Unauthorized
### `list` list or watch objects of kind StorageClass
#### HTTP Request
GET /apis/storage.k8s.io/v1/storageclasses
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">StorageClassList</a>): OK
401: Unauthorized
### `create` create a StorageClass
#### HTTP Request
POST /apis/storage.k8s.io/v1/storageclasses
#### Parameters
- **body**: <a href="">StorageClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageClass</a>): OK
201 (<a href="">StorageClass</a>): Created
202 (<a href="">StorageClass</a>): Accepted
401: Unauthorized
### `update` replace the specified StorageClass
#### HTTP Request
PUT /apis/storage.k8s.io/v1/storageclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StorageClass
- **body**: <a href="">StorageClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageClass</a>): OK
201 (<a href="">StorageClass</a>): Created
401: Unauthorized
### `patch` partially update the specified StorageClass
#### HTTP Request
PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StorageClass
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageClass</a>): OK
201 (<a href="">StorageClass</a>): Created
401: Unauthorized
### `delete` delete a StorageClass
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StorageClass
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">StorageClass</a>): OK
202 (<a href="">StorageClass</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of StorageClass
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/storageclasses
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion storage k8s io v1 import k8s io api storage v1 kind StorageClass content type api reference description StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned title StorageClass weight 8 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 apiVersion storage k8s io v1 import k8s io api storage v1 StorageClass StorageClass StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned StorageClasses are non namespaced the name of the storage class according to etcd is in ObjectMeta Name hr apiVersion storage k8s io v1 kind StorageClass metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata provisioner string required provisioner indicates the type of the provisioner allowVolumeExpansion boolean allowVolumeExpansion shows whether the storage class allow volume expand allowedTopologies TopologySelectorTerm Atomic will be replaced during a merge allowedTopologies restrict the node topologies where volumes can be dynamically provisioned Each volume plugin defines its own supported topology specifications An empty TopologySelectorTerm list means there is no topology restriction This field is only honored by servers that enable the VolumeScheduling feature a name TopologySelectorTerm a A topology selector term represents the result of label queries A null or empty topology selector term matches no objects The requirements of them are ANDed It provides a subset of functionality as NodeSelectorTerm This is an alpha feature and may change in the future allowedTopologies matchLabelExpressions TopologySelectorLabelRequirement Atomic will be replaced during a merge A list of topology selector requirements by labels a name TopologySelectorLabelRequirement a A topology selector requirement is a selector that matches given label This is an alpha feature and may change in the future allowedTopologies matchLabelExpressions key string required The label key that the selector applies to allowedTopologies matchLabelExpressions values string required Atomic will be replaced during a merge An array of string values One value must match the label to be selected Each entry in Values is ORed mountOptions string Atomic will be replaced during a merge mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class e g ro soft Not validated mount of the PVs will simply fail if one is invalid parameters map string string parameters holds the parameters for the provisioner that should create volumes of this storage class reclaimPolicy string reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class Defaults to Delete volumeBindingMode string volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound When unset VolumeBindingImmediate is used This field is only honored by servers that enable the VolumeScheduling feature StorageClassList StorageClassList StorageClassList is a collection of storage classes hr apiVersion storage k8s io v1 kind StorageClassList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href StorageClass a required items is the list of StorageClasses Operations Operations hr get read the specified StorageClass HTTP Request GET apis storage k8s io v1 storageclasses name Parameters name in path string required name of the StorageClass pretty in query string a href pretty a Response 200 a href StorageClass a OK 401 Unauthorized list list or watch objects of kind StorageClass HTTP Request GET apis storage k8s io v1 storageclasses Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href StorageClassList a OK 401 Unauthorized create create a StorageClass HTTP Request POST apis storage k8s io v1 storageclasses Parameters body a href StorageClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href StorageClass a OK 201 a href StorageClass a Created 202 a href StorageClass a Accepted 401 Unauthorized update replace the specified StorageClass HTTP Request PUT apis storage k8s io v1 storageclasses name Parameters name in path string required name of the StorageClass body a href StorageClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href StorageClass a OK 201 a href StorageClass a Created 401 Unauthorized patch partially update the specified StorageClass HTTP Request PATCH apis storage k8s io v1 storageclasses name Parameters name in path string required name of the StorageClass body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href StorageClass a OK 201 a href StorageClass a Created 401 Unauthorized delete delete a StorageClass HTTP Request DELETE apis storage k8s io v1 storageclasses name Parameters name in path string required name of the StorageClass body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href StorageClass a OK 202 a href StorageClass a Accepted 401 Unauthorized deletecollection delete collection of StorageClass HTTP Request DELETE apis storage k8s io v1 storageclasses Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion v1 weight 6 title PersistentVolumeClaim contenttype apireference apimetadata import k8s io api core v1 autogenerated true PersistentVolumeClaim is a user s request for and claim to a persistent volume kind PersistentVolumeClaim | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "PersistentVolumeClaim"
content_type: "api_reference"
description: "PersistentVolumeClaim is a user's request for and claim to a persistent volume."
title: "PersistentVolumeClaim"
weight: 6
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## PersistentVolumeClaim {#PersistentVolumeClaim}
PersistentVolumeClaim is a user's request for and claim to a persistent volume
<hr>
- **apiVersion**: v1
- **kind**: PersistentVolumeClaim
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">PersistentVolumeClaimSpec</a>)
spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- **status** (<a href="">PersistentVolumeClaimStatus</a>)
status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
## PersistentVolumeClaimSpec {#PersistentVolumeClaimSpec}
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
<hr>
- **accessModes** ([]string)
*Atomic: will be replaced during a merge*
accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- **selector** (<a href="">LabelSelector</a>)
selector is a label query over volumes to consider for binding.
- **resources** (VolumeResourceRequirements)
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
<a name="VolumeResourceRequirements"></a>
*VolumeResourceRequirements describes the storage resource requirements for a volume.*
- **resources.limits** (map[string]<a href="">Quantity</a>)
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **resources.requests** (map[string]<a href="">Quantity</a>)
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **volumeName** (string)
volumeName is the binding reference to the PersistentVolume backing this claim.
- **storageClassName** (string)
storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- **volumeMode** (string)
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
### Beta level
- **dataSource** (<a href="">TypedLocalObjectReference</a>)
dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- **dataSourceRef** (TypedObjectReference)
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
* While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
<a name="TypedObjectReference"></a>
**
- **dataSourceRef.kind** (string), required
Kind is the type of resource being referenced
- **dataSourceRef.name** (string), required
Name is the name of resource being referenced
- **dataSourceRef.apiGroup** (string)
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
- **dataSourceRef.namespace** (string)
Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- **volumeAttributesClassName** (string)
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
## PersistentVolumeClaimStatus {#PersistentVolumeClaimStatus}
PersistentVolumeClaimStatus is the current status of a persistent volume claim.
<hr>
- **accessModes** ([]string)
*Atomic: will be replaced during a merge*
accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- **allocatedResourceStatuses** (map[string]string)
allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either:
* Un-prefixed keys:
- storage - the capacity of the volume.
* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.
ClaimResourceStatus can be in any of following states:
- ControllerResizeInProgress:
State set when resize controller starts resizing the volume in control-plane.
- ControllerResizeFailed:
State set when resize has failed in resize controller with a terminal error.
- NodeResizePending:
State set when resize controller has finished resizing the volume but further resizing of
volume is needed on the node.
- NodeResizeInProgress:
State set when kubelet starts resizing the volume.
- NodeResizeFailed:
State set when resizing has failed in kubelet with a terminal error. Transient errors don't set
NodeResizeFailed.
For example: if expanding a PVC for more capacity - this field can be one of the following states:
- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress"
- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed"
- pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending"
- pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress"
- pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed"
When this field is not set, it means that no resize operation is in progress for the given PVC.
A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.
This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
- **allocatedResources** (map[string]<a href="">Quantity</a>)
allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either:
* Un-prefixed keys:
- storage - the capacity of the volume.
* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.
Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity.
A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.
This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
- **capacity** (map[string]<a href="">Quantity</a>)
capacity represents the actual resources of the underlying volume.
- **conditions** ([]PersistentVolumeClaimCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
<a name="PersistentVolumeClaimCondition"></a>
*PersistentVolumeClaimCondition contains details about state of pvc*
- **conditions.status** (string), required
- **conditions.type** (string), required
- **conditions.lastProbeTime** (Time)
lastProbeTime is the time we probed the condition.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.lastTransitionTime** (Time)
lastTransitionTime is the time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
message is the human-readable message indicating details about last transition.
- **conditions.reason** (string)
reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.
- **currentVolumeAttributesClassName** (string)
currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
- **modifyVolumeStatus** (ModifyVolumeStatus)
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
<a name="ModifyVolumeStatus"></a>
*ModifyVolumeStatus represents the status object of ControllerModifyVolume operation*
- **modifyVolumeStatus.status** (string), required
status is the status of the ControllerModifyVolume operation. It can be in any of following states:
- Pending
Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as
the specified VolumeAttributesClass not existing.
- InProgress
InProgress indicates that the volume is being modified.
- Infeasible
Infeasible indicates that the request has been rejected as invalid by the CSI driver. To
resolve the error, a valid VolumeAttributesClass needs to be specified.
Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
- **modifyVolumeStatus.targetVolumeAttributesClassName** (string)
targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
- **phase** (string)
phase represents the current phase of PersistentVolumeClaim.
## PersistentVolumeClaimList {#PersistentVolumeClaimList}
PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
<hr>
- **apiVersion**: v1
- **kind**: PersistentVolumeClaimList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">PersistentVolumeClaim</a>), required
items is a list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
## Operations {#Operations}
<hr>
### `get` read the specified PersistentVolumeClaim
#### HTTP Request
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolumeClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolumeClaim</a>): OK
401: Unauthorized
### `get` read status of the specified PersistentVolumeClaim
#### HTTP Request
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolumeClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolumeClaim</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PersistentVolumeClaim
#### HTTP Request
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PersistentVolumeClaimList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PersistentVolumeClaim
#### HTTP Request
GET /api/v1/persistentvolumeclaims
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PersistentVolumeClaimList</a>): OK
401: Unauthorized
### `create` create a PersistentVolumeClaim
#### HTTP Request
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PersistentVolumeClaim</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolumeClaim</a>): OK
201 (<a href="">PersistentVolumeClaim</a>): Created
202 (<a href="">PersistentVolumeClaim</a>): Accepted
401: Unauthorized
### `update` replace the specified PersistentVolumeClaim
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolumeClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PersistentVolumeClaim</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolumeClaim</a>): OK
201 (<a href="">PersistentVolumeClaim</a>): Created
401: Unauthorized
### `update` replace status of the specified PersistentVolumeClaim
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolumeClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PersistentVolumeClaim</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolumeClaim</a>): OK
201 (<a href="">PersistentVolumeClaim</a>): Created
401: Unauthorized
### `patch` partially update the specified PersistentVolumeClaim
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolumeClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolumeClaim</a>): OK
201 (<a href="">PersistentVolumeClaim</a>): Created
401: Unauthorized
### `patch` partially update status of the specified PersistentVolumeClaim
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolumeClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PersistentVolumeClaim</a>): OK
201 (<a href="">PersistentVolumeClaim</a>): Created
401: Unauthorized
### `delete` delete a PersistentVolumeClaim
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PersistentVolumeClaim
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">PersistentVolumeClaim</a>): OK
202 (<a href="">PersistentVolumeClaim</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of PersistentVolumeClaim
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind PersistentVolumeClaim content type api reference description PersistentVolumeClaim is a user s request for and claim to a persistent volume title PersistentVolumeClaim weight 6 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 apiVersion v1 import k8s io api core v1 PersistentVolumeClaim PersistentVolumeClaim PersistentVolumeClaim is a user s request for and claim to a persistent volume hr apiVersion v1 kind PersistentVolumeClaim metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href PersistentVolumeClaimSpec a spec defines the desired characteristics of a volume requested by a pod author More info https kubernetes io docs concepts storage persistent volumes persistentvolumeclaims status a href PersistentVolumeClaimStatus a status represents the current information status of a persistent volume claim Read only More info https kubernetes io docs concepts storage persistent volumes persistentvolumeclaims PersistentVolumeClaimSpec PersistentVolumeClaimSpec PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider specific attributes hr accessModes string Atomic will be replaced during a merge accessModes contains the desired access modes the volume should have More info https kubernetes io docs concepts storage persistent volumes access modes 1 selector a href LabelSelector a selector is a label query over volumes to consider for binding resources VolumeResourceRequirements resources represents the minimum resources the volume should have If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim More info https kubernetes io docs concepts storage persistent volumes resources a name VolumeResourceRequirements a VolumeResourceRequirements describes the storage resource requirements for a volume resources limits map string a href Quantity a Limits describes the maximum amount of compute resources allowed More info https kubernetes io docs concepts configuration manage resources containers resources requests map string a href Quantity a Requests describes the minimum amount of compute resources required If Requests is omitted for a container it defaults to Limits if that is explicitly specified otherwise to an implementation defined value Requests cannot exceed Limits More info https kubernetes io docs concepts configuration manage resources containers volumeName string volumeName is the binding reference to the PersistentVolume backing this claim storageClassName string storageClassName is the name of the StorageClass required by the claim More info https kubernetes io docs concepts storage persistent volumes class 1 volumeMode string volumeMode defines what type of volume is required by the claim Value of Filesystem is implied when not included in claim spec Beta level dataSource a href TypedLocalObjectReference a dataSource field can be used to specify either An existing VolumeSnapshot object snapshot storage k8s io VolumeSnapshot An existing PVC PersistentVolumeClaim If the provisioner or an external controller can support the specified data source it will create a new volume based on the contents of the specified data source When the AnyVolumeDataSource feature gate is enabled dataSource contents will be copied to dataSourceRef and dataSourceRef contents will be copied to dataSource when dataSourceRef namespace is not specified If the namespace is specified then dataSourceRef will not be copied to dataSource dataSourceRef TypedObjectReference dataSourceRef specifies the object from which to populate the volume with data if a non empty volume is desired This may be any object from a non empty API group non core object or a PersistentVolumeClaim object When this field is specified volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner This field will replace the functionality of the dataSource field and as such if both fields are non empty they must have the same value For backwards compatibility when namespace isn t specified in dataSourceRef both fields dataSource and dataSourceRef will be set to the same value automatically if one of them is empty and the other is non empty When namespace is specified in dataSourceRef dataSource isn t set to the same value and must be empty There are three important differences between dataSource and dataSourceRef While dataSource only allows two specific types of objects dataSourceRef allows any non core object as well as PersistentVolumeClaim objects While dataSource ignores disallowed values dropping them dataSourceRef preserves all values and generates an error if a disallowed value is specified While dataSource only allows local objects dataSourceRef allows objects in any namespaces Beta Using this field requires the AnyVolumeDataSource feature gate to be enabled Alpha Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled a name TypedObjectReference a dataSourceRef kind string required Kind is the type of resource being referenced dataSourceRef name string required Name is the name of resource being referenced dataSourceRef apiGroup string APIGroup is the group for the resource being referenced If APIGroup is not specified the specified Kind must be in the core API group For any other third party types APIGroup is required dataSourceRef namespace string Namespace is the namespace of resource being referenced Note that when a namespace is specified a gateway networking k8s io ReferenceGrant object is required in the referent namespace to allow that namespace s owner to accept the reference See the ReferenceGrant documentation for details Alpha This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled volumeAttributesClassName string volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim If specified the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass This has a different purpose than storageClassName it can be changed after the claim is created An empty string value means that no VolumeAttributesClass will be applied to the claim but it s not allowed to reset this field to empty string once it is set If unspecified and the PersistentVolumeClaim is unbound the default VolumeAttributesClass will be set by the persistentvolume controller if it exists If the resource referred to by volumeAttributesClass does not exist this PersistentVolumeClaim will be set to a Pending state as reflected by the modifyVolumeStatus field until such as a resource exists More info https kubernetes io docs concepts storage volume attributes classes Beta Using this field requires the VolumeAttributesClass feature gate to be enabled off by default PersistentVolumeClaimStatus PersistentVolumeClaimStatus PersistentVolumeClaimStatus is the current status of a persistent volume claim hr accessModes string Atomic will be replaced during a merge accessModes contains the actual access modes the volume backing the PVC has More info https kubernetes io docs concepts storage persistent volumes access modes 1 allocatedResourceStatuses map string string allocatedResourceStatuses stores status of resource being resized for the given PVC Key names follow standard Kubernetes label syntax Valid values are either Un prefixed keys storage the capacity of the volume Custom resources must use implementation defined prefixed names such as example com my custom resource Apart from above values keys that are unprefixed or have kubernetes io prefix are considered reserved and hence may not be used ClaimResourceStatus can be in any of following states ControllerResizeInProgress State set when resize controller starts resizing the volume in control plane ControllerResizeFailed State set when resize has failed in resize controller with a terminal error NodeResizePending State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node NodeResizeInProgress State set when kubelet starts resizing the volume NodeResizeFailed State set when resizing has failed in kubelet with a terminal error Transient errors don t set NodeResizeFailed For example if expanding a PVC for more capacity this field can be one of the following states pvc status allocatedResourceStatus storage ControllerResizeInProgress pvc status allocatedResourceStatus storage ControllerResizeFailed pvc status allocatedResourceStatus storage NodeResizePending pvc status allocatedResourceStatus storage NodeResizeInProgress pvc status allocatedResourceStatus storage NodeResizeFailed When this field is not set it means that no resize operation is in progress for the given PVC A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed For example a controller that only is responsible for resizing capacity of the volume should ignore PVC updates that change other valid resources associated with PVC This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature allocatedResources map string a href Quantity a allocatedResources tracks the resources allocated to a PVC including its capacity Key names follow standard Kubernetes label syntax Valid values are either Un prefixed keys storage the capacity of the volume Custom resources must use implementation defined prefixed names such as example com my custom resource Apart from above values keys that are unprefixed or have kubernetes io prefix are considered reserved and hence may not be used Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested For storage quota the larger value from allocatedResources and PVC spec resources is used If allocatedResources is not set PVC spec resources alone is used for quota calculation If a volume expansion capacity request is lowered allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed For example a controller that only is responsible for resizing capacity of the volume should ignore PVC updates that change other valid resources associated with PVC This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature capacity map string a href Quantity a capacity represents the actual resources of the underlying volume conditions PersistentVolumeClaimCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge conditions is the current Condition of persistent volume claim If underlying persistent volume is being resized then the Condition will be set to Resizing a name PersistentVolumeClaimCondition a PersistentVolumeClaimCondition contains details about state of pvc conditions status string required conditions type string required conditions lastProbeTime Time lastProbeTime is the time we probed the condition a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions lastTransitionTime Time lastTransitionTime is the time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string message is the human readable message indicating details about last transition conditions reason string reason is a unique this should be a short machine understandable string that gives the reason for condition s last transition If it reports Resizing that means the underlying persistent volume is being resized currentVolumeAttributesClassName string currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using When unset there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is a beta field and requires enabling VolumeAttributesClass feature off by default modifyVolumeStatus ModifyVolumeStatus ModifyVolumeStatus represents the status object of ControllerModifyVolume operation When this is unset there is no ModifyVolume operation being attempted This is a beta field and requires enabling VolumeAttributesClass feature off by default a name ModifyVolumeStatus a ModifyVolumeStatus represents the status object of ControllerModifyVolume operation modifyVolumeStatus status string required status is the status of the ControllerModifyVolume operation It can be in any of following states Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements such as the specified VolumeAttributesClass not existing InProgress InProgress indicates that the volume is being modified Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver To resolve the error a valid VolumeAttributesClass needs to be specified Note New statuses can be added in the future Consumers should check for unknown statuses and fail appropriately modifyVolumeStatus targetVolumeAttributesClassName string targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled phase string phase represents the current phase of PersistentVolumeClaim PersistentVolumeClaimList PersistentVolumeClaimList PersistentVolumeClaimList is a list of PersistentVolumeClaim items hr apiVersion v1 kind PersistentVolumeClaimList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href PersistentVolumeClaim a required items is a list of persistent volume claims More info https kubernetes io docs concepts storage persistent volumes persistentvolumeclaims Operations Operations hr get read the specified PersistentVolumeClaim HTTP Request GET api v1 namespaces namespace persistentvolumeclaims name Parameters name in path string required name of the PersistentVolumeClaim namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href PersistentVolumeClaim a OK 401 Unauthorized get read status of the specified PersistentVolumeClaim HTTP Request GET api v1 namespaces namespace persistentvolumeclaims name status Parameters name in path string required name of the PersistentVolumeClaim namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href PersistentVolumeClaim a OK 401 Unauthorized list list or watch objects of kind PersistentVolumeClaim HTTP Request GET api v1 namespaces namespace persistentvolumeclaims Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PersistentVolumeClaimList a OK 401 Unauthorized list list or watch objects of kind PersistentVolumeClaim HTTP Request GET api v1 persistentvolumeclaims Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PersistentVolumeClaimList a OK 401 Unauthorized create create a PersistentVolumeClaim HTTP Request POST api v1 namespaces namespace persistentvolumeclaims Parameters namespace in path string required a href namespace a body a href PersistentVolumeClaim a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PersistentVolumeClaim a OK 201 a href PersistentVolumeClaim a Created 202 a href PersistentVolumeClaim a Accepted 401 Unauthorized update replace the specified PersistentVolumeClaim HTTP Request PUT api v1 namespaces namespace persistentvolumeclaims name Parameters name in path string required name of the PersistentVolumeClaim namespace in path string required a href namespace a body a href PersistentVolumeClaim a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PersistentVolumeClaim a OK 201 a href PersistentVolumeClaim a Created 401 Unauthorized update replace status of the specified PersistentVolumeClaim HTTP Request PUT api v1 namespaces namespace persistentvolumeclaims name status Parameters name in path string required name of the PersistentVolumeClaim namespace in path string required a href namespace a body a href PersistentVolumeClaim a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PersistentVolumeClaim a OK 201 a href PersistentVolumeClaim a Created 401 Unauthorized patch partially update the specified PersistentVolumeClaim HTTP Request PATCH api v1 namespaces namespace persistentvolumeclaims name Parameters name in path string required name of the PersistentVolumeClaim namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PersistentVolumeClaim a OK 201 a href PersistentVolumeClaim a Created 401 Unauthorized patch partially update status of the specified PersistentVolumeClaim HTTP Request PATCH api v1 namespaces namespace persistentvolumeclaims name status Parameters name in path string required name of the PersistentVolumeClaim namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PersistentVolumeClaim a OK 201 a href PersistentVolumeClaim a Created 401 Unauthorized delete delete a PersistentVolumeClaim HTTP Request DELETE api v1 namespaces namespace persistentvolumeclaims name Parameters name in path string required name of the PersistentVolumeClaim namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href PersistentVolumeClaim a OK 202 a href PersistentVolumeClaim a Accepted 401 Unauthorized deletecollection delete collection of PersistentVolumeClaim HTTP Request DELETE api v1 namespaces namespace persistentvolumeclaims Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind VolumeAttachment title VolumeAttachment autogenerated true weight 11 contenttype apireference apimetadata apiVersion storage k8s io v1 VolumeAttachment captures the intent to attach or detach the specified volume to from the specified node import k8s io api storage v1 | ---
api_metadata:
apiVersion: "storage.k8s.io/v1"
import: "k8s.io/api/storage/v1"
kind: "VolumeAttachment"
content_type: "api_reference"
description: "VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node."
title: "VolumeAttachment"
weight: 11
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.
-->
`apiVersion: storage.k8s.io/v1`
`import "k8s.io/api/storage/v1"`
## VolumeAttachment {#VolumeAttachment}
VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.
VolumeAttachment objects are non-namespaced.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: VolumeAttachment
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">VolumeAttachmentSpec</a>), required
spec represents specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
- **status** (<a href="">VolumeAttachmentStatus</a>)
status represents status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
## VolumeAttachmentSpec {#VolumeAttachmentSpec}
VolumeAttachmentSpec is the specification of a VolumeAttachment request.
<hr>
- **attacher** (string), required
attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
- **nodeName** (string), required
nodeName represents the node that the volume should be attached to.
- **source** (VolumeAttachmentSource), required
source represents the volume that should be attached.
<a name="VolumeAttachmentSource"></a>
*VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.*
- **source.inlineVolumeSpec** (<a href="">PersistentVolumeSpec</a>)
inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature.
- **source.persistentVolumeName** (string)
persistentVolumeName represents the name of the persistent volume to attach.
## VolumeAttachmentStatus {#VolumeAttachmentStatus}
VolumeAttachmentStatus is the status of a VolumeAttachment request.
<hr>
- **attached** (boolean), required
attached indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
- **attachError** (VolumeError)
attachError represents the last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
<a name="VolumeError"></a>
*VolumeError captures an error encountered during a volume operation.*
- **attachError.message** (string)
message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
- **attachError.time** (Time)
time represents the time the error was encountered.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **attachmentMetadata** (map[string]string)
attachmentMetadata is populated with any information returned by the attach operation, upon successful attach, that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
- **detachError** (VolumeError)
detachError represents the last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
<a name="VolumeError"></a>
*VolumeError captures an error encountered during a volume operation.*
- **detachError.message** (string)
message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
- **detachError.time** (Time)
time represents the time the error was encountered.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
## VolumeAttachmentList {#VolumeAttachmentList}
VolumeAttachmentList is a collection of VolumeAttachment objects.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: VolumeAttachmentList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">VolumeAttachment</a>), required
items is the list of VolumeAttachments
## Operations {#Operations}
<hr>
### `get` read the specified VolumeAttachment
#### HTTP Request
GET /apis/storage.k8s.io/v1/volumeattachments/{name}
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttachment
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttachment</a>): OK
401: Unauthorized
### `get` read status of the specified VolumeAttachment
#### HTTP Request
GET /apis/storage.k8s.io/v1/volumeattachments/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttachment
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttachment</a>): OK
401: Unauthorized
### `list` list or watch objects of kind VolumeAttachment
#### HTTP Request
GET /apis/storage.k8s.io/v1/volumeattachments
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">VolumeAttachmentList</a>): OK
401: Unauthorized
### `create` create a VolumeAttachment
#### HTTP Request
POST /apis/storage.k8s.io/v1/volumeattachments
#### Parameters
- **body**: <a href="">VolumeAttachment</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttachment</a>): OK
201 (<a href="">VolumeAttachment</a>): Created
202 (<a href="">VolumeAttachment</a>): Accepted
401: Unauthorized
### `update` replace the specified VolumeAttachment
#### HTTP Request
PUT /apis/storage.k8s.io/v1/volumeattachments/{name}
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttachment
- **body**: <a href="">VolumeAttachment</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttachment</a>): OK
201 (<a href="">VolumeAttachment</a>): Created
401: Unauthorized
### `update` replace status of the specified VolumeAttachment
#### HTTP Request
PUT /apis/storage.k8s.io/v1/volumeattachments/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttachment
- **body**: <a href="">VolumeAttachment</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttachment</a>): OK
201 (<a href="">VolumeAttachment</a>): Created
401: Unauthorized
### `patch` partially update the specified VolumeAttachment
#### HTTP Request
PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttachment
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttachment</a>): OK
201 (<a href="">VolumeAttachment</a>): Created
401: Unauthorized
### `patch` partially update status of the specified VolumeAttachment
#### HTTP Request
PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttachment
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">VolumeAttachment</a>): OK
201 (<a href="">VolumeAttachment</a>): Created
401: Unauthorized
### `delete` delete a VolumeAttachment
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/volumeattachments/{name}
#### Parameters
- **name** (*in path*): string, required
name of the VolumeAttachment
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">VolumeAttachment</a>): OK
202 (<a href="">VolumeAttachment</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of VolumeAttachment
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/volumeattachments
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion storage k8s io v1 import k8s io api storage v1 kind VolumeAttachment content type api reference description VolumeAttachment captures the intent to attach or detach the specified volume to from the specified node title VolumeAttachment weight 11 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 apiVersion storage k8s io v1 import k8s io api storage v1 VolumeAttachment VolumeAttachment VolumeAttachment captures the intent to attach or detach the specified volume to from the specified node VolumeAttachment objects are non namespaced hr apiVersion storage k8s io v1 kind VolumeAttachment metadata a href ObjectMeta a Standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href VolumeAttachmentSpec a required spec represents specification of the desired attach detach volume behavior Populated by the Kubernetes system status a href VolumeAttachmentStatus a status represents status of the VolumeAttachment request Populated by the entity completing the attach or detach operation i e the external attacher VolumeAttachmentSpec VolumeAttachmentSpec VolumeAttachmentSpec is the specification of a VolumeAttachment request hr attacher string required attacher indicates the name of the volume driver that MUST handle this request This is the name returned by GetPluginName nodeName string required nodeName represents the node that the volume should be attached to source VolumeAttachmentSource required source represents the volume that should be attached a name VolumeAttachmentSource a VolumeAttachmentSource represents a volume that should be attached Right now only PersistenVolumes can be attached via external attacher in future we may allow also inline volumes in pods Exactly one member can be set source inlineVolumeSpec a href PersistentVolumeSpec a inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod s inline VolumeSource This field is populated only for the CSIMigration feature It contains translated fields from a pod s inline VolumeSource to a PersistentVolumeSpec This field is beta level and is only honored by servers that enabled the CSIMigration feature source persistentVolumeName string persistentVolumeName represents the name of the persistent volume to attach VolumeAttachmentStatus VolumeAttachmentStatus VolumeAttachmentStatus is the status of a VolumeAttachment request hr attached boolean required attached indicates the volume is successfully attached This field must only be set by the entity completing the attach operation i e the external attacher attachError VolumeError attachError represents the last error encountered during attach operation if any This field must only be set by the entity completing the attach operation i e the external attacher a name VolumeError a VolumeError captures an error encountered during a volume operation attachError message string message represents the error encountered during Attach or Detach operation This string may be logged so it should not contain sensitive information attachError time Time time represents the time the error was encountered a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers attachmentMetadata map string string attachmentMetadata is populated with any information returned by the attach operation upon successful attach that must be passed into subsequent WaitForAttach or Mount calls This field must only be set by the entity completing the attach operation i e the external attacher detachError VolumeError detachError represents the last error encountered during detach operation if any This field must only be set by the entity completing the detach operation i e the external attacher a name VolumeError a VolumeError captures an error encountered during a volume operation detachError message string message represents the error encountered during Attach or Detach operation This string may be logged so it should not contain sensitive information detachError time Time time represents the time the error was encountered a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers VolumeAttachmentList VolumeAttachmentList VolumeAttachmentList is a collection of VolumeAttachment objects hr apiVersion storage k8s io v1 kind VolumeAttachmentList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href VolumeAttachment a required items is the list of VolumeAttachments Operations Operations hr get read the specified VolumeAttachment HTTP Request GET apis storage k8s io v1 volumeattachments name Parameters name in path string required name of the VolumeAttachment pretty in query string a href pretty a Response 200 a href VolumeAttachment a OK 401 Unauthorized get read status of the specified VolumeAttachment HTTP Request GET apis storage k8s io v1 volumeattachments name status Parameters name in path string required name of the VolumeAttachment pretty in query string a href pretty a Response 200 a href VolumeAttachment a OK 401 Unauthorized list list or watch objects of kind VolumeAttachment HTTP Request GET apis storage k8s io v1 volumeattachments Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href VolumeAttachmentList a OK 401 Unauthorized create create a VolumeAttachment HTTP Request POST apis storage k8s io v1 volumeattachments Parameters body a href VolumeAttachment a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href VolumeAttachment a OK 201 a href VolumeAttachment a Created 202 a href VolumeAttachment a Accepted 401 Unauthorized update replace the specified VolumeAttachment HTTP Request PUT apis storage k8s io v1 volumeattachments name Parameters name in path string required name of the VolumeAttachment body a href VolumeAttachment a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href VolumeAttachment a OK 201 a href VolumeAttachment a Created 401 Unauthorized update replace status of the specified VolumeAttachment HTTP Request PUT apis storage k8s io v1 volumeattachments name status Parameters name in path string required name of the VolumeAttachment body a href VolumeAttachment a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href VolumeAttachment a OK 201 a href VolumeAttachment a Created 401 Unauthorized patch partially update the specified VolumeAttachment HTTP Request PATCH apis storage k8s io v1 volumeattachments name Parameters name in path string required name of the VolumeAttachment body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href VolumeAttachment a OK 201 a href VolumeAttachment a Created 401 Unauthorized patch partially update status of the specified VolumeAttachment HTTP Request PATCH apis storage k8s io v1 volumeattachments name status Parameters name in path string required name of the VolumeAttachment body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href VolumeAttachment a OK 201 a href VolumeAttachment a Created 401 Unauthorized delete delete a VolumeAttachment HTTP Request DELETE apis storage k8s io v1 volumeattachments name Parameters name in path string required name of the VolumeAttachment body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href VolumeAttachment a OK 202 a href VolumeAttachment a Accepted 401 Unauthorized deletecollection delete collection of VolumeAttachment HTTP Request DELETE apis storage k8s io v1 volumeattachments Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference autogenerated true apiVersion storagemigration k8s io v1alpha1 StorageVersionMigration represents a migration of stored data to the latest storage version contenttype apireference title StorageVersionMigration v1alpha1 import k8s io api storagemigration v1alpha1 apimetadata kind StorageVersionMigration weight 9 | ---
api_metadata:
apiVersion: "storagemigration.k8s.io/v1alpha1"
import: "k8s.io/api/storagemigration/v1alpha1"
kind: "StorageVersionMigration"
content_type: "api_reference"
description: "StorageVersionMigration represents a migration of stored data to the latest storage version."
title: "StorageVersionMigration v1alpha1"
weight: 9
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.
-->
`apiVersion: storagemigration.k8s.io/v1alpha1`
`import "k8s.io/api/storagemigration/v1alpha1"`
## StorageVersionMigration {#StorageVersionMigration}
StorageVersionMigration represents a migration of stored data to the latest storage version.
<hr>
- **apiVersion**: storagemigration.k8s.io/v1alpha1
- **kind**: StorageVersionMigration
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">StorageVersionMigrationSpec</a>)
Specification of the migration.
- **status** (<a href="">StorageVersionMigrationStatus</a>)
Status of the migration.
## StorageVersionMigrationSpec {#StorageVersionMigrationSpec}
Spec of the storage version migration.
<hr>
- **continueToken** (string)
The token used in the list options to get the next chunk of objects to migrate. When the .status.conditions indicates the migration is "Running", users can use this token to check the progress of the migration.
- **resource** (GroupVersionResource), required
The resource that is being migrated. The migrator sends requests to the endpoint serving the resource. Immutable.
<a name="GroupVersionResource"></a>
*The names of the group, the version, and the resource.*
- **resource.group** (string)
The name of the group.
- **resource.resource** (string)
The name of the resource.
- **resource.version** (string)
The name of the version.
## StorageVersionMigrationStatus {#StorageVersionMigrationStatus}
Status of the storage version migration.
<hr>
- **conditions** ([]MigrationCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
The latest available observations of the migration's current state.
<a name="MigrationCondition"></a>
*Describes the state of a migration at a certain point.*
- **conditions.status** (string), required
Status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
Type of the condition.
- **conditions.lastUpdateTime** (Time)
The last time this condition was updated.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
A human readable message indicating details about the transition.
- **conditions.reason** (string)
The reason for the condition's last transition.
- **resourceVersion** (string)
ResourceVersion to compare with the GC cache for performing the migration. This is the current resource version of given group, version and resource when kube-controller-manager first observes this StorageVersionMigration resource.
## StorageVersionMigrationList {#StorageVersionMigrationList}
StorageVersionMigrationList is a collection of storage version migrations.
<hr>
- **apiVersion**: storagemigration.k8s.io/v1alpha1
- **kind**: StorageVersionMigrationList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">StorageVersionMigration</a>), required
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Items is the list of StorageVersionMigration
## Operations {#Operations}
<hr>
### `get` read the specified StorageVersionMigration
#### HTTP Request
GET /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StorageVersionMigration
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageVersionMigration</a>): OK
401: Unauthorized
### `get` read status of the specified StorageVersionMigration
#### HTTP Request
GET /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the StorageVersionMigration
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageVersionMigration</a>): OK
401: Unauthorized
### `list` list or watch objects of kind StorageVersionMigration
#### HTTP Request
GET /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">StorageVersionMigrationList</a>): OK
401: Unauthorized
### `create` create a StorageVersionMigration
#### HTTP Request
POST /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations
#### Parameters
- **body**: <a href="">StorageVersionMigration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageVersionMigration</a>): OK
201 (<a href="">StorageVersionMigration</a>): Created
202 (<a href="">StorageVersionMigration</a>): Accepted
401: Unauthorized
### `update` replace the specified StorageVersionMigration
#### HTTP Request
PUT /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StorageVersionMigration
- **body**: <a href="">StorageVersionMigration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageVersionMigration</a>): OK
201 (<a href="">StorageVersionMigration</a>): Created
401: Unauthorized
### `update` replace status of the specified StorageVersionMigration
#### HTTP Request
PUT /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the StorageVersionMigration
- **body**: <a href="">StorageVersionMigration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageVersionMigration</a>): OK
201 (<a href="">StorageVersionMigration</a>): Created
401: Unauthorized
### `patch` partially update the specified StorageVersionMigration
#### HTTP Request
PATCH /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StorageVersionMigration
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageVersionMigration</a>): OK
201 (<a href="">StorageVersionMigration</a>): Created
401: Unauthorized
### `patch` partially update status of the specified StorageVersionMigration
#### HTTP Request
PATCH /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the StorageVersionMigration
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">StorageVersionMigration</a>): OK
201 (<a href="">StorageVersionMigration</a>): Created
401: Unauthorized
### `delete` delete a StorageVersionMigration
#### HTTP Request
DELETE /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the StorageVersionMigration
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of StorageVersionMigration
#### HTTP Request
DELETE /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion storagemigration k8s io v1alpha1 import k8s io api storagemigration v1alpha1 kind StorageVersionMigration content type api reference description StorageVersionMigration represents a migration of stored data to the latest storage version title StorageVersionMigration v1alpha1 weight 9 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 apiVersion storagemigration k8s io v1alpha1 import k8s io api storagemigration v1alpha1 StorageVersionMigration StorageVersionMigration StorageVersionMigration represents a migration of stored data to the latest storage version hr apiVersion storagemigration k8s io v1alpha1 kind StorageVersionMigration metadata a href ObjectMeta a Standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href StorageVersionMigrationSpec a Specification of the migration status a href StorageVersionMigrationStatus a Status of the migration StorageVersionMigrationSpec StorageVersionMigrationSpec Spec of the storage version migration hr continueToken string The token used in the list options to get the next chunk of objects to migrate When the status conditions indicates the migration is Running users can use this token to check the progress of the migration resource GroupVersionResource required The resource that is being migrated The migrator sends requests to the endpoint serving the resource Immutable a name GroupVersionResource a The names of the group the version and the resource resource group string The name of the group resource resource string The name of the resource resource version string The name of the version StorageVersionMigrationStatus StorageVersionMigrationStatus Status of the storage version migration hr conditions MigrationCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge The latest available observations of the migration s current state a name MigrationCondition a Describes the state of a migration at a certain point conditions status string required Status of the condition one of True False Unknown conditions type string required Type of the condition conditions lastUpdateTime Time The last time this condition was updated a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string A human readable message indicating details about the transition conditions reason string The reason for the condition s last transition resourceVersion string ResourceVersion to compare with the GC cache for performing the migration This is the current resource version of given group version and resource when kube controller manager first observes this StorageVersionMigration resource StorageVersionMigrationList StorageVersionMigrationList StorageVersionMigrationList is a collection of storage version migrations hr apiVersion storagemigration k8s io v1alpha1 kind StorageVersionMigrationList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href StorageVersionMigration a required Patch strategy merge on key type Map unique values on key type will be kept during a merge Items is the list of StorageVersionMigration Operations Operations hr get read the specified StorageVersionMigration HTTP Request GET apis storagemigration k8s io v1alpha1 storageversionmigrations name Parameters name in path string required name of the StorageVersionMigration pretty in query string a href pretty a Response 200 a href StorageVersionMigration a OK 401 Unauthorized get read status of the specified StorageVersionMigration HTTP Request GET apis storagemigration k8s io v1alpha1 storageversionmigrations name status Parameters name in path string required name of the StorageVersionMigration pretty in query string a href pretty a Response 200 a href StorageVersionMigration a OK 401 Unauthorized list list or watch objects of kind StorageVersionMigration HTTP Request GET apis storagemigration k8s io v1alpha1 storageversionmigrations Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href StorageVersionMigrationList a OK 401 Unauthorized create create a StorageVersionMigration HTTP Request POST apis storagemigration k8s io v1alpha1 storageversionmigrations Parameters body a href StorageVersionMigration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href StorageVersionMigration a OK 201 a href StorageVersionMigration a Created 202 a href StorageVersionMigration a Accepted 401 Unauthorized update replace the specified StorageVersionMigration HTTP Request PUT apis storagemigration k8s io v1alpha1 storageversionmigrations name Parameters name in path string required name of the StorageVersionMigration body a href StorageVersionMigration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href StorageVersionMigration a OK 201 a href StorageVersionMigration a Created 401 Unauthorized update replace status of the specified StorageVersionMigration HTTP Request PUT apis storagemigration k8s io v1alpha1 storageversionmigrations name status Parameters name in path string required name of the StorageVersionMigration body a href StorageVersionMigration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href StorageVersionMigration a OK 201 a href StorageVersionMigration a Created 401 Unauthorized patch partially update the specified StorageVersionMigration HTTP Request PATCH apis storagemigration k8s io v1alpha1 storageversionmigrations name Parameters name in path string required name of the StorageVersionMigration body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href StorageVersionMigration a OK 201 a href StorageVersionMigration a Created 401 Unauthorized patch partially update status of the specified StorageVersionMigration HTTP Request PATCH apis storagemigration k8s io v1alpha1 storageversionmigrations name status Parameters name in path string required name of the StorageVersionMigration body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href StorageVersionMigration a OK 201 a href StorageVersionMigration a Created 401 Unauthorized delete delete a StorageVersionMigration HTTP Request DELETE apis storagemigration k8s io v1alpha1 storageversionmigrations name Parameters name in path string required name of the StorageVersionMigration body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of StorageVersionMigration HTTP Request DELETE apis storagemigration k8s io v1alpha1 storageversionmigrations Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference CSIDriver captures information about a Container Storage Interface CSI volume driver deployed on the cluster autogenerated true kind CSIDriver contenttype apireference apimetadata apiVersion storage k8s io v1 weight 3 title CSIDriver import k8s io api storage v1 | ---
api_metadata:
apiVersion: "storage.k8s.io/v1"
import: "k8s.io/api/storage/v1"
kind: "CSIDriver"
content_type: "api_reference"
description: "CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster."
title: "CSIDriver"
weight: 3
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.
-->
`apiVersion: storage.k8s.io/v1`
`import "k8s.io/api/storage/v1"`
## CSIDriver {#CSIDriver}
CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: CSIDriver
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">CSIDriverSpec</a>), required
spec represents the specification of the CSI Driver.
## CSIDriverSpec {#CSIDriverSpec}
CSIDriverSpec is the specification of a CSIDriver.
<hr>
- **attachRequired** (boolean)
attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called.
This field is immutable.
- **fsGroupPolicy** (string)
fsGroupPolicy defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details.
This field was immutable in Kubernetes \< 1.29 and now is mutable.
Defaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce.
- **podInfoOnMount** (boolean)
podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations, if set to true. If set to false, pod information will not be passed on mount. Default is false.
The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext.
The following VolumeContext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume
defined by a CSIVolumeSource, otherwise "false"
"csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver.
This field was immutable in Kubernetes \< 1.29 and now is mutable.
- **requiresRepublish** (boolean)
requiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false.
Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container.
- **seLinuxMount** (boolean)
seLinuxMount specifies if the CSI driver supports "-o context" mount option.
When "true", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different `-o context` options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with "-o context=xyz" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context.
When "false", Kubernetes won't pass any special SELinux mount options to the driver. This is typical for volumes that represent subdirectories of a bigger shared filesystem.
Default is "false".
- **storageCapacity** (boolean)
storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information, if set to true.
The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object.
Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published.
This field was immutable in Kubernetes \<= 1.22 and now is mutable.
- **tokenRequests** ([]TokenRequest)
*Atomic: will be replaced during a merge*
tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": {
"\<audience>": {
"token": \<token>,
"expirationTimestamp": \<expiration timestamp in RFC3339>,
},
...
}
Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically.
<a name="TokenRequest"></a>
*TokenRequest contains parameters of a service account token.*
- **tokenRequests.audience** (string), required
audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver.
- **tokenRequests.expirationSeconds** (int64)
expirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec".
- **volumeLifecycleModes** ([]string)
*Set: unique values will be kept during a merge*
volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism.
The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume.
For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future.
This field is beta. This field is immutable.
## CSIDriverList {#CSIDriverList}
CSIDriverList is a collection of CSIDriver objects.
<hr>
- **apiVersion**: storage.k8s.io/v1
- **kind**: CSIDriverList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">CSIDriver</a>), required
items is the list of CSIDriver
## Operations {#Operations}
<hr>
### `get` read the specified CSIDriver
#### HTTP Request
GET /apis/storage.k8s.io/v1/csidrivers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIDriver
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSIDriver</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CSIDriver
#### HTTP Request
GET /apis/storage.k8s.io/v1/csidrivers
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">CSIDriverList</a>): OK
401: Unauthorized
### `create` create a CSIDriver
#### HTTP Request
POST /apis/storage.k8s.io/v1/csidrivers
#### Parameters
- **body**: <a href="">CSIDriver</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSIDriver</a>): OK
201 (<a href="">CSIDriver</a>): Created
202 (<a href="">CSIDriver</a>): Accepted
401: Unauthorized
### `update` replace the specified CSIDriver
#### HTTP Request
PUT /apis/storage.k8s.io/v1/csidrivers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIDriver
- **body**: <a href="">CSIDriver</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSIDriver</a>): OK
201 (<a href="">CSIDriver</a>): Created
401: Unauthorized
### `patch` partially update the specified CSIDriver
#### HTTP Request
PATCH /apis/storage.k8s.io/v1/csidrivers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIDriver
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">CSIDriver</a>): OK
201 (<a href="">CSIDriver</a>): Created
401: Unauthorized
### `delete` delete a CSIDriver
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/csidrivers/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIDriver
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">CSIDriver</a>): OK
202 (<a href="">CSIDriver</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of CSIDriver
#### HTTP Request
DELETE /apis/storage.k8s.io/v1/csidrivers
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion storage k8s io v1 import k8s io api storage v1 kind CSIDriver content type api reference description CSIDriver captures information about a Container Storage Interface CSI volume driver deployed on the cluster title CSIDriver weight 3 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 apiVersion storage k8s io v1 import k8s io api storage v1 CSIDriver CSIDriver CSIDriver captures information about a Container Storage Interface CSI volume driver deployed on the cluster Kubernetes attach detach controller uses this object to determine whether attach is required Kubelet uses this object to determine whether pod information needs to be passed on mount CSIDriver objects are non namespaced hr apiVersion storage k8s io v1 kind CSIDriver metadata a href ObjectMeta a Standard object metadata metadata Name indicates the name of the CSI driver that this object refers to it MUST be the same name returned by the CSI GetPluginName call for that driver The driver name must be 63 characters or less beginning and ending with an alphanumeric character a z0 9A Z with dashes dots and alphanumerics between More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href CSIDriverSpec a required spec represents the specification of the CSI Driver CSIDriverSpec CSIDriverSpec CSIDriverSpec is the specification of a CSIDriver hr attachRequired boolean attachRequired indicates this CSI volume driver requires an attach operation because it implements the CSI ControllerPublishVolume method and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting The CSI external attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete If the CSIDriverRegistry feature gate is enabled and the value is specified to false the attach operation will be skipped Otherwise the attach operation will be called This field is immutable fsGroupPolicy string fsGroupPolicy defines if the underlying volume supports changing ownership and permission of the volume before being mounted Refer to the specific FSGroupPolicy values for additional details This field was immutable in Kubernetes 1 29 and now is mutable Defaults to ReadWriteOnceWithFSType which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume s access mode contains ReadWriteOnce podInfoOnMount boolean podInfoOnMount indicates this CSI volume driver requires additional pod information like podName podUID etc during mount operations if set to true If set to false pod information will not be passed on mount Default is false The CSI driver specifies podInfoOnMount as part of driver deployment If true Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume calls The CSI driver is responsible for parsing and validating the information passed in as VolumeContext The following VolumeContext will be passed if podInfoOnMount is set to true This list might grow but the prefix will be used csi storage k8s io pod name pod Name csi storage k8s io pod namespace pod Namespace csi storage k8s io pod uid string pod UID csi storage k8s io ephemeral true if the volume is an ephemeral inline volume defined by a CSIVolumeSource otherwise false csi storage k8s io ephemeral is a new feature in Kubernetes 1 16 It is only required for drivers which support both the Persistent and Ephemeral VolumeLifecycleMode Other drivers can leave pod info disabled and or ignore this field As Kubernetes 1 15 doesn t support this field drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is for example via a command line parameter of the driver This field was immutable in Kubernetes 1 29 and now is mutable requiresRepublish boolean requiresRepublish indicates the CSI driver wants NodePublishVolume being periodically called to reflect any possible change in the mounted volume This field defaults to false Note After a successful initial NodePublishVolume call subsequent calls to NodePublishVolume should only update the contents of the volume New mount points will not be seen by a running container seLinuxMount boolean seLinuxMount specifies if the CSI driver supports o context mount option When true the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different o context options This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes Kubernetes will call NodeStage NodePublish with o context xyz mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context In the future it may be expanded to other volume AccessModes In any case Kubernetes will ensure that the volume is mounted only with a single SELinux context When false Kubernetes won t pass any special SELinux mount options to the driver This is typical for volumes that represent subdirectories of a bigger shared filesystem Default is false storageCapacity boolean storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information if set to true The check can be enabled immediately when deploying a driver In that case provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object Alternatively the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published This field was immutable in Kubernetes 1 22 and now is mutable tokenRequests TokenRequest Atomic will be replaced during a merge tokenRequests indicates the CSI driver needs pods service account tokens it is mounting volume for to do necessary authentication Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls The CSI driver should parse and validate the following VolumeContext csi storage k8s io serviceAccount tokens audience token token expirationTimestamp expiration timestamp in RFC3339 Note Audience in each TokenRequest should be different and at most one token is empty string To receive a new token after expiry RequiresRepublish can be used to trigger NodePublishVolume periodically a name TokenRequest a TokenRequest contains parameters of a service account token tokenRequests audience string required audience is the intended audience of the token in TokenRequestSpec It will default to the audiences of kube apiserver tokenRequests expirationSeconds int64 expirationSeconds is the duration of validity of the token in TokenRequestSpec It has the same default value of ExpirationSeconds in TokenRequestSpec volumeLifecycleModes string Set unique values will be kept during a merge volumeLifecycleModes defines what kind of volumes this CSI volume driver supports The default if the list is empty is Persistent which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV PVC mechanism The other mode is Ephemeral In this mode volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume For more information about implementing this mode see https kubernetes csi github io docs ephemeral local volumes html A driver can support one or more of these modes and more modes may be added in the future This field is beta This field is immutable CSIDriverList CSIDriverList CSIDriverList is a collection of CSIDriver objects hr apiVersion storage k8s io v1 kind CSIDriverList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href CSIDriver a required items is the list of CSIDriver Operations Operations hr get read the specified CSIDriver HTTP Request GET apis storage k8s io v1 csidrivers name Parameters name in path string required name of the CSIDriver pretty in query string a href pretty a Response 200 a href CSIDriver a OK 401 Unauthorized list list or watch objects of kind CSIDriver HTTP Request GET apis storage k8s io v1 csidrivers Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href CSIDriverList a OK 401 Unauthorized create create a CSIDriver HTTP Request POST apis storage k8s io v1 csidrivers Parameters body a href CSIDriver a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CSIDriver a OK 201 a href CSIDriver a Created 202 a href CSIDriver a Accepted 401 Unauthorized update replace the specified CSIDriver HTTP Request PUT apis storage k8s io v1 csidrivers name Parameters name in path string required name of the CSIDriver body a href CSIDriver a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href CSIDriver a OK 201 a href CSIDriver a Created 401 Unauthorized patch partially update the specified CSIDriver HTTP Request PATCH apis storage k8s io v1 csidrivers name Parameters name in path string required name of the CSIDriver body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href CSIDriver a OK 201 a href CSIDriver a Created 401 Unauthorized delete delete a CSIDriver HTTP Request DELETE apis storage k8s io v1 csidrivers name Parameters name in path string required name of the CSIDriver body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href CSIDriver a OK 202 a href CSIDriver a Accepted 401 Unauthorized deletecollection delete collection of CSIDriver HTTP Request DELETE apis storage k8s io v1 csidrivers Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion v1 weight 2 kind LimitRange contenttype apireference title LimitRange apimetadata autogenerated true LimitRange sets resource usage limits for each kind of resource in a Namespace import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "LimitRange"
content_type: "api_reference"
description: "LimitRange sets resource usage limits for each kind of resource in a Namespace."
title: "LimitRange"
weight: 2
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## LimitRange {#LimitRange}
LimitRange sets resource usage limits for each kind of resource in a Namespace.
<hr>
- **apiVersion**: v1
- **kind**: LimitRange
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">LimitRangeSpec</a>)
Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## LimitRangeSpec {#LimitRangeSpec}
LimitRangeSpec defines a min/max usage limit for resources that match on kind.
<hr>
- **limits** ([]LimitRangeItem), required
*Atomic: will be replaced during a merge*
Limits is the list of LimitRangeItem objects that are enforced.
<a name="LimitRangeItem"></a>
*LimitRangeItem defines a min/max usage limit for any resource that matches on kind.*
- **limits.type** (string), required
Type of resource that this limit applies to.
- **limits.default** (map[string]<a href="">Quantity</a>)
Default resource requirement limit value by resource name if resource limit is omitted.
- **limits.defaultRequest** (map[string]<a href="">Quantity</a>)
DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
- **limits.max** (map[string]<a href="">Quantity</a>)
Max usage constraints on this kind by resource name.
- **limits.maxLimitRequestRatio** (map[string]<a href="">Quantity</a>)
MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
- **limits.min** (map[string]<a href="">Quantity</a>)
Min usage constraints on this kind by resource name.
## LimitRangeList {#LimitRangeList}
LimitRangeList is a list of LimitRange items.
<hr>
- **apiVersion**: v1
- **kind**: LimitRangeList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">LimitRange</a>), required
Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
## Operations {#Operations}
<hr>
### `get` read the specified LimitRange
#### HTTP Request
GET /api/v1/namespaces/{namespace}/limitranges/{name}
#### Parameters
- **name** (*in path*): string, required
name of the LimitRange
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">LimitRange</a>): OK
401: Unauthorized
### `list` list or watch objects of kind LimitRange
#### HTTP Request
GET /api/v1/namespaces/{namespace}/limitranges
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">LimitRangeList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind LimitRange
#### HTTP Request
GET /api/v1/limitranges
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">LimitRangeList</a>): OK
401: Unauthorized
### `create` create a LimitRange
#### HTTP Request
POST /api/v1/namespaces/{namespace}/limitranges
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">LimitRange</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">LimitRange</a>): OK
201 (<a href="">LimitRange</a>): Created
202 (<a href="">LimitRange</a>): Accepted
401: Unauthorized
### `update` replace the specified LimitRange
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/limitranges/{name}
#### Parameters
- **name** (*in path*): string, required
name of the LimitRange
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">LimitRange</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">LimitRange</a>): OK
201 (<a href="">LimitRange</a>): Created
401: Unauthorized
### `patch` partially update the specified LimitRange
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
#### Parameters
- **name** (*in path*): string, required
name of the LimitRange
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">LimitRange</a>): OK
201 (<a href="">LimitRange</a>): Created
401: Unauthorized
### `delete` delete a LimitRange
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
#### Parameters
- **name** (*in path*): string, required
name of the LimitRange
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of LimitRange
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/limitranges
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind LimitRange content type api reference description LimitRange sets resource usage limits for each kind of resource in a Namespace title LimitRange weight 2 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 apiVersion v1 import k8s io api core v1 LimitRange LimitRange LimitRange sets resource usage limits for each kind of resource in a Namespace hr apiVersion v1 kind LimitRange metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href LimitRangeSpec a Spec defines the limits enforced More info https git k8s io community contributors devel sig architecture api conventions md spec and status LimitRangeSpec LimitRangeSpec LimitRangeSpec defines a min max usage limit for resources that match on kind hr limits LimitRangeItem required Atomic will be replaced during a merge Limits is the list of LimitRangeItem objects that are enforced a name LimitRangeItem a LimitRangeItem defines a min max usage limit for any resource that matches on kind limits type string required Type of resource that this limit applies to limits default map string a href Quantity a Default resource requirement limit value by resource name if resource limit is omitted limits defaultRequest map string a href Quantity a DefaultRequest is the default resource requirement request value by resource name if resource request is omitted limits max map string a href Quantity a Max usage constraints on this kind by resource name limits maxLimitRequestRatio map string a href Quantity a MaxLimitRequestRatio if specified the named resource must have a request and limit that are both non zero where limit divided by request is less than or equal to the enumerated value this represents the max burst for the named resource limits min map string a href Quantity a Min usage constraints on this kind by resource name LimitRangeList LimitRangeList LimitRangeList is a list of LimitRange items hr apiVersion v1 kind LimitRangeList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href LimitRange a required Items is a list of LimitRange objects More info https kubernetes io docs concepts configuration manage resources containers Operations Operations hr get read the specified LimitRange HTTP Request GET api v1 namespaces namespace limitranges name Parameters name in path string required name of the LimitRange namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href LimitRange a OK 401 Unauthorized list list or watch objects of kind LimitRange HTTP Request GET api v1 namespaces namespace limitranges Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href LimitRangeList a OK 401 Unauthorized list list or watch objects of kind LimitRange HTTP Request GET api v1 limitranges Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href LimitRangeList a OK 401 Unauthorized create create a LimitRange HTTP Request POST api v1 namespaces namespace limitranges Parameters namespace in path string required a href namespace a body a href LimitRange a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href LimitRange a OK 201 a href LimitRange a Created 202 a href LimitRange a Accepted 401 Unauthorized update replace the specified LimitRange HTTP Request PUT api v1 namespaces namespace limitranges name Parameters name in path string required name of the LimitRange namespace in path string required a href namespace a body a href LimitRange a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href LimitRange a OK 201 a href LimitRange a Created 401 Unauthorized patch partially update the specified LimitRange HTTP Request PATCH api v1 namespaces namespace limitranges name Parameters name in path string required name of the LimitRange namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href LimitRange a OK 201 a href LimitRange a Created 401 Unauthorized delete delete a LimitRange HTTP Request DELETE api v1 namespaces namespace limitranges name Parameters name in path string required name of the LimitRange namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of LimitRange HTTP Request DELETE api v1 namespaces namespace limitranges Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind NetworkPolicy NetworkPolicy describes what network traffic is allowed for a set of Pods title NetworkPolicy contenttype apireference apimetadata weight 4 autogenerated true import k8s io api networking v1 apiVersion networking k8s io v1 | ---
api_metadata:
apiVersion: "networking.k8s.io/v1"
import: "k8s.io/api/networking/v1"
kind: "NetworkPolicy"
content_type: "api_reference"
description: "NetworkPolicy describes what network traffic is allowed for a set of Pods."
title: "NetworkPolicy"
weight: 4
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.
-->
`apiVersion: networking.k8s.io/v1`
`import "k8s.io/api/networking/v1"`
## NetworkPolicy {#NetworkPolicy}
NetworkPolicy describes what network traffic is allowed for a set of Pods
<hr>
- **apiVersion**: networking.k8s.io/v1
- **kind**: NetworkPolicy
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">NetworkPolicySpec</a>)
spec represents the specification of the desired behavior for this NetworkPolicy.
## NetworkPolicySpec {#NetworkPolicySpec}
NetworkPolicySpec provides the specification of a NetworkPolicy
<hr>
- **podSelector** (<a href="">LabelSelector</a>), required
podSelector selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
- **policyTypes** ([]string)
*Atomic: will be replaced during a merge*
policyTypes is a list of rule types that the NetworkPolicy relates to. Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of ingress or egress rules; policies that contain an egress section are assumed to affect egress, and all policies (whether or not they contain an ingress section) are assumed to affect ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
- **ingress** ([]NetworkPolicyIngressRule)
*Atomic: will be replaced during a merge*
ingress is a list of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
<a name="NetworkPolicyIngressRule"></a>
*NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.*
- **ingress.from** ([]NetworkPolicyPeer)
*Atomic: will be replaced during a merge*
from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.
<a name="NetworkPolicyPeer"></a>
*NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed*
- **ingress.from.ipBlock** (IPBlock)
ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
<a name="IPBlock"></a>
*IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.*
- **ingress.from.ipBlock.cidr** (string), required
cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64"
- **ingress.from.ipBlock.except** ([]string)
*Atomic: will be replaced during a merge*
except is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr range
- **ingress.from.namespaceSelector** (<a href="">LabelSelector</a>)
namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.
If podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector.
- **ingress.from.podSelector** (<a href="">LabelSelector</a>)
podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods.
If namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace.
- **ingress.ports** ([]NetworkPolicyPort)
*Atomic: will be replaced during a merge*
ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
<a name="NetworkPolicyPort"></a>
*NetworkPolicyPort describes a port to allow traffic on*
- **ingress.ports.port** (IntOrString)
port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **ingress.ports.endPort** (int32)
endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.
- **ingress.ports.protocol** (string)
protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
- **egress** ([]NetworkPolicyEgressRule)
*Atomic: will be replaced during a merge*
egress is a list of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
<a name="NetworkPolicyEgressRule"></a>
*NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8*
- **egress.to** ([]NetworkPolicyPeer)
*Atomic: will be replaced during a merge*
to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
<a name="NetworkPolicyPeer"></a>
*NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed*
- **egress.to.ipBlock** (IPBlock)
ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
<a name="IPBlock"></a>
*IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.*
- **egress.to.ipBlock.cidr** (string), required
cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64"
- **egress.to.ipBlock.except** ([]string)
*Atomic: will be replaced during a merge*
except is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr range
- **egress.to.namespaceSelector** (<a href="">LabelSelector</a>)
namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.
If podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector.
- **egress.to.podSelector** (<a href="">LabelSelector</a>)
podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods.
If namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace.
- **egress.ports** ([]NetworkPolicyPort)
*Atomic: will be replaced during a merge*
ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
<a name="NetworkPolicyPort"></a>
*NetworkPolicyPort describes a port to allow traffic on*
- **egress.ports.port** (IntOrString)
port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **egress.ports.endPort** (int32)
endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.
- **egress.ports.protocol** (string)
protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
## NetworkPolicyList {#NetworkPolicyList}
NetworkPolicyList is a list of NetworkPolicy objects.
<hr>
- **apiVersion**: networking.k8s.io/v1
- **kind**: NetworkPolicyList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">NetworkPolicy</a>), required
items is a list of schema objects.
## Operations {#Operations}
<hr>
### `get` read the specified NetworkPolicy
#### HTTP Request
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
#### Parameters
- **name** (*in path*): string, required
name of the NetworkPolicy
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">NetworkPolicy</a>): OK
401: Unauthorized
### `list` list or watch objects of kind NetworkPolicy
#### HTTP Request
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">NetworkPolicyList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind NetworkPolicy
#### HTTP Request
GET /apis/networking.k8s.io/v1/networkpolicies
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">NetworkPolicyList</a>): OK
401: Unauthorized
### `create` create a NetworkPolicy
#### HTTP Request
POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">NetworkPolicy</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">NetworkPolicy</a>): OK
201 (<a href="">NetworkPolicy</a>): Created
202 (<a href="">NetworkPolicy</a>): Accepted
401: Unauthorized
### `update` replace the specified NetworkPolicy
#### HTTP Request
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
#### Parameters
- **name** (*in path*): string, required
name of the NetworkPolicy
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">NetworkPolicy</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">NetworkPolicy</a>): OK
201 (<a href="">NetworkPolicy</a>): Created
401: Unauthorized
### `patch` partially update the specified NetworkPolicy
#### HTTP Request
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
#### Parameters
- **name** (*in path*): string, required
name of the NetworkPolicy
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">NetworkPolicy</a>): OK
201 (<a href="">NetworkPolicy</a>): Created
401: Unauthorized
### `delete` delete a NetworkPolicy
#### HTTP Request
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
#### Parameters
- **name** (*in path*): string, required
name of the NetworkPolicy
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of NetworkPolicy
#### HTTP Request
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion networking k8s io v1 import k8s io api networking v1 kind NetworkPolicy content type api reference description NetworkPolicy describes what network traffic is allowed for a set of Pods title NetworkPolicy weight 4 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 apiVersion networking k8s io v1 import k8s io api networking v1 NetworkPolicy NetworkPolicy NetworkPolicy describes what network traffic is allowed for a set of Pods hr apiVersion networking k8s io v1 kind NetworkPolicy metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href NetworkPolicySpec a spec represents the specification of the desired behavior for this NetworkPolicy NetworkPolicySpec NetworkPolicySpec NetworkPolicySpec provides the specification of a NetworkPolicy hr podSelector a href LabelSelector a required podSelector selects the pods to which this NetworkPolicy object applies The array of ingress rules is applied to any pods selected by this field Multiple network policies can select the same set of pods In this case the ingress rules for each are combined additively This field is NOT optional and follows standard label selector semantics An empty podSelector matches all pods in this namespace policyTypes string Atomic will be replaced during a merge policyTypes is a list of rule types that the NetworkPolicy relates to Valid options are Ingress Egress or Ingress Egress If this field is not specified it will default based on the existence of ingress or egress rules policies that contain an egress section are assumed to affect egress and all policies whether or not they contain an ingress section are assumed to affect ingress If you want to write an egress only policy you must explicitly specify policyTypes Egress Likewise if you want to write a policy that specifies that no egress is allowed you must specify a policyTypes value that include Egress since such a policy would not include an egress section and would otherwise default to just Ingress This field is beta level in 1 8 ingress NetworkPolicyIngressRule Atomic will be replaced during a merge ingress is a list of ingress rules to be applied to the selected pods Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod and cluster policy otherwise allows the traffic OR if the traffic source is the pod s local node OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod If this field is empty then this NetworkPolicy does not allow any traffic and serves solely to ensure that the pods it selects are isolated by default a name NetworkPolicyIngressRule a NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec s podSelector The traffic must match both ports and from ingress from NetworkPolicyPeer Atomic will be replaced during a merge from is a list of sources which should be able to access the pods selected for this rule Items in this list are combined using a logical OR operation If this field is empty or missing this rule matches all sources traffic not restricted by source If this field is present and contains at least one item this rule allows traffic only if the traffic matches at least one item in the from list a name NetworkPolicyPeer a NetworkPolicyPeer describes a peer to allow traffic to from Only certain combinations of fields are allowed ingress from ipBlock IPBlock ipBlock defines policy on a particular IPBlock If this field is set then neither of the other fields can be a name IPBlock a IPBlock describes a particular CIDR Ex 192 168 1 0 24 2001 db8 64 that is allowed to the pods matched by a NetworkPolicySpec s podSelector The except entry describes CIDRs that should not be included within this rule ingress from ipBlock cidr string required cidr is a string representing the IPBlock Valid examples are 192 168 1 0 24 or 2001 db8 64 ingress from ipBlock except string Atomic will be replaced during a merge except is a slice of CIDRs that should not be included within an IPBlock Valid examples are 192 168 1 0 24 or 2001 db8 64 Except values will be rejected if they are outside the cidr range ingress from namespaceSelector a href LabelSelector a namespaceSelector selects namespaces using cluster scoped labels This field follows standard label selector semantics if present but empty it selects all namespaces If podSelector is also set then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector Otherwise it selects all pods in the namespaces selected by namespaceSelector ingress from podSelector a href LabelSelector a podSelector is a label selector which selects pods This field follows standard label selector semantics if present but empty it selects all pods If namespaceSelector is also set then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector Otherwise it selects the pods matching podSelector in the policy s own namespace ingress ports NetworkPolicyPort Atomic will be replaced during a merge ports is a list of ports which should be made accessible on the pods selected for this rule Each item in this list is combined using a logical OR If this field is empty or missing this rule matches all ports traffic not restricted by port If this field is present and contains at least one item then this rule allows traffic only if the traffic matches at least one port in the list a name NetworkPolicyPort a NetworkPolicyPort describes a port to allow traffic on ingress ports port IntOrString port represents the port on the given protocol This can either be a numerical or named port on a pod If this field is not provided this matches all port names and numbers If present only traffic on the specified protocol AND port will be matched a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number ingress ports endPort int32 endPort indicates that the range of ports from port to endPort if set inclusive should be allowed by the policy This field cannot be defined if the port field is not defined or if the port field is defined as a named string port The endPort must be equal or greater than port ingress ports protocol string protocol represents the protocol TCP UDP or SCTP which traffic must match If not specified this field defaults to TCP egress NetworkPolicyEgressRule Atomic will be replaced during a merge egress is a list of egress rules to be applied to the selected pods Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod and cluster policy otherwise allows the traffic OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod If this field is empty then this NetworkPolicy limits all outgoing traffic and serves solely to ensure that the pods it selects are isolated by default This field is beta level in 1 8 a name NetworkPolicyEgressRule a NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec s podSelector The traffic must match both ports and to This type is beta level in 1 8 egress to NetworkPolicyPeer Atomic will be replaced during a merge to is a list of destinations for outgoing traffic of pods selected for this rule Items in this list are combined using a logical OR operation If this field is empty or missing this rule matches all destinations traffic not restricted by destination If this field is present and contains at least one item this rule allows traffic only if the traffic matches at least one item in the to list a name NetworkPolicyPeer a NetworkPolicyPeer describes a peer to allow traffic to from Only certain combinations of fields are allowed egress to ipBlock IPBlock ipBlock defines policy on a particular IPBlock If this field is set then neither of the other fields can be a name IPBlock a IPBlock describes a particular CIDR Ex 192 168 1 0 24 2001 db8 64 that is allowed to the pods matched by a NetworkPolicySpec s podSelector The except entry describes CIDRs that should not be included within this rule egress to ipBlock cidr string required cidr is a string representing the IPBlock Valid examples are 192 168 1 0 24 or 2001 db8 64 egress to ipBlock except string Atomic will be replaced during a merge except is a slice of CIDRs that should not be included within an IPBlock Valid examples are 192 168 1 0 24 or 2001 db8 64 Except values will be rejected if they are outside the cidr range egress to namespaceSelector a href LabelSelector a namespaceSelector selects namespaces using cluster scoped labels This field follows standard label selector semantics if present but empty it selects all namespaces If podSelector is also set then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector Otherwise it selects all pods in the namespaces selected by namespaceSelector egress to podSelector a href LabelSelector a podSelector is a label selector which selects pods This field follows standard label selector semantics if present but empty it selects all pods If namespaceSelector is also set then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector Otherwise it selects the pods matching podSelector in the policy s own namespace egress ports NetworkPolicyPort Atomic will be replaced during a merge ports is a list of destination ports for outgoing traffic Each item in this list is combined using a logical OR If this field is empty or missing this rule matches all ports traffic not restricted by port If this field is present and contains at least one item then this rule allows traffic only if the traffic matches at least one port in the list a name NetworkPolicyPort a NetworkPolicyPort describes a port to allow traffic on egress ports port IntOrString port represents the port on the given protocol This can either be a numerical or named port on a pod If this field is not provided this matches all port names and numbers If present only traffic on the specified protocol AND port will be matched a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number egress ports endPort int32 endPort indicates that the range of ports from port to endPort if set inclusive should be allowed by the policy This field cannot be defined if the port field is not defined or if the port field is defined as a named string port The endPort must be equal or greater than port egress ports protocol string protocol represents the protocol TCP UDP or SCTP which traffic must match If not specified this field defaults to TCP NetworkPolicyList NetworkPolicyList NetworkPolicyList is a list of NetworkPolicy objects hr apiVersion networking k8s io v1 kind NetworkPolicyList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href NetworkPolicy a required items is a list of schema objects Operations Operations hr get read the specified NetworkPolicy HTTP Request GET apis networking k8s io v1 namespaces namespace networkpolicies name Parameters name in path string required name of the NetworkPolicy namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href NetworkPolicy a OK 401 Unauthorized list list or watch objects of kind NetworkPolicy HTTP Request GET apis networking k8s io v1 namespaces namespace networkpolicies Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href NetworkPolicyList a OK 401 Unauthorized list list or watch objects of kind NetworkPolicy HTTP Request GET apis networking k8s io v1 networkpolicies Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href NetworkPolicyList a OK 401 Unauthorized create create a NetworkPolicy HTTP Request POST apis networking k8s io v1 namespaces namespace networkpolicies Parameters namespace in path string required a href namespace a body a href NetworkPolicy a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href NetworkPolicy a OK 201 a href NetworkPolicy a Created 202 a href NetworkPolicy a Accepted 401 Unauthorized update replace the specified NetworkPolicy HTTP Request PUT apis networking k8s io v1 namespaces namespace networkpolicies name Parameters name in path string required name of the NetworkPolicy namespace in path string required a href namespace a body a href NetworkPolicy a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href NetworkPolicy a OK 201 a href NetworkPolicy a Created 401 Unauthorized patch partially update the specified NetworkPolicy HTTP Request PATCH apis networking k8s io v1 namespaces namespace networkpolicies name Parameters name in path string required name of the NetworkPolicy namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href NetworkPolicy a OK 201 a href NetworkPolicy a Created 401 Unauthorized delete delete a NetworkPolicy HTTP Request DELETE apis networking k8s io v1 namespaces namespace networkpolicies name Parameters name in path string required name of the NetworkPolicy namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of NetworkPolicy HTTP Request DELETE apis networking k8s io v1 namespaces namespace networkpolicies Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title PodDisruptionBudget import k8s io api policy v1 weight 5 PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods kind PodDisruptionBudget contenttype apireference apimetadata autogenerated true apiVersion policy v1 | ---
api_metadata:
apiVersion: "policy/v1"
import: "k8s.io/api/policy/v1"
kind: "PodDisruptionBudget"
content_type: "api_reference"
description: "PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods."
title: "PodDisruptionBudget"
weight: 5
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.
-->
`apiVersion: policy/v1`
`import "k8s.io/api/policy/v1"`
## PodDisruptionBudget {#PodDisruptionBudget}
PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods
<hr>
- **apiVersion**: policy/v1
- **kind**: PodDisruptionBudget
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">PodDisruptionBudgetSpec</a>)
Specification of the desired behavior of the PodDisruptionBudget.
- **status** (<a href="">PodDisruptionBudgetStatus</a>)
Most recently observed status of the PodDisruptionBudget.
## PodDisruptionBudgetSpec {#PodDisruptionBudgetSpec}
PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.
<hr>
- **maxUnavailable** (IntOrString)
An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **minAvailable** (IntOrString)
An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **selector** (<a href="">LabelSelector</a>)
Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace.
- **unhealthyPodEvictionPolicy** (string)
UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with type="Ready",status="True".
Valid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy.
IfHealthyBudget policy means that running pods (status.phase="Running"), but not yet healthy can be evicted only if the guarded application is not disrupted (status.currentHealthy is at least equal to status.desiredHealthy). Healthy pods will be subject to the PDB for eviction.
AlwaysAllow policy means that all running pods (status.phase="Running"), but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met. This means perspective running pods of a disrupted application might not get a chance to become healthy. Healthy pods will be subject to the PDB for eviction.
Additional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field.
This field is beta-level. The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default).
## PodDisruptionBudgetStatus {#PodDisruptionBudgetStatus}
PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.
<hr>
- **currentHealthy** (int32), required
current number of healthy pods
- **desiredHealthy** (int32), required
minimum desired number of healthy pods
- **disruptionsAllowed** (int32), required
Number of pod disruptions that are currently allowed.
- **expectedPods** (int32), required
total number of pods counted by this disruption budget
- **conditions** ([]Condition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute
the number of allowed disruptions. Therefore no disruptions are
allowed and the status of the condition will be False.
- InsufficientPods: The number of pods are either at or below the number
required by the PodDisruptionBudget. No disruptions are
allowed and the status of the condition will be False.
- SufficientPods: There are more pods than required by the PodDisruptionBudget.
The condition will be True, and the number of allowed
disruptions are provided by the disruptionsAllowed property.
<a name="Condition"></a>
*Condition contains details for one aspect of the current state of this API Resource.*
- **conditions.lastTransitionTime** (Time), required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string), required
message is a human readable message indicating details about the transition. This may be an empty string.
- **conditions.reason** (string), required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
- **conditions.status** (string), required
status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
type of condition in CamelCase or in foo.example.com/CamelCase.
- **conditions.observedGeneration** (int64)
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
- **disruptedPods** (map[string]Time)
DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **observedGeneration** (int64)
Most recent generation observed when updating this PDB status. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.
## PodDisruptionBudgetList {#PodDisruptionBudgetList}
PodDisruptionBudgetList is a collection of PodDisruptionBudgets.
<hr>
- **apiVersion**: policy/v1
- **kind**: PodDisruptionBudgetList
- **metadata** (<a href="">ListMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">PodDisruptionBudget</a>), required
Items is a list of PodDisruptionBudgets
## Operations {#Operations}
<hr>
### `get` read the specified PodDisruptionBudget
#### HTTP Request
GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodDisruptionBudget
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodDisruptionBudget</a>): OK
401: Unauthorized
### `get` read status of the specified PodDisruptionBudget
#### HTTP Request
GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PodDisruptionBudget
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodDisruptionBudget</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PodDisruptionBudget
#### HTTP Request
GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PodDisruptionBudgetList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PodDisruptionBudget
#### HTTP Request
GET /apis/policy/v1/poddisruptionbudgets
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PodDisruptionBudgetList</a>): OK
401: Unauthorized
### `create` create a PodDisruptionBudget
#### HTTP Request
POST /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PodDisruptionBudget</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodDisruptionBudget</a>): OK
201 (<a href="">PodDisruptionBudget</a>): Created
202 (<a href="">PodDisruptionBudget</a>): Accepted
401: Unauthorized
### `update` replace the specified PodDisruptionBudget
#### HTTP Request
PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodDisruptionBudget
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PodDisruptionBudget</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodDisruptionBudget</a>): OK
201 (<a href="">PodDisruptionBudget</a>): Created
401: Unauthorized
### `update` replace status of the specified PodDisruptionBudget
#### HTTP Request
PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PodDisruptionBudget
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">PodDisruptionBudget</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodDisruptionBudget</a>): OK
201 (<a href="">PodDisruptionBudget</a>): Created
401: Unauthorized
### `patch` partially update the specified PodDisruptionBudget
#### HTTP Request
PATCH /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodDisruptionBudget
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodDisruptionBudget</a>): OK
201 (<a href="">PodDisruptionBudget</a>): Created
401: Unauthorized
### `patch` partially update status of the specified PodDisruptionBudget
#### HTTP Request
PATCH /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PodDisruptionBudget
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PodDisruptionBudget</a>): OK
201 (<a href="">PodDisruptionBudget</a>): Created
401: Unauthorized
### `delete` delete a PodDisruptionBudget
#### HTTP Request
DELETE /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodDisruptionBudget
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of PodDisruptionBudget
#### HTTP Request
DELETE /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion policy v1 import k8s io api policy v1 kind PodDisruptionBudget content type api reference description PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods title PodDisruptionBudget weight 5 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 apiVersion policy v1 import k8s io api policy v1 PodDisruptionBudget PodDisruptionBudget PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods hr apiVersion policy v1 kind PodDisruptionBudget metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href PodDisruptionBudgetSpec a Specification of the desired behavior of the PodDisruptionBudget status a href PodDisruptionBudgetStatus a Most recently observed status of the PodDisruptionBudget PodDisruptionBudgetSpec PodDisruptionBudgetSpec PodDisruptionBudgetSpec is a description of a PodDisruptionBudget hr maxUnavailable IntOrString An eviction is allowed if at most maxUnavailable pods selected by selector are unavailable after the eviction i e even in absence of the evicted pod For example one can prevent all voluntary evictions by specifying 0 This is a mutually exclusive setting with minAvailable a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number minAvailable IntOrString An eviction is allowed if at least minAvailable pods selected by selector will still be available after the eviction i e even in the absence of the evicted pod So for example you can prevent all voluntary evictions by specifying 100 a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number selector a href LabelSelector a Label query over pods whose evictions are managed by the disruption budget A null selector will match no pods while an empty selector will select all pods within the namespace unhealthyPodEvictionPolicy string UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction Current implementation considers healthy pods as pods that have status conditions item with type Ready status True Valid policies are IfHealthyBudget and AlwaysAllow If no policy is specified the default behavior will be used which corresponds to the IfHealthyBudget policy IfHealthyBudget policy means that running pods status phase Running but not yet healthy can be evicted only if the guarded application is not disrupted status currentHealthy is at least equal to status desiredHealthy Healthy pods will be subject to the PDB for eviction AlwaysAllow policy means that all running pods status phase Running but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met This means perspective running pods of a disrupted application might not get a chance to become healthy Healthy pods will be subject to the PDB for eviction Additional policies may be added in the future Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field This field is beta level The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled enabled by default PodDisruptionBudgetStatus PodDisruptionBudgetStatus PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget Status may trail the actual state of a system hr currentHealthy int32 required current number of healthy pods desiredHealthy int32 required minimum desired number of healthy pods disruptionsAllowed int32 required Number of pod disruptions that are currently allowed expectedPods int32 required total number of pods counted by this disruption budget conditions Condition Patch strategy merge on key type Map unique values on key type will be kept during a merge Conditions contain conditions for PDB The disruption controller sets the DisruptionAllowed condition The following are known values for the reason field additional reasons could be added in the future SyncFailed The controller encountered an error and wasn t able to compute the number of allowed disruptions Therefore no disruptions are allowed and the status of the condition will be False InsufficientPods The number of pods are either at or below the number required by the PodDisruptionBudget No disruptions are allowed and the status of the condition will be False SufficientPods There are more pods than required by the PodDisruptionBudget The condition will be True and the number of allowed disruptions are provided by the disruptionsAllowed property a name Condition a Condition contains details for one aspect of the current state of this API Resource conditions lastTransitionTime Time required lastTransitionTime is the last time the condition transitioned from one status to another This should be when the underlying condition changed If that is not known then using the time when the API field changed is acceptable a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string required message is a human readable message indicating details about the transition This may be an empty string conditions reason string required reason contains a programmatic identifier indicating the reason for the condition s last transition Producers of specific condition types may define expected values and meanings for this field and whether the values are considered a guaranteed API The value should be a CamelCase string This field may not be empty conditions status string required status of the condition one of True False Unknown conditions type string required type of condition in CamelCase or in foo example com CamelCase conditions observedGeneration int64 observedGeneration represents the metadata generation that the condition was set based upon For instance if metadata generation is currently 12 but the status conditions x observedGeneration is 9 the condition is out of date with respect to the current state of the instance disruptedPods map string Time DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion or after a timeout The key in the map is the name of the pod and the value is the time when the API server processed the eviction request If the deletion didn t occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time If everything goes smooth this map should be empty for the most of the time Large number of entries in the map may indicate problems with pod deletions a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers observedGeneration int64 Most recent generation observed when updating this PDB status DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB s object generation PodDisruptionBudgetList PodDisruptionBudgetList PodDisruptionBudgetList is a collection of PodDisruptionBudgets hr apiVersion policy v1 kind PodDisruptionBudgetList metadata a href ListMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href PodDisruptionBudget a required Items is a list of PodDisruptionBudgets Operations Operations hr get read the specified PodDisruptionBudget HTTP Request GET apis policy v1 namespaces namespace poddisruptionbudgets name Parameters name in path string required name of the PodDisruptionBudget namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href PodDisruptionBudget a OK 401 Unauthorized get read status of the specified PodDisruptionBudget HTTP Request GET apis policy v1 namespaces namespace poddisruptionbudgets name status Parameters name in path string required name of the PodDisruptionBudget namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href PodDisruptionBudget a OK 401 Unauthorized list list or watch objects of kind PodDisruptionBudget HTTP Request GET apis policy v1 namespaces namespace poddisruptionbudgets Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PodDisruptionBudgetList a OK 401 Unauthorized list list or watch objects of kind PodDisruptionBudget HTTP Request GET apis policy v1 poddisruptionbudgets Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PodDisruptionBudgetList a OK 401 Unauthorized create create a PodDisruptionBudget HTTP Request POST apis policy v1 namespaces namespace poddisruptionbudgets Parameters namespace in path string required a href namespace a body a href PodDisruptionBudget a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PodDisruptionBudget a OK 201 a href PodDisruptionBudget a Created 202 a href PodDisruptionBudget a Accepted 401 Unauthorized update replace the specified PodDisruptionBudget HTTP Request PUT apis policy v1 namespaces namespace poddisruptionbudgets name Parameters name in path string required name of the PodDisruptionBudget namespace in path string required a href namespace a body a href PodDisruptionBudget a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PodDisruptionBudget a OK 201 a href PodDisruptionBudget a Created 401 Unauthorized update replace status of the specified PodDisruptionBudget HTTP Request PUT apis policy v1 namespaces namespace poddisruptionbudgets name status Parameters name in path string required name of the PodDisruptionBudget namespace in path string required a href namespace a body a href PodDisruptionBudget a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PodDisruptionBudget a OK 201 a href PodDisruptionBudget a Created 401 Unauthorized patch partially update the specified PodDisruptionBudget HTTP Request PATCH apis policy v1 namespaces namespace poddisruptionbudgets name Parameters name in path string required name of the PodDisruptionBudget namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PodDisruptionBudget a OK 201 a href PodDisruptionBudget a Created 401 Unauthorized patch partially update status of the specified PodDisruptionBudget HTTP Request PATCH apis policy v1 namespaces namespace poddisruptionbudgets name status Parameters name in path string required name of the PodDisruptionBudget namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PodDisruptionBudget a OK 201 a href PodDisruptionBudget a Created 401 Unauthorized delete delete a PodDisruptionBudget HTTP Request DELETE apis policy v1 namespaces namespace poddisruptionbudgets name Parameters name in path string required name of the PodDisruptionBudget namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of PodDisruptionBudget HTTP Request DELETE apis policy v1 namespaces namespace poddisruptionbudgets Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference import k8s io api flowcontrol v1 apiVersion flowcontrol apiserver k8s io v1 contenttype apireference title FlowSchema apimetadata FlowSchema defines the schema of a group of flows autogenerated true weight 1 kind FlowSchema | ---
api_metadata:
apiVersion: "flowcontrol.apiserver.k8s.io/v1"
import: "k8s.io/api/flowcontrol/v1"
kind: "FlowSchema"
content_type: "api_reference"
description: "FlowSchema defines the schema of a group of flows."
title: "FlowSchema"
weight: 1
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.
-->
`apiVersion: flowcontrol.apiserver.k8s.io/v1`
`import "k8s.io/api/flowcontrol/v1"`
## FlowSchema {#FlowSchema}
FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher".
<hr>
- **apiVersion**: flowcontrol.apiserver.k8s.io/v1
- **kind**: FlowSchema
- **metadata** (<a href="">ObjectMeta</a>)
`metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">FlowSchemaSpec</a>)
`spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">FlowSchemaStatus</a>)
`status` is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## FlowSchemaSpec {#FlowSchemaSpec}
FlowSchemaSpec describes how the FlowSchema's specification looks like.
<hr>
- **distinguisherMethod** (FlowDistinguisherMethod)
`distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string.
<a name="FlowDistinguisherMethod"></a>
*FlowDistinguisherMethod specifies the method of a flow distinguisher.*
- **distinguisherMethod.type** (string), required
`type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required.
- **matchingPrecedence** (int32)
`matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default.
- **priorityLevelConfiguration** (PriorityLevelConfigurationReference), required
`priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required.
<a name="PriorityLevelConfigurationReference"></a>
*PriorityLevelConfigurationReference contains information that points to the "request-priority" being used.*
- **priorityLevelConfiguration.name** (string), required
`name` is the name of the priority level configuration being referenced Required.
- **rules** ([]PolicyRulesWithSubjects)
*Atomic: will be replaced during a merge*
`rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema.
<a name="PolicyRulesWithSubjects"></a>
*PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request.*
- **rules.subjects** ([]Subject), required
*Atomic: will be replaced during a merge*
subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required.
<a name="Subject"></a>
*Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account.*
- **rules.subjects.kind** (string), required
`kind` indicates which one of the other fields is non-empty. Required
- **rules.subjects.group** (GroupSubject)
`group` matches based on user group name.
<a name="GroupSubject"></a>
*GroupSubject holds detailed information for group-kind subject.*
- **rules.subjects.group.name** (string), required
name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required.
- **rules.subjects.serviceAccount** (ServiceAccountSubject)
`serviceAccount` matches ServiceAccounts.
<a name="ServiceAccountSubject"></a>
*ServiceAccountSubject holds detailed information for service-account-kind subject.*
- **rules.subjects.serviceAccount.name** (string), required
`name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required.
- **rules.subjects.serviceAccount.namespace** (string), required
`namespace` is the namespace of matching ServiceAccount objects. Required.
- **rules.subjects.user** (UserSubject)
`user` matches based on username.
<a name="UserSubject"></a>
*UserSubject holds detailed information for user-kind subject.*
- **rules.subjects.user.name** (string), required
`name` is the username that matches, or "*" to match all usernames. Required.
- **rules.nonResourceRules** ([]NonResourcePolicyRule)
*Atomic: will be replaced during a merge*
`nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL.
<a name="NonResourcePolicyRule"></a>
*NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request.*
- **rules.nonResourceRules.nonResourceURLs** ([]string), required
*Set: unique values will be kept during a merge*
`nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example:
- "/healthz" is legal
- "/hea*" is illegal
- "/hea" is legal but matches nothing
- "/hea/*" also matches nothing
- "/healthz/*" matches all per-component health checks.
"*" matches all non-resource urls. if it is present, it must be the only entry. Required.
- **rules.nonResourceRules.verbs** ([]string), required
*Set: unique values will be kept during a merge*
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.
- **rules.resourceRules** ([]ResourcePolicyRule)
*Atomic: will be replaced during a merge*
`resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty.
<a name="ResourcePolicyRule"></a>
*ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) either (d1) the request does not specify a namespace (i.e., `Namespace==""`) and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request's namespace.*
- **rules.resourceRules.apiGroups** ([]string), required
*Set: unique values will be kept during a merge*
`apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.
- **rules.resourceRules.resources** ([]string), required
*Set: unique values will be kept during a merge*
`resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.
- **rules.resourceRules.verbs** ([]string), required
*Set: unique values will be kept during a merge*
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.
- **rules.resourceRules.clusterScope** (boolean)
`clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.
- **rules.resourceRules.namespaces** ([]string)
*Set: unique values will be kept during a merge*
`namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.
## FlowSchemaStatus {#FlowSchemaStatus}
FlowSchemaStatus represents the current state of a FlowSchema.
<hr>
- **conditions** ([]FlowSchemaCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
`conditions` is a list of the current states of FlowSchema.
<a name="FlowSchemaCondition"></a>
*FlowSchemaCondition describes conditions for a FlowSchema.*
- **conditions.lastTransitionTime** (Time)
`lastTransitionTime` is the last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
`message` is a human-readable message indicating details about last transition.
- **conditions.reason** (string)
`reason` is a unique, one-word, CamelCase reason for the condition's last transition.
- **conditions.status** (string)
`status` is the status of the condition. Can be True, False, Unknown. Required.
- **conditions.type** (string)
`type` is the type of the condition. Required.
## FlowSchemaList {#FlowSchemaList}
FlowSchemaList is a list of FlowSchema objects.
<hr>
- **apiVersion**: flowcontrol.apiserver.k8s.io/v1
- **kind**: FlowSchemaList
- **metadata** (<a href="">ListMeta</a>)
`metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">FlowSchema</a>), required
`items` is a list of FlowSchemas.
## Operations {#Operations}
<hr>
### `get` read the specified FlowSchema
#### HTTP Request
GET /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}
#### Parameters
- **name** (*in path*): string, required
name of the FlowSchema
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">FlowSchema</a>): OK
401: Unauthorized
### `get` read status of the specified FlowSchema
#### HTTP Request
GET /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the FlowSchema
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">FlowSchema</a>): OK
401: Unauthorized
### `list` list or watch objects of kind FlowSchema
#### HTTP Request
GET /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">FlowSchemaList</a>): OK
401: Unauthorized
### `create` create a FlowSchema
#### HTTP Request
POST /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas
#### Parameters
- **body**: <a href="">FlowSchema</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">FlowSchema</a>): OK
201 (<a href="">FlowSchema</a>): Created
202 (<a href="">FlowSchema</a>): Accepted
401: Unauthorized
### `update` replace the specified FlowSchema
#### HTTP Request
PUT /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}
#### Parameters
- **name** (*in path*): string, required
name of the FlowSchema
- **body**: <a href="">FlowSchema</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">FlowSchema</a>): OK
201 (<a href="">FlowSchema</a>): Created
401: Unauthorized
### `update` replace status of the specified FlowSchema
#### HTTP Request
PUT /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the FlowSchema
- **body**: <a href="">FlowSchema</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">FlowSchema</a>): OK
201 (<a href="">FlowSchema</a>): Created
401: Unauthorized
### `patch` partially update the specified FlowSchema
#### HTTP Request
PATCH /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}
#### Parameters
- **name** (*in path*): string, required
name of the FlowSchema
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">FlowSchema</a>): OK
201 (<a href="">FlowSchema</a>): Created
401: Unauthorized
### `patch` partially update status of the specified FlowSchema
#### HTTP Request
PATCH /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the FlowSchema
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">FlowSchema</a>): OK
201 (<a href="">FlowSchema</a>): Created
401: Unauthorized
### `delete` delete a FlowSchema
#### HTTP Request
DELETE /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}
#### Parameters
- **name** (*in path*): string, required
name of the FlowSchema
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of FlowSchema
#### HTTP Request
DELETE /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion flowcontrol apiserver k8s io v1 import k8s io api flowcontrol v1 kind FlowSchema content type api reference description FlowSchema defines the schema of a group of flows title FlowSchema weight 1 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 apiVersion flowcontrol apiserver k8s io v1 import k8s io api flowcontrol v1 FlowSchema FlowSchema FlowSchema defines the schema of a group of flows Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings the name of the FlowSchema and a flow distinguisher hr apiVersion flowcontrol apiserver k8s io v1 kind FlowSchema metadata a href ObjectMeta a metadata is the standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href FlowSchemaSpec a spec is the specification of the desired behavior of a FlowSchema More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href FlowSchemaStatus a status is the current status of a FlowSchema More info https git k8s io community contributors devel sig architecture api conventions md spec and status FlowSchemaSpec FlowSchemaSpec FlowSchemaSpec describes how the FlowSchema s specification looks like hr distinguisherMethod FlowDistinguisherMethod distinguisherMethod defines how to compute the flow distinguisher for requests that match this schema nil specifies that the distinguisher is disabled and thus will always be the empty string a name FlowDistinguisherMethod a FlowDistinguisherMethod specifies the method of a flow distinguisher distinguisherMethod type string required type is the type of flow distinguisher method The supported types are ByUser and ByNamespace Required matchingPrecedence int32 matchingPrecedence is used to choose among the FlowSchemas that match a given request The chosen FlowSchema is among those with the numerically lowest which we take to be logically highest MatchingPrecedence Each MatchingPrecedence value must be ranged in 1 10000 Note that if the precedence is not specified it will be set to 1000 as default priorityLevelConfiguration PriorityLevelConfigurationReference required priorityLevelConfiguration should reference a PriorityLevelConfiguration in the cluster If the reference cannot be resolved the FlowSchema will be ignored and marked as invalid in its status Required a name PriorityLevelConfigurationReference a PriorityLevelConfigurationReference contains information that points to the request priority being used priorityLevelConfiguration name string required name is the name of the priority level configuration being referenced Required rules PolicyRulesWithSubjects Atomic will be replaced during a merge rules describes which requests will match this flow schema This FlowSchema matches a request if and only if at least one member of rules matches the request if it is an empty slice there will be no requests matching the FlowSchema a name PolicyRulesWithSubjects a PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver The test considers the subject making the request the verb being requested and the resource to be acted upon This PolicyRulesWithSubjects matches a request if and only if both a at least one member of subjects matches the request and b at least one member of resourceRules or nonResourceRules matches the request rules subjects Subject required Atomic will be replaced during a merge subjects is the list of normal user serviceaccount or group that this rule cares about There must be at least one member in this slice A slice that includes both the system authenticated and system unauthenticated user groups matches every request Required a name Subject a Subject matches the originator of a request as identified by the request authentication system There are three ways of matching an originator by user group or service account rules subjects kind string required kind indicates which one of the other fields is non empty Required rules subjects group GroupSubject group matches based on user group name a name GroupSubject a GroupSubject holds detailed information for group kind subject rules subjects group name string required name is the user group that matches or to match all user groups See https github com kubernetes apiserver blob master pkg authentication user user go for some well known group names Required rules subjects serviceAccount ServiceAccountSubject serviceAccount matches ServiceAccounts a name ServiceAccountSubject a ServiceAccountSubject holds detailed information for service account kind subject rules subjects serviceAccount name string required name is the name of matching ServiceAccount objects or to match regardless of name Required rules subjects serviceAccount namespace string required namespace is the namespace of matching ServiceAccount objects Required rules subjects user UserSubject user matches based on username a name UserSubject a UserSubject holds detailed information for user kind subject rules subjects user name string required name is the username that matches or to match all usernames Required rules nonResourceRules NonResourcePolicyRule Atomic will be replaced during a merge nonResourceRules is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non resource URL a name NonResourcePolicyRule a NonResourcePolicyRule is a predicate that matches non resource requests according to their verb and the target non resource URL A NonResourcePolicyRule matches a request if and only if both a at least one member of verbs matches the request and b at least one member of nonResourceURLs matches the request rules nonResourceRules nonResourceURLs string required Set unique values will be kept during a merge nonResourceURLs is a set of url prefixes that a user should have access to and may not be empty For example healthz is legal hea is illegal hea is legal but matches nothing hea also matches nothing healthz matches all per component health checks matches all non resource urls if it is present it must be the only entry Required rules nonResourceRules verbs string required Set unique values will be kept during a merge verbs is a list of matching verbs and may not be empty matches all verbs If it is present it must be the only entry Required rules resourceRules ResourcePolicyRule Atomic will be replaced during a merge resourceRules is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource At least one of resourceRules and nonResourceRules has to be non empty a name ResourcePolicyRule a ResourcePolicyRule is a predicate that matches some resource requests testing the request s verb and the target resource A ResourcePolicyRule matches a resource request if and only if a at least one member of verbs matches the request b at least one member of apiGroups matches the request c at least one member of resources matches the request and d either d1 the request does not specify a namespace i e Namespace and clusterScope is true or d2 the request specifies a namespace and least one member of namespaces matches the request s namespace rules resourceRules apiGroups string required Set unique values will be kept during a merge apiGroups is a list of matching API groups and may not be empty matches all API groups and if present must be the only entry Required rules resourceRules resources string required Set unique values will be kept during a merge resources is a list of matching resources i e lowercase and plural with if desired subresource For example services nodes status This list may not be empty matches all resources and if present must be the only entry Required rules resourceRules verbs string required Set unique values will be kept during a merge verbs is a list of matching verbs and may not be empty matches all verbs and if present must be the only entry Required rules resourceRules clusterScope boolean clusterScope indicates whether to match requests that do not specify a namespace which happens either because the resource is not namespaced or the request targets all namespaces If this field is omitted or false then the namespaces field must contain a non empty list rules resourceRules namespaces string Set unique values will be kept during a merge namespaces is a list of target namespaces that restricts matches A request that specifies a target namespace matches only if either a this list contains that target namespace or b this list contains Note that matches any specified namespace but does not match a request that does not specify a namespace see the clusterScope field for that This list may be empty but only if clusterScope is true FlowSchemaStatus FlowSchemaStatus FlowSchemaStatus represents the current state of a FlowSchema hr conditions FlowSchemaCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge conditions is a list of the current states of FlowSchema a name FlowSchemaCondition a FlowSchemaCondition describes conditions for a FlowSchema conditions lastTransitionTime Time lastTransitionTime is the last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string message is a human readable message indicating details about last transition conditions reason string reason is a unique one word CamelCase reason for the condition s last transition conditions status string status is the status of the condition Can be True False Unknown Required conditions type string type is the type of the condition Required FlowSchemaList FlowSchemaList FlowSchemaList is a list of FlowSchema objects hr apiVersion flowcontrol apiserver k8s io v1 kind FlowSchemaList metadata a href ListMeta a metadata is the standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href FlowSchema a required items is a list of FlowSchemas Operations Operations hr get read the specified FlowSchema HTTP Request GET apis flowcontrol apiserver k8s io v1 flowschemas name Parameters name in path string required name of the FlowSchema pretty in query string a href pretty a Response 200 a href FlowSchema a OK 401 Unauthorized get read status of the specified FlowSchema HTTP Request GET apis flowcontrol apiserver k8s io v1 flowschemas name status Parameters name in path string required name of the FlowSchema pretty in query string a href pretty a Response 200 a href FlowSchema a OK 401 Unauthorized list list or watch objects of kind FlowSchema HTTP Request GET apis flowcontrol apiserver k8s io v1 flowschemas Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href FlowSchemaList a OK 401 Unauthorized create create a FlowSchema HTTP Request POST apis flowcontrol apiserver k8s io v1 flowschemas Parameters body a href FlowSchema a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href FlowSchema a OK 201 a href FlowSchema a Created 202 a href FlowSchema a Accepted 401 Unauthorized update replace the specified FlowSchema HTTP Request PUT apis flowcontrol apiserver k8s io v1 flowschemas name Parameters name in path string required name of the FlowSchema body a href FlowSchema a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href FlowSchema a OK 201 a href FlowSchema a Created 401 Unauthorized update replace status of the specified FlowSchema HTTP Request PUT apis flowcontrol apiserver k8s io v1 flowschemas name status Parameters name in path string required name of the FlowSchema body a href FlowSchema a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href FlowSchema a OK 201 a href FlowSchema a Created 401 Unauthorized patch partially update the specified FlowSchema HTTP Request PATCH apis flowcontrol apiserver k8s io v1 flowschemas name Parameters name in path string required name of the FlowSchema body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href FlowSchema a OK 201 a href FlowSchema a Created 401 Unauthorized patch partially update status of the specified FlowSchema HTTP Request PATCH apis flowcontrol apiserver k8s io v1 flowschemas name status Parameters name in path string required name of the FlowSchema body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href FlowSchema a OK 201 a href FlowSchema a Created 401 Unauthorized delete delete a FlowSchema HTTP Request DELETE apis flowcontrol apiserver k8s io v1 flowschemas name Parameters name in path string required name of the FlowSchema body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of FlowSchema HTTP Request DELETE apis flowcontrol apiserver k8s io v1 flowschemas Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title PriorityLevelConfiguration weight 6 import k8s io api flowcontrol v1 apiVersion flowcontrol apiserver k8s io v1 contenttype apireference kind PriorityLevelConfiguration PriorityLevelConfiguration represents the configuration of a priority level apimetadata autogenerated true | ---
api_metadata:
apiVersion: "flowcontrol.apiserver.k8s.io/v1"
import: "k8s.io/api/flowcontrol/v1"
kind: "PriorityLevelConfiguration"
content_type: "api_reference"
description: "PriorityLevelConfiguration represents the configuration of a priority level."
title: "PriorityLevelConfiguration"
weight: 6
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.
-->
`apiVersion: flowcontrol.apiserver.k8s.io/v1`
`import "k8s.io/api/flowcontrol/v1"`
## PriorityLevelConfiguration {#PriorityLevelConfiguration}
PriorityLevelConfiguration represents the configuration of a priority level.
<hr>
- **apiVersion**: flowcontrol.apiserver.k8s.io/v1
- **kind**: PriorityLevelConfiguration
- **metadata** (<a href="">ObjectMeta</a>)
`metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">PriorityLevelConfigurationSpec</a>)
`spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">PriorityLevelConfigurationStatus</a>)
`status` is the current status of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## PriorityLevelConfigurationSpec {#PriorityLevelConfigurationSpec}
PriorityLevelConfigurationSpec specifies the configuration of a priority level.
<hr>
- **exempt** (ExemptPriorityLevelConfiguration)
`exempt` specifies how requests are handled for an exempt priority level. This field MUST be empty if `type` is `"Limited"`. This field MAY be non-empty if `type` is `"Exempt"`. If empty and `type` is `"Exempt"` then the default values for `ExemptPriorityLevelConfiguration` apply.
<a name="ExemptPriorityLevelConfiguration"></a>
*ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests. In the mandatory exempt configuration object the values in the fields here can be modified by authorized users, unlike the rest of the `spec`.*
- **exempt.lendablePercent** (int32)
`lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. This value of this field must be between 0 and 100, inclusive, and it defaults to 0. The number of seats that other levels can borrow from this level, known as this level's LendableConcurrencyLimit (LendableCL), is defined as follows.
LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 )
- **exempt.nominalConcurrencyShares** (int32)
`nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats nominally reserved for this priority level. This DOES NOT limit the dispatching from this priority level but affects the other priority levels through the borrowing mechanism. The server's concurrency limit (ServerCL) is divided among all the priority levels in proportion to their NCS values:
NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k)
Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. This field has a default value of zero.
- **limited** (LimitedPriorityLevelConfiguration)
`limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`.
<a name="LimitedPriorityLevelConfiguration"></a>
*LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues:
- How are requests for this priority level limited?
- What should be done with requests that exceed the limit?*
- **limited.borrowingLimitPercent** (int32)
`borrowingLimitPercent`, if present, configures a limit on how many seats this priority level can borrow from other priority levels. The limit is known as this level's BorrowingConcurrencyLimit (BorrowingCL) and is a limit on the total number of seats that this level may borrow at any one time. This field holds the ratio of that limit to the level's nominal concurrency limit. When this field is non-nil, it must hold a non-negative integer and the limit is calculated as follows.
BorrowingCL(i) = round( NominalCL(i) * borrowingLimitPercent(i)/100.0 )
The value of this field can be more than 100, implying that this priority level can borrow a number of seats that is greater than its own nominal concurrency limit (NominalCL). When this field is left `nil`, the limit is effectively infinite.
- **limited.lendablePercent** (int32)
`lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. The value of this field must be between 0 and 100, inclusive, and it defaults to 0. The number of seats that other levels can borrow from this level, known as this level's LendableConcurrencyLimit (LendableCL), is defined as follows.
LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 )
- **limited.limitResponse** (LimitResponse)
`limitResponse` indicates what to do with requests that can not be executed right now
<a name="LimitResponse"></a>
*LimitResponse defines how to handle requests that can not be executed right now.*
- **limited.limitResponse.type** (string), required
`type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required.
- **limited.limitResponse.queuing** (QueuingConfiguration)
`queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`.
<a name="QueuingConfiguration"></a>
*QueuingConfiguration holds the configuration parameters for queuing*
- **limited.limitResponse.queuing.handSize** (int32)
`handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8.
- **limited.limitResponse.queuing.queueLengthLimit** (int32)
`queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50.
- **limited.limitResponse.queuing.queues** (int32)
`queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64.
- **limited.nominalConcurrencyShares** (int32)
`nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats available at this priority level. This is used both for requests dispatched from this priority level as well as requests dispatched from other priority levels borrowing seats from this level. The server's concurrency limit (ServerCL) is divided among the Limited priority levels in proportion to their NCS values:
NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k)
Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level.
If not specified, this field defaults to a value of 30.
Setting this field to zero supports the construction of a "jail" for this priority level that is used to hold some request(s)
- **type** (string), required
`type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required.
## PriorityLevelConfigurationStatus {#PriorityLevelConfigurationStatus}
PriorityLevelConfigurationStatus represents the current state of a "request-priority".
<hr>
- **conditions** ([]PriorityLevelConfigurationCondition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
`conditions` is the current state of "request-priority".
<a name="PriorityLevelConfigurationCondition"></a>
*PriorityLevelConfigurationCondition defines the condition of priority level.*
- **conditions.lastTransitionTime** (Time)
`lastTransitionTime` is the last time the condition transitioned from one status to another.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string)
`message` is a human-readable message indicating details about last transition.
- **conditions.reason** (string)
`reason` is a unique, one-word, CamelCase reason for the condition's last transition.
- **conditions.status** (string)
`status` is the status of the condition. Can be True, False, Unknown. Required.
- **conditions.type** (string)
`type` is the type of the condition. Required.
## PriorityLevelConfigurationList {#PriorityLevelConfigurationList}
PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects.
<hr>
- **apiVersion**: flowcontrol.apiserver.k8s.io/v1
- **kind**: PriorityLevelConfigurationList
- **metadata** (<a href="">ListMeta</a>)
`metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="">PriorityLevelConfiguration</a>), required
`items` is a list of request-priorities.
## Operations {#Operations}
<hr>
### `get` read the specified PriorityLevelConfiguration
#### HTTP Request
GET /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PriorityLevelConfiguration
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityLevelConfiguration</a>): OK
401: Unauthorized
### `get` read status of the specified PriorityLevelConfiguration
#### HTTP Request
GET /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PriorityLevelConfiguration
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityLevelConfiguration</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PriorityLevelConfiguration
#### HTTP Request
GET /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">PriorityLevelConfigurationList</a>): OK
401: Unauthorized
### `create` create a PriorityLevelConfiguration
#### HTTP Request
POST /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations
#### Parameters
- **body**: <a href="">PriorityLevelConfiguration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityLevelConfiguration</a>): OK
201 (<a href="">PriorityLevelConfiguration</a>): Created
202 (<a href="">PriorityLevelConfiguration</a>): Accepted
401: Unauthorized
### `update` replace the specified PriorityLevelConfiguration
#### HTTP Request
PUT /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PriorityLevelConfiguration
- **body**: <a href="">PriorityLevelConfiguration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityLevelConfiguration</a>): OK
201 (<a href="">PriorityLevelConfiguration</a>): Created
401: Unauthorized
### `update` replace status of the specified PriorityLevelConfiguration
#### HTTP Request
PUT /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PriorityLevelConfiguration
- **body**: <a href="">PriorityLevelConfiguration</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityLevelConfiguration</a>): OK
201 (<a href="">PriorityLevelConfiguration</a>): Created
401: Unauthorized
### `patch` partially update the specified PriorityLevelConfiguration
#### HTTP Request
PATCH /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PriorityLevelConfiguration
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityLevelConfiguration</a>): OK
201 (<a href="">PriorityLevelConfiguration</a>): Created
401: Unauthorized
### `patch` partially update status of the specified PriorityLevelConfiguration
#### HTTP Request
PATCH /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PriorityLevelConfiguration
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">PriorityLevelConfiguration</a>): OK
201 (<a href="">PriorityLevelConfiguration</a>): Created
401: Unauthorized
### `delete` delete a PriorityLevelConfiguration
#### HTTP Request
DELETE /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PriorityLevelConfiguration
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of PriorityLevelConfiguration
#### HTTP Request
DELETE /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion flowcontrol apiserver k8s io v1 import k8s io api flowcontrol v1 kind PriorityLevelConfiguration content type api reference description PriorityLevelConfiguration represents the configuration of a priority level title PriorityLevelConfiguration weight 6 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 apiVersion flowcontrol apiserver k8s io v1 import k8s io api flowcontrol v1 PriorityLevelConfiguration PriorityLevelConfiguration PriorityLevelConfiguration represents the configuration of a priority level hr apiVersion flowcontrol apiserver k8s io v1 kind PriorityLevelConfiguration metadata a href ObjectMeta a metadata is the standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href PriorityLevelConfigurationSpec a spec is the specification of the desired behavior of a request priority More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href PriorityLevelConfigurationStatus a status is the current status of a request priority More info https git k8s io community contributors devel sig architecture api conventions md spec and status PriorityLevelConfigurationSpec PriorityLevelConfigurationSpec PriorityLevelConfigurationSpec specifies the configuration of a priority level hr exempt ExemptPriorityLevelConfiguration exempt specifies how requests are handled for an exempt priority level This field MUST be empty if type is Limited This field MAY be non empty if type is Exempt If empty and type is Exempt then the default values for ExemptPriorityLevelConfiguration apply a name ExemptPriorityLevelConfiguration a ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests In the mandatory exempt configuration object the values in the fields here can be modified by authorized users unlike the rest of the spec exempt lendablePercent int32 lendablePercent prescribes the fraction of the level s NominalCL that can be borrowed by other priority levels This value of this field must be between 0 and 100 inclusive and it defaults to 0 The number of seats that other levels can borrow from this level known as this level s LendableConcurrencyLimit LendableCL is defined as follows LendableCL i round NominalCL i lendablePercent i 100 0 exempt nominalConcurrencyShares int32 nominalConcurrencyShares NCS contributes to the computation of the NominalConcurrencyLimit NominalCL of this level This is the number of execution seats nominally reserved for this priority level This DOES NOT limit the dispatching from this priority level but affects the other priority levels through the borrowing mechanism The server s concurrency limit ServerCL is divided among all the priority levels in proportion to their NCS values NominalCL i ceil ServerCL NCS i sum ncs sum ncs sum priority level k NCS k Bigger numbers mean a larger nominal concurrency limit at the expense of every other priority level This field has a default value of zero limited LimitedPriorityLevelConfiguration limited specifies how requests are handled for a Limited priority level This field must be non empty if and only if type is Limited a name LimitedPriorityLevelConfiguration a LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits It addresses two issues How are requests for this priority level limited What should be done with requests that exceed the limit limited borrowingLimitPercent int32 borrowingLimitPercent if present configures a limit on how many seats this priority level can borrow from other priority levels The limit is known as this level s BorrowingConcurrencyLimit BorrowingCL and is a limit on the total number of seats that this level may borrow at any one time This field holds the ratio of that limit to the level s nominal concurrency limit When this field is non nil it must hold a non negative integer and the limit is calculated as follows BorrowingCL i round NominalCL i borrowingLimitPercent i 100 0 The value of this field can be more than 100 implying that this priority level can borrow a number of seats that is greater than its own nominal concurrency limit NominalCL When this field is left nil the limit is effectively infinite limited lendablePercent int32 lendablePercent prescribes the fraction of the level s NominalCL that can be borrowed by other priority levels The value of this field must be between 0 and 100 inclusive and it defaults to 0 The number of seats that other levels can borrow from this level known as this level s LendableConcurrencyLimit LendableCL is defined as follows LendableCL i round NominalCL i lendablePercent i 100 0 limited limitResponse LimitResponse limitResponse indicates what to do with requests that can not be executed right now a name LimitResponse a LimitResponse defines how to handle requests that can not be executed right now limited limitResponse type string required type is Queue or Reject Queue means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached Reject means that requests that can not be executed upon arrival are rejected Required limited limitResponse queuing QueuingConfiguration queuing holds the configuration parameters for queuing This field may be non empty only if type is Queue a name QueuingConfiguration a QueuingConfiguration holds the configuration parameters for queuing limited limitResponse queuing handSize int32 handSize is a small positive number that configures the shuffle sharding of requests into queues When enqueuing a request at this priority level the request s flow identifier a string pair is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here The request is put into one of the shortest queues in that hand handSize must be no larger than queues and should be significantly smaller so that a few heavy flows do not saturate most of the queues See the user facing documentation for more extensive guidance on setting this field This field has a default value of 8 limited limitResponse queuing queueLengthLimit int32 queueLengthLimit is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time excess requests are rejected This value must be positive If not specified it will be defaulted to 50 limited limitResponse queuing queues int32 queues is the number of queues for this priority level The queues exist independently at each apiserver The value must be positive Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant This field has a default value of 64 limited nominalConcurrencyShares int32 nominalConcurrencyShares NCS contributes to the computation of the NominalConcurrencyLimit NominalCL of this level This is the number of execution seats available at this priority level This is used both for requests dispatched from this priority level as well as requests dispatched from other priority levels borrowing seats from this level The server s concurrency limit ServerCL is divided among the Limited priority levels in proportion to their NCS values NominalCL i ceil ServerCL NCS i sum ncs sum ncs sum priority level k NCS k Bigger numbers mean a larger nominal concurrency limit at the expense of every other priority level If not specified this field defaults to a value of 30 Setting this field to zero supports the construction of a jail for this priority level that is used to hold some request s type string required type indicates whether this priority level is subject to limitation on request execution A value of Exempt means that requests of this priority level are not subject to a limit and thus are never queued and do not detract from the capacity made available to other priority levels A value of Limited means that a requests of this priority level are subject to limits and b some of the server s limited capacity is made available exclusively to this priority level Required PriorityLevelConfigurationStatus PriorityLevelConfigurationStatus PriorityLevelConfigurationStatus represents the current state of a request priority hr conditions PriorityLevelConfigurationCondition Patch strategy merge on key type Map unique values on key type will be kept during a merge conditions is the current state of request priority a name PriorityLevelConfigurationCondition a PriorityLevelConfigurationCondition defines the condition of priority level conditions lastTransitionTime Time lastTransitionTime is the last time the condition transitioned from one status to another a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string message is a human readable message indicating details about last transition conditions reason string reason is a unique one word CamelCase reason for the condition s last transition conditions status string status is the status of the condition Can be True False Unknown Required conditions type string type is the type of the condition Required PriorityLevelConfigurationList PriorityLevelConfigurationList PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects hr apiVersion flowcontrol apiserver k8s io v1 kind PriorityLevelConfigurationList metadata a href ListMeta a metadata is the standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata items a href PriorityLevelConfiguration a required items is a list of request priorities Operations Operations hr get read the specified PriorityLevelConfiguration HTTP Request GET apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations name Parameters name in path string required name of the PriorityLevelConfiguration pretty in query string a href pretty a Response 200 a href PriorityLevelConfiguration a OK 401 Unauthorized get read status of the specified PriorityLevelConfiguration HTTP Request GET apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations name status Parameters name in path string required name of the PriorityLevelConfiguration pretty in query string a href pretty a Response 200 a href PriorityLevelConfiguration a OK 401 Unauthorized list list or watch objects of kind PriorityLevelConfiguration HTTP Request GET apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href PriorityLevelConfigurationList a OK 401 Unauthorized create create a PriorityLevelConfiguration HTTP Request POST apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations Parameters body a href PriorityLevelConfiguration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PriorityLevelConfiguration a OK 201 a href PriorityLevelConfiguration a Created 202 a href PriorityLevelConfiguration a Accepted 401 Unauthorized update replace the specified PriorityLevelConfiguration HTTP Request PUT apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations name Parameters name in path string required name of the PriorityLevelConfiguration body a href PriorityLevelConfiguration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PriorityLevelConfiguration a OK 201 a href PriorityLevelConfiguration a Created 401 Unauthorized update replace status of the specified PriorityLevelConfiguration HTTP Request PUT apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations name status Parameters name in path string required name of the PriorityLevelConfiguration body a href PriorityLevelConfiguration a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href PriorityLevelConfiguration a OK 201 a href PriorityLevelConfiguration a Created 401 Unauthorized patch partially update the specified PriorityLevelConfiguration HTTP Request PATCH apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations name Parameters name in path string required name of the PriorityLevelConfiguration body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PriorityLevelConfiguration a OK 201 a href PriorityLevelConfiguration a Created 401 Unauthorized patch partially update status of the specified PriorityLevelConfiguration HTTP Request PATCH apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations name status Parameters name in path string required name of the PriorityLevelConfiguration body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href PriorityLevelConfiguration a OK 201 a href PriorityLevelConfiguration a Created 401 Unauthorized delete delete a PriorityLevelConfiguration HTTP Request DELETE apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations name Parameters name in path string required name of the PriorityLevelConfiguration body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of PriorityLevelConfiguration HTTP Request DELETE apis flowcontrol apiserver k8s io v1 prioritylevelconfigurations Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference weight 7 title ValidatingAdmissionPolicy contenttype apireference apiVersion admissionregistration k8s io v1 apimetadata kind ValidatingAdmissionPolicy ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it autogenerated true import k8s io api admissionregistration v1 | ---
api_metadata:
apiVersion: "admissionregistration.k8s.io/v1"
import: "k8s.io/api/admissionregistration/v1"
kind: "ValidatingAdmissionPolicy"
content_type: "api_reference"
description: "ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it."
title: "ValidatingAdmissionPolicy"
weight: 7
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.
-->
`apiVersion: admissionregistration.k8s.io/v1`
`import "k8s.io/api/admissionregistration/v1"`
## ValidatingAdmissionPolicy {#ValidatingAdmissionPolicy}
ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it.
<hr>
- **apiVersion**: admissionregistration.k8s.io/v1
- **kind**: ValidatingAdmissionPolicy
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- **spec** (ValidatingAdmissionPolicySpec)
Specification of the desired behavior of the ValidatingAdmissionPolicy.
<a name="ValidatingAdmissionPolicySpec"></a>
*ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy.*
- **spec.auditAnnotations** ([]AuditAnnotation)
*Atomic: will be replaced during a merge*
auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required.
<a name="AuditAnnotation"></a>
*AuditAnnotation describes how to produce an audit annotation for an API request.*
- **spec.auditAnnotations.key** (string), required
key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length.
The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}".
If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded.
Required.
- **spec.auditAnnotations.valueExpression** (string), required
valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb.
If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list.
Required.
- **spec.failurePolicy** (string)
failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings.
A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource.
failurePolicy does not define how validations that evaluate to false are handled.
When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced.
Allowed values are Ignore or Fail. Defaults to Fail.
- **spec.matchConditions** ([]MatchCondition)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.
If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions.
The exact matching logic is (in order):
1. If ANY matchCondition evaluates to FALSE, the policy is skipped.
2. If ALL matchConditions evaluate to TRUE, the policy is evaluated.
3. If any matchCondition evaluates to an error (but none are FALSE):
- If failurePolicy=Fail, reject the request
- If failurePolicy=Ignore, the policy is skipped
<a name="MatchCondition"></a>
*MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.*
- **spec.matchConditions.expression** (string), required
Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:
'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Required.
- **spec.matchConditions.name** (string), required
Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')
Required.
- **spec.matchConstraints** (MatchResources)
MatchConstraints specifies what resources this policy is designed to validate. The AdmissionPolicy cares about a request if it matches _all_ Constraints. However, in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API ValidatingAdmissionPolicy cannot match ValidatingAdmissionPolicy and ValidatingAdmissionPolicyBinding. Required.
<a name="MatchResources"></a>
*MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)*
- **spec.matchConstraints.excludeResourceRules** ([]NamedRuleWithOperations)
*Atomic: will be replaced during a merge*
ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
<a name="NamedRuleWithOperations"></a>
*NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.*
- **spec.matchConstraints.excludeResourceRules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.excludeResourceRules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.excludeResourceRules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.excludeResourceRules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **spec.matchConstraints.excludeResourceRules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **spec.matchConstraints.excludeResourceRules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **spec.matchConstraints.matchPolicy** (string)
matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".
- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy.
- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy.
Defaults to "Equivalent"
- **spec.matchConstraints.namespaceSelector** (<a href="">LabelSelector</a>)
NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy.
For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "runlevel",
"operator": "NotIn",
"values": [
"0",
"1"
]
}
]
}
If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "environment",
"operator": "In",
"values": [
"prod",
"staging"
]
}
]
}
See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors.
Default to the empty LabelSelector, which matches everything.
- **spec.matchConstraints.objectSelector** (<a href="">LabelSelector</a>)
ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
- **spec.matchConstraints.resourceRules** ([]NamedRuleWithOperations)
*Atomic: will be replaced during a merge*
ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule.
<a name="NamedRuleWithOperations"></a>
*NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.*
- **spec.matchConstraints.resourceRules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.resourceRules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.resourceRules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.resourceRules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **spec.matchConstraints.resourceRules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **spec.matchConstraints.resourceRules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **spec.paramKind** (ParamKind)
ParamKind specifies the kind of resources used to parameterize this policy. If absent, there are no parameters for this policy and the param CEL variable will not be provided to validation expressions. If ParamKind refers to a non-existent kind, this policy definition is mis-configured and the FailurePolicy is applied. If paramKind is specified but paramRef is unset in ValidatingAdmissionPolicyBinding, the params variable will be null.
<a name="ParamKind"></a>
*ParamKind is a tuple of Group Kind and Version.*
- **spec.paramKind.apiVersion** (string)
APIVersion is the API group version the resources belong to. In format of "group/version". Required.
- **spec.paramKind.kind** (string)
Kind is the API kind the resources belong to. Required.
- **spec.validations** ([]Validation)
*Atomic: will be replaced during a merge*
Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required.
<a name="Validation"></a>
*Validation specifies the CEL expression which is used to apply the validation.*
- **spec.validations.expression** (string), required
Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables:
- 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value.
For example, a variable named 'foo' can be accessed as 'variables.foo'.
- 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
- 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible.
Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:
"true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if",
"import", "let", "loop", "package", "namespace", "return".
Examples:
- Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"}
- Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"}
- Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"}
Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and
non-intersecting elements in `Y` are appended, retaining their partial order.
- 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values
are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with
non-intersecting keys are appended, retaining their partial order.
Required.
- **spec.validations.message** (string)
Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}".
- **spec.validations.messageExpression** (string)
messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the `expression` except for 'authorizer' and 'authorizer.requestResource'. Example: "object.x must be less than max ("+string(params.max)+")"
- **spec.validations.reason** (string)
Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client.
- **spec.variables** ([]Variable)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy.
The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic.
<a name="Variable"></a>
*Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.*
- **spec.variables.expression** (string), required
Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation.
- **spec.variables.name** (string), required
Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is "foo", the variable will be available as `variables.foo`
- **status** (ValidatingAdmissionPolicyStatus)
The status of the ValidatingAdmissionPolicy, including warnings that are useful to determine if the policy behaves in the expected way. Populated by the system. Read-only.
<a name="ValidatingAdmissionPolicyStatus"></a>
*ValidatingAdmissionPolicyStatus represents the status of an admission validation policy.*
- **status.conditions** ([]Condition)
*Map: unique values on key type will be kept during a merge*
The conditions represent the latest available observations of a policy's current state.
<a name="Condition"></a>
*Condition contains details for one aspect of the current state of this API Resource.*
- **status.conditions.lastTransitionTime** (Time), required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **status.conditions.message** (string), required
message is a human readable message indicating details about the transition. This may be an empty string.
- **status.conditions.reason** (string), required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
- **status.conditions.status** (string), required
status of the condition, one of True, False, Unknown.
- **status.conditions.type** (string), required
type of condition in CamelCase or in foo.example.com/CamelCase.
- **status.conditions.observedGeneration** (int64)
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
- **status.observedGeneration** (int64)
The generation observed by the controller.
- **status.typeChecking** (TypeChecking)
The results of type checking for each expression. Presence of this field indicates the completion of the type checking.
<a name="TypeChecking"></a>
*TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy*
- **status.typeChecking.expressionWarnings** ([]ExpressionWarning)
*Atomic: will be replaced during a merge*
The type checking warnings for each expression.
<a name="ExpressionWarning"></a>
*ExpressionWarning is a warning information that targets a specific expression.*
- **status.typeChecking.expressionWarnings.fieldRef** (string), required
The path to the field that refers the expression. For example, the reference to the expression of the first item of validations is "spec.validations[0].expression"
- **status.typeChecking.expressionWarnings.warning** (string), required
The content of type checking information in a human-readable form. Each line of the warning contains the type that the expression is checked against, followed by the type check error from the compiler.
## ValidatingAdmissionPolicyList {#ValidatingAdmissionPolicyList}
ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy.
<hr>
- **items** ([]<a href="">ValidatingAdmissionPolicy</a>), required
List of ValidatingAdmissionPolicy.
- **apiVersion** (string)
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
## ValidatingAdmissionPolicyBinding {#ValidatingAdmissionPolicyBinding}
ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.
For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.
The CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.
<hr>
- **apiVersion** (string)
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- **spec** (ValidatingAdmissionPolicyBindingSpec)
Specification of the desired behavior of the ValidatingAdmissionPolicyBinding.
<a name="ValidatingAdmissionPolicyBindingSpec"></a>
*ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding.*
- **spec.matchResources** (MatchResources)
MatchResources declares what resources match this binding and will be validated by it. Note that this is intersected with the policy's matchConstraints, so only requests that are matched by the policy can be selected by this. If this is unset, all resources matched by the policy are validated by this binding When resourceRules is unset, it does not constrain resource matching. If a resource is matched by the other fields of this object, it will be validated. Note that this is differs from ValidatingAdmissionPolicy matchConstraints, where resourceRules are required.
<a name="MatchResources"></a>
*MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)*
- **spec.matchResources.excludeResourceRules** ([]NamedRuleWithOperations)
*Atomic: will be replaced during a merge*
ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
<a name="NamedRuleWithOperations"></a>
*NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.*
- **spec.matchResources.excludeResourceRules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.excludeResourceRules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.excludeResourceRules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.excludeResourceRules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **spec.matchResources.excludeResourceRules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **spec.matchResources.excludeResourceRules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **spec.matchResources.matchPolicy** (string)
matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".
- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy.
- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy.
Defaults to "Equivalent"
- **spec.matchResources.namespaceSelector** (<a href="">LabelSelector</a>)
NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy.
For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "runlevel",
"operator": "NotIn",
"values": [
"0",
"1"
]
}
]
}
If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "environment",
"operator": "In",
"values": [
"prod",
"staging"
]
}
]
}
See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors.
Default to the empty LabelSelector, which matches everything.
- **spec.matchResources.objectSelector** (<a href="">LabelSelector</a>)
ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
- **spec.matchResources.resourceRules** ([]NamedRuleWithOperations)
*Atomic: will be replaced during a merge*
ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule.
<a name="NamedRuleWithOperations"></a>
*NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.*
- **spec.matchResources.resourceRules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.resourceRules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.resourceRules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.resourceRules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **spec.matchResources.resourceRules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **spec.matchResources.resourceRules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **spec.paramRef** (ParamRef)
paramRef specifies the parameter resource used to configure the admission control policy. It should point to a resource of the type specified in ParamKind of the bound ValidatingAdmissionPolicy. If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist, this binding is considered mis-configured and the FailurePolicy of the ValidatingAdmissionPolicy applied. If the policy does not specify a ParamKind then this field is ignored, and the rules are evaluated without a param.
<a name="ParamRef"></a>
*ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding.*
- **spec.paramRef.name** (string)
name is the name of the resource being referenced.
One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset.
A single parameter used for all admission requests can be configured by setting the `name` field, leaving `selector` blank, and setting namespace if `paramKind` is namespace-scoped.
- **spec.paramRef.namespace** (string)
namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields.
A per-namespace parameter may be used by specifying a namespace-scoped `paramKind` in the policy and leaving this field empty.
- If `paramKind` is cluster-scoped, this field MUST be unset. Setting this field results in a configuration error.
- If `paramKind` is namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error.
- **spec.paramRef.parameterNotFoundAction** (string)
`parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to `Allow`, then no matched parameters will be treated as successful validation by the binding. If set to `Deny`, then no matched parameters will be subject to the `failurePolicy` of the policy.
Allowed values are `Allow` or `Deny`
Required
- **spec.paramRef.selector** (<a href="">LabelSelector</a>)
selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind.
If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together.
One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset.
- **spec.policyName** (string)
PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be ignored Required.
- **spec.validationActions** ([]string)
*Set: unique values will be kept during a merge*
validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. If a validation evaluates to false it is always enforced according to these actions.
Failures defined by the ValidatingAdmissionPolicy's FailurePolicy are enforced according to these actions only if the FailurePolicy is set to Fail, otherwise the failures are ignored. This includes compilation errors, runtime errors and misconfigurations of the policy.
validationActions is declared as a set of action values. Order does not matter. validationActions may not contain duplicates of the same action.
The supported actions values are:
"Deny" specifies that a validation failure results in a denied request.
"Warn" specifies that a validation failure is reported to the request client in HTTP Warning headers, with a warning code of 299. Warnings can be sent both for allowed or denied admission responses.
"Audit" specifies that a validation failure is included in the published audit event for the request. The audit event will contain a `validation.policy.admission.k8s.io/validation_failure` audit annotation with a value containing the details of the validation failures, formatted as a JSON list of objects, each with the following fields: - message: The validation failure message string - policy: The resource name of the ValidatingAdmissionPolicy - binding: The resource name of the ValidatingAdmissionPolicyBinding - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy - validationActions: The enforcement actions enacted for the validation failure Example audit annotation: `"validation.policy.admission.k8s.io/validation_failure": "[{"message": "Invalid value", {"policy": "policy.example.com", {"binding": "policybinding.example.com", {"expressionIndex": "1", {"validationActions": ["Audit"]}]"`
Clients should expect to handle additional values by ignoring any values not recognized.
"Deny" and "Warn" may not be used together since this combination needlessly duplicates the validation failure both in the API response body and the HTTP warning headers.
Required.
## Operations {#Operations}
<hr>
### `get` read the specified ValidatingAdmissionPolicy
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicy</a>): OK
401: Unauthorized
### `get` read status of the specified ValidatingAdmissionPolicy
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicy</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ValidatingAdmissionPolicy
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicyList</a>): OK
401: Unauthorized
### `create` create a ValidatingAdmissionPolicy
#### HTTP Request
POST /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies
#### Parameters
- **body**: <a href="">ValidatingAdmissionPolicy</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicy</a>): OK
201 (<a href="">ValidatingAdmissionPolicy</a>): Created
202 (<a href="">ValidatingAdmissionPolicy</a>): Accepted
401: Unauthorized
### `update` replace the specified ValidatingAdmissionPolicy
#### HTTP Request
PUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **body**: <a href="">ValidatingAdmissionPolicy</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicy</a>): OK
201 (<a href="">ValidatingAdmissionPolicy</a>): Created
401: Unauthorized
### `update` replace status of the specified ValidatingAdmissionPolicy
#### HTTP Request
PUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **body**: <a href="">ValidatingAdmissionPolicy</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicy</a>): OK
201 (<a href="">ValidatingAdmissionPolicy</a>): Created
401: Unauthorized
### `patch` partially update the specified ValidatingAdmissionPolicy
#### HTTP Request
PATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicy</a>): OK
201 (<a href="">ValidatingAdmissionPolicy</a>): Created
401: Unauthorized
### `patch` partially update status of the specified ValidatingAdmissionPolicy
#### HTTP Request
PATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicy</a>): OK
201 (<a href="">ValidatingAdmissionPolicy</a>): Created
401: Unauthorized
### `delete` delete a ValidatingAdmissionPolicy
#### HTTP Request
DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ValidatingAdmissionPolicy
#### HTTP Request
DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion admissionregistration k8s io v1 import k8s io api admissionregistration v1 kind ValidatingAdmissionPolicy content type api reference description ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it title ValidatingAdmissionPolicy weight 7 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 apiVersion admissionregistration k8s io v1 import k8s io api admissionregistration v1 ValidatingAdmissionPolicy ValidatingAdmissionPolicy ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it hr apiVersion admissionregistration k8s io v1 kind ValidatingAdmissionPolicy metadata a href ObjectMeta a Standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec ValidatingAdmissionPolicySpec Specification of the desired behavior of the ValidatingAdmissionPolicy a name ValidatingAdmissionPolicySpec a ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy spec auditAnnotations AuditAnnotation Atomic will be replaced during a merge auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request validations and auditAnnotations may not both be empty a least one of validations or auditAnnotations is required a name AuditAnnotation a AuditAnnotation describes how to produce an audit annotation for an API request spec auditAnnotations key string required key specifies the audit annotation key The audit annotation keys of a ValidatingAdmissionPolicy must be unique The key must be a qualified name A Za z0 9 A Za z0 9 no more than 63 bytes in length The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key ValidatingAdmissionPolicy name key If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key the annotation key will be identical In this case the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded Required spec auditAnnotations valueExpression string required valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value The expression must evaluate to either a string or null value If the expression evaluates to a string the audit annotation is included with the string value If the expression evaluates to null or empty string the audit annotation will be omitted The valueExpression may be no longer than 5kb in length If the result of the valueExpression is more than 10kb in length it will be truncated to 10kb If multiple ValidatingAdmissionPolicyBinding resources match an API request then the valueExpression will be evaluated for each binding All unique values produced by the valueExpressions will be joined together in a comma separated list Required spec failurePolicy string failurePolicy defines how to handle failures for the admission policy Failures can occur from CEL expression parse errors type check errors runtime errors and invalid or mis configured policy definitions or bindings A policy is invalid if spec paramKind refers to a non existent Kind A binding is invalid if spec paramRef name refers to a non existent resource failurePolicy does not define how validations that evaluate to false are handled When failurePolicy is set to Fail ValidatingAdmissionPolicyBinding validationActions define how failures are enforced Allowed values are Ignore or Fail Defaults to Fail spec matchConditions MatchCondition Patch strategy merge on key name Map unique values on key name will be kept during a merge MatchConditions is a list of conditions that must be met for a request to be validated Match conditions filter requests that have already been matched by the rules namespaceSelector and objectSelector An empty list of matchConditions matches all requests There are a maximum of 64 match conditions allowed If a parameter object is provided it can be accessed via the params handle in the same manner as validation expressions The exact matching logic is in order 1 If ANY matchCondition evaluates to FALSE the policy is skipped 2 If ALL matchConditions evaluate to TRUE the policy is evaluated 3 If any matchCondition evaluates to an error but none are FALSE If failurePolicy Fail reject the request If failurePolicy Ignore the policy is skipped a name MatchCondition a MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook spec matchConditions expression string required Expression represents the expression which will be evaluated by CEL Must evaluate to bool CEL expressions have access to the contents of the AdmissionRequest and Authorizer organized into CEL variables object The object from the incoming request The value is null for DELETE requests oldObject The existing object The value is null for CREATE requests request Attributes of the admission request pkg apis admission types go AdmissionRequest authorizer A CEL Authorizer May be used to perform authorization checks for the principal user or service account of the request See https pkg go dev k8s io apiserver pkg cel library Authz authorizer requestResource A CEL ResourceCheck constructed from the authorizer and configured with the request resource Documentation on CEL https kubernetes io docs reference using api cel Required spec matchConditions name string required Name is an identifier for this match condition used for strategic merging of MatchConditions as well as providing an identifier for logging purposes A good name should be descriptive of the associated expression Name must be a qualified name consisting of alphanumeric characters or and must start and end with an alphanumeric character e g MyName or my name or 123 abc regex used for validation is A Za z0 9 A Za z0 9 A Za z0 9 with an optional DNS subdomain prefix and e g example com MyName Required spec matchConstraints MatchResources MatchConstraints specifies what resources this policy is designed to validate The AdmissionPolicy cares about a request if it matches all Constraints However in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API ValidatingAdmissionPolicy cannot match ValidatingAdmissionPolicy and ValidatingAdmissionPolicyBinding Required a name MatchResources a MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria The exclude rules take precedence over include rules if a resource matches both it is excluded spec matchConstraints excludeResourceRules NamedRuleWithOperations Atomic will be replaced during a merge ExcludeResourceRules describes what operations on what resources subresources the ValidatingAdmissionPolicy should not care about The exclude rules take precedence over include rules if a resource matches both it is excluded a name NamedRuleWithOperations a NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames spec matchConstraints excludeResourceRules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required spec matchConstraints excludeResourceRules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required spec matchConstraints excludeResourceRules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required spec matchConstraints excludeResourceRules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed spec matchConstraints excludeResourceRules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required spec matchConstraints excludeResourceRules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is spec matchConstraints matchPolicy string matchPolicy defines how the MatchResources list is used to match incoming requests Allowed values are Exact or Equivalent Exact match a request only if it exactly matches a specified rule For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 but rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would not be sent to the ValidatingAdmissionPolicy Equivalent match a request if modifies a resource listed in rules even via another API group or version For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 and rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would be converted to apps v1 and sent to the ValidatingAdmissionPolicy Defaults to Equivalent spec matchConstraints namespaceSelector a href LabelSelector a NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector If the object itself is a namespace the matching is performed on object metadata labels If the object is another cluster scoped resource it never skips the policy For example to run the webhook on any objects whose namespace is not associated with runlevel of 0 or 1 you will set the selector as follows namespaceSelector matchExpressions key runlevel operator NotIn values 0 1 If instead you want to only run the policy on any objects whose namespace is associated with the environment of prod or staging you will set the selector as follows namespaceSelector matchExpressions key environment operator In values prod staging See https kubernetes io docs concepts overview working with objects labels for more examples of label selectors Default to the empty LabelSelector which matches everything spec matchConstraints objectSelector a href LabelSelector a ObjectSelector decides whether to run the validation based on if the object has matching labels objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation and is considered to match if either object matches the selector A null object oldObject in the case of create or newObject in the case of delete or an object that cannot have labels like a DeploymentRollback or a PodProxyOptions object is not considered to match Use the object selector only if the webhook is opt in because end users may skip the admission webhook by setting the labels Default to the empty LabelSelector which matches everything spec matchConstraints resourceRules NamedRuleWithOperations Atomic will be replaced during a merge ResourceRules describes what operations on what resources subresources the ValidatingAdmissionPolicy matches The policy cares about an operation if it matches any Rule a name NamedRuleWithOperations a NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames spec matchConstraints resourceRules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required spec matchConstraints resourceRules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required spec matchConstraints resourceRules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required spec matchConstraints resourceRules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed spec matchConstraints resourceRules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required spec matchConstraints resourceRules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is spec paramKind ParamKind ParamKind specifies the kind of resources used to parameterize this policy If absent there are no parameters for this policy and the param CEL variable will not be provided to validation expressions If ParamKind refers to a non existent kind this policy definition is mis configured and the FailurePolicy is applied If paramKind is specified but paramRef is unset in ValidatingAdmissionPolicyBinding the params variable will be null a name ParamKind a ParamKind is a tuple of Group Kind and Version spec paramKind apiVersion string APIVersion is the API group version the resources belong to In format of group version Required spec paramKind kind string Kind is the API kind the resources belong to Required spec validations Validation Atomic will be replaced during a merge Validations contain CEL expressions which is used to apply the validation Validations and AuditAnnotations may not both be empty a minimum of one Validations or AuditAnnotations is required a name Validation a Validation specifies the CEL expression which is used to apply the validation spec validations expression string required Expression represents the expression which will be evaluated by CEL ref https github com google cel spec CEL expressions have access to the contents of the API request response organized into CEL variables as well as some other useful variables object The object from the incoming request The value is null for DELETE requests oldObject The existing object The value is null for CREATE requests request Attributes of the API request ref pkg apis admission types go AdmissionRequest params Parameter resource referred to by the policy binding being evaluated Only populated if the policy has a ParamKind namespaceObject The namespace object that the incoming object belongs to The value is null for cluster scoped resources variables Map of composited variables from its name to its lazily evaluated value For example a variable named foo can be accessed as variables foo authorizer A CEL Authorizer May be used to perform authorization checks for the principal user or service account of the request See https pkg go dev k8s io apiserver pkg cel library Authz authorizer requestResource A CEL ResourceCheck constructed from the authorizer and configured with the request resource The apiVersion kind metadata name and metadata generateName are always accessible from the root of the object No other metadata properties are accessible Only property names of the form a zA Z a zA Z0 9 are accessible Accessible property names are escaped according to the following rules when accessed in the expression escapes to underscores escapes to dot escapes to dash escapes to slash Property names that exactly match a CEL RESERVED keyword escape to keyword The keywords are true false null in as break const continue else for function if import let loop package namespace return Examples Expression accessing a property named namespace Expression object namespace 0 Expression accessing a property named x prop Expression object x dash prop 0 Expression accessing a property named redact d Expression object redact underscores d 0 Equality on arrays with list type of set or map ignores element order i e 1 2 2 1 Concatenation on arrays with x kubernetes list type use the semantics of the list type set X Y performs a union where the array positions of all elements in X are preserved and non intersecting elements in Y are appended retaining their partial order map X Y performs a merge where the array positions of all keys in X are preserved but the values are overwritten by values in Y when the key sets of X and Y intersect Elements in Y with non intersecting keys are appended retaining their partial order Required spec validations message string Message represents the message displayed when validation fails The message is required if the Expression contains line breaks The message must not contain line breaks If unset the message is failed rule Rule e g must be a URL with the host matching spec host If the Expression contains line breaks Message is required The message must not contain line breaks If unset the message is failed Expression Expression spec validations messageExpression string messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails Since messageExpression is used as a failure message it must evaluate to a string If both message and messageExpression are present on a validation then messageExpression will be used if validation fails If messageExpression results in a runtime error the runtime error is logged and the validation failure message is produced as if the messageExpression field were unset If messageExpression evaluates to an empty string a string with only spaces or a string that contains line breaks then the validation failure message will also be produced as if the messageExpression field were unset and the fact that messageExpression produced an empty string string with only spaces string with line breaks will be logged messageExpression has access to all the same variables as the expression except for authorizer and authorizer requestResource Example object x must be less than max string params max spec validations reason string Reason represents a machine readable description of why this validation failed If this is the first validation in the list to fail this reason as well as the corresponding HTTP response code are used in the HTTP response to the client The currently supported reasons are Unauthorized Forbidden Invalid RequestEntityTooLarge If not set StatusReasonInvalid is used in the response to the client spec variables Variable Patch strategy merge on key name Map unique values on key name will be kept during a merge Variables contain definitions of variables that can be used in composition of other expressions Each variable is defined as a named CEL expression The variables defined here will be available under variables in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy The expression of a variable can refer to other variables defined earlier in the list but not those after Thus Variables must be sorted by the order of first appearance and acyclic a name Variable a Variable is the definition of a variable that is used for composition A variable is defined as a named expression spec variables expression string required Expression is the expression that will be evaluated as the value of the variable The CEL expression has access to the same identifiers as the CEL expressions in Validation spec variables name string required Name is the name of the variable The name must be a valid CEL identifier and unique among all variables The variable can be accessed in other expressions through variables For example if name is foo the variable will be available as variables foo status ValidatingAdmissionPolicyStatus The status of the ValidatingAdmissionPolicy including warnings that are useful to determine if the policy behaves in the expected way Populated by the system Read only a name ValidatingAdmissionPolicyStatus a ValidatingAdmissionPolicyStatus represents the status of an admission validation policy status conditions Condition Map unique values on key type will be kept during a merge The conditions represent the latest available observations of a policy s current state a name Condition a Condition contains details for one aspect of the current state of this API Resource status conditions lastTransitionTime Time required lastTransitionTime is the last time the condition transitioned from one status to another This should be when the underlying condition changed If that is not known then using the time when the API field changed is acceptable a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers status conditions message string required message is a human readable message indicating details about the transition This may be an empty string status conditions reason string required reason contains a programmatic identifier indicating the reason for the condition s last transition Producers of specific condition types may define expected values and meanings for this field and whether the values are considered a guaranteed API The value should be a CamelCase string This field may not be empty status conditions status string required status of the condition one of True False Unknown status conditions type string required type of condition in CamelCase or in foo example com CamelCase status conditions observedGeneration int64 observedGeneration represents the metadata generation that the condition was set based upon For instance if metadata generation is currently 12 but the status conditions x observedGeneration is 9 the condition is out of date with respect to the current state of the instance status observedGeneration int64 The generation observed by the controller status typeChecking TypeChecking The results of type checking for each expression Presence of this field indicates the completion of the type checking a name TypeChecking a TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy status typeChecking expressionWarnings ExpressionWarning Atomic will be replaced during a merge The type checking warnings for each expression a name ExpressionWarning a ExpressionWarning is a warning information that targets a specific expression status typeChecking expressionWarnings fieldRef string required The path to the field that refers the expression For example the reference to the expression of the first item of validations is spec validations 0 expression status typeChecking expressionWarnings warning string required The content of type checking information in a human readable form Each line of the warning contains the type that the expression is checked against followed by the type check error from the compiler ValidatingAdmissionPolicyList ValidatingAdmissionPolicyList ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy hr items a href ValidatingAdmissionPolicy a required List of ValidatingAdmissionPolicy apiVersion string APIVersion defines the versioned schema of this representation of an object Servers should convert recognized schemas to the latest internal value and may reject unrecognized values More info https git k8s io community contributors devel sig architecture api conventions md resources kind string Kind is a string value representing the REST resource this object represents Servers may infer this from the endpoint the client submits requests to Cannot be updated In CamelCase More info https git k8s io community contributors devel sig architecture api conventions md types kinds metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds ValidatingAdmissionPolicyBinding ValidatingAdmissionPolicyBinding ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters For a given admission request each binding will cause its policy to be evaluated N times where N is 1 for policies bindings that don t use params otherwise N is the number of parameters selected by the binding The CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget Each evaluation of the policy is given an independent CEL cost budget Adding removing policies bindings or params can not affect whether a given policy binding param combination is within its own CEL budget hr apiVersion string APIVersion defines the versioned schema of this representation of an object Servers should convert recognized schemas to the latest internal value and may reject unrecognized values More info https git k8s io community contributors devel sig architecture api conventions md resources kind string Kind is a string value representing the REST resource this object represents Servers may infer this from the endpoint the client submits requests to Cannot be updated In CamelCase More info https git k8s io community contributors devel sig architecture api conventions md types kinds metadata a href ObjectMeta a Standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec ValidatingAdmissionPolicyBindingSpec Specification of the desired behavior of the ValidatingAdmissionPolicyBinding a name ValidatingAdmissionPolicyBindingSpec a ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding spec matchResources MatchResources MatchResources declares what resources match this binding and will be validated by it Note that this is intersected with the policy s matchConstraints so only requests that are matched by the policy can be selected by this If this is unset all resources matched by the policy are validated by this binding When resourceRules is unset it does not constrain resource matching If a resource is matched by the other fields of this object it will be validated Note that this is differs from ValidatingAdmissionPolicy matchConstraints where resourceRules are required a name MatchResources a MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria The exclude rules take precedence over include rules if a resource matches both it is excluded spec matchResources excludeResourceRules NamedRuleWithOperations Atomic will be replaced during a merge ExcludeResourceRules describes what operations on what resources subresources the ValidatingAdmissionPolicy should not care about The exclude rules take precedence over include rules if a resource matches both it is excluded a name NamedRuleWithOperations a NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames spec matchResources excludeResourceRules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required spec matchResources excludeResourceRules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required spec matchResources excludeResourceRules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required spec matchResources excludeResourceRules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed spec matchResources excludeResourceRules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required spec matchResources excludeResourceRules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is spec matchResources matchPolicy string matchPolicy defines how the MatchResources list is used to match incoming requests Allowed values are Exact or Equivalent Exact match a request only if it exactly matches a specified rule For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 but rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would not be sent to the ValidatingAdmissionPolicy Equivalent match a request if modifies a resource listed in rules even via another API group or version For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 and rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would be converted to apps v1 and sent to the ValidatingAdmissionPolicy Defaults to Equivalent spec matchResources namespaceSelector a href LabelSelector a NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector If the object itself is a namespace the matching is performed on object metadata labels If the object is another cluster scoped resource it never skips the policy For example to run the webhook on any objects whose namespace is not associated with runlevel of 0 or 1 you will set the selector as follows namespaceSelector matchExpressions key runlevel operator NotIn values 0 1 If instead you want to only run the policy on any objects whose namespace is associated with the environment of prod or staging you will set the selector as follows namespaceSelector matchExpressions key environment operator In values prod staging See https kubernetes io docs concepts overview working with objects labels for more examples of label selectors Default to the empty LabelSelector which matches everything spec matchResources objectSelector a href LabelSelector a ObjectSelector decides whether to run the validation based on if the object has matching labels objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation and is considered to match if either object matches the selector A null object oldObject in the case of create or newObject in the case of delete or an object that cannot have labels like a DeploymentRollback or a PodProxyOptions object is not considered to match Use the object selector only if the webhook is opt in because end users may skip the admission webhook by setting the labels Default to the empty LabelSelector which matches everything spec matchResources resourceRules NamedRuleWithOperations Atomic will be replaced during a merge ResourceRules describes what operations on what resources subresources the ValidatingAdmissionPolicy matches The policy cares about an operation if it matches any Rule a name NamedRuleWithOperations a NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames spec matchResources resourceRules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required spec matchResources resourceRules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required spec matchResources resourceRules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required spec matchResources resourceRules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed spec matchResources resourceRules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required spec matchResources resourceRules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is spec paramRef ParamRef paramRef specifies the parameter resource used to configure the admission control policy It should point to a resource of the type specified in ParamKind of the bound ValidatingAdmissionPolicy If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist this binding is considered mis configured and the FailurePolicy of the ValidatingAdmissionPolicy applied If the policy does not specify a ParamKind then this field is ignored and the rules are evaluated without a param a name ParamRef a ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding spec paramRef name string name is the name of the resource being referenced One of name or selector must be set but name and selector are mutually exclusive properties If one is set the other must be unset A single parameter used for all admission requests can be configured by setting the name field leaving selector blank and setting namespace if paramKind is namespace scoped spec paramRef namespace string namespace is the namespace of the referenced resource Allows limiting the search for params to a specific namespace Applies to both name and selector fields A per namespace parameter may be used by specifying a namespace scoped paramKind in the policy and leaving this field empty If paramKind is cluster scoped this field MUST be unset Setting this field results in a configuration error If paramKind is namespace scoped the namespace of the object being evaluated for admission will be used when this field is left unset Take care that if this is left empty the binding must not match any cluster scoped resources which will result in an error spec paramRef parameterNotFoundAction string parameterNotFoundAction controls the behavior of the binding when the resource exists and name or selector is valid but there are no parameters matched by the binding If the value is set to Allow then no matched parameters will be treated as successful validation by the binding If set to Deny then no matched parameters will be subject to the failurePolicy of the policy Allowed values are Allow or Deny Required spec paramRef selector a href LabelSelector a selector can be used to match multiple param objects based on their labels Supply selector to match all resources of the ParamKind If multiple params are found they are all evaluated with the policy expressions and the results are ANDed together One of name or selector must be set but name and selector are mutually exclusive properties If one is set the other must be unset spec policyName string PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to If the referenced resource does not exist this binding is considered invalid and will be ignored Required spec validationActions string Set unique values will be kept during a merge validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced If a validation evaluates to false it is always enforced according to these actions Failures defined by the ValidatingAdmissionPolicy s FailurePolicy are enforced according to these actions only if the FailurePolicy is set to Fail otherwise the failures are ignored This includes compilation errors runtime errors and misconfigurations of the policy validationActions is declared as a set of action values Order does not matter validationActions may not contain duplicates of the same action The supported actions values are Deny specifies that a validation failure results in a denied request Warn specifies that a validation failure is reported to the request client in HTTP Warning headers with a warning code of 299 Warnings can be sent both for allowed or denied admission responses Audit specifies that a validation failure is included in the published audit event for the request The audit event will contain a validation policy admission k8s io validation failure audit annotation with a value containing the details of the validation failures formatted as a JSON list of objects each with the following fields message The validation failure message string policy The resource name of the ValidatingAdmissionPolicy binding The resource name of the ValidatingAdmissionPolicyBinding expressionIndex The index of the failed validations in the ValidatingAdmissionPolicy validationActions The enforcement actions enacted for the validation failure Example audit annotation validation policy admission k8s io validation failure message Invalid value policy policy example com binding policybinding example com expressionIndex 1 validationActions Audit Clients should expect to handle additional values by ignoring any values not recognized Deny and Warn may not be used together since this combination needlessly duplicates the validation failure both in the API response body and the HTTP warning headers Required Operations Operations hr get read the specified ValidatingAdmissionPolicy HTTP Request GET apis admissionregistration k8s io v1 validatingadmissionpolicies name Parameters name in path string required name of the ValidatingAdmissionPolicy pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicy a OK 401 Unauthorized get read status of the specified ValidatingAdmissionPolicy HTTP Request GET apis admissionregistration k8s io v1 validatingadmissionpolicies name status Parameters name in path string required name of the ValidatingAdmissionPolicy pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicy a OK 401 Unauthorized list list or watch objects of kind ValidatingAdmissionPolicy HTTP Request GET apis admissionregistration k8s io v1 validatingadmissionpolicies Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ValidatingAdmissionPolicyList a OK 401 Unauthorized create create a ValidatingAdmissionPolicy HTTP Request POST apis admissionregistration k8s io v1 validatingadmissionpolicies Parameters body a href ValidatingAdmissionPolicy a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicy a OK 201 a href ValidatingAdmissionPolicy a Created 202 a href ValidatingAdmissionPolicy a Accepted 401 Unauthorized update replace the specified ValidatingAdmissionPolicy HTTP Request PUT apis admissionregistration k8s io v1 validatingadmissionpolicies name Parameters name in path string required name of the ValidatingAdmissionPolicy body a href ValidatingAdmissionPolicy a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicy a OK 201 a href ValidatingAdmissionPolicy a Created 401 Unauthorized update replace status of the specified ValidatingAdmissionPolicy HTTP Request PUT apis admissionregistration k8s io v1 validatingadmissionpolicies name status Parameters name in path string required name of the ValidatingAdmissionPolicy body a href ValidatingAdmissionPolicy a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicy a OK 201 a href ValidatingAdmissionPolicy a Created 401 Unauthorized patch partially update the specified ValidatingAdmissionPolicy HTTP Request PATCH apis admissionregistration k8s io v1 validatingadmissionpolicies name Parameters name in path string required name of the ValidatingAdmissionPolicy body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicy a OK 201 a href ValidatingAdmissionPolicy a Created 401 Unauthorized patch partially update status of the specified ValidatingAdmissionPolicy HTTP Request PATCH apis admissionregistration k8s io v1 validatingadmissionpolicies name status Parameters name in path string required name of the ValidatingAdmissionPolicy body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicy a OK 201 a href ValidatingAdmissionPolicy a Created 401 Unauthorized delete delete a ValidatingAdmissionPolicy HTTP Request DELETE apis admissionregistration k8s io v1 validatingadmissionpolicies name Parameters name in path string required name of the ValidatingAdmissionPolicy body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ValidatingAdmissionPolicy HTTP Request DELETE apis admissionregistration k8s io v1 validatingadmissionpolicies Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion v1 contenttype apireference kind ResourceQuota title ResourceQuota apimetadata ResourceQuota sets aggregate quota restrictions enforced per namespace weight 3 autogenerated true import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "ResourceQuota"
content_type: "api_reference"
description: "ResourceQuota sets aggregate quota restrictions enforced per namespace."
title: "ResourceQuota"
weight: 3
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## ResourceQuota {#ResourceQuota}
ResourceQuota sets aggregate quota restrictions enforced per namespace
<hr>
- **apiVersion**: v1
- **kind**: ResourceQuota
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">ResourceQuotaSpec</a>)
Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">ResourceQuotaStatus</a>)
Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## ResourceQuotaSpec {#ResourceQuotaSpec}
ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
<hr>
- **hard** (map[string]<a href="">Quantity</a>)
hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
- **scopeSelector** (ScopeSelector)
scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.
<a name="ScopeSelector"></a>
*A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.*
- **scopeSelector.matchExpressions** ([]ScopedResourceSelectorRequirement)
*Atomic: will be replaced during a merge*
A list of scope selector requirements by scope of the resources.
<a name="ScopedResourceSelectorRequirement"></a>
*A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.*
- **scopeSelector.matchExpressions.operator** (string), required
Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
- **scopeSelector.matchExpressions.scopeName** (string), required
The name of the scope that the selector applies to.
- **scopeSelector.matchExpressions.values** ([]string)
*Atomic: will be replaced during a merge*
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- **scopes** ([]string)
*Atomic: will be replaced during a merge*
A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.
## ResourceQuotaStatus {#ResourceQuotaStatus}
ResourceQuotaStatus defines the enforced hard limits and observed use.
<hr>
- **hard** (map[string]<a href="">Quantity</a>)
Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
- **used** (map[string]<a href="">Quantity</a>)
Used is the current observed total usage of the resource in the namespace.
## ResourceQuotaList {#ResourceQuotaList}
ResourceQuotaList is a list of ResourceQuota items.
<hr>
- **apiVersion**: v1
- **kind**: ResourceQuotaList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">ResourceQuota</a>), required
Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
## Operations {#Operations}
<hr>
### `get` read the specified ResourceQuota
#### HTTP Request
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceQuota
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceQuota</a>): OK
401: Unauthorized
### `get` read status of the specified ResourceQuota
#### HTTP Request
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ResourceQuota
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceQuota</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ResourceQuota
#### HTTP Request
GET /api/v1/namespaces/{namespace}/resourcequotas
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ResourceQuotaList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ResourceQuota
#### HTTP Request
GET /api/v1/resourcequotas
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ResourceQuotaList</a>): OK
401: Unauthorized
### `create` create a ResourceQuota
#### HTTP Request
POST /api/v1/namespaces/{namespace}/resourcequotas
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ResourceQuota</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceQuota</a>): OK
201 (<a href="">ResourceQuota</a>): Created
202 (<a href="">ResourceQuota</a>): Accepted
401: Unauthorized
### `update` replace the specified ResourceQuota
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceQuota
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ResourceQuota</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceQuota</a>): OK
201 (<a href="">ResourceQuota</a>): Created
401: Unauthorized
### `update` replace status of the specified ResourceQuota
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ResourceQuota
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">ResourceQuota</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceQuota</a>): OK
201 (<a href="">ResourceQuota</a>): Created
401: Unauthorized
### `patch` partially update the specified ResourceQuota
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceQuota
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceQuota</a>): OK
201 (<a href="">ResourceQuota</a>): Created
401: Unauthorized
### `patch` partially update status of the specified ResourceQuota
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ResourceQuota
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ResourceQuota</a>): OK
201 (<a href="">ResourceQuota</a>): Created
401: Unauthorized
### `delete` delete a ResourceQuota
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ResourceQuota
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">ResourceQuota</a>): OK
202 (<a href="">ResourceQuota</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ResourceQuota
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/resourcequotas
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind ResourceQuota content type api reference description ResourceQuota sets aggregate quota restrictions enforced per namespace title ResourceQuota weight 3 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 apiVersion v1 import k8s io api core v1 ResourceQuota ResourceQuota ResourceQuota sets aggregate quota restrictions enforced per namespace hr apiVersion v1 kind ResourceQuota metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href ResourceQuotaSpec a Spec defines the desired quota https git k8s io community contributors devel sig architecture api conventions md spec and status status a href ResourceQuotaStatus a Status defines the actual enforced quota and its current usage https git k8s io community contributors devel sig architecture api conventions md spec and status ResourceQuotaSpec ResourceQuotaSpec ResourceQuotaSpec defines the desired hard limits to enforce for Quota hr hard map string a href Quantity a hard is the set of desired hard limits for each named resource More info https kubernetes io docs concepts policy resource quotas scopeSelector ScopeSelector scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values For a resource to match both scopes AND scopeSelector if specified in spec must be matched a name ScopeSelector a A scope selector represents the AND of the selectors represented by the scoped resource selector requirements scopeSelector matchExpressions ScopedResourceSelectorRequirement Atomic will be replaced during a merge A list of scope selector requirements by scope of the resources a name ScopedResourceSelectorRequirement a A scoped resource selector requirement is a selector that contains values a scope name and an operator that relates the scope name and values scopeSelector matchExpressions operator string required Represents a scope s relationship to a set of values Valid operators are In NotIn Exists DoesNotExist scopeSelector matchExpressions scopeName string required The name of the scope that the selector applies to scopeSelector matchExpressions values string Atomic will be replaced during a merge An array of string values If the operator is In or NotIn the values array must be non empty If the operator is Exists or DoesNotExist the values array must be empty This array is replaced during a strategic merge patch scopes string Atomic will be replaced during a merge A collection of filters that must match each object tracked by a quota If not specified the quota matches all objects ResourceQuotaStatus ResourceQuotaStatus ResourceQuotaStatus defines the enforced hard limits and observed use hr hard map string a href Quantity a Hard is the set of enforced hard limits for each named resource More info https kubernetes io docs concepts policy resource quotas used map string a href Quantity a Used is the current observed total usage of the resource in the namespace ResourceQuotaList ResourceQuotaList ResourceQuotaList is a list of ResourceQuota items hr apiVersion v1 kind ResourceQuotaList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href ResourceQuota a required Items is a list of ResourceQuota objects More info https kubernetes io docs concepts policy resource quotas Operations Operations hr get read the specified ResourceQuota HTTP Request GET api v1 namespaces namespace resourcequotas name Parameters name in path string required name of the ResourceQuota namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ResourceQuota a OK 401 Unauthorized get read status of the specified ResourceQuota HTTP Request GET api v1 namespaces namespace resourcequotas name status Parameters name in path string required name of the ResourceQuota namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href ResourceQuota a OK 401 Unauthorized list list or watch objects of kind ResourceQuota HTTP Request GET api v1 namespaces namespace resourcequotas Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ResourceQuotaList a OK 401 Unauthorized list list or watch objects of kind ResourceQuota HTTP Request GET api v1 resourcequotas Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ResourceQuotaList a OK 401 Unauthorized create create a ResourceQuota HTTP Request POST api v1 namespaces namespace resourcequotas Parameters namespace in path string required a href namespace a body a href ResourceQuota a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceQuota a OK 201 a href ResourceQuota a Created 202 a href ResourceQuota a Accepted 401 Unauthorized update replace the specified ResourceQuota HTTP Request PUT api v1 namespaces namespace resourcequotas name Parameters name in path string required name of the ResourceQuota namespace in path string required a href namespace a body a href ResourceQuota a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceQuota a OK 201 a href ResourceQuota a Created 401 Unauthorized update replace status of the specified ResourceQuota HTTP Request PUT api v1 namespaces namespace resourcequotas name status Parameters name in path string required name of the ResourceQuota namespace in path string required a href namespace a body a href ResourceQuota a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ResourceQuota a OK 201 a href ResourceQuota a Created 401 Unauthorized patch partially update the specified ResourceQuota HTTP Request PATCH api v1 namespaces namespace resourcequotas name Parameters name in path string required name of the ResourceQuota namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ResourceQuota a OK 201 a href ResourceQuota a Created 401 Unauthorized patch partially update status of the specified ResourceQuota HTTP Request PATCH api v1 namespaces namespace resourcequotas name status Parameters name in path string required name of the ResourceQuota namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ResourceQuota a OK 201 a href ResourceQuota a Created 401 Unauthorized delete delete a ResourceQuota HTTP Request DELETE api v1 namespaces namespace resourcequotas name Parameters name in path string required name of the ResourceQuota namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href ResourceQuota a OK 202 a href ResourceQuota a Accepted 401 Unauthorized deletecollection delete collection of ResourceQuota HTTP Request DELETE api v1 namespaces namespace resourcequotas Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference title ValidatingAdmissionPolicyBinding contenttype apireference apiVersion admissionregistration k8s io v1 weight 8 apimetadata autogenerated true kind ValidatingAdmissionPolicyBinding import k8s io api admissionregistration v1 ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources | ---
api_metadata:
apiVersion: "admissionregistration.k8s.io/v1"
import: "k8s.io/api/admissionregistration/v1"
kind: "ValidatingAdmissionPolicyBinding"
content_type: "api_reference"
description: "ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources."
title: "ValidatingAdmissionPolicyBinding"
weight: 8
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.
-->
`apiVersion: admissionregistration.k8s.io/v1`
`import "k8s.io/api/admissionregistration/v1"`
## ValidatingAdmissionPolicyBinding {#ValidatingAdmissionPolicyBinding}
ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.
For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.
The CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.
<hr>
- **apiVersion**: admissionregistration.k8s.io/v1
- **kind**: ValidatingAdmissionPolicyBinding
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- **spec** (ValidatingAdmissionPolicyBindingSpec)
Specification of the desired behavior of the ValidatingAdmissionPolicyBinding.
<a name="ValidatingAdmissionPolicyBindingSpec"></a>
*ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding.*
- **spec.matchResources** (MatchResources)
MatchResources declares what resources match this binding and will be validated by it. Note that this is intersected with the policy's matchConstraints, so only requests that are matched by the policy can be selected by this. If this is unset, all resources matched by the policy are validated by this binding When resourceRules is unset, it does not constrain resource matching. If a resource is matched by the other fields of this object, it will be validated. Note that this is differs from ValidatingAdmissionPolicy matchConstraints, where resourceRules are required.
<a name="MatchResources"></a>
*MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)*
- **spec.matchResources.excludeResourceRules** ([]NamedRuleWithOperations)
*Atomic: will be replaced during a merge*
ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
<a name="NamedRuleWithOperations"></a>
*NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.*
- **spec.matchResources.excludeResourceRules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.excludeResourceRules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.excludeResourceRules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.excludeResourceRules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **spec.matchResources.excludeResourceRules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **spec.matchResources.excludeResourceRules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **spec.matchResources.matchPolicy** (string)
matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".
- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy.
- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy.
Defaults to "Equivalent"
- **spec.matchResources.namespaceSelector** (<a href="">LabelSelector</a>)
NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy.
For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "runlevel",
"operator": "NotIn",
"values": [
"0",
"1"
]
}
]
}
If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "environment",
"operator": "In",
"values": [
"prod",
"staging"
]
}
]
}
See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors.
Default to the empty LabelSelector, which matches everything.
- **spec.matchResources.objectSelector** (<a href="">LabelSelector</a>)
ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
- **spec.matchResources.resourceRules** ([]NamedRuleWithOperations)
*Atomic: will be replaced during a merge*
ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule.
<a name="NamedRuleWithOperations"></a>
*NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.*
- **spec.matchResources.resourceRules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.resourceRules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.resourceRules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **spec.matchResources.resourceRules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **spec.matchResources.resourceRules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **spec.matchResources.resourceRules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **spec.paramRef** (ParamRef)
paramRef specifies the parameter resource used to configure the admission control policy. It should point to a resource of the type specified in ParamKind of the bound ValidatingAdmissionPolicy. If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist, this binding is considered mis-configured and the FailurePolicy of the ValidatingAdmissionPolicy applied. If the policy does not specify a ParamKind then this field is ignored, and the rules are evaluated without a param.
<a name="ParamRef"></a>
*ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding.*
- **spec.paramRef.name** (string)
name is the name of the resource being referenced.
One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset.
A single parameter used for all admission requests can be configured by setting the `name` field, leaving `selector` blank, and setting namespace if `paramKind` is namespace-scoped.
- **spec.paramRef.namespace** (string)
namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields.
A per-namespace parameter may be used by specifying a namespace-scoped `paramKind` in the policy and leaving this field empty.
- If `paramKind` is cluster-scoped, this field MUST be unset. Setting this field results in a configuration error.
- If `paramKind` is namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error.
- **spec.paramRef.parameterNotFoundAction** (string)
`parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to `Allow`, then no matched parameters will be treated as successful validation by the binding. If set to `Deny`, then no matched parameters will be subject to the `failurePolicy` of the policy.
Allowed values are `Allow` or `Deny`
Required
- **spec.paramRef.selector** (<a href="">LabelSelector</a>)
selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind.
If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together.
One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset.
- **spec.policyName** (string)
PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be ignored Required.
- **spec.validationActions** ([]string)
*Set: unique values will be kept during a merge*
validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. If a validation evaluates to false it is always enforced according to these actions.
Failures defined by the ValidatingAdmissionPolicy's FailurePolicy are enforced according to these actions only if the FailurePolicy is set to Fail, otherwise the failures are ignored. This includes compilation errors, runtime errors and misconfigurations of the policy.
validationActions is declared as a set of action values. Order does not matter. validationActions may not contain duplicates of the same action.
The supported actions values are:
"Deny" specifies that a validation failure results in a denied request.
"Warn" specifies that a validation failure is reported to the request client in HTTP Warning headers, with a warning code of 299. Warnings can be sent both for allowed or denied admission responses.
"Audit" specifies that a validation failure is included in the published audit event for the request. The audit event will contain a `validation.policy.admission.k8s.io/validation_failure` audit annotation with a value containing the details of the validation failures, formatted as a JSON list of objects, each with the following fields: - message: The validation failure message string - policy: The resource name of the ValidatingAdmissionPolicy - binding: The resource name of the ValidatingAdmissionPolicyBinding - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy - validationActions: The enforcement actions enacted for the validation failure Example audit annotation: `"validation.policy.admission.k8s.io/validation_failure": "[{"message": "Invalid value", {"policy": "policy.example.com", {"binding": "policybinding.example.com", {"expressionIndex": "1", {"validationActions": ["Audit"]}]"`
Clients should expect to handle additional values by ignoring any values not recognized.
"Deny" and "Warn" may not be used together since this combination needlessly duplicates the validation failure both in the API response body and the HTTP warning headers.
Required.
## ValidatingAdmissionPolicy {#ValidatingAdmissionPolicy}
ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it.
<hr>
- **apiVersion** (string)
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (<a href="">ObjectMeta</a>)
Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- **spec** (ValidatingAdmissionPolicySpec)
Specification of the desired behavior of the ValidatingAdmissionPolicy.
<a name="ValidatingAdmissionPolicySpec"></a>
*ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy.*
- **spec.auditAnnotations** ([]AuditAnnotation)
*Atomic: will be replaced during a merge*
auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required.
<a name="AuditAnnotation"></a>
*AuditAnnotation describes how to produce an audit annotation for an API request.*
- **spec.auditAnnotations.key** (string), required
key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length.
The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}".
If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded.
Required.
- **spec.auditAnnotations.valueExpression** (string), required
valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb.
If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list.
Required.
- **spec.failurePolicy** (string)
failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings.
A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource.
failurePolicy does not define how validations that evaluate to false are handled.
When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced.
Allowed values are Ignore or Fail. Defaults to Fail.
- **spec.matchConditions** ([]MatchCondition)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.
If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions.
The exact matching logic is (in order):
1. If ANY matchCondition evaluates to FALSE, the policy is skipped.
2. If ALL matchConditions evaluate to TRUE, the policy is evaluated.
3. If any matchCondition evaluates to an error (but none are FALSE):
- If failurePolicy=Fail, reject the request
- If failurePolicy=Ignore, the policy is skipped
<a name="MatchCondition"></a>
*MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.*
- **spec.matchConditions.expression** (string), required
Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:
'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Required.
- **spec.matchConditions.name** (string), required
Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')
Required.
- **spec.matchConstraints** (MatchResources)
MatchConstraints specifies what resources this policy is designed to validate. The AdmissionPolicy cares about a request if it matches _all_ Constraints. However, in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API ValidatingAdmissionPolicy cannot match ValidatingAdmissionPolicy and ValidatingAdmissionPolicyBinding. Required.
<a name="MatchResources"></a>
*MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)*
- **spec.matchConstraints.excludeResourceRules** ([]NamedRuleWithOperations)
*Atomic: will be replaced during a merge*
ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
<a name="NamedRuleWithOperations"></a>
*NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.*
- **spec.matchConstraints.excludeResourceRules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.excludeResourceRules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.excludeResourceRules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.excludeResourceRules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **spec.matchConstraints.excludeResourceRules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **spec.matchConstraints.excludeResourceRules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **spec.matchConstraints.matchPolicy** (string)
matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".
- Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy.
- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy.
Defaults to "Equivalent"
- **spec.matchConstraints.namespaceSelector** (<a href="">LabelSelector</a>)
NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy.
For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "runlevel",
"operator": "NotIn",
"values": [
"0",
"1"
]
}
]
}
If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": {
"matchExpressions": [
{
"key": "environment",
"operator": "In",
"values": [
"prod",
"staging"
]
}
]
}
See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors.
Default to the empty LabelSelector, which matches everything.
- **spec.matchConstraints.objectSelector** (<a href="">LabelSelector</a>)
ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
- **spec.matchConstraints.resourceRules** ([]NamedRuleWithOperations)
*Atomic: will be replaced during a merge*
ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule.
<a name="NamedRuleWithOperations"></a>
*NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.*
- **spec.matchConstraints.resourceRules.apiGroups** ([]string)
*Atomic: will be replaced during a merge*
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.resourceRules.apiVersions** ([]string)
*Atomic: will be replaced during a merge*
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.resourceRules.operations** ([]string)
*Atomic: will be replaced during a merge*
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **spec.matchConstraints.resourceRules.resourceNames** ([]string)
*Atomic: will be replaced during a merge*
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- **spec.matchConstraints.resourceRules.resources** ([]string)
*Atomic: will be replaced during a merge*
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **spec.matchConstraints.resourceRules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **spec.paramKind** (ParamKind)
ParamKind specifies the kind of resources used to parameterize this policy. If absent, there are no parameters for this policy and the param CEL variable will not be provided to validation expressions. If ParamKind refers to a non-existent kind, this policy definition is mis-configured and the FailurePolicy is applied. If paramKind is specified but paramRef is unset in ValidatingAdmissionPolicyBinding, the params variable will be null.
<a name="ParamKind"></a>
*ParamKind is a tuple of Group Kind and Version.*
- **spec.paramKind.apiVersion** (string)
APIVersion is the API group version the resources belong to. In format of "group/version". Required.
- **spec.paramKind.kind** (string)
Kind is the API kind the resources belong to. Required.
- **spec.validations** ([]Validation)
*Atomic: will be replaced during a merge*
Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required.
<a name="Validation"></a>
*Validation specifies the CEL expression which is used to apply the validation.*
- **spec.validations.expression** (string), required
Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables:
- 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value.
For example, a variable named 'foo' can be accessed as 'variables.foo'.
- 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
- 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible.
Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:
"true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if",
"import", "let", "loop", "package", "namespace", "return".
Examples:
- Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"}
- Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"}
- Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"}
Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and
non-intersecting elements in `Y` are appended, retaining their partial order.
- 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values
are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with
non-intersecting keys are appended, retaining their partial order.
Required.
- **spec.validations.message** (string)
Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}".
- **spec.validations.messageExpression** (string)
messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the `expression` except for 'authorizer' and 'authorizer.requestResource'. Example: "object.x must be less than max ("+string(params.max)+")"
- **spec.validations.reason** (string)
Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client.
- **spec.variables** ([]Variable)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy.
The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic.
<a name="Variable"></a>
*Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.*
- **spec.variables.expression** (string), required
Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation.
- **spec.variables.name** (string), required
Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is "foo", the variable will be available as `variables.foo`
- **status** (ValidatingAdmissionPolicyStatus)
The status of the ValidatingAdmissionPolicy, including warnings that are useful to determine if the policy behaves in the expected way. Populated by the system. Read-only.
<a name="ValidatingAdmissionPolicyStatus"></a>
*ValidatingAdmissionPolicyStatus represents the status of an admission validation policy.*
- **status.conditions** ([]Condition)
*Map: unique values on key type will be kept during a merge*
The conditions represent the latest available observations of a policy's current state.
<a name="Condition"></a>
*Condition contains details for one aspect of the current state of this API Resource.*
- **status.conditions.lastTransitionTime** (Time), required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **status.conditions.message** (string), required
message is a human readable message indicating details about the transition. This may be an empty string.
- **status.conditions.reason** (string), required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
- **status.conditions.status** (string), required
status of the condition, one of True, False, Unknown.
- **status.conditions.type** (string), required
type of condition in CamelCase or in foo.example.com/CamelCase.
- **status.conditions.observedGeneration** (int64)
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
- **status.observedGeneration** (int64)
The generation observed by the controller.
- **status.typeChecking** (TypeChecking)
The results of type checking for each expression. Presence of this field indicates the completion of the type checking.
<a name="TypeChecking"></a>
*TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy*
- **status.typeChecking.expressionWarnings** ([]ExpressionWarning)
*Atomic: will be replaced during a merge*
The type checking warnings for each expression.
<a name="ExpressionWarning"></a>
*ExpressionWarning is a warning information that targets a specific expression.*
- **status.typeChecking.expressionWarnings.fieldRef** (string), required
The path to the field that refers the expression. For example, the reference to the expression of the first item of validations is "spec.validations[0].expression"
- **status.typeChecking.expressionWarnings.warning** (string), required
The content of type checking information in a human-readable form. Each line of the warning contains the type that the expression is checked against, followed by the type check error from the compiler.
## ValidatingAdmissionPolicyBindingList {#ValidatingAdmissionPolicyBindingList}
ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding.
<hr>
- **items** ([]<a href="">ValidatingAdmissionPolicyBinding</a>), required
List of PolicyBinding.
- **apiVersion** (string)
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
## Operations {#Operations}
<hr>
### `get` read the specified ValidatingAdmissionPolicyBinding
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicyBinding
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicyBinding</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ValidatingAdmissionPolicyBinding
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicyBindingList</a>): OK
401: Unauthorized
### `create` create a ValidatingAdmissionPolicyBinding
#### HTTP Request
POST /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings
#### Parameters
- **body**: <a href="">ValidatingAdmissionPolicyBinding</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicyBinding</a>): OK
201 (<a href="">ValidatingAdmissionPolicyBinding</a>): Created
202 (<a href="">ValidatingAdmissionPolicyBinding</a>): Accepted
401: Unauthorized
### `update` replace the specified ValidatingAdmissionPolicyBinding
#### HTTP Request
PUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicyBinding
- **body**: <a href="">ValidatingAdmissionPolicyBinding</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicyBinding</a>): OK
201 (<a href="">ValidatingAdmissionPolicyBinding</a>): Created
401: Unauthorized
### `patch` partially update the specified ValidatingAdmissionPolicyBinding
#### HTTP Request
PATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicyBinding
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">ValidatingAdmissionPolicyBinding</a>): OK
201 (<a href="">ValidatingAdmissionPolicyBinding</a>): Created
401: Unauthorized
### `delete` delete a ValidatingAdmissionPolicyBinding
#### HTTP Request
DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicyBinding
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of ValidatingAdmissionPolicyBinding
#### HTTP Request
DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion admissionregistration k8s io v1 import k8s io api admissionregistration v1 kind ValidatingAdmissionPolicyBinding content type api reference description ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources title ValidatingAdmissionPolicyBinding weight 8 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 apiVersion admissionregistration k8s io v1 import k8s io api admissionregistration v1 ValidatingAdmissionPolicyBinding ValidatingAdmissionPolicyBinding ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters For a given admission request each binding will cause its policy to be evaluated N times where N is 1 for policies bindings that don t use params otherwise N is the number of parameters selected by the binding The CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget Each evaluation of the policy is given an independent CEL cost budget Adding removing policies bindings or params can not affect whether a given policy binding param combination is within its own CEL budget hr apiVersion admissionregistration k8s io v1 kind ValidatingAdmissionPolicyBinding metadata a href ObjectMeta a Standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec ValidatingAdmissionPolicyBindingSpec Specification of the desired behavior of the ValidatingAdmissionPolicyBinding a name ValidatingAdmissionPolicyBindingSpec a ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding spec matchResources MatchResources MatchResources declares what resources match this binding and will be validated by it Note that this is intersected with the policy s matchConstraints so only requests that are matched by the policy can be selected by this If this is unset all resources matched by the policy are validated by this binding When resourceRules is unset it does not constrain resource matching If a resource is matched by the other fields of this object it will be validated Note that this is differs from ValidatingAdmissionPolicy matchConstraints where resourceRules are required a name MatchResources a MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria The exclude rules take precedence over include rules if a resource matches both it is excluded spec matchResources excludeResourceRules NamedRuleWithOperations Atomic will be replaced during a merge ExcludeResourceRules describes what operations on what resources subresources the ValidatingAdmissionPolicy should not care about The exclude rules take precedence over include rules if a resource matches both it is excluded a name NamedRuleWithOperations a NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames spec matchResources excludeResourceRules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required spec matchResources excludeResourceRules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required spec matchResources excludeResourceRules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required spec matchResources excludeResourceRules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed spec matchResources excludeResourceRules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required spec matchResources excludeResourceRules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is spec matchResources matchPolicy string matchPolicy defines how the MatchResources list is used to match incoming requests Allowed values are Exact or Equivalent Exact match a request only if it exactly matches a specified rule For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 but rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would not be sent to the ValidatingAdmissionPolicy Equivalent match a request if modifies a resource listed in rules even via another API group or version For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 and rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would be converted to apps v1 and sent to the ValidatingAdmissionPolicy Defaults to Equivalent spec matchResources namespaceSelector a href LabelSelector a NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector If the object itself is a namespace the matching is performed on object metadata labels If the object is another cluster scoped resource it never skips the policy For example to run the webhook on any objects whose namespace is not associated with runlevel of 0 or 1 you will set the selector as follows namespaceSelector matchExpressions key runlevel operator NotIn values 0 1 If instead you want to only run the policy on any objects whose namespace is associated with the environment of prod or staging you will set the selector as follows namespaceSelector matchExpressions key environment operator In values prod staging See https kubernetes io docs concepts overview working with objects labels for more examples of label selectors Default to the empty LabelSelector which matches everything spec matchResources objectSelector a href LabelSelector a ObjectSelector decides whether to run the validation based on if the object has matching labels objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation and is considered to match if either object matches the selector A null object oldObject in the case of create or newObject in the case of delete or an object that cannot have labels like a DeploymentRollback or a PodProxyOptions object is not considered to match Use the object selector only if the webhook is opt in because end users may skip the admission webhook by setting the labels Default to the empty LabelSelector which matches everything spec matchResources resourceRules NamedRuleWithOperations Atomic will be replaced during a merge ResourceRules describes what operations on what resources subresources the ValidatingAdmissionPolicy matches The policy cares about an operation if it matches any Rule a name NamedRuleWithOperations a NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames spec matchResources resourceRules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required spec matchResources resourceRules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required spec matchResources resourceRules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required spec matchResources resourceRules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed spec matchResources resourceRules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required spec matchResources resourceRules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is spec paramRef ParamRef paramRef specifies the parameter resource used to configure the admission control policy It should point to a resource of the type specified in ParamKind of the bound ValidatingAdmissionPolicy If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist this binding is considered mis configured and the FailurePolicy of the ValidatingAdmissionPolicy applied If the policy does not specify a ParamKind then this field is ignored and the rules are evaluated without a param a name ParamRef a ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding spec paramRef name string name is the name of the resource being referenced One of name or selector must be set but name and selector are mutually exclusive properties If one is set the other must be unset A single parameter used for all admission requests can be configured by setting the name field leaving selector blank and setting namespace if paramKind is namespace scoped spec paramRef namespace string namespace is the namespace of the referenced resource Allows limiting the search for params to a specific namespace Applies to both name and selector fields A per namespace parameter may be used by specifying a namespace scoped paramKind in the policy and leaving this field empty If paramKind is cluster scoped this field MUST be unset Setting this field results in a configuration error If paramKind is namespace scoped the namespace of the object being evaluated for admission will be used when this field is left unset Take care that if this is left empty the binding must not match any cluster scoped resources which will result in an error spec paramRef parameterNotFoundAction string parameterNotFoundAction controls the behavior of the binding when the resource exists and name or selector is valid but there are no parameters matched by the binding If the value is set to Allow then no matched parameters will be treated as successful validation by the binding If set to Deny then no matched parameters will be subject to the failurePolicy of the policy Allowed values are Allow or Deny Required spec paramRef selector a href LabelSelector a selector can be used to match multiple param objects based on their labels Supply selector to match all resources of the ParamKind If multiple params are found they are all evaluated with the policy expressions and the results are ANDed together One of name or selector must be set but name and selector are mutually exclusive properties If one is set the other must be unset spec policyName string PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to If the referenced resource does not exist this binding is considered invalid and will be ignored Required spec validationActions string Set unique values will be kept during a merge validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced If a validation evaluates to false it is always enforced according to these actions Failures defined by the ValidatingAdmissionPolicy s FailurePolicy are enforced according to these actions only if the FailurePolicy is set to Fail otherwise the failures are ignored This includes compilation errors runtime errors and misconfigurations of the policy validationActions is declared as a set of action values Order does not matter validationActions may not contain duplicates of the same action The supported actions values are Deny specifies that a validation failure results in a denied request Warn specifies that a validation failure is reported to the request client in HTTP Warning headers with a warning code of 299 Warnings can be sent both for allowed or denied admission responses Audit specifies that a validation failure is included in the published audit event for the request The audit event will contain a validation policy admission k8s io validation failure audit annotation with a value containing the details of the validation failures formatted as a JSON list of objects each with the following fields message The validation failure message string policy The resource name of the ValidatingAdmissionPolicy binding The resource name of the ValidatingAdmissionPolicyBinding expressionIndex The index of the failed validations in the ValidatingAdmissionPolicy validationActions The enforcement actions enacted for the validation failure Example audit annotation validation policy admission k8s io validation failure message Invalid value policy policy example com binding policybinding example com expressionIndex 1 validationActions Audit Clients should expect to handle additional values by ignoring any values not recognized Deny and Warn may not be used together since this combination needlessly duplicates the validation failure both in the API response body and the HTTP warning headers Required ValidatingAdmissionPolicy ValidatingAdmissionPolicy ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it hr apiVersion string APIVersion defines the versioned schema of this representation of an object Servers should convert recognized schemas to the latest internal value and may reject unrecognized values More info https git k8s io community contributors devel sig architecture api conventions md resources kind string Kind is a string value representing the REST resource this object represents Servers may infer this from the endpoint the client submits requests to Cannot be updated In CamelCase More info https git k8s io community contributors devel sig architecture api conventions md types kinds metadata a href ObjectMeta a Standard object metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec ValidatingAdmissionPolicySpec Specification of the desired behavior of the ValidatingAdmissionPolicy a name ValidatingAdmissionPolicySpec a ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy spec auditAnnotations AuditAnnotation Atomic will be replaced during a merge auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request validations and auditAnnotations may not both be empty a least one of validations or auditAnnotations is required a name AuditAnnotation a AuditAnnotation describes how to produce an audit annotation for an API request spec auditAnnotations key string required key specifies the audit annotation key The audit annotation keys of a ValidatingAdmissionPolicy must be unique The key must be a qualified name A Za z0 9 A Za z0 9 no more than 63 bytes in length The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key ValidatingAdmissionPolicy name key If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key the annotation key will be identical In this case the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded Required spec auditAnnotations valueExpression string required valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value The expression must evaluate to either a string or null value If the expression evaluates to a string the audit annotation is included with the string value If the expression evaluates to null or empty string the audit annotation will be omitted The valueExpression may be no longer than 5kb in length If the result of the valueExpression is more than 10kb in length it will be truncated to 10kb If multiple ValidatingAdmissionPolicyBinding resources match an API request then the valueExpression will be evaluated for each binding All unique values produced by the valueExpressions will be joined together in a comma separated list Required spec failurePolicy string failurePolicy defines how to handle failures for the admission policy Failures can occur from CEL expression parse errors type check errors runtime errors and invalid or mis configured policy definitions or bindings A policy is invalid if spec paramKind refers to a non existent Kind A binding is invalid if spec paramRef name refers to a non existent resource failurePolicy does not define how validations that evaluate to false are handled When failurePolicy is set to Fail ValidatingAdmissionPolicyBinding validationActions define how failures are enforced Allowed values are Ignore or Fail Defaults to Fail spec matchConditions MatchCondition Patch strategy merge on key name Map unique values on key name will be kept during a merge MatchConditions is a list of conditions that must be met for a request to be validated Match conditions filter requests that have already been matched by the rules namespaceSelector and objectSelector An empty list of matchConditions matches all requests There are a maximum of 64 match conditions allowed If a parameter object is provided it can be accessed via the params handle in the same manner as validation expressions The exact matching logic is in order 1 If ANY matchCondition evaluates to FALSE the policy is skipped 2 If ALL matchConditions evaluate to TRUE the policy is evaluated 3 If any matchCondition evaluates to an error but none are FALSE If failurePolicy Fail reject the request If failurePolicy Ignore the policy is skipped a name MatchCondition a MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook spec matchConditions expression string required Expression represents the expression which will be evaluated by CEL Must evaluate to bool CEL expressions have access to the contents of the AdmissionRequest and Authorizer organized into CEL variables object The object from the incoming request The value is null for DELETE requests oldObject The existing object The value is null for CREATE requests request Attributes of the admission request pkg apis admission types go AdmissionRequest authorizer A CEL Authorizer May be used to perform authorization checks for the principal user or service account of the request See https pkg go dev k8s io apiserver pkg cel library Authz authorizer requestResource A CEL ResourceCheck constructed from the authorizer and configured with the request resource Documentation on CEL https kubernetes io docs reference using api cel Required spec matchConditions name string required Name is an identifier for this match condition used for strategic merging of MatchConditions as well as providing an identifier for logging purposes A good name should be descriptive of the associated expression Name must be a qualified name consisting of alphanumeric characters or and must start and end with an alphanumeric character e g MyName or my name or 123 abc regex used for validation is A Za z0 9 A Za z0 9 A Za z0 9 with an optional DNS subdomain prefix and e g example com MyName Required spec matchConstraints MatchResources MatchConstraints specifies what resources this policy is designed to validate The AdmissionPolicy cares about a request if it matches all Constraints However in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API ValidatingAdmissionPolicy cannot match ValidatingAdmissionPolicy and ValidatingAdmissionPolicyBinding Required a name MatchResources a MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria The exclude rules take precedence over include rules if a resource matches both it is excluded spec matchConstraints excludeResourceRules NamedRuleWithOperations Atomic will be replaced during a merge ExcludeResourceRules describes what operations on what resources subresources the ValidatingAdmissionPolicy should not care about The exclude rules take precedence over include rules if a resource matches both it is excluded a name NamedRuleWithOperations a NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames spec matchConstraints excludeResourceRules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required spec matchConstraints excludeResourceRules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required spec matchConstraints excludeResourceRules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required spec matchConstraints excludeResourceRules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed spec matchConstraints excludeResourceRules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required spec matchConstraints excludeResourceRules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is spec matchConstraints matchPolicy string matchPolicy defines how the MatchResources list is used to match incoming requests Allowed values are Exact or Equivalent Exact match a request only if it exactly matches a specified rule For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 but rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would not be sent to the ValidatingAdmissionPolicy Equivalent match a request if modifies a resource listed in rules even via another API group or version For example if deployments can be modified via apps v1 apps v1beta1 and extensions v1beta1 and rules only included apiGroups apps apiVersions v1 resources deployments a request to apps v1beta1 or extensions v1beta1 would be converted to apps v1 and sent to the ValidatingAdmissionPolicy Defaults to Equivalent spec matchConstraints namespaceSelector a href LabelSelector a NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector If the object itself is a namespace the matching is performed on object metadata labels If the object is another cluster scoped resource it never skips the policy For example to run the webhook on any objects whose namespace is not associated with runlevel of 0 or 1 you will set the selector as follows namespaceSelector matchExpressions key runlevel operator NotIn values 0 1 If instead you want to only run the policy on any objects whose namespace is associated with the environment of prod or staging you will set the selector as follows namespaceSelector matchExpressions key environment operator In values prod staging See https kubernetes io docs concepts overview working with objects labels for more examples of label selectors Default to the empty LabelSelector which matches everything spec matchConstraints objectSelector a href LabelSelector a ObjectSelector decides whether to run the validation based on if the object has matching labels objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation and is considered to match if either object matches the selector A null object oldObject in the case of create or newObject in the case of delete or an object that cannot have labels like a DeploymentRollback or a PodProxyOptions object is not considered to match Use the object selector only if the webhook is opt in because end users may skip the admission webhook by setting the labels Default to the empty LabelSelector which matches everything spec matchConstraints resourceRules NamedRuleWithOperations Atomic will be replaced during a merge ResourceRules describes what operations on what resources subresources the ValidatingAdmissionPolicy matches The policy cares about an operation if it matches any Rule a name NamedRuleWithOperations a NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames spec matchConstraints resourceRules apiGroups string Atomic will be replaced during a merge APIGroups is the API groups the resources belong to is all groups If is present the length of the slice must be one Required spec matchConstraints resourceRules apiVersions string Atomic will be replaced during a merge APIVersions is the API versions the resources belong to is all versions If is present the length of the slice must be one Required spec matchConstraints resourceRules operations string Atomic will be replaced during a merge Operations is the operations the admission hook cares about CREATE UPDATE DELETE CONNECT or for all of those operations and any future admission operations that are added If is present the length of the slice must be one Required spec matchConstraints resourceRules resourceNames string Atomic will be replaced during a merge ResourceNames is an optional white list of names that the rule applies to An empty set means that everything is allowed spec matchConstraints resourceRules resources string Atomic will be replaced during a merge Resources is a list of resources this rule applies to For example pods means pods pods log means the log subresource of pods means all resources but not subresources pods means all subresources of pods scale means all scale subresources means all resources and their subresources If wildcard is present the validation rule will ensure resources do not overlap with each other Depending on the enclosing object subresources might not be allowed Required spec matchConstraints resourceRules scope string scope specifies the scope of this rule Valid values are Cluster Namespaced and Cluster means that only cluster scoped resources will match this rule Namespace API objects are cluster scoped Namespaced means that only namespaced resources will match this rule means that there are no scope restrictions Subresources match the scope of their parent resource Default is spec paramKind ParamKind ParamKind specifies the kind of resources used to parameterize this policy If absent there are no parameters for this policy and the param CEL variable will not be provided to validation expressions If ParamKind refers to a non existent kind this policy definition is mis configured and the FailurePolicy is applied If paramKind is specified but paramRef is unset in ValidatingAdmissionPolicyBinding the params variable will be null a name ParamKind a ParamKind is a tuple of Group Kind and Version spec paramKind apiVersion string APIVersion is the API group version the resources belong to In format of group version Required spec paramKind kind string Kind is the API kind the resources belong to Required spec validations Validation Atomic will be replaced during a merge Validations contain CEL expressions which is used to apply the validation Validations and AuditAnnotations may not both be empty a minimum of one Validations or AuditAnnotations is required a name Validation a Validation specifies the CEL expression which is used to apply the validation spec validations expression string required Expression represents the expression which will be evaluated by CEL ref https github com google cel spec CEL expressions have access to the contents of the API request response organized into CEL variables as well as some other useful variables object The object from the incoming request The value is null for DELETE requests oldObject The existing object The value is null for CREATE requests request Attributes of the API request ref pkg apis admission types go AdmissionRequest params Parameter resource referred to by the policy binding being evaluated Only populated if the policy has a ParamKind namespaceObject The namespace object that the incoming object belongs to The value is null for cluster scoped resources variables Map of composited variables from its name to its lazily evaluated value For example a variable named foo can be accessed as variables foo authorizer A CEL Authorizer May be used to perform authorization checks for the principal user or service account of the request See https pkg go dev k8s io apiserver pkg cel library Authz authorizer requestResource A CEL ResourceCheck constructed from the authorizer and configured with the request resource The apiVersion kind metadata name and metadata generateName are always accessible from the root of the object No other metadata properties are accessible Only property names of the form a zA Z a zA Z0 9 are accessible Accessible property names are escaped according to the following rules when accessed in the expression escapes to underscores escapes to dot escapes to dash escapes to slash Property names that exactly match a CEL RESERVED keyword escape to keyword The keywords are true false null in as break const continue else for function if import let loop package namespace return Examples Expression accessing a property named namespace Expression object namespace 0 Expression accessing a property named x prop Expression object x dash prop 0 Expression accessing a property named redact d Expression object redact underscores d 0 Equality on arrays with list type of set or map ignores element order i e 1 2 2 1 Concatenation on arrays with x kubernetes list type use the semantics of the list type set X Y performs a union where the array positions of all elements in X are preserved and non intersecting elements in Y are appended retaining their partial order map X Y performs a merge where the array positions of all keys in X are preserved but the values are overwritten by values in Y when the key sets of X and Y intersect Elements in Y with non intersecting keys are appended retaining their partial order Required spec validations message string Message represents the message displayed when validation fails The message is required if the Expression contains line breaks The message must not contain line breaks If unset the message is failed rule Rule e g must be a URL with the host matching spec host If the Expression contains line breaks Message is required The message must not contain line breaks If unset the message is failed Expression Expression spec validations messageExpression string messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails Since messageExpression is used as a failure message it must evaluate to a string If both message and messageExpression are present on a validation then messageExpression will be used if validation fails If messageExpression results in a runtime error the runtime error is logged and the validation failure message is produced as if the messageExpression field were unset If messageExpression evaluates to an empty string a string with only spaces or a string that contains line breaks then the validation failure message will also be produced as if the messageExpression field were unset and the fact that messageExpression produced an empty string string with only spaces string with line breaks will be logged messageExpression has access to all the same variables as the expression except for authorizer and authorizer requestResource Example object x must be less than max string params max spec validations reason string Reason represents a machine readable description of why this validation failed If this is the first validation in the list to fail this reason as well as the corresponding HTTP response code are used in the HTTP response to the client The currently supported reasons are Unauthorized Forbidden Invalid RequestEntityTooLarge If not set StatusReasonInvalid is used in the response to the client spec variables Variable Patch strategy merge on key name Map unique values on key name will be kept during a merge Variables contain definitions of variables that can be used in composition of other expressions Each variable is defined as a named CEL expression The variables defined here will be available under variables in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy The expression of a variable can refer to other variables defined earlier in the list but not those after Thus Variables must be sorted by the order of first appearance and acyclic a name Variable a Variable is the definition of a variable that is used for composition A variable is defined as a named expression spec variables expression string required Expression is the expression that will be evaluated as the value of the variable The CEL expression has access to the same identifiers as the CEL expressions in Validation spec variables name string required Name is the name of the variable The name must be a valid CEL identifier and unique among all variables The variable can be accessed in other expressions through variables For example if name is foo the variable will be available as variables foo status ValidatingAdmissionPolicyStatus The status of the ValidatingAdmissionPolicy including warnings that are useful to determine if the policy behaves in the expected way Populated by the system Read only a name ValidatingAdmissionPolicyStatus a ValidatingAdmissionPolicyStatus represents the status of an admission validation policy status conditions Condition Map unique values on key type will be kept during a merge The conditions represent the latest available observations of a policy s current state a name Condition a Condition contains details for one aspect of the current state of this API Resource status conditions lastTransitionTime Time required lastTransitionTime is the last time the condition transitioned from one status to another This should be when the underlying condition changed If that is not known then using the time when the API field changed is acceptable a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers status conditions message string required message is a human readable message indicating details about the transition This may be an empty string status conditions reason string required reason contains a programmatic identifier indicating the reason for the condition s last transition Producers of specific condition types may define expected values and meanings for this field and whether the values are considered a guaranteed API The value should be a CamelCase string This field may not be empty status conditions status string required status of the condition one of True False Unknown status conditions type string required type of condition in CamelCase or in foo example com CamelCase status conditions observedGeneration int64 observedGeneration represents the metadata generation that the condition was set based upon For instance if metadata generation is currently 12 but the status conditions x observedGeneration is 9 the condition is out of date with respect to the current state of the instance status observedGeneration int64 The generation observed by the controller status typeChecking TypeChecking The results of type checking for each expression Presence of this field indicates the completion of the type checking a name TypeChecking a TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy status typeChecking expressionWarnings ExpressionWarning Atomic will be replaced during a merge The type checking warnings for each expression a name ExpressionWarning a ExpressionWarning is a warning information that targets a specific expression status typeChecking expressionWarnings fieldRef string required The path to the field that refers the expression For example the reference to the expression of the first item of validations is spec validations 0 expression status typeChecking expressionWarnings warning string required The content of type checking information in a human readable form Each line of the warning contains the type that the expression is checked against followed by the type check error from the compiler ValidatingAdmissionPolicyBindingList ValidatingAdmissionPolicyBindingList ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding hr items a href ValidatingAdmissionPolicyBinding a required List of PolicyBinding apiVersion string APIVersion defines the versioned schema of this representation of an object Servers should convert recognized schemas to the latest internal value and may reject unrecognized values More info https git k8s io community contributors devel sig architecture api conventions md resources kind string Kind is a string value representing the REST resource this object represents Servers may infer this from the endpoint the client submits requests to Cannot be updated In CamelCase More info https git k8s io community contributors devel sig architecture api conventions md types kinds metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds Operations Operations hr get read the specified ValidatingAdmissionPolicyBinding HTTP Request GET apis admissionregistration k8s io v1 validatingadmissionpolicybindings name Parameters name in path string required name of the ValidatingAdmissionPolicyBinding pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicyBinding a OK 401 Unauthorized list list or watch objects of kind ValidatingAdmissionPolicyBinding HTTP Request GET apis admissionregistration k8s io v1 validatingadmissionpolicybindings Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ValidatingAdmissionPolicyBindingList a OK 401 Unauthorized create create a ValidatingAdmissionPolicyBinding HTTP Request POST apis admissionregistration k8s io v1 validatingadmissionpolicybindings Parameters body a href ValidatingAdmissionPolicyBinding a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicyBinding a OK 201 a href ValidatingAdmissionPolicyBinding a Created 202 a href ValidatingAdmissionPolicyBinding a Accepted 401 Unauthorized update replace the specified ValidatingAdmissionPolicyBinding HTTP Request PUT apis admissionregistration k8s io v1 validatingadmissionpolicybindings name Parameters name in path string required name of the ValidatingAdmissionPolicyBinding body a href ValidatingAdmissionPolicyBinding a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicyBinding a OK 201 a href ValidatingAdmissionPolicyBinding a Created 401 Unauthorized patch partially update the specified ValidatingAdmissionPolicyBinding HTTP Request PATCH apis admissionregistration k8s io v1 validatingadmissionpolicybindings name Parameters name in path string required name of the ValidatingAdmissionPolicyBinding body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href ValidatingAdmissionPolicyBinding a OK 201 a href ValidatingAdmissionPolicyBinding a Created 401 Unauthorized delete delete a ValidatingAdmissionPolicyBinding HTTP Request DELETE apis admissionregistration k8s io v1 validatingadmissionpolicybindings name Parameters name in path string required name of the ValidatingAdmissionPolicyBinding body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of ValidatingAdmissionPolicyBinding HTTP Request DELETE apis admissionregistration k8s io v1 validatingadmissionpolicybindings Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference import k8s io api discovery v1 EndpointSlice represents a subset of the endpoints that implement a service apiVersion discovery k8s io v1 title EndpointSlice kind EndpointSlice contenttype apireference apimetadata weight 3 autogenerated true | ---
api_metadata:
apiVersion: "discovery.k8s.io/v1"
import: "k8s.io/api/discovery/v1"
kind: "EndpointSlice"
content_type: "api_reference"
description: "EndpointSlice represents a subset of the endpoints that implement a service."
title: "EndpointSlice"
weight: 3
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.
-->
`apiVersion: discovery.k8s.io/v1`
`import "k8s.io/api/discovery/v1"`
## EndpointSlice {#EndpointSlice}
EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints.
<hr>
- **apiVersion**: discovery.k8s.io/v1
- **kind**: EndpointSlice
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata.
- **addressType** (string), required
addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name.
- **endpoints** ([]Endpoint), required
*Atomic: will be replaced during a merge*
endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.
<a name="Endpoint"></a>
*Endpoint represents a single logical "backend" implementing a service.*
- **endpoints.addresses** ([]string), required
*Set: unique values will be kept during a merge*
addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. These are all assumed to be fungible and clients may choose to only use the first element. Refer to: https://issue.k8s.io/106267
- **endpoints.conditions** (EndpointConditions)
conditions contains information about the current status of the endpoint.
<a name="EndpointConditions"></a>
*EndpointConditions represents the current condition of an endpoint.*
- **endpoints.conditions.ready** (boolean)
ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints, except when the normal readiness behavior is being explicitly overridden, for example when the associated Service has set the publishNotReadyAddresses flag.
- **endpoints.conditions.serving** (boolean)
serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition.
- **endpoints.conditions.terminating** (boolean)
terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating.
- **endpoints.deprecatedTopology** (map[string]string)
deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.
- **endpoints.hints** (EndpointHints)
hints contains information associated with how an endpoint should be consumed.
<a name="EndpointHints"></a>
*EndpointHints provides hints describing how an endpoint should be consumed.*
- **endpoints.hints.forZones** ([]ForZone)
*Atomic: will be replaced during a merge*
forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing.
<a name="ForZone"></a>
*ForZone provides information about which zones should consume this endpoint.*
- **endpoints.hints.forZones.name** (string), required
name represents the name of the zone.
- **endpoints.hostname** (string)
hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.
- **endpoints.nodeName** (string)
nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node.
- **endpoints.targetRef** (<a href="">ObjectReference</a>)
targetRef is a reference to a Kubernetes object that represents this endpoint.
- **endpoints.zone** (string)
zone is the name of the Zone this endpoint exists in.
- **ports** ([]EndpointPort)
*Atomic: will be replaced during a merge*
ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports.
<a name="EndpointPort"></a>
*EndpointPort represents a Port used by an EndpointSlice*
- **ports.port** (int32)
port represents the port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.
- **ports.protocol** (string)
protocol represents the IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
- **ports.name** (string)
name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
- **ports.appProtocol** (string)
The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:
* Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names:
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
## EndpointSliceList {#EndpointSliceList}
EndpointSliceList represents a list of endpoint slices
<hr>
- **apiVersion**: discovery.k8s.io/v1
- **kind**: EndpointSliceList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata.
- **items** ([]<a href="">EndpointSlice</a>), required
items is the list of endpoint slices
## Operations {#Operations}
<hr>
### `get` read the specified EndpointSlice
#### HTTP Request
GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the EndpointSlice
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">EndpointSlice</a>): OK
401: Unauthorized
### `list` list or watch objects of kind EndpointSlice
#### HTTP Request
GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">EndpointSliceList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind EndpointSlice
#### HTTP Request
GET /apis/discovery.k8s.io/v1/endpointslices
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">EndpointSliceList</a>): OK
401: Unauthorized
### `create` create an EndpointSlice
#### HTTP Request
POST /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">EndpointSlice</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">EndpointSlice</a>): OK
201 (<a href="">EndpointSlice</a>): Created
202 (<a href="">EndpointSlice</a>): Accepted
401: Unauthorized
### `update` replace the specified EndpointSlice
#### HTTP Request
PUT /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the EndpointSlice
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">EndpointSlice</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">EndpointSlice</a>): OK
201 (<a href="">EndpointSlice</a>): Created
401: Unauthorized
### `patch` partially update the specified EndpointSlice
#### HTTP Request
PATCH /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the EndpointSlice
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">EndpointSlice</a>): OK
201 (<a href="">EndpointSlice</a>): Created
401: Unauthorized
### `delete` delete an EndpointSlice
#### HTTP Request
DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### Parameters
- **name** (*in path*): string, required
name of the EndpointSlice
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of EndpointSlice
#### HTTP Request
DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion discovery k8s io v1 import k8s io api discovery v1 kind EndpointSlice content type api reference description EndpointSlice represents a subset of the endpoints that implement a service title EndpointSlice weight 3 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 apiVersion discovery k8s io v1 import k8s io api discovery v1 EndpointSlice EndpointSlice EndpointSlice represents a subset of the endpoints that implement a service For a given service there may be multiple EndpointSlice objects selected by labels which must be joined to produce the full set of endpoints hr apiVersion discovery k8s io v1 kind EndpointSlice metadata a href ObjectMeta a Standard object s metadata addressType string required addressType specifies the type of address carried by this EndpointSlice All addresses in this slice must be the same type This field is immutable after creation The following address types are currently supported IPv4 Represents an IPv4 Address IPv6 Represents an IPv6 Address FQDN Represents a Fully Qualified Domain Name endpoints Endpoint required Atomic will be replaced during a merge endpoints is a list of unique endpoints in this slice Each slice may include a maximum of 1000 endpoints a name Endpoint a Endpoint represents a single logical backend implementing a service endpoints addresses string required Set unique values will be kept during a merge addresses of this endpoint The contents of this field are interpreted according to the corresponding EndpointSlice addressType field Consumers must handle different types of addresses in the context of their own capabilities This must contain at least one address but no more than 100 These are all assumed to be fungible and clients may choose to only use the first element Refer to https issue k8s io 106267 endpoints conditions EndpointConditions conditions contains information about the current status of the endpoint a name EndpointConditions a EndpointConditions represents the current condition of an endpoint endpoints conditions ready boolean ready indicates that this endpoint is prepared to receive traffic according to whatever system is managing the endpoint A nil value indicates an unknown state In most cases consumers should interpret this unknown state as ready For compatibility reasons ready should never be true for terminating endpoints except when the normal readiness behavior is being explicitly overridden for example when the associated Service has set the publishNotReadyAddresses flag endpoints conditions serving boolean serving is identical to ready except that it is set regardless of the terminating state of endpoints This condition should be set to true for a ready endpoint that is terminating If nil consumers should defer to the ready condition endpoints conditions terminating boolean terminating indicates that this endpoint is terminating A nil value indicates an unknown state Consumers should interpret this unknown state to mean that the endpoint is not terminating endpoints deprecatedTopology map string string deprecatedTopology contains topology information part of the v1beta1 API This field is deprecated and will be removed when the v1beta1 API is removed no sooner than kubernetes v1 24 While this field can hold values it is not writable through the v1 API and any attempts to write to it will be silently ignored Topology information can be found in the zone and nodeName fields instead endpoints hints EndpointHints hints contains information associated with how an endpoint should be consumed a name EndpointHints a EndpointHints provides hints describing how an endpoint should be consumed endpoints hints forZones ForZone Atomic will be replaced during a merge forZones indicates the zone s this endpoint should be consumed by to enable topology aware routing a name ForZone a ForZone provides information about which zones should consume this endpoint endpoints hints forZones name string required name represents the name of the zone endpoints hostname string hostname of this endpoint This field may be used by consumers of endpoints to distinguish endpoints from each other e g in DNS names Multiple endpoints which use the same hostname should be considered fungible e g multiple A values in DNS Must be lowercase and pass DNS Label RFC 1123 validation endpoints nodeName string nodeName represents the name of the Node hosting this endpoint This can be used to determine endpoints local to a Node endpoints targetRef a href ObjectReference a targetRef is a reference to a Kubernetes object that represents this endpoint endpoints zone string zone is the name of the Zone this endpoint exists in ports EndpointPort Atomic will be replaced during a merge ports specifies the list of network ports exposed by each endpoint in this slice Each port must have a unique name When ports is empty it indicates that there are no defined ports When a port is defined with a nil port value it indicates all ports Each slice may include a maximum of 100 ports a name EndpointPort a EndpointPort represents a Port used by an EndpointSlice ports port int32 port represents the port number of the endpoint If this is not specified ports are not restricted and must be interpreted in the context of the specific consumer ports protocol string protocol represents the IP protocol for this port Must be UDP TCP or SCTP Default is TCP ports name string name represents the name of this port All ports in an EndpointSlice must have a unique name If the EndpointSlice is derived from a Kubernetes service this corresponds to the Service ports name Name must either be an empty string or pass DNS LABEL validation must be no more than 63 characters long must consist of lower case alphanumeric characters or must start and end with an alphanumeric character Default is empty string ports appProtocol string The application protocol for this port This is used as a hint for implementations to offer richer behavior for protocols that they understand This field follows standard Kubernetes label syntax Valid values are either Un prefixed protocol names reserved for IANA standard service names as per RFC 6335 and https www iana org assignments service names Kubernetes defined prefixed names kubernetes io h2c HTTP 2 prior knowledge over cleartext as described in https www rfc editor org rfc rfc9113 html name starting http 2 with prior kubernetes io ws WebSocket over cleartext as described in https www rfc editor org rfc rfc6455 kubernetes io wss WebSocket over TLS as described in https www rfc editor org rfc rfc6455 Other protocols should use implementation defined prefixed names such as mycompany com my custom protocol EndpointSliceList EndpointSliceList EndpointSliceList represents a list of endpoint slices hr apiVersion discovery k8s io v1 kind EndpointSliceList metadata a href ListMeta a Standard list metadata items a href EndpointSlice a required items is the list of endpoint slices Operations Operations hr get read the specified EndpointSlice HTTP Request GET apis discovery k8s io v1 namespaces namespace endpointslices name Parameters name in path string required name of the EndpointSlice namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href EndpointSlice a OK 401 Unauthorized list list or watch objects of kind EndpointSlice HTTP Request GET apis discovery k8s io v1 namespaces namespace endpointslices Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href EndpointSliceList a OK 401 Unauthorized list list or watch objects of kind EndpointSlice HTTP Request GET apis discovery k8s io v1 endpointslices Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href EndpointSliceList a OK 401 Unauthorized create create an EndpointSlice HTTP Request POST apis discovery k8s io v1 namespaces namespace endpointslices Parameters namespace in path string required a href namespace a body a href EndpointSlice a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href EndpointSlice a OK 201 a href EndpointSlice a Created 202 a href EndpointSlice a Accepted 401 Unauthorized update replace the specified EndpointSlice HTTP Request PUT apis discovery k8s io v1 namespaces namespace endpointslices name Parameters name in path string required name of the EndpointSlice namespace in path string required a href namespace a body a href EndpointSlice a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href EndpointSlice a OK 201 a href EndpointSlice a Created 401 Unauthorized patch partially update the specified EndpointSlice HTTP Request PATCH apis discovery k8s io v1 namespaces namespace endpointslices name Parameters name in path string required name of the EndpointSlice namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href EndpointSlice a OK 201 a href EndpointSlice a Created 401 Unauthorized delete delete an EndpointSlice HTTP Request DELETE apis discovery k8s io v1 namespaces namespace endpointslices name Parameters name in path string required name of the EndpointSlice namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of EndpointSlice HTTP Request DELETE apis discovery k8s io v1 namespaces namespace endpointslices Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference apiVersion v1 kind Endpoints weight 2 Endpoints is a collection of endpoints that implement the actual service contenttype apireference apimetadata title Endpoints autogenerated true import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "Endpoints"
content_type: "api_reference"
description: "Endpoints is a collection of endpoints that implement the actual service."
title: "Endpoints"
weight: 2
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## Endpoints {#Endpoints}
Endpoints is a collection of endpoints that implement the actual service. Example:
Name: "mysvc",
Subsets: [
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
},
{
Addresses: [{"ip": "10.10.3.3"}],
Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
},
]
<hr>
- **apiVersion**: v1
- **kind**: Endpoints
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **subsets** ([]EndpointSubset)
*Atomic: will be replaced during a merge*
The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.
<a name="EndpointSubset"></a>
*EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
}
The resulting set of endpoints can be viewed as:
a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
b: [ 10.10.1.1:309, 10.10.2.2:309 ]*
- **subsets.addresses** ([]EndpointAddress)
*Atomic: will be replaced during a merge*
IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
<a name="EndpointAddress"></a>
*EndpointAddress is a tuple that describes single IP address.*
- **subsets.addresses.ip** (string), required
The IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).
- **subsets.addresses.hostname** (string)
The Hostname of this endpoint
- **subsets.addresses.nodeName** (string)
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
- **subsets.addresses.targetRef** (<a href="">ObjectReference</a>)
Reference to object providing the endpoint.
- **subsets.notReadyAddresses** ([]EndpointAddress)
*Atomic: will be replaced during a merge*
IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.
<a name="EndpointAddress"></a>
*EndpointAddress is a tuple that describes single IP address.*
- **subsets.notReadyAddresses.ip** (string), required
The IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).
- **subsets.notReadyAddresses.hostname** (string)
The Hostname of this endpoint
- **subsets.notReadyAddresses.nodeName** (string)
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
- **subsets.notReadyAddresses.targetRef** (<a href="">ObjectReference</a>)
Reference to object providing the endpoint.
- **subsets.ports** ([]EndpointPort)
*Atomic: will be replaced during a merge*
Port numbers available on the related IP addresses.
<a name="EndpointPort"></a>
*EndpointPort is a tuple that describes a single port.*
- **subsets.ports.port** (int32), required
The port number of the endpoint.
- **subsets.ports.protocol** (string)
The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
- **subsets.ports.name** (string)
The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.
- **subsets.ports.appProtocol** (string)
The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:
* Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names:
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
## EndpointsList {#EndpointsList}
EndpointsList is a list of endpoints.
<hr>
- **apiVersion**: v1
- **kind**: EndpointsList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">Endpoints</a>), required
List of endpoints.
## Operations {#Operations}
<hr>
### `get` read the specified Endpoints
#### HTTP Request
GET /api/v1/namespaces/{namespace}/endpoints/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Endpoints
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Endpoints</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Endpoints
#### HTTP Request
GET /api/v1/namespaces/{namespace}/endpoints
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">EndpointsList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Endpoints
#### HTTP Request
GET /api/v1/endpoints
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">EndpointsList</a>): OK
401: Unauthorized
### `create` create Endpoints
#### HTTP Request
POST /api/v1/namespaces/{namespace}/endpoints
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Endpoints</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Endpoints</a>): OK
201 (<a href="">Endpoints</a>): Created
202 (<a href="">Endpoints</a>): Accepted
401: Unauthorized
### `update` replace the specified Endpoints
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Endpoints
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Endpoints</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Endpoints</a>): OK
201 (<a href="">Endpoints</a>): Created
401: Unauthorized
### `patch` partially update the specified Endpoints
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Endpoints
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Endpoints</a>): OK
201 (<a href="">Endpoints</a>): Created
401: Unauthorized
### `delete` delete Endpoints
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Endpoints
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Endpoints
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/endpoints
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind Endpoints content type api reference description Endpoints is a collection of endpoints that implement the actual service title Endpoints weight 2 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 apiVersion v1 import k8s io api core v1 Endpoints Endpoints Endpoints is a collection of endpoints that implement the actual service Example Name mysvc Subsets Addresses ip 10 10 1 1 ip 10 10 2 2 Ports name a port 8675 name b port 309 Addresses ip 10 10 3 3 Ports name a port 93 name b port 76 hr apiVersion v1 kind Endpoints metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata subsets EndpointSubset Atomic will be replaced during a merge The set of all endpoints is the union of all subsets Addresses are placed into subsets according to the IPs they share A single address with multiple ports some of which are ready and some of which are not because they come from different containers will result in the address being displayed in different subsets for the different ports No address will appear in both Addresses and NotReadyAddresses in the same subset Sets of addresses and ports that comprise a service a name EndpointSubset a EndpointSubset is a group of addresses with a common set of ports The expanded set of endpoints is the Cartesian product of Addresses x Ports For example given Addresses ip 10 10 1 1 ip 10 10 2 2 Ports name a port 8675 name b port 309 The resulting set of endpoints can be viewed as a 10 10 1 1 8675 10 10 2 2 8675 b 10 10 1 1 309 10 10 2 2 309 subsets addresses EndpointAddress Atomic will be replaced during a merge IP addresses which offer the related ports that are marked as ready These endpoints should be considered safe for load balancers and clients to utilize a name EndpointAddress a EndpointAddress is a tuple that describes single IP address subsets addresses ip string required The IP of this endpoint May not be loopback 127 0 0 0 8 or 1 link local 169 254 0 0 16 or fe80 10 or link local multicast 224 0 0 0 24 or ff02 16 subsets addresses hostname string The Hostname of this endpoint subsets addresses nodeName string Optional Node hosting this endpoint This can be used to determine endpoints local to a node subsets addresses targetRef a href ObjectReference a Reference to object providing the endpoint subsets notReadyAddresses EndpointAddress Atomic will be replaced during a merge IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting have recently failed a readiness check or have recently failed a liveness check a name EndpointAddress a EndpointAddress is a tuple that describes single IP address subsets notReadyAddresses ip string required The IP of this endpoint May not be loopback 127 0 0 0 8 or 1 link local 169 254 0 0 16 or fe80 10 or link local multicast 224 0 0 0 24 or ff02 16 subsets notReadyAddresses hostname string The Hostname of this endpoint subsets notReadyAddresses nodeName string Optional Node hosting this endpoint This can be used to determine endpoints local to a node subsets notReadyAddresses targetRef a href ObjectReference a Reference to object providing the endpoint subsets ports EndpointPort Atomic will be replaced during a merge Port numbers available on the related IP addresses a name EndpointPort a EndpointPort is a tuple that describes a single port subsets ports port int32 required The port number of the endpoint subsets ports protocol string The IP protocol for this port Must be UDP TCP or SCTP Default is TCP subsets ports name string The name of this port This must match the name field in the corresponding ServicePort Must be a DNS LABEL Optional only if one port is defined subsets ports appProtocol string The application protocol for this port This is used as a hint for implementations to offer richer behavior for protocols that they understand This field follows standard Kubernetes label syntax Valid values are either Un prefixed protocol names reserved for IANA standard service names as per RFC 6335 and https www iana org assignments service names Kubernetes defined prefixed names kubernetes io h2c HTTP 2 prior knowledge over cleartext as described in https www rfc editor org rfc rfc9113 html name starting http 2 with prior kubernetes io ws WebSocket over cleartext as described in https www rfc editor org rfc rfc6455 kubernetes io wss WebSocket over TLS as described in https www rfc editor org rfc rfc6455 Other protocols should use implementation defined prefixed names such as mycompany com my custom protocol EndpointsList EndpointsList EndpointsList is a list of endpoints hr apiVersion v1 kind EndpointsList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href Endpoints a required List of endpoints Operations Operations hr get read the specified Endpoints HTTP Request GET api v1 namespaces namespace endpoints name Parameters name in path string required name of the Endpoints namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Endpoints a OK 401 Unauthorized list list or watch objects of kind Endpoints HTTP Request GET api v1 namespaces namespace endpoints Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href EndpointsList a OK 401 Unauthorized list list or watch objects of kind Endpoints HTTP Request GET api v1 endpoints Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href EndpointsList a OK 401 Unauthorized create create Endpoints HTTP Request POST api v1 namespaces namespace endpoints Parameters namespace in path string required a href namespace a body a href Endpoints a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Endpoints a OK 201 a href Endpoints a Created 202 a href Endpoints a Accepted 401 Unauthorized update replace the specified Endpoints HTTP Request PUT api v1 namespaces namespace endpoints name Parameters name in path string required name of the Endpoints namespace in path string required a href namespace a body a href Endpoints a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Endpoints a OK 201 a href Endpoints a Created 401 Unauthorized patch partially update the specified Endpoints HTTP Request PATCH api v1 namespaces namespace endpoints name Parameters name in path string required name of the Endpoints namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Endpoints a OK 201 a href Endpoints a Created 401 Unauthorized delete delete Endpoints HTTP Request DELETE api v1 namespaces namespace endpoints name Parameters name in path string required name of the Endpoints namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of Endpoints HTTP Request DELETE api v1 namespaces namespace endpoints Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference weight 5 kind IngressClass IngressClass represents the class of the Ingress referenced by the Ingress Spec contenttype apireference apimetadata title IngressClass autogenerated true import k8s io api networking v1 apiVersion networking k8s io v1 | ---
api_metadata:
apiVersion: "networking.k8s.io/v1"
import: "k8s.io/api/networking/v1"
kind: "IngressClass"
content_type: "api_reference"
description: "IngressClass represents the class of the Ingress, referenced by the Ingress Spec."
title: "IngressClass"
weight: 5
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.
-->
`apiVersion: networking.k8s.io/v1`
`import "k8s.io/api/networking/v1"`
## IngressClass {#IngressClass}
IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.
<hr>
- **apiVersion**: networking.k8s.io/v1
- **kind**: IngressClass
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">IngressClassSpec</a>)
spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## IngressClassSpec {#IngressClassSpec}
IngressClassSpec provides information about the class of an Ingress.
<hr>
- **controller** (string)
controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable.
- **parameters** (IngressClassParametersReference)
parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.
<a name="IngressClassParametersReference"></a>
*IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.*
- **parameters.kind** (string), required
kind is the type of resource being referenced.
- **parameters.name** (string), required
name is the name of resource being referenced.
- **parameters.apiGroup** (string)
apiGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
- **parameters.namespace** (string)
namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster".
- **parameters.scope** (string)
scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace".
## IngressClassList {#IngressClassList}
IngressClassList is a collection of IngressClasses.
<hr>
- **apiVersion**: networking.k8s.io/v1
- **kind**: IngressClassList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata.
- **items** ([]<a href="">IngressClass</a>), required
items is the list of IngressClasses.
## Operations {#Operations}
<hr>
### `get` read the specified IngressClass
#### HTTP Request
GET /apis/networking.k8s.io/v1/ingressclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IngressClass
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">IngressClass</a>): OK
401: Unauthorized
### `list` list or watch objects of kind IngressClass
#### HTTP Request
GET /apis/networking.k8s.io/v1/ingressclasses
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">IngressClassList</a>): OK
401: Unauthorized
### `create` create an IngressClass
#### HTTP Request
POST /apis/networking.k8s.io/v1/ingressclasses
#### Parameters
- **body**: <a href="">IngressClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">IngressClass</a>): OK
201 (<a href="">IngressClass</a>): Created
202 (<a href="">IngressClass</a>): Accepted
401: Unauthorized
### `update` replace the specified IngressClass
#### HTTP Request
PUT /apis/networking.k8s.io/v1/ingressclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IngressClass
- **body**: <a href="">IngressClass</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">IngressClass</a>): OK
201 (<a href="">IngressClass</a>): Created
401: Unauthorized
### `patch` partially update the specified IngressClass
#### HTTP Request
PATCH /apis/networking.k8s.io/v1/ingressclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IngressClass
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">IngressClass</a>): OK
201 (<a href="">IngressClass</a>): Created
401: Unauthorized
### `delete` delete an IngressClass
#### HTTP Request
DELETE /apis/networking.k8s.io/v1/ingressclasses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IngressClass
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of IngressClass
#### HTTP Request
DELETE /apis/networking.k8s.io/v1/ingressclasses
#### Parameters
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion networking k8s io v1 import k8s io api networking v1 kind IngressClass content type api reference description IngressClass represents the class of the Ingress referenced by the Ingress Spec title IngressClass weight 5 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 apiVersion networking k8s io v1 import k8s io api networking v1 IngressClass IngressClass IngressClass represents the class of the Ingress referenced by the Ingress Spec The ingressclass kubernetes io is default class annotation can be used to indicate that an IngressClass should be considered default When a single IngressClass resource has this annotation set to true new Ingress resources without a class specified will be assigned this default class hr apiVersion networking k8s io v1 kind IngressClass metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href IngressClassSpec a spec is the desired state of the IngressClass More info https git k8s io community contributors devel sig architecture api conventions md spec and status IngressClassSpec IngressClassSpec IngressClassSpec provides information about the class of an Ingress hr controller string controller refers to the name of the controller that should handle this class This allows for different flavors that are controlled by the same controller For example you may have different parameters for the same implementing controller This should be specified as a domain prefixed path no more than 250 characters in length e g acme io ingress controller This field is immutable parameters IngressClassParametersReference parameters is a link to a custom resource containing additional configuration for the controller This is optional if the controller does not require extra parameters a name IngressClassParametersReference a IngressClassParametersReference identifies an API object This can be used to specify a cluster or namespace scoped resource parameters kind string required kind is the type of resource being referenced parameters name string required name is the name of resource being referenced parameters apiGroup string apiGroup is the group for the resource being referenced If APIGroup is not specified the specified Kind must be in the core API group For any other third party types APIGroup is required parameters namespace string namespace is the namespace of the resource being referenced This field is required when scope is set to Namespace and must be unset when scope is set to Cluster parameters scope string scope represents if this refers to a cluster or namespace scoped resource This may be set to Cluster default or Namespace IngressClassList IngressClassList IngressClassList is a collection of IngressClasses hr apiVersion networking k8s io v1 kind IngressClassList metadata a href ListMeta a Standard list metadata items a href IngressClass a required items is the list of IngressClasses Operations Operations hr get read the specified IngressClass HTTP Request GET apis networking k8s io v1 ingressclasses name Parameters name in path string required name of the IngressClass pretty in query string a href pretty a Response 200 a href IngressClass a OK 401 Unauthorized list list or watch objects of kind IngressClass HTTP Request GET apis networking k8s io v1 ingressclasses Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href IngressClassList a OK 401 Unauthorized create create an IngressClass HTTP Request POST apis networking k8s io v1 ingressclasses Parameters body a href IngressClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href IngressClass a OK 201 a href IngressClass a Created 202 a href IngressClass a Accepted 401 Unauthorized update replace the specified IngressClass HTTP Request PUT apis networking k8s io v1 ingressclasses name Parameters name in path string required name of the IngressClass body a href IngressClass a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href IngressClass a OK 201 a href IngressClass a Created 401 Unauthorized patch partially update the specified IngressClass HTTP Request PATCH apis networking k8s io v1 ingressclasses name Parameters name in path string required name of the IngressClass body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href IngressClass a OK 201 a href IngressClass a Created 401 Unauthorized delete delete an IngressClass HTTP Request DELETE apis networking k8s io v1 ingressclasses name Parameters name in path string required name of the IngressClass body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of IngressClass HTTP Request DELETE apis networking k8s io v1 ingressclasses Parameters body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind Service apiVersion v1 weight 1 contenttype apireference title Service apimetadata autogenerated true Service is a named abstraction of software service for example mysql consisting of local port for example 3306 that the proxy listens on and the selector that determines which pods will answer requests sent through the proxy import k8s io api core v1 | ---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "Service"
content_type: "api_reference"
description: "Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy."
title: "Service"
weight: 1
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.
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## Service {#Service}
Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.
<hr>
- **apiVersion**: v1
- **kind**: Service
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">ServiceSpec</a>)
Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">ServiceStatus</a>)
Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## ServiceSpec {#ServiceSpec}
ServiceSpec describes the attributes that a user creates on a service.
<hr>
- **selector** (map[string]string)
Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/
- **ports** ([]ServicePort)
*Patch strategy: merge on key `port`*
*Map: unique values on keys `port, protocol` will be kept during a merge*
The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
<a name="ServicePort"></a>
*ServicePort contains information on service's port.*
- **ports.port** (int32), required
The port that will be exposed by this service.
- **ports.targetPort** (IntOrString)
Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **ports.protocol** (string)
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.
- **ports.name** (string)
The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.
- **ports.nodePort** (int32)
The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
- **ports.appProtocol** (string)
The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:
* Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names:
* 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
* 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
* 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
* Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
- **type** (string)
type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
- **ipFamilies** ([]string)
*Atomic: will be replaced during a merge*
IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName.
This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
- **ipFamilyPolicy** (string)
IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName.
- **clusterIP** (string)
clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
- **clusterIPs** ([]string)
*Atomic: will be replaced during a merge*
ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value.
This field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
- **externalIPs** ([]string)
*Atomic: will be replaced during a merge*
externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.
- **sessionAffinity** (string)
Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
- **loadBalancerIP** (string)
Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations. Using it is non-portable and it may not support dual-stack. Users are encouraged to use implementation-specific annotations when available.
- **loadBalancerSourceRanges** ([]string)
*Atomic: will be replaced during a merge*
If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
- **loadBalancerClass** (string)
loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
- **externalName** (string)
externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
- **externalTrafficPolicy** (string)
externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node.
- **internalTrafficPolicy** (string)
InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features).
- **healthCheckNodePort** (int32)
healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set.
- **publishNotReadyAddresses** (boolean)
publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior.
- **sessionAffinityConfig** (SessionAffinityConfig)
sessionAffinityConfig contains the configurations of session affinity.
<a name="SessionAffinityConfig"></a>
*SessionAffinityConfig represents the configurations of session affinity.*
- **sessionAffinityConfig.clientIP** (ClientIPConfig)
clientIP contains the configurations of Client IP based session affinity.
<a name="ClientIPConfig"></a>
*ClientIPConfig represents the configurations of Client IP based session affinity.*
- **sessionAffinityConfig.clientIP.timeoutSeconds** (int32)
timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && \<=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).
- **allocateLoadBalancerNodePorts** (boolean)
allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type.
- **trafficDistribution** (string)
TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to "PreferClose", implementations should prioritize endpoints that are topologically close (e.g., same zone). This is an beta field and requires enabling ServiceTrafficDistribution feature.
## ServiceStatus {#ServiceStatus}
ServiceStatus represents the current status of a service.
<hr>
- **conditions** ([]Condition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Current service state
<a name="Condition"></a>
*Condition contains details for one aspect of the current state of this API Resource.*
- **conditions.lastTransitionTime** (Time), required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string), required
message is a human readable message indicating details about the transition. This may be an empty string.
- **conditions.reason** (string), required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
- **conditions.status** (string), required
status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
type of condition in CamelCase or in foo.example.com/CamelCase.
- **conditions.observedGeneration** (int64)
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
- **loadBalancer** (LoadBalancerStatus)
LoadBalancer contains the current status of the load-balancer, if one is present.
<a name="LoadBalancerStatus"></a>
*LoadBalancerStatus represents the status of a load-balancer.*
- **loadBalancer.ingress** ([]LoadBalancerIngress)
*Atomic: will be replaced during a merge*
Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.
<a name="LoadBalancerIngress"></a>
*LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.*
- **loadBalancer.ingress.hostname** (string)
Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
- **loadBalancer.ingress.ip** (string)
IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
- **loadBalancer.ingress.ipMode** (string)
IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified. Setting this to "VIP" indicates that traffic is delivered to the node with the destination set to the load-balancer's IP and port. Setting this to "Proxy" indicates that traffic is delivered to the node or pod with the destination set to the node's IP and node port or the pod's IP and port. Service implementations may use this information to adjust traffic routing.
- **loadBalancer.ingress.ports** ([]PortStatus)
*Atomic: will be replaced during a merge*
Ports is a list of records of service ports If used, every port defined in the service should have an entry in it
<a name="PortStatus"></a>
**
- **loadBalancer.ingress.ports.port** (int32), required
Port is the port number of the service port of which status is recorded here
- **loadBalancer.ingress.ports.protocol** (string), required
Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
- **loadBalancer.ingress.ports.error** (string)
Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use
CamelCase names
- cloud provider specific error values must have names that comply with the
format foo.example.com/CamelCase.
## ServiceList {#ServiceList}
ServiceList holds a list of services.
<hr>
- **apiVersion**: v1
- **kind**: ServiceList
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="">Service</a>), required
List of services
## Operations {#Operations}
<hr>
### `get` read the specified Service
#### HTTP Request
GET /api/v1/namespaces/{namespace}/services/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Service
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Service</a>): OK
401: Unauthorized
### `get` read status of the specified Service
#### HTTP Request
GET /api/v1/namespaces/{namespace}/services/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Service
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Service</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Service
#### HTTP Request
GET /api/v1/namespaces/{namespace}/services
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ServiceList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Service
#### HTTP Request
GET /api/v1/services
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">ServiceList</a>): OK
401: Unauthorized
### `create` create a Service
#### HTTP Request
POST /api/v1/namespaces/{namespace}/services
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Service</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Service</a>): OK
201 (<a href="">Service</a>): Created
202 (<a href="">Service</a>): Accepted
401: Unauthorized
### `update` replace the specified Service
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/services/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Service
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Service</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Service</a>): OK
201 (<a href="">Service</a>): Created
401: Unauthorized
### `update` replace status of the specified Service
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/services/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Service
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Service</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Service</a>): OK
201 (<a href="">Service</a>): Created
401: Unauthorized
### `patch` partially update the specified Service
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/services/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Service
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Service</a>): OK
201 (<a href="">Service</a>): Created
401: Unauthorized
### `patch` partially update status of the specified Service
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Service
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Service</a>): OK
201 (<a href="">Service</a>): Created
401: Unauthorized
### `delete` delete a Service
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/services/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Service
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Service</a>): OK
202 (<a href="">Service</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Service
#### HTTP Request
DELETE /api/v1/namespaces/{namespace}/services
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion v1 import k8s io api core v1 kind Service content type api reference description Service is a named abstraction of software service for example mysql consisting of local port for example 3306 that the proxy listens on and the selector that determines which pods will answer requests sent through the proxy title Service weight 1 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 apiVersion v1 import k8s io api core v1 Service Service Service is a named abstraction of software service for example mysql consisting of local port for example 3306 that the proxy listens on and the selector that determines which pods will answer requests sent through the proxy hr apiVersion v1 kind Service metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href ServiceSpec a Spec defines the behavior of a service https git k8s io community contributors devel sig architecture api conventions md spec and status status a href ServiceStatus a Most recently observed status of the service Populated by the system Read only More info https git k8s io community contributors devel sig architecture api conventions md spec and status ServiceSpec ServiceSpec ServiceSpec describes the attributes that a user creates on a service hr selector map string string Route service traffic to pods with label keys and values matching this selector If empty or not present the service is assumed to have an external process managing its endpoints which Kubernetes will not modify Only applies to types ClusterIP NodePort and LoadBalancer Ignored if type is ExternalName More info https kubernetes io docs concepts services networking service ports ServicePort Patch strategy merge on key port Map unique values on keys port protocol will be kept during a merge The list of ports that are exposed by this service More info https kubernetes io docs concepts services networking service virtual ips and service proxies a name ServicePort a ServicePort contains information on service s port ports port int32 required The port that will be exposed by this service ports targetPort IntOrString Number or name of the port to access on the pods targeted by the service Number must be in the range 1 to 65535 Name must be an IANA SVC NAME If this is a string it will be looked up as a named port in the target Pod s container ports If this is not specified the value of the port field is used an identity map This field is ignored for services with clusterIP None and should be omitted or set equal to the port field More info https kubernetes io docs concepts services networking service defining a service a name IntOrString a IntOrString is a type that can hold an int32 or a string When used in JSON or YAML marshalling and unmarshalling it produces or consumes the inner type This allows you to have for example a JSON field that can accept a name or number ports protocol string The IP protocol for this port Supports TCP UDP and SCTP Default is TCP ports name string The name of this port within the service This must be a DNS LABEL All ports within a ServiceSpec must have unique names When considering the endpoints for a Service this must match the name field in the EndpointPort Optional if only one ServicePort is defined on this service ports nodePort int32 The port on each node on which this service is exposed when type is NodePort or LoadBalancer Usually assigned by the system If a value is specified in range and not in use it will be used otherwise the operation will fail If not specified a port will be allocated if this Service requires one If this field is specified when creating a Service which does not need it creation will fail This field will be wiped when updating a Service to no longer need it e g changing type from NodePort to ClusterIP More info https kubernetes io docs concepts services networking service type nodeport ports appProtocol string The application protocol for this port This is used as a hint for implementations to offer richer behavior for protocols that they understand This field follows standard Kubernetes label syntax Valid values are either Un prefixed protocol names reserved for IANA standard service names as per RFC 6335 and https www iana org assignments service names Kubernetes defined prefixed names kubernetes io h2c HTTP 2 prior knowledge over cleartext as described in https www rfc editor org rfc rfc9113 html name starting http 2 with prior kubernetes io ws WebSocket over cleartext as described in https www rfc editor org rfc rfc6455 kubernetes io wss WebSocket over TLS as described in https www rfc editor org rfc rfc6455 Other protocols should use implementation defined prefixed names such as mycompany com my custom protocol type string type determines how the Service is exposed Defaults to ClusterIP Valid options are ExternalName ClusterIP NodePort and LoadBalancer ClusterIP allocates a cluster internal IP address for load balancing to endpoints Endpoints are determined by the selector or if that is not specified by manual construction of an Endpoints object or EndpointSlice objects If clusterIP is None no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP NodePort builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP LoadBalancer builds on NodePort and creates an external load balancer if supported in the current cloud which routes to the same endpoints as the clusterIP ExternalName aliases this service to the specified externalName Several other fields do not apply to ExternalName services More info https kubernetes io docs concepts services networking service publishing services service types ipFamilies string Atomic will be replaced during a merge IPFamilies is a list of IP families e g IPv4 IPv6 assigned to this service This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field If this field is specified manually the requested family is available in the cluster and ipFamilyPolicy allows it it will be used otherwise creation of the service will fail This field is conditionally mutable it allows for adding or removing a secondary IP family but it does not allow changing the primary IP family of the Service Valid values are IPv4 and IPv6 This field only applies to Services of types ClusterIP NodePort and LoadBalancer and does apply to headless services This field will be wiped when updating a Service to type ExternalName This field may hold a maximum of two entries dual stack families in either order These families must correspond to the values of the clusterIPs field if specified Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field ipFamilyPolicy string IPFamilyPolicy represents the dual stack ness requested or required by this Service If there is no value provided then this field will be set to SingleStack Services can be SingleStack a single IP family PreferDualStack two IP families on dual stack configured clusters or a single IP family on single stack clusters or RequireDualStack two IP families on dual stack configured clusters otherwise fail The ipFamilies and clusterIPs fields depend on the value of this field This field will be wiped when updating a service to type ExternalName clusterIP string clusterIP is the IP address of the service and is usually assigned randomly If an address is specified manually is in range as per system configuration and is not in use it will be allocated to the service otherwise creation of the service will fail This field may not be changed through updates unless the type field is also being changed to ExternalName which requires this field to be blank or the type field is being changed from ExternalName in which case this field may optionally be specified as describe above Valid values are None empty string or a valid IP address Setting this to None makes a headless service no virtual IP which is useful when direct endpoint connections are preferred and proxying is not required Only applies to types ClusterIP NodePort and LoadBalancer If this field is specified when creating a Service of type ExternalName creation will fail This field will be wiped when updating a Service to type ExternalName More info https kubernetes io docs concepts services networking service virtual ips and service proxies clusterIPs string Atomic will be replaced during a merge ClusterIPs is a list of IP addresses assigned to this service and are usually assigned randomly If an address is specified manually is in range as per system configuration and is not in use it will be allocated to the service otherwise creation of the service will fail This field may not be changed through updates unless the type field is also being changed to ExternalName which requires this field to be empty or the type field is being changed from ExternalName in which case this field may optionally be specified as describe above Valid values are None empty string or a valid IP address Setting this to None makes a headless service no virtual IP which is useful when direct endpoint connections are preferred and proxying is not required Only applies to types ClusterIP NodePort and LoadBalancer If this field is specified when creating a Service of type ExternalName creation will fail This field will be wiped when updating a Service to type ExternalName If this field is not specified it will be initialized from the clusterIP field If this field is specified clients must ensure that clusterIPs 0 and clusterIP have the same value This field may hold a maximum of two entries dual stack IPs in either order These IPs must correspond to the values of the ipFamilies field Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field More info https kubernetes io docs concepts services networking service virtual ips and service proxies externalIPs string Atomic will be replaced during a merge externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service These IPs are not managed by Kubernetes The user is responsible for ensuring that traffic arrives at a node with this IP A common example is external load balancers that are not part of the Kubernetes system sessionAffinity string Supports ClientIP and None Used to maintain session affinity Enable client IP based session affinity Must be ClientIP or None Defaults to None More info https kubernetes io docs concepts services networking service virtual ips and service proxies loadBalancerIP string Only applies to Service Type LoadBalancer This feature depends on whether the underlying cloud provider supports specifying the loadBalancerIP when a load balancer is created This field will be ignored if the cloud provider does not support the feature Deprecated This field was under specified and its meaning varies across implementations Using it is non portable and it may not support dual stack Users are encouraged to use implementation specific annotations when available loadBalancerSourceRanges string Atomic will be replaced during a merge If specified and supported by the platform this will restrict traffic through the cloud provider load balancer will be restricted to the specified client IPs This field will be ignored if the cloud provider does not support the feature More info https kubernetes io docs tasks access application cluster create external load balancer loadBalancerClass string loadBalancerClass is the class of the load balancer implementation this Service belongs to If specified the value of this field must be a label style identifier with an optional prefix e g internal vip or example com internal vip Unprefixed names are reserved for end users This field can only be set when the Service type is LoadBalancer If not set the default load balancer implementation is used today this is typically done through the cloud provider integration but should apply for any default implementation If set it is assumed that a load balancer implementation is watching for Services with a matching class Any default load balancer implementation e g cloud providers should ignore Services that set this field This field can only be set when creating or updating a Service to type LoadBalancer Once set it can not be changed This field will be wiped when a service is updated to a non LoadBalancer type externalName string externalName is the external reference that discovery mechanisms will return as an alias for this service e g a DNS CNAME record No proxying will be involved Must be a lowercase RFC 1123 hostname https tools ietf org html rfc1123 and requires type to be ExternalName externalTrafficPolicy string externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service s externally facing addresses NodePorts ExternalIPs and LoadBalancer IPs If set to Local the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes and so each node will deliver traffic only to the node local endpoints of the service without masquerading the client source IP Traffic mistakenly sent to a node with no endpoints will be dropped The default value Cluster uses the standard behavior of routing to all endpoints evenly possibly modified by topology and other features Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get Cluster semantics but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node internalTrafficPolicy string InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP If set to Local the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod dropping the traffic if there are no local endpoints The default value Cluster uses the standard behavior of routing to all endpoints evenly possibly modified by topology and other features healthCheckNodePort int32 healthCheckNodePort specifies the healthcheck nodePort for the service This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local If a value is specified is in range and is not in use it will be used If not specified a value will be automatically allocated External systems e g load balancers can use this port to determine if a given node holds endpoints for this service or not If this field is specified when creating a Service which does not need it creation will fail This field will be wiped when updating a Service to no longer need it e g changing type This field cannot be updated once set publishNotReadyAddresses boolean publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready not ready The primary use case for setting this field is for a StatefulSet s Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered ready even if the Pods themselves are not Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior sessionAffinityConfig SessionAffinityConfig sessionAffinityConfig contains the configurations of session affinity a name SessionAffinityConfig a SessionAffinityConfig represents the configurations of session affinity sessionAffinityConfig clientIP ClientIPConfig clientIP contains the configurations of Client IP based session affinity a name ClientIPConfig a ClientIPConfig represents the configurations of Client IP based session affinity sessionAffinityConfig clientIP timeoutSeconds int32 timeoutSeconds specifies the seconds of ClientIP type session sticky time The value must be 0 86400 for 1 day if ServiceAffinity ClientIP Default value is 10800 for 3 hours allocateLoadBalancerNodePorts boolean allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer Default is true It may be set to false if the cluster load balancer does not rely on NodePorts If the caller requests specific NodePorts by specifying a value those requests will be respected regardless of this field This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type trafficDistribution string TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints Implementations can use this field as a hint but are not required to guarantee strict adherence If the field is not set the implementation will apply its default routing strategy If set to PreferClose implementations should prioritize endpoints that are topologically close e g same zone This is an beta field and requires enabling ServiceTrafficDistribution feature ServiceStatus ServiceStatus ServiceStatus represents the current status of a service hr conditions Condition Patch strategy merge on key type Map unique values on key type will be kept during a merge Current service state a name Condition a Condition contains details for one aspect of the current state of this API Resource conditions lastTransitionTime Time required lastTransitionTime is the last time the condition transitioned from one status to another This should be when the underlying condition changed If that is not known then using the time when the API field changed is acceptable a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers conditions message string required message is a human readable message indicating details about the transition This may be an empty string conditions reason string required reason contains a programmatic identifier indicating the reason for the condition s last transition Producers of specific condition types may define expected values and meanings for this field and whether the values are considered a guaranteed API The value should be a CamelCase string This field may not be empty conditions status string required status of the condition one of True False Unknown conditions type string required type of condition in CamelCase or in foo example com CamelCase conditions observedGeneration int64 observedGeneration represents the metadata generation that the condition was set based upon For instance if metadata generation is currently 12 but the status conditions x observedGeneration is 9 the condition is out of date with respect to the current state of the instance loadBalancer LoadBalancerStatus LoadBalancer contains the current status of the load balancer if one is present a name LoadBalancerStatus a LoadBalancerStatus represents the status of a load balancer loadBalancer ingress LoadBalancerIngress Atomic will be replaced during a merge Ingress is a list containing ingress points for the load balancer Traffic intended for the service should be sent to these ingress points a name LoadBalancerIngress a LoadBalancerIngress represents the status of a load balancer ingress point traffic intended for the service should be sent to an ingress point loadBalancer ingress hostname string Hostname is set for load balancer ingress points that are DNS based typically AWS load balancers loadBalancer ingress ip string IP is set for load balancer ingress points that are IP based typically GCE or OpenStack load balancers loadBalancer ingress ipMode string IPMode specifies how the load balancer IP behaves and may only be specified when the ip field is specified Setting this to VIP indicates that traffic is delivered to the node with the destination set to the load balancer s IP and port Setting this to Proxy indicates that traffic is delivered to the node or pod with the destination set to the node s IP and node port or the pod s IP and port Service implementations may use this information to adjust traffic routing loadBalancer ingress ports PortStatus Atomic will be replaced during a merge Ports is a list of records of service ports If used every port defined in the service should have an entry in it a name PortStatus a loadBalancer ingress ports port int32 required Port is the port number of the service port of which status is recorded here loadBalancer ingress ports protocol string required Protocol is the protocol of the service port of which status is recorded here The supported values are TCP UDP SCTP loadBalancer ingress ports error string Error is to record the problem with the service port The format of the error shall comply with the following rules built in error values shall be specified in this file and those shall use CamelCase names cloud provider specific error values must have names that comply with the format foo example com CamelCase ServiceList ServiceList ServiceList holds a list of services hr apiVersion v1 kind ServiceList metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds items a href Service a required List of services Operations Operations hr get read the specified Service HTTP Request GET api v1 namespaces namespace services name Parameters name in path string required name of the Service namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Service a OK 401 Unauthorized get read status of the specified Service HTTP Request GET api v1 namespaces namespace services name status Parameters name in path string required name of the Service namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Service a OK 401 Unauthorized list list or watch objects of kind Service HTTP Request GET api v1 namespaces namespace services Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ServiceList a OK 401 Unauthorized list list or watch objects of kind Service HTTP Request GET api v1 services Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href ServiceList a OK 401 Unauthorized create create a Service HTTP Request POST api v1 namespaces namespace services Parameters namespace in path string required a href namespace a body a href Service a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Service a OK 201 a href Service a Created 202 a href Service a Accepted 401 Unauthorized update replace the specified Service HTTP Request PUT api v1 namespaces namespace services name Parameters name in path string required name of the Service namespace in path string required a href namespace a body a href Service a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Service a OK 201 a href Service a Created 401 Unauthorized update replace status of the specified Service HTTP Request PUT api v1 namespaces namespace services name status Parameters name in path string required name of the Service namespace in path string required a href namespace a body a href Service a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Service a OK 201 a href Service a Created 401 Unauthorized patch partially update the specified Service HTTP Request PATCH api v1 namespaces namespace services name Parameters name in path string required name of the Service namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Service a OK 201 a href Service a Created 401 Unauthorized patch partially update status of the specified Service HTTP Request PATCH api v1 namespaces namespace services name status Parameters name in path string required name of the Service namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Service a OK 201 a href Service a Created 401 Unauthorized delete delete a Service HTTP Request DELETE api v1 namespaces namespace services name Parameters name in path string required name of the Service namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Service a OK 202 a href Service a Accepted 401 Unauthorized deletecollection delete collection of Service HTTP Request DELETE api v1 namespaces namespace services Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend kind Ingress contenttype apireference title Ingress apimetadata weight 4 autogenerated true import k8s io api networking v1 apiVersion networking k8s io v1 | ---
api_metadata:
apiVersion: "networking.k8s.io/v1"
import: "k8s.io/api/networking/v1"
kind: "Ingress"
content_type: "api_reference"
description: "Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend."
title: "Ingress"
weight: 4
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.
-->
`apiVersion: networking.k8s.io/v1`
`import "k8s.io/api/networking/v1"`
## Ingress {#Ingress}
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
<hr>
- **apiVersion**: networking.k8s.io/v1
- **kind**: Ingress
- **metadata** (<a href="">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="">IngressSpec</a>)
spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="">IngressStatus</a>)
status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## IngressSpec {#IngressSpec}
IngressSpec describes the Ingress the user wishes to exist.
<hr>
- **defaultBackend** (<a href="">IngressBackend</a>)
defaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller.
- **ingressClassName** (string)
ingressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.
- **rules** ([]IngressRule)
*Atomic: will be replaced during a merge*
rules is a list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
<a name="IngressRule"></a>
*IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.*
- **rules.host** (string)
host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
the IP in the Spec of the parent Ingress.
2. The `:` delimiter is not respected because ports are not allowed.
Currently the port of an Ingress is implicitly :80 for http and
:443 for https.
Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.
host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If host is precise, the request matches this rule if the http host header is equal to Host. 2. If host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.
- **rules.http** (HTTPIngressRuleValue)
<a name="HTTPIngressRuleValue"></a>
*HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.*
- **rules.http.paths** ([]HTTPIngressPath), required
*Atomic: will be replaced during a merge*
paths is a collection of paths that map requests to backends.
<a name="HTTPIngressPath"></a>
*HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.*
- **rules.http.paths.backend** (<a href="">IngressBackend</a>), required
backend defines the referenced service endpoint to which the traffic will be forwarded to.
- **rules.http.paths.pathType** (string), required
pathType determines the interpretation of the path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is
done on a path element by element basis. A path element refers is the
list of labels in the path split by the '/' separator. A request is a
match for path p if every p is an element-wise prefix of p of the
request path. Note that if the last element of the path is a substring
of the last element in request path, it is not a match (e.g. /foo/bar
matches /foo/bar/baz, but does not match /foo/barbaz).
* ImplementationSpecific: Interpretation of the Path matching is up to
the IngressClass. Implementations can treat this as a separate PathType
or treat it identically to Prefix or Exact path types.
Implementations are required to support all path types.
- **rules.http.paths.path** (string)
path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value "Exact" or "Prefix".
- **tls** ([]IngressTLS)
*Atomic: will be replaced during a merge*
tls represents the TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
<a name="IngressTLS"></a>
*IngressTLS describes the transport layer security associated with an ingress.*
- **tls.hosts** ([]string)
*Atomic: will be replaced during a merge*
hosts is a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
- **tls.secretName** (string)
secretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the "Host" header is used for routing.
## IngressBackend {#IngressBackend}
IngressBackend describes all endpoints for a given service and port.
<hr>
- **resource** (<a href="">TypedLocalObjectReference</a>)
resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service".
- **service** (IngressServiceBackend)
service references a service as a backend. This is a mutually exclusive setting with "Resource".
<a name="IngressServiceBackend"></a>
*IngressServiceBackend references a Kubernetes Service as a Backend.*
- **service.name** (string), required
name is the referenced service. The service must exist in the same namespace as the Ingress object.
- **service.port** (ServiceBackendPort)
port of the referenced service. A port name or port number is required for a IngressServiceBackend.
<a name="ServiceBackendPort"></a>
*ServiceBackendPort is the service port being referenced.*
- **service.port.name** (string)
name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
- **service.port.number** (int32)
number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".
## IngressStatus {#IngressStatus}
IngressStatus describe the current state of the Ingress.
<hr>
- **loadBalancer** (IngressLoadBalancerStatus)
loadBalancer contains the current status of the load-balancer.
<a name="IngressLoadBalancerStatus"></a>
*IngressLoadBalancerStatus represents the status of a load-balancer.*
- **loadBalancer.ingress** ([]IngressLoadBalancerIngress)
*Atomic: will be replaced during a merge*
ingress is a list containing ingress points for the load-balancer.
<a name="IngressLoadBalancerIngress"></a>
*IngressLoadBalancerIngress represents the status of a load-balancer ingress point.*
- **loadBalancer.ingress.hostname** (string)
hostname is set for load-balancer ingress points that are DNS based.
- **loadBalancer.ingress.ip** (string)
ip is set for load-balancer ingress points that are IP based.
- **loadBalancer.ingress.ports** ([]IngressPortStatus)
*Atomic: will be replaced during a merge*
ports provides information about the ports exposed by this LoadBalancer.
<a name="IngressPortStatus"></a>
*IngressPortStatus represents the error condition of a service port*
- **loadBalancer.ingress.ports.port** (int32), required
port is the port number of the ingress port.
- **loadBalancer.ingress.ports.protocol** (string), required
protocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP"
- **loadBalancer.ingress.ports.error** (string)
error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use
CamelCase names
- cloud provider specific error values must have names that comply with the
format foo.example.com/CamelCase.
## IngressList {#IngressList}
IngressList is a collection of Ingress.
<hr>
- **items** ([]<a href="">Ingress</a>), required
items is the list of Ingress.
- **apiVersion** (string)
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (<a href="">ListMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
## Operations {#Operations}
<hr>
### `get` read the specified Ingress
#### HTTP Request
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Ingress
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Ingress</a>): OK
401: Unauthorized
### `get` read status of the specified Ingress
#### HTTP Request
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Ingress
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Ingress</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Ingress
#### HTTP Request
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">IngressList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind Ingress
#### HTTP Request
GET /apis/networking.k8s.io/v1/ingresses
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="">watch</a>
#### Response
200 (<a href="">IngressList</a>): OK
401: Unauthorized
### `create` create an Ingress
#### HTTP Request
POST /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Ingress</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Ingress</a>): OK
201 (<a href="">Ingress</a>): Created
202 (<a href="">Ingress</a>): Accepted
401: Unauthorized
### `update` replace the specified Ingress
#### HTTP Request
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Ingress
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Ingress</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Ingress</a>): OK
201 (<a href="">Ingress</a>): Created
401: Unauthorized
### `update` replace status of the specified Ingress
#### HTTP Request
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Ingress
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Ingress</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Ingress</a>): OK
201 (<a href="">Ingress</a>): Created
401: Unauthorized
### `patch` partially update the specified Ingress
#### HTTP Request
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Ingress
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Ingress</a>): OK
201 (<a href="">Ingress</a>): Created
401: Unauthorized
### `patch` partially update status of the specified Ingress
#### HTTP Request
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the Ingress
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">Patch</a>, required
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldManager** (*in query*): string
<a href="">fieldManager</a>
- **fieldValidation** (*in query*): string
<a href="">fieldValidation</a>
- **force** (*in query*): boolean
<a href="">force</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
#### Response
200 (<a href="">Ingress</a>): OK
201 (<a href="">Ingress</a>): Created
401: Unauthorized
### `delete` delete an Ingress
#### HTTP Request
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the Ingress
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
#### Response
200 (<a href="">Status</a>): OK
202 (<a href="">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of Ingress
#### HTTP Request
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
#### Parameters
- **namespace** (*in path*): string, required
<a href="">namespace</a>
- **body**: <a href="">DeleteOptions</a>
- **continue** (*in query*): string
<a href="">continue</a>
- **dryRun** (*in query*): string
<a href="">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="">labelSelector</a>
- **limit** (*in query*): integer
<a href="">limit</a>
- **pretty** (*in query*): string
<a href="">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="">timeoutSeconds</a>
#### Response
200 (<a href="">Status</a>): OK
401: Unauthorized
| kubernetes reference | api metadata apiVersion networking k8s io v1 import k8s io api networking v1 kind Ingress content type api reference description Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend title Ingress weight 4 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 apiVersion networking k8s io v1 import k8s io api networking v1 Ingress Ingress Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend An Ingress can be configured to give services externally reachable urls load balance traffic terminate SSL offer name based virtual hosting etc hr apiVersion networking k8s io v1 kind Ingress metadata a href ObjectMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata spec a href IngressSpec a spec is the desired state of the Ingress More info https git k8s io community contributors devel sig architecture api conventions md spec and status status a href IngressStatus a status is the current state of the Ingress More info https git k8s io community contributors devel sig architecture api conventions md spec and status IngressSpec IngressSpec IngressSpec describes the Ingress the user wishes to exist hr defaultBackend a href IngressBackend a defaultBackend is the backend that should handle requests that don t match any rule If Rules are not specified DefaultBackend must be specified If DefaultBackend is not set the handling of requests that do not match any of the rules will be up to the Ingress controller ingressClassName string ingressClassName is the name of an IngressClass cluster resource Ingress controller implementations use this field to know whether they should be serving this Ingress resource by a transitive connection controller IngressClass Ingress resource Although the kubernetes io ingress class annotation simple constant name was never formally defined it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources Newly created Ingress resources should prefer using the field However even though the annotation is officially deprecated for backwards compatibility reasons ingress controllers should still honor that annotation if present rules IngressRule Atomic will be replaced during a merge rules is a list of host rules used to configure the Ingress If unspecified or no rule matches all traffic is sent to the default backend a name IngressRule a IngressRule represents the rules mapping the paths under a specified host to the related backend services Incoming requests are first evaluated for a host match then routed to the backend associated with the matching IngressRuleValue rules host string host is the fully qualified domain name of a network host as defined by RFC 3986 Note the following deviations from the host part of the URI as defined in RFC 3986 1 IPs are not allowed Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress 2 The delimiter is not respected because ports are not allowed Currently the port of an Ingress is implicitly 80 for http and 443 for https Both these may change in the future Incoming requests are matched against the host before the IngressRuleValue If the host is unspecified the Ingress routes all traffic based on the specified IngressRuleValue host can be precise which is a domain name without the terminating dot of a network host e g foo bar com or wildcard which is a domain name prefixed with a single wildcard label e g foo com The wildcard character must appear by itself as the first DNS label and matches only a single label You cannot have a wildcard label by itself e g Host Requests will be matched against the Host field in the following way 1 If host is precise the request matches this rule if the http host header is equal to Host 2 If host is a wildcard then the request matches this rule if the http host header is to equal to the suffix removing the first label of the wildcard rule rules http HTTPIngressRuleValue a name HTTPIngressRuleValue a HTTPIngressRuleValue is a list of http selectors pointing to backends In the example http host path searchpart backend where where parts of the url correspond to RFC 3986 this resource will be used to match against everything after the last and before the first or rules http paths HTTPIngressPath required Atomic will be replaced during a merge paths is a collection of paths that map requests to backends a name HTTPIngressPath a HTTPIngressPath associates a path with a backend Incoming urls matching the path are forwarded to the backend rules http paths backend a href IngressBackend a required backend defines the referenced service endpoint to which the traffic will be forwarded to rules http paths pathType string required pathType determines the interpretation of the path matching PathType can be one of the following values Exact Matches the URL path exactly Prefix Matches based on a URL path prefix split by Matching is done on a path element by element basis A path element refers is the list of labels in the path split by the separator A request is a match for path p if every p is an element wise prefix of p of the request path Note that if the last element of the path is a substring of the last element in request path it is not a match e g foo bar matches foo bar baz but does not match foo barbaz ImplementationSpecific Interpretation of the Path matching is up to the IngressClass Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types Implementations are required to support all path types rules http paths path string path is matched against the path of an incoming request Currently it can contain characters disallowed from the conventional path part of a URL as defined by RFC 3986 Paths must begin with a and must be present when using PathType with value Exact or Prefix tls IngressTLS Atomic will be replaced during a merge tls represents the TLS configuration Currently the Ingress only supports a single TLS port 443 If multiple members of this list specify different hosts they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension if the ingress controller fulfilling the ingress supports SNI a name IngressTLS a IngressTLS describes the transport layer security associated with an ingress tls hosts string Atomic will be replaced during a merge hosts is a list of hosts included in the TLS certificate The values in this list must match the name s used in the tlsSecret Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress if left unspecified tls secretName string secretName is the name of the secret used to terminate TLS traffic on port 443 Field is left optional to allow TLS routing based on SNI hostname alone If the SNI host in a listener conflicts with the Host header field used by an IngressRule the SNI host is used for termination and value of the Host header is used for routing IngressBackend IngressBackend IngressBackend describes all endpoints for a given service and port hr resource a href TypedLocalObjectReference a resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object If resource is specified a service Name and service Port must not be specified This is a mutually exclusive setting with Service service IngressServiceBackend service references a service as a backend This is a mutually exclusive setting with Resource a name IngressServiceBackend a IngressServiceBackend references a Kubernetes Service as a Backend service name string required name is the referenced service The service must exist in the same namespace as the Ingress object service port ServiceBackendPort port of the referenced service A port name or port number is required for a IngressServiceBackend a name ServiceBackendPort a ServiceBackendPort is the service port being referenced service port name string name is the name of the port on the Service This is a mutually exclusive setting with Number service port number int32 number is the numerical port number e g 80 on the Service This is a mutually exclusive setting with Name IngressStatus IngressStatus IngressStatus describe the current state of the Ingress hr loadBalancer IngressLoadBalancerStatus loadBalancer contains the current status of the load balancer a name IngressLoadBalancerStatus a IngressLoadBalancerStatus represents the status of a load balancer loadBalancer ingress IngressLoadBalancerIngress Atomic will be replaced during a merge ingress is a list containing ingress points for the load balancer a name IngressLoadBalancerIngress a IngressLoadBalancerIngress represents the status of a load balancer ingress point loadBalancer ingress hostname string hostname is set for load balancer ingress points that are DNS based loadBalancer ingress ip string ip is set for load balancer ingress points that are IP based loadBalancer ingress ports IngressPortStatus Atomic will be replaced during a merge ports provides information about the ports exposed by this LoadBalancer a name IngressPortStatus a IngressPortStatus represents the error condition of a service port loadBalancer ingress ports port int32 required port is the port number of the ingress port loadBalancer ingress ports protocol string required protocol is the protocol of the ingress port The supported values are TCP UDP SCTP loadBalancer ingress ports error string error is to record the problem with the service port The format of the error shall comply with the following rules built in error values shall be specified in this file and those shall use CamelCase names cloud provider specific error values must have names that comply with the format foo example com CamelCase IngressList IngressList IngressList is a collection of Ingress hr items a href Ingress a required items is the list of Ingress apiVersion string APIVersion defines the versioned schema of this representation of an object Servers should convert recognized schemas to the latest internal value and may reject unrecognized values More info https git k8s io community contributors devel sig architecture api conventions md resources kind string Kind is a string value representing the REST resource this object represents Servers may infer this from the endpoint the client submits requests to Cannot be updated In CamelCase More info https git k8s io community contributors devel sig architecture api conventions md types kinds metadata a href ListMeta a Standard object s metadata More info https git k8s io community contributors devel sig architecture api conventions md metadata Operations Operations hr get read the specified Ingress HTTP Request GET apis networking k8s io v1 namespaces namespace ingresses name Parameters name in path string required name of the Ingress namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Ingress a OK 401 Unauthorized get read status of the specified Ingress HTTP Request GET apis networking k8s io v1 namespaces namespace ingresses name status Parameters name in path string required name of the Ingress namespace in path string required a href namespace a pretty in query string a href pretty a Response 200 a href Ingress a OK 401 Unauthorized list list or watch objects of kind Ingress HTTP Request GET apis networking k8s io v1 namespaces namespace ingresses Parameters namespace in path string required a href namespace a allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href IngressList a OK 401 Unauthorized list list or watch objects of kind Ingress HTTP Request GET apis networking k8s io v1 ingresses Parameters allowWatchBookmarks in query boolean a href allowWatchBookmarks a continue in query string a href continue a fieldSelector in query string a href fieldSelector a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a watch in query boolean a href watch a Response 200 a href IngressList a OK 401 Unauthorized create create an Ingress HTTP Request POST apis networking k8s io v1 namespaces namespace ingresses Parameters namespace in path string required a href namespace a body a href Ingress a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Ingress a OK 201 a href Ingress a Created 202 a href Ingress a Accepted 401 Unauthorized update replace the specified Ingress HTTP Request PUT apis networking k8s io v1 namespaces namespace ingresses name Parameters name in path string required name of the Ingress namespace in path string required a href namespace a body a href Ingress a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Ingress a OK 201 a href Ingress a Created 401 Unauthorized update replace status of the specified Ingress HTTP Request PUT apis networking k8s io v1 namespaces namespace ingresses name status Parameters name in path string required name of the Ingress namespace in path string required a href namespace a body a href Ingress a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a pretty in query string a href pretty a Response 200 a href Ingress a OK 201 a href Ingress a Created 401 Unauthorized patch partially update the specified Ingress HTTP Request PATCH apis networking k8s io v1 namespaces namespace ingresses name Parameters name in path string required name of the Ingress namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Ingress a OK 201 a href Ingress a Created 401 Unauthorized patch partially update status of the specified Ingress HTTP Request PATCH apis networking k8s io v1 namespaces namespace ingresses name status Parameters name in path string required name of the Ingress namespace in path string required a href namespace a body a href Patch a required dryRun in query string a href dryRun a fieldManager in query string a href fieldManager a fieldValidation in query string a href fieldValidation a force in query boolean a href force a pretty in query string a href pretty a Response 200 a href Ingress a OK 201 a href Ingress a Created 401 Unauthorized delete delete an Ingress HTTP Request DELETE apis networking k8s io v1 namespaces namespace ingresses name Parameters name in path string required name of the Ingress namespace in path string required a href namespace a body a href DeleteOptions a dryRun in query string a href dryRun a gracePeriodSeconds in query integer a href gracePeriodSeconds a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a Response 200 a href Status a OK 202 a href Status a Accepted 401 Unauthorized deletecollection delete collection of Ingress HTTP Request DELETE apis networking k8s io v1 namespaces namespace ingresses Parameters namespace in path string required a href namespace a body a href DeleteOptions a continue in query string a href continue a dryRun in query string a href dryRun a fieldSelector in query string a href fieldSelector a gracePeriodSeconds in query integer a href gracePeriodSeconds a labelSelector in query string a href labelSelector a limit in query integer a href limit a pretty in query string a href pretty a propagationPolicy in query string a href propagationPolicy a resourceVersion in query string a href resourceVersion a resourceVersionMatch in query string a href resourceVersionMatch a sendInitialEvents in query boolean a href sendInitialEvents a timeoutSeconds in query integer a href timeoutSeconds a Response 200 a href Status a OK 401 Unauthorized |
kubernetes reference kind Common Parameters title Common Parameters apiVersion contenttype apireference import weight 10 apimetadata autogenerated true | ---
api_metadata:
apiVersion: ""
import: ""
kind: "Common Parameters"
content_type: "api_reference"
description: ""
title: "Common Parameters"
weight: 10
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.
-->
## allowWatchBookmarks {#allowWatchBookmarks}
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
<hr>
## continue {#continue}
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".
This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
<hr>
## dryRun {#dryRun}
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
<hr>
## fieldManager {#fieldManager}
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
<hr>
## fieldSelector {#fieldSelector}
A selector to restrict the list of returned objects by their fields. Defaults to everything.
<hr>
## fieldValidation {#fieldValidation}
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
<hr>
## force {#force}
Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
<hr>
## gracePeriodSeconds {#gracePeriodSeconds}
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
<hr>
## labelSelector {#labelSelector}
A selector to restrict the list of returned objects by their labels. Defaults to everything.
<hr>
## limit {#limit}
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
<hr>
## namespace {#namespace}
object name and auth scope, such as for teams and projects
<hr>
## pretty {#pretty}
If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
<hr>
## propagationPolicy {#propagationPolicy}
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
<hr>
## resourceVersion {#resourceVersion}
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.
Defaults to unset
<hr>
## resourceVersionMatch {#resourceVersionMatch}
resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.
Defaults to unset
<hr>
## sendInitialEvents {#sendInitialEvents}
`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.
When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan
is interpreted as "data at least as new as the provided `resourceVersion`"
and the bookmark event is send when the state is synced
to a `resourceVersion` at least as fresh as the one provided by the ListOptions.
If `resourceVersion` is unset, this is interpreted as "consistent read" and the
bookmark event is send when the state is synced at least to the moment
when request started being processed.
- `resourceVersionMatch` set to any other value or unset
Invalid error is returned.
Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward compatibility reasons) and to false otherwise.
<hr>
## timeoutSeconds {#timeoutSeconds}
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
<hr>
## watch {#watch}
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
<hr>
| kubernetes reference | api metadata apiVersion import kind Common Parameters content type api reference description title Common Parameters weight 10 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 allowWatchBookmarks allowWatchBookmarks allowWatchBookmarks requests watch events with type BOOKMARK Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server s discretion Clients should not assume bookmarks are returned at any specific interval nor may they assume the server will send any BOOKMARK event during a session If this is not a watch this field is ignored hr continue continue The continue option should be set when retrieving more results from the server Since this value is server defined clients may only use the continue value from a previous query result with identical query parameters except for the value of continue and the server may reject a continue value it does not recognize If the specified continue value is no longer valid whether due to expiration generally five to fifteen minutes or a configuration change on the server the server will respond with a 410 ResourceExpired error together with a continue token If the client needs a consistent list it must restart their list without the continue field Otherwise the client may send another list request with the token received with the 410 error the server will respond with a list starting from the next key but from the latest snapshot which is inconsistent from the previous list results objects that are created modified or deleted after the first list request will be included in the response as long as their keys are after the next key This field is not supported when watch is true Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications hr dryRun dryRun When present indicates that modifications should not be persisted An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request Valid values are All all dry run stages will be processed hr fieldManager fieldManager fieldManager is a name associated with the actor or entity that is making these changes The value must be less than or 128 characters long and only contain printable characters as defined by https golang org pkg unicode IsPrint hr fieldSelector fieldSelector A selector to restrict the list of returned objects by their fields Defaults to everything hr fieldValidation fieldValidation fieldValidation instructs the server on how to handle objects in the request POST PUT PATCH containing unknown or duplicate fields Valid values are Ignore This will ignore any unknown fields that are silently dropped from the object and will ignore all but the last duplicate field that the decoder encounters This is the default behavior prior to v1 23 Warn This will send a warning via the standard warning response header for each unknown field that is dropped from the object and for each duplicate field that is encountered The request will still succeed if there are no other errors and will only persist the last of any duplicate fields This is the default in v1 23 Strict This will fail the request with a BadRequest error if any unknown fields would be dropped from the object or if any duplicate fields are present The error returned from the server will contain all unknown and duplicate fields encountered hr force force Force is going to force Apply requests It means user will re acquire conflicting fields owned by other people Force flag must be unset for non apply patch requests hr gracePeriodSeconds gracePeriodSeconds The duration in seconds before the object should be deleted Value must be non negative integer The value zero indicates delete immediately If this value is nil the default grace period for the specified type will be used Defaults to a per object value if not specified zero means delete immediately hr labelSelector labelSelector A selector to restrict the list of returned objects by their labels Defaults to everything hr limit limit limit is a maximum number of responses to return for a list call If more items exist the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results Setting a limit may return fewer than the requested amount of items up to zero items in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available Servers may choose not to support the limit argument and will return all of the available results If limit is specified and the continue field is empty clients may assume that no more results are available This field is not supported if watch is true The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit that is no objects created modified or deleted after the first request is issued will be included in any subsequent continued requests This is sometimes referred to as a consistent snapshot and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned hr namespace namespace object name and auth scope such as for teams and projects hr pretty pretty If true then the output is pretty printed Defaults to false unless the user agent indicates a browser or command line HTTP tool curl and wget hr propagationPolicy propagationPolicy Whether and how garbage collection will be performed Either this field or OrphanDependents may be set but not both The default policy is decided by the existing finalizer set in the metadata finalizers and the resource specific default policy Acceptable values are Orphan orphan the dependents Background allow the garbage collector to delete the dependents in the background Foreground a cascading policy that deletes all dependents in the foreground hr resourceVersion resourceVersion resourceVersion sets a constraint on what resource versions a request may be served from See https kubernetes io docs reference using api api concepts resource versions for details Defaults to unset hr resourceVersionMatch resourceVersionMatch resourceVersionMatch determines how resourceVersion is applied to list calls It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https kubernetes io docs reference using api api concepts resource versions for details Defaults to unset hr sendInitialEvents sendInitialEvents sendInitialEvents true may be set together with watch true In that case the watch stream will begin with synthetic events to produce the current state of objects in the collection Once all such events have been sent a synthetic Bookmark event will be sent The bookmark will report the ResourceVersion RV corresponding to the set of objects and be marked with k8s io initial events end true annotation Afterwards the watch stream will proceed as usual sending watch events corresponding to changes subsequent to the RV to objects watched When sendInitialEvents option is set we require resourceVersionMatch option to also be set The semantic of the watch request is as following resourceVersionMatch NotOlderThan is interpreted as data at least as new as the provided resourceVersion and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions If resourceVersion is unset this is interpreted as consistent read and the bookmark event is send when the state is synced at least to the moment when request started being processed resourceVersionMatch set to any other value or unset Invalid error is returned Defaults to true if resourceVersion or resourceVersion 0 for backward compatibility reasons and to false otherwise hr timeoutSeconds timeoutSeconds Timeout for the list watch call This limits the duration of the call regardless of any activity or inactivity hr watch watch Watch for changes to the described resources and return them as a stream of add update and remove notifications Specify resourceVersion hr |
kubernetes reference kind Status import k8s io apimachinery pkg apis meta v1 title Status Status is a return value for calls that don t return other objects apiVersion contenttype apireference apimetadata weight 12 autogenerated true | ---
api_metadata:
apiVersion: ""
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
kind: "Status"
content_type: "api_reference"
description: "Status is a return value for calls that don't return other objects."
title: "Status"
weight: 12
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.
-->
`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
Status is a return value for calls that don't return other objects.
<hr>
- **apiVersion** (string)
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **code** (int32)
Suggested HTTP return code for this status, 0 if not set.
- **details** (StatusDetails)
*Atomic: will be replaced during a merge*
Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
<a name="StatusDetails"></a>
*StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.*
- **details.causes** ([]StatusCause)
*Atomic: will be replaced during a merge*
The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
<a name="StatusCause"></a>
*StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.*
- **details.causes.field** (string)
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples:
"name" - the field "name" on the current resource
"items[0].name" - the field "name" on the first array entry in "items"
- **details.causes.message** (string)
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
- **details.causes.reason** (string)
A machine-readable description of the cause of the error. If this value is empty there is no information available.
- **details.group** (string)
The group attribute of the resource associated with the status StatusReason.
- **details.kind** (string)
The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **details.name** (string)
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
- **details.retryAfterSeconds** (int32)
If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
- **details.uid** (string)
UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- **kind** (string)
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **message** (string)
A human-readable description of the status of this operation.
- **metadata** (<a href="">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **reason** (string)
A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
- **status** (string)
Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
| kubernetes reference | api metadata apiVersion import k8s io apimachinery pkg apis meta v1 kind Status content type api reference description Status is a return value for calls that don t return other objects title Status weight 12 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 import k8s io apimachinery pkg apis meta v1 Status is a return value for calls that don t return other objects hr apiVersion string APIVersion defines the versioned schema of this representation of an object Servers should convert recognized schemas to the latest internal value and may reject unrecognized values More info https git k8s io community contributors devel sig architecture api conventions md resources code int32 Suggested HTTP return code for this status 0 if not set details StatusDetails Atomic will be replaced during a merge Extended data associated with the reason Each reason may define its own extended details This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type a name StatusDetails a StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response The Reason field of a Status object defines what attributes will be set Clients must ignore fields that do not match the defined type of each attribute and should assume that any attribute may be empty invalid or under defined details causes StatusCause Atomic will be replaced during a merge The Causes array includes more details associated with the StatusReason failure Not all StatusReasons may provide detailed causes a name StatusCause a StatusCause provides more information about an api Status failure including cases when multiple errors are encountered details causes field string The field of the resource that has caused this error as named by its JSON serialization May include dot and postfix notation for nested attributes Arrays are zero indexed Fields may appear more than once in an array of causes due to fields having multiple errors Optional Examples name the field name on the current resource items 0 name the field name on the first array entry in items details causes message string A human readable description of the cause of the error This field may be presented as is to a reader details causes reason string A machine readable description of the cause of the error If this value is empty there is no information available details group string The group attribute of the resource associated with the status StatusReason details kind string The kind attribute of the resource associated with the status StatusReason On some operations may differ from the requested resource Kind More info https git k8s io community contributors devel sig architecture api conventions md types kinds details name string The name attribute of the resource associated with the status StatusReason when there is a single name which can be described details retryAfterSeconds int32 If specified the time in seconds before the operation should be retried Some errors may indicate the client must take an alternate action for those errors this field may indicate how long to wait before taking the alternate action details uid string UID of the resource when there is a single resource which can be described More info https kubernetes io docs concepts overview working with objects names uids kind string Kind is a string value representing the REST resource this object represents Servers may infer this from the endpoint the client submits requests to Cannot be updated In CamelCase More info https git k8s io community contributors devel sig architecture api conventions md types kinds message string A human readable description of the status of this operation metadata a href ListMeta a Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds reason string A machine readable description of why this operation is in the Failure status If this value is empty there is no information available A Reason clarifies an HTTP status code but does not override it status string Status of the operation One of Success or Failure More info https git k8s io community contributors devel sig architecture api conventions md spec and status |
kubernetes reference weight 7 import k8s io apimachinery pkg apis meta v1 apiVersion contenttype apireference kind ObjectMeta apimetadata autogenerated true ObjectMeta is metadata that all persisted resources must have which includes all objects users must create title ObjectMeta | ---
api_metadata:
apiVersion: ""
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
kind: "ObjectMeta"
content_type: "api_reference"
description: "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
title: "ObjectMeta"
weight: 7
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.
-->
`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
<hr>
- **name** (string)
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- **generateName** (string)
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- **namespace** (string)
Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
- **labels** (map[string]string)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
- **annotations** (map[string]string)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
### System {#System}
- **finalizers** ([]string)
*Set: unique values will be kept during a merge*
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
- **managedFields** ([]ManagedFieldsEntry)
*Atomic: will be replaced during a merge*
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
<a name="ManagedFieldsEntry"></a>
*ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.*
- **managedFields.apiVersion** (string)
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
- **managedFields.fieldsType** (string)
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
- **managedFields.fieldsV1** (FieldsV1)
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
<a name="FieldsV1"></a>
*FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
The exact format is defined in sigs.k8s.io/structured-merge-diff*
- **managedFields.manager** (string)
Manager is an identifier of the workflow managing these fields.
- **managedFields.operation** (string)
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
- **managedFields.subresource** (string)
Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
- **managedFields.time** (Time)
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **ownerReferences** ([]OwnerReference)
*Patch strategy: merge on key `uid`*
*Map: unique values on key uid will be kept during a merge*
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
<a name="OwnerReference"></a>
*OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.*
- **ownerReferences.apiVersion** (string), required
API version of the referent.
- **ownerReferences.kind** (string), required
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **ownerReferences.name** (string), required
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- **ownerReferences.uid** (string), required
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- **ownerReferences.blockOwnerDeletion** (boolean)
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
- **ownerReferences.controller** (boolean)
If true, this reference points to the managing controller.
### Read-only {#Read-only}
- **creationTimestamp** (Time)
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **deletionGracePeriodSeconds** (int64)
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
- **deletionTimestamp** (Time)
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **generation** (int64)
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- **resourceVersion** (string)
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- **selfLink** (string)
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- **uid** (string)
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
| kubernetes reference | api metadata apiVersion import k8s io apimachinery pkg apis meta v1 kind ObjectMeta content type api reference description ObjectMeta is metadata that all persisted resources must have which includes all objects users must create title ObjectMeta weight 7 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 import k8s io apimachinery pkg apis meta v1 ObjectMeta is metadata that all persisted resources must have which includes all objects users must create hr name string Name must be unique within a namespace Is required when creating resources although some resources may allow a client to request the generation of an appropriate name automatically Name is primarily intended for creation idempotence and configuration definition Cannot be updated More info https kubernetes io docs concepts overview working with objects names names generateName string GenerateName is an optional prefix used by the server to generate a unique name ONLY IF the Name field has not been provided If this field is used the name returned to the client will be different than the name passed This value will also be combined with a unique suffix The provided value has the same validation rules as the Name field and may be truncated by the length of the suffix required to make the value unique on the server If this field is specified and the generated name exists the server will return a 409 Applied only if Name is not specified More info https git k8s io community contributors devel sig architecture api conventions md idempotency namespace string Namespace defines the space within which each name must be unique An empty namespace is equivalent to the default namespace but default is the canonical representation Not all objects are required to be scoped to a namespace the value of this field for those objects will be empty Must be a DNS LABEL Cannot be updated More info https kubernetes io docs concepts overview working with objects namespaces labels map string string Map of string keys and values that can be used to organize and categorize scope and select objects May match selectors of replication controllers and services More info https kubernetes io docs concepts overview working with objects labels annotations map string string Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata They are not queryable and should be preserved when modifying objects More info https kubernetes io docs concepts overview working with objects annotations System System finalizers string Set unique values will be kept during a merge Must be empty before the object is deleted from the registry Each entry is an identifier for the responsible component that will remove the entry from the list If the deletionTimestamp of the object is non nil entries in this list can only be removed Finalizers may be processed and removed in any order Order is NOT enforced because it introduces significant risk of stuck finalizers finalizers is a shared field any actor with permission can reorder it If the finalizer list is processed in order then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal field value external system or other produced by a component responsible for a finalizer later in the list resulting in a deadlock Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list managedFields ManagedFieldsEntry Atomic will be replaced during a merge ManagedFields maps workflow id and version to the set of fields that are managed by that workflow This is mostly for internal housekeeping and users typically shouldn t need to set or understand this field A workflow can be the user s name a controller s name or the name of a specific apply path like ci cd The set of fields is always in the version that the workflow used when modifying the object a name ManagedFieldsEntry a ManagedFieldsEntry is a workflow id a FieldSet and the group version of the resource that the fieldset applies to managedFields apiVersion string APIVersion defines the version of this resource that this field set applies to The format is group version just like the top level APIVersion field It is necessary to track the version of a field set because it cannot be automatically converted managedFields fieldsType string FieldsType is the discriminator for the different fields format and version There is currently only one possible value FieldsV1 managedFields fieldsV1 FieldsV1 FieldsV1 holds the first JSON version format as described in the FieldsV1 type a name FieldsV1 a FieldsV1 stores a set of fields in a data structure like a Trie in JSON format Each key is either a representing the field itself and will always map to an empty set or a string representing a sub field or item The string will follow one of these four formats f name where name is the name of a field in a struct or key in a map v value where value is the exact json formatted value of a list item i index where index is position of a item in a list k keys where keys is a map of a list item s key fields to their unique values If a key maps to an empty Fields value the field that key represents is part of the set The exact format is defined in sigs k8s io structured merge diff managedFields manager string Manager is an identifier of the workflow managing these fields managedFields operation string Operation is the type of operation which lead to this ManagedFieldsEntry being created The only valid values for this field are Apply and Update managedFields subresource string Subresource is the name of the subresource used to update that object or empty string if the object was updated through the main resource The value of this field is used to distinguish between managers even if they share the same name For example a status update will be distinct from a regular update using the same manager name Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource managedFields time Time Time is the timestamp of when the ManagedFields entry was added The timestamp will also be updated if a field is added the manager changes any of the owned fields value or removes a field The timestamp does not update when a field is removed from the entry because another manager took it over a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers ownerReferences OwnerReference Patch strategy merge on key uid Map unique values on key uid will be kept during a merge List of objects depended by this object If ALL objects in the list have been deleted this object will be garbage collected If this object is managed by a controller then an entry in this list will point to this controller with the controller field set to true There cannot be more than one managing controller a name OwnerReference a OwnerReference contains enough information to let you identify an owning object An owning object must be in the same namespace as the dependent or be cluster scoped so there is no namespace field ownerReferences apiVersion string required API version of the referent ownerReferences kind string required Kind of the referent More info https git k8s io community contributors devel sig architecture api conventions md types kinds ownerReferences name string required Name of the referent More info https kubernetes io docs concepts overview working with objects names names ownerReferences uid string required UID of the referent More info https kubernetes io docs concepts overview working with objects names uids ownerReferences blockOwnerDeletion boolean If true AND if the owner has the foregroundDeletion finalizer then the owner cannot be deleted from the key value store until this reference is removed See https kubernetes io docs concepts architecture garbage collection foreground deletion for how the garbage collector interacts with this field and enforces the foreground deletion Defaults to false To set this field a user needs delete permission of the owner otherwise 422 Unprocessable Entity will be returned ownerReferences controller boolean If true this reference points to the managing controller Read only Read only creationTimestamp Time CreationTimestamp is a timestamp representing the server time when this object was created It is not guaranteed to be set in happens before order across separate operations Clients may not set this value It is represented in RFC3339 form and is in UTC Populated by the system Read only Null for lists More info https git k8s io community contributors devel sig architecture api conventions md metadata a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers deletionGracePeriodSeconds int64 Number of seconds allowed for this object to gracefully terminate before it will be removed from the system Only set when deletionTimestamp is also set May only be shortened Read only deletionTimestamp Time DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted This field is set by the server when a graceful deletion is requested by the user and is not directly settable by a client The resource is expected to be deleted no longer visible from resource lists and not reachable by name after the time in this field once the finalizers list is empty As long as the finalizers list contains items deletion is blocked Once the deletionTimestamp is set this value may not be unset or be set further into the future although it may be shortened or the resource may be deleted prior to this time For example a user may request that a pod is deleted in 30 seconds The Kubelet will react by sending a graceful termination signal to the containers in the pod After that 30 seconds the Kubelet will send a hard termination signal SIGKILL to the container and after cleanup remove the pod from the API In the presence of network partitions this object may still exist after this timestamp until an administrator or automated process can determine the resource is fully terminated If not set graceful deletion of the object has not been requested Populated by the system when a graceful deletion is requested Read only More info https git k8s io community contributors devel sig architecture api conventions md metadata a name Time a Time is a wrapper around time Time which supports correct marshaling to YAML and JSON Wrappers are provided for many of the factory methods that the time package offers generation int64 A sequence number representing a specific generation of the desired state Populated by the system Read only resourceVersion string An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed May be used for optimistic concurrency change detection and the watch operation on a resource or set of resources Clients must treat these values as opaque and passed unmodified back to the server They may only be valid for a particular resource or set of resources Populated by the system Read only Value must be treated as opaque by clients and More info https git k8s io community contributors devel sig architecture api conventions md concurrency control and consistency selfLink string Deprecated selfLink is a legacy read only field that is no longer populated by the system uid string UID is the unique in time and space value for this object It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations Populated by the system Read only More info https kubernetes io docs concepts overview working with objects names uids |
kubernetes reference weight 10 title Audit Annotations namespace These annotations apply to object from API group This page serves as a reference for the audit annotations of the kubernetes io overview | ---
title: "Audit Annotations"
weight: 10
---
<!-- overview -->
This page serves as a reference for the audit annotations of the kubernetes.io
namespace. These annotations apply to `Event` object from API group
`audit.k8s.io`.
The following annotations are not used within the Kubernetes API. When you
[enable auditing](/docs/tasks/debug/debug-cluster/audit/) in your cluster,
audit event data is written using `Event` from API group `audit.k8s.io`.
The annotations apply to audit events. Audit events are different from objects in the
[Event API](/docs/reference/kubernetes-api/cluster-resources/event-v1/) (API group
`events.k8s.io`).
<!-- body -->
## k8s.io/deprecated
Example: `k8s.io/deprecated: "true"`
Value **must** be "true" or "false". The value "true" indicates that the
request used a deprecated API version.
## k8s.io/removed-release
Example: `k8s.io/removed-release: "1.22"`
Value **must** be in the format "<major>.<minor>". It is set to target the removal release
on requests made to deprecated API versions with a target removal release.
## pod-security.kubernetes.io/exempt
Example: `pod-security.kubernetes.io/exempt: namespace`
Value **must** be one of `user`, `namespace`, or `runtimeClass` which correspond to
[Pod Security Exemption](/docs/concepts/security/pod-security-admission/#exemptions)
dimensions. This annotation indicates on which dimension was based the exemption
from the PodSecurity enforcement.
## pod-security.kubernetes.io/enforce-policy
Example: `pod-security.kubernetes.io/enforce-policy: restricted:latest`
Value **must** be `privileged:<version>`, `baseline:<version>`,
`restricted:<version>` which correspond to [Pod Security
Standard](/docs/concepts/security/pod-security-standards) levels accompanied by
a version which **must** be `latest` or a valid Kubernetes version in the format
`v<MAJOR>.<MINOR>`. This annotations informs about the enforcement level that
allowed or denied the pod during PodSecurity admission.
See [Pod Security Standards](/docs/concepts/security/pod-security-standards/)
for more information.
## pod-security.kubernetes.io/audit-violations
Example: `pod-security.kubernetes.io/audit-violations: would violate
PodSecurity "restricted:latest": allowPrivilegeEscalation != false (container
"example" must set securityContext.allowPrivilegeEscalation=false), ...`
Value details an audit policy violation, it contains the
[Pod Security Standard](/docs/concepts/security/pod-security-standards/) level
that was transgressed as well as the specific policies on the fields that were
violated from the PodSecurity enforcement.
See [Pod Security Standards](/docs/concepts/security/pod-security-standards/)
for more information.
## authorization.k8s.io/decision
Example: `authorization.k8s.io/decision: "forbid"`
Value must be **forbid** or **allow**. This annotation indicates whether or not a request
was authorized in Kubernetes audit logs.
See [Auditing](/docs/tasks/debug/debug-cluster/audit/) for more information.
## authorization.k8s.io/reason
Example: `authorization.k8s.io/reason: "Human-readable reason for the decision"`
This annotation gives reason for the [decision](#authorization-k8s-io-decision) in Kubernetes audit logs.
See [Auditing](/docs/tasks/debug/debug-cluster/audit/) for more information.
## missing-san.invalid-cert.kubernetes.io/$hostname
Example: `missing-san.invalid-cert.kubernetes.io/example-svc.example-namespace.svc: "relies on a legacy Common Name field instead of the SAN extension for subject validation"`
Used by Kubernetes version v1.24 and later
This annotation indicates a webhook or aggregated API server
is using an invalid certificate that is missing `subjectAltNames`.
Support for these certificates was disabled by default in Kubernetes 1.19,
and removed in Kubernetes 1.23.
Requests to endpoints using these certificates will fail.
Services using these certificates should replace them as soon as possible
to avoid disruption when running in Kubernetes 1.23+ environments.
There's more information about this in the Go documentation:
[X.509 CommonName deprecation](https://go.dev/doc/go1.15#commonname).
## insecure-sha1.invalid-cert.kubernetes.io/$hostname
Example: `insecure-sha1.invalid-cert.kubernetes.io/example-svc.example-namespace.svc: "uses an insecure SHA-1 signature"`
Used by Kubernetes version v1.24 and later
This annotation indicates a webhook or aggregated API server
is using an insecure certificate signed with a SHA-1 hash.
Support for these insecure certificates is disabled by default in Kubernetes 1.24,
and will be removed in a future release.
Services using these certificates should replace them as soon as possible,
to ensure connections are secured properly and to avoid disruption in future releases.
There's more information about this in the Go documentation:
[Rejecting SHA-1 certificates](https://go.dev/doc/go1.18#sha1).
## validation.policy.admission.k8s.io/validation_failure
Example: `validation.policy.admission.k8s.io/validation_failure: '[{"message": "Invalid value", {"policy": "policy.example.com", {"binding": "policybinding.example.com", {"expressionIndex": "1", {"validationActions": ["Audit"]}]'`
Used by Kubernetes version v1.27 and later.
This annotation indicates that a admission policy validation evaluated to false
for an API request, or that the validation resulted in an error while the policy
was configured with `failurePolicy: Fail`.
The value of the annotation is a JSON object. The `message` in the JSON
provides the message about the validation failure.
The `policy`, `binding` and `expressionIndex` in the JSON identifies the
name of the `ValidatingAdmissionPolicy`, the name of the
`ValidatingAdmissionPolicyBinding` and the index in the policy `validations` of
the CEL expressions that failed, respectively.
The `validationActions` shows what actions were taken for this validation failure.
See [Validating Admission Policy](/docs/reference/access-authn-authz/validating-admission-policy/)
for more details about `validationActions`. | kubernetes reference | title Audit Annotations weight 10 overview This page serves as a reference for the audit annotations of the kubernetes io namespace These annotations apply to Event object from API group audit k8s io The following annotations are not used within the Kubernetes API When you enable auditing docs tasks debug debug cluster audit in your cluster audit event data is written using Event from API group audit k8s io The annotations apply to audit events Audit events are different from objects in the Event API docs reference kubernetes api cluster resources event v1 API group events k8s io body k8s io deprecated Example k8s io deprecated true Value must be true or false The value true indicates that the request used a deprecated API version k8s io removed release Example k8s io removed release 1 22 Value must be in the format major minor It is set to target the removal release on requests made to deprecated API versions with a target removal release pod security kubernetes io exempt Example pod security kubernetes io exempt namespace Value must be one of user namespace or runtimeClass which correspond to Pod Security Exemption docs concepts security pod security admission exemptions dimensions This annotation indicates on which dimension was based the exemption from the PodSecurity enforcement pod security kubernetes io enforce policy Example pod security kubernetes io enforce policy restricted latest Value must be privileged version baseline version restricted version which correspond to Pod Security Standard docs concepts security pod security standards levels accompanied by a version which must be latest or a valid Kubernetes version in the format v MAJOR MINOR This annotations informs about the enforcement level that allowed or denied the pod during PodSecurity admission See Pod Security Standards docs concepts security pod security standards for more information pod security kubernetes io audit violations Example pod security kubernetes io audit violations would violate PodSecurity restricted latest allowPrivilegeEscalation false container example must set securityContext allowPrivilegeEscalation false Value details an audit policy violation it contains the Pod Security Standard docs concepts security pod security standards level that was transgressed as well as the specific policies on the fields that were violated from the PodSecurity enforcement See Pod Security Standards docs concepts security pod security standards for more information authorization k8s io decision Example authorization k8s io decision forbid Value must be forbid or allow This annotation indicates whether or not a request was authorized in Kubernetes audit logs See Auditing docs tasks debug debug cluster audit for more information authorization k8s io reason Example authorization k8s io reason Human readable reason for the decision This annotation gives reason for the decision authorization k8s io decision in Kubernetes audit logs See Auditing docs tasks debug debug cluster audit for more information missing san invalid cert kubernetes io hostname Example missing san invalid cert kubernetes io example svc example namespace svc relies on a legacy Common Name field instead of the SAN extension for subject validation Used by Kubernetes version v1 24 and later This annotation indicates a webhook or aggregated API server is using an invalid certificate that is missing subjectAltNames Support for these certificates was disabled by default in Kubernetes 1 19 and removed in Kubernetes 1 23 Requests to endpoints using these certificates will fail Services using these certificates should replace them as soon as possible to avoid disruption when running in Kubernetes 1 23 environments There s more information about this in the Go documentation X 509 CommonName deprecation https go dev doc go1 15 commonname insecure sha1 invalid cert kubernetes io hostname Example insecure sha1 invalid cert kubernetes io example svc example namespace svc uses an insecure SHA 1 signature Used by Kubernetes version v1 24 and later This annotation indicates a webhook or aggregated API server is using an insecure certificate signed with a SHA 1 hash Support for these insecure certificates is disabled by default in Kubernetes 1 24 and will be removed in a future release Services using these certificates should replace them as soon as possible to ensure connections are secured properly and to avoid disruption in future releases There s more information about this in the Go documentation Rejecting SHA 1 certificates https go dev doc go1 18 sha1 validation policy admission k8s io validation failure Example validation policy admission k8s io validation failure message Invalid value policy policy example com binding policybinding example com expressionIndex 1 validationActions Audit Used by Kubernetes version v1 27 and later This annotation indicates that a admission policy validation evaluated to false for an API request or that the validation resulted in an error while the policy was configured with failurePolicy Fail The value of the annotation is a JSON object The message in the JSON provides the message about the validation failure The policy binding and expressionIndex in the JSON identifies the name of the ValidatingAdmissionPolicy the name of the ValidatingAdmissionPolicyBinding and the index in the policy validations of the CEL expressions that failed respectively The validationActions shows what actions were taken for this validation failure See Validating Admission Policy docs reference access authn authz validating admission policy for more details about validationActions |
kubernetes reference name reference anchor labels annotations and taints used on api objects title Well Known Labels Annotations and Taints weight 30 contenttype concept weight 40 card nolist true anchors | ---
title: Well-Known Labels, Annotations and Taints
content_type: concept
weight: 40
no_list: true
card:
name: reference
weight: 30
anchors:
- anchor: "#labels-annotations-and-taints-used-on-api-objects"
title: Labels, annotations and taints
---
<!-- overview -->
Kubernetes reserves all labels, annotations and taints in the `kubernetes.io` and `k8s.io` namespaces.
This document serves both as a reference to the values and as a coordination point for assigning values.
<!-- body -->
## Labels, annotations and taints used on API objects
### apf.kubernetes.io/autoupdate-spec
Type: Annotation
Example: `apf.kubernetes.io/autoupdate-spec: "true"`
Used on: [`FlowSchema` and `PriorityLevelConfiguration` Objects](/docs/concepts/cluster-administration/flow-control/#defaults)
If this annotation is set to true on a FlowSchema or PriorityLevelConfiguration, the `spec` for that object
is managed by the kube-apiserver. If the API server does not recognize an APF object, and you annotate it
for automatic update, the API server deletes the entire object. Otherwise, the API server does not manage the
object spec.
For more details, read [Maintenance of the Mandatory and Suggested Configuration Objects](/docs/concepts/cluster-administration/flow-control/#maintenance-of-the-mandatory-and-suggested-configuration-objects).
### app.kubernetes.io/component
Type: Label
Example: `app.kubernetes.io/component: "database"`
Used on: All Objects (typically used on [workload resources](/docs/reference/kubernetes-api/workload-resources/)).
The component within the application architecture.
One of the [recommended labels](/docs/concepts/overview/working-with-objects/common-labels/#labels).
### app.kubernetes.io/created-by (deprecated)
Type: Label
Example: `app.kubernetes.io/created-by: "controller-manager"`
Used on: All Objects (typically used on [workload resources](/docs/reference/kubernetes-api/workload-resources/)).
The controller/user who created this resource.
Starting from v1.9, this label is deprecated.
### app.kubernetes.io/instance
Type: Label
Example: `app.kubernetes.io/instance: "mysql-abcxyz"`
Used on: All Objects (typically used on
[workload resources](/docs/reference/kubernetes-api/workload-resources/)).
A unique name identifying the instance of an application.
To assign a non-unique name, use [app.kubernetes.io/name](#app-kubernetes-io-name).
One of the [recommended labels](/docs/concepts/overview/working-with-objects/common-labels/#labels).
### app.kubernetes.io/managed-by
Type: Label
Example: `app.kubernetes.io/managed-by: "helm"`
Used on: All Objects (typically used on
[workload resources](/docs/reference/kubernetes-api/workload-resources/)).
The tool being used to manage the operation of an application.
One of the [recommended labels](/docs/concepts/overview/working-with-objects/common-labels/#labels).
### app.kubernetes.io/name
Type: Label
Example: `app.kubernetes.io/name: "mysql"`
Used on: All Objects (typically used on
[workload resources](/docs/reference/kubernetes-api/workload-resources/)).
The name of the application.
One of the [recommended labels](/docs/concepts/overview/working-with-objects/common-labels/#labels).
### app.kubernetes.io/part-of
Type: Label
Example: `app.kubernetes.io/part-of: "wordpress"`
Used on: All Objects (typically used on
[workload resources](/docs/reference/kubernetes-api/workload-resources/)).
The name of a higher-level application this object is part of.
One of the [recommended labels](/docs/concepts/overview/working-with-objects/common-labels/#labels).
### app.kubernetes.io/version
Type: Label
Example: `app.kubernetes.io/version: "5.7.21"`
Used on: All Objects (typically used on
[workload resources](/docs/reference/kubernetes-api/workload-resources/)).
The current version of the application.
Common forms of values include:
- [semantic version](https://semver.org/spec/v1.0.0.html)
- the Git [revision hash](https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection#_single_revisions)
for the source code.
One of the [recommended labels](/docs/concepts/overview/working-with-objects/common-labels/#labels).
### applyset.kubernetes.io/additional-namespaces (alpha) {#applyset-kubernetes-io-additional-namespaces}
Type: Annotation
Example: `applyset.kubernetes.io/additional-namespaces: "namespace1,namespace2"`
Used on: Objects being used as ApplySet parents.
Use of this annotation is Alpha.
For Kubernetes version , you can use this annotation on Secrets,
ConfigMaps, or custom resources if the
defining them has the `applyset.kubernetes.io/is-parent-type` label.
Part of the specification used to implement
[ApplySet-based pruning in kubectl](/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune).
This annotation is applied to the parent object used to track an ApplySet to extend the scope of
the ApplySet beyond the parent object's own namespace (if any).
The value is a comma-separated list of the names of namespaces other than the parent's namespace
in which objects are found.
### applyset.kubernetes.io/contains-group-kinds (alpha) {#applyset-kubernetes-io-contains-group-kinds}
Type: Annotation
Example: `applyset.kubernetes.io/contains-group-kinds: "certificates.cert-manager.io,configmaps,deployments.apps,secrets,services"`
Used on: Objects being used as ApplySet parents.
Use of this annotation is Alpha.
For Kubernetes version , you can use this annotation on Secrets, ConfigMaps,
or custom resources if the CustomResourceDefinition
defining them has the `applyset.kubernetes.io/is-parent-type` label.
Part of the specification used to implement
[ApplySet-based pruning in kubectl](/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune).
This annotation is applied to the parent object used to track an ApplySet to optimize listing of
ApplySet member objects. It is optional in the ApplySet specification, as tools can perform discovery
or use a different optimization. However, as of Kubernetes version ,
it is required by kubectl. When present, the value of this annotation must be a comma separated list
of the group-kinds, in the fully-qualified name format, i.e. `<resource>.<group>`.
### applyset.kubernetes.io/contains-group-resources (deprecated) {#applyset-kubernetes-io-contains-group-resources}
Type: Annotation
Example: `applyset.kubernetes.io/contains-group-resources: "certificates.cert-manager.io,configmaps,deployments.apps,secrets,services"`
Used on: Objects being used as ApplySet parents.
For Kubernetes version , you can use this annotation on Secrets, ConfigMaps,
or custom resources if the CustomResourceDefinition
defining them has the `applyset.kubernetes.io/is-parent-type` label.
Part of the specification used to implement
[ApplySet-based pruning in kubectl](/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune).
This annotation is applied to the parent object used to track an ApplySet to optimize listing of
ApplySet member objects. It is optional in the ApplySet specification, as tools can perform discovery
or use a different optimization. However, in Kubernetes version ,
it is required by kubectl. When present, the value of this annotation must be a comma separated list
of the group-kinds, in the fully-qualified name format, i.e. `<resource>.<group>`.
This annotation is currently deprecated and replaced by [`applyset.kubernetes.io/contains-group-kinds`](#applyset-kubernetes-io-contains-group-kinds),
support for this will be removed in applyset beta or GA.
### applyset.kubernetes.io/id (alpha) {#applyset-kubernetes-io-id}
Type: Label
Example: `applyset.kubernetes.io/id: "applyset-0eFHV8ySqp7XoShsGvyWFQD3s96yqwHmzc4e0HR1dsY-v1"`
Used on: Objects being used as ApplySet parents.
Use of this label is Alpha.
For Kubernetes version , you can use this label on Secrets, ConfigMaps,
or custom resources if the CustomResourceDefinition
defining them has the `applyset.kubernetes.io/is-parent-type` label.
Part of the specification used to implement
[ApplySet-based pruning in kubectl](/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune).
This label is what makes an object an ApplySet parent object.
Its value is the unique ID of the ApplySet, which is derived from the identity of the parent
object itself. This ID **must** be the base64 encoding (using the URL safe encoding of RFC4648) of
the hash of the group-kind-name-namespace of the object it is on, in the form:
`<base64(sha256(<name>.<namespace>.<kind>.<group>))>`.
There is no relation between the value of this label and object UID.
### applyset.kubernetes.io/is-parent-type (alpha) {#applyset-kubernetes-io-is-parent-type}
Type: Label
Example: `applyset.kubernetes.io/is-parent-type: "true"`
Used on: Custom Resource Definition (CRD)
Use of this label is Alpha.
Part of the specification used to implement
[ApplySet-based pruning in kubectl](/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune).
You can set this label on a CustomResourceDefinition (CRD) to identify the custom resource type it
defines (not the CRD itself) as an allowed parent for an ApplySet.
The only permitted value for this label is `"true"`; if you want to mark a CRD as
not being a valid parent for ApplySets, omit this label.
### applyset.kubernetes.io/part-of (alpha) {#applyset-kubernetes-io-part-of}
Type: Label
Example: `applyset.kubernetes.io/part-of: "applyset-0eFHV8ySqp7XoShsGvyWFQD3s96yqwHmzc4e0HR1dsY-v1"`
Used on: All objects.
Use of this label is Alpha.
Part of the specification used to implement
[ApplySet-based pruning in kubectl](/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune).
This label is what makes an object a member of an ApplySet.
The value of the label **must** match the value of the `applyset.kubernetes.io/id`
label on the parent object.
### applyset.kubernetes.io/tooling (alpha) {#applyset-kubernetes-io-tooling}
Type: Annotation
Example: `applyset.kubernetes.io/tooling: "kubectl/v"`
Used on: Objects being used as ApplySet parents.
Use of this annotation is Alpha.
For Kubernetes version , you can use this annotation on Secrets,
ConfigMaps, or custom resources if the CustomResourceDefinitiondefining them has the
`applyset.kubernetes.io/is-parent-type` label.
Part of the specification used to implement
[ApplySet-based pruning in kubectl](/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune).
This annotation is applied to the parent object used to track an ApplySet to indicate which
tooling manages that ApplySet. Tooling should refuse to mutate ApplySets belonging to other tools.
The value must be in the format `<toolname>/<semver>`.
### apps.kubernetes.io/pod-index (beta) {#apps-kubernetes.io-pod-index}
Type: Label
Example: `apps.kubernetes.io/pod-index: "0"`
Used on: Pod
When a StatefulSet controller creates a Pod for the StatefulSet, it sets this label on that Pod.
The value of the label is the ordinal index of the pod being created.
See [Pod Index Label](/docs/concepts/workloads/controllers/statefulset/#pod-index-label)
in the StatefulSet topic for more details.
Note the [PodIndexLabel](/docs/reference/command-line-tools-reference/feature-gates/)
feature gate must be enabled for this label to be added to pods.
### resource.kubernetes.io/pod-claim-name
Type: Annotation
Example: `resource.kubernetes.io/pod-claim-name: "my-pod-claim"`
Used on: ResourceClaim
This annotation is assigned to generated ResourceClaims.
Its value corresponds to the name of the resource claim in the `.spec` of any Pod(s) for which the ResourceClaim was created.
This annotation is an internal implementation detail of [dynamic resource allocation](/docs/concepts/scheduling-eviction/dynamic-resource-allocation/).
You should not need to read or modify the value of this annotation.
### cluster-autoscaler.kubernetes.io/safe-to-evict
Type: Annotation
Example: `cluster-autoscaler.kubernetes.io/safe-to-evict: "true"`
Used on: Pod
When this annotation is set to `"true"`, the cluster autoscaler is allowed to evict a Pod
even if other rules would normally prevent that.
The cluster autoscaler never evicts Pods that have this annotation explicitly set to
`"false"`; you could set that on an important Pod that you want to keep running.
If this annotation is not set then the cluster autoscaler follows its Pod-level behavior.
### config.kubernetes.io/local-config
Type: Annotation
Example: `config.kubernetes.io/local-config: "true"`
Used on: All objects
This annotation is used in manifests to mark an object as local configuration that
should not be submitted to the Kubernetes API.
A value of `"true"` for this annotation declares that the object is only consumed by
client-side tooling and should not be submitted to the API server.
A value of `"false"` can be used to declare that the object should be submitted to
the API server even when it would otherwise be assumed to be local.
This annotation is part of the Kubernetes Resource Model (KRM) Functions Specification,
which is used by Kustomize and similar third-party tools.
For example, Kustomize removes objects with this annotation from its final build output.
### container.apparmor.security.beta.kubernetes.io/* (deprecated) {#container-apparmor-security-beta-kubernetes-io}
Type: Annotation
Example: `container.apparmor.security.beta.kubernetes.io/my-container: my-custom-profile`
Used on: Pods
This annotation allows you to specify the AppArmor security profile for a container within a
Kubernetes pod. As of Kubernetes v1.30, this should be set with the `appArmorProfile` field instead.
To learn more, see the [AppArmor](/docs/tutorials/security/apparmor/) tutorial.
The tutorial illustrates using AppArmor to restrict a container's abilities and access.
The profile specified dictates the set of rules and restrictions that the containerized process must
adhere to. This helps enforce security policies and isolation for your containers.
### internal.config.kubernetes.io/* (reserved prefix) {#internal.config.kubernetes.io-reserved-wildcard}
Type: Annotation
Used on: All objects
This prefix is reserved for internal use by tools that act as orchestrators in accordance
with the Kubernetes Resource Model (KRM) Functions Specification.
Annotations with this prefix are internal to the orchestration process and are not persisted to
the manifests on the filesystem. In other words, the orchestrator tool should set these
annotations when reading files from the local filesystem and remove them when writing the output
of functions back to the filesystem.
A KRM function **must not** modify annotations with this prefix, unless otherwise specified for a
given annotation. This enables orchestrator tools to add additional internal annotations, without
requiring changes to existing functions.
### internal.config.kubernetes.io/path
Type: Annotation
Example: `internal.config.kubernetes.io/path: "relative/file/path.yaml"`
Used on: All objects
This annotation records the slash-delimited, OS-agnostic, relative path to the manifest file the
object was loaded from. The path is relative to a fixed location on the filesystem, determined by
the orchestrator tool.
This annotation is part of the Kubernetes Resource Model (KRM) Functions Specification, which is
used by Kustomize and similar third-party tools.
A KRM Function **should not** modify this annotation on input objects unless it is modifying the
referenced files. A KRM Function **may** include this annotation on objects it generates.
### internal.config.kubernetes.io/index
Type: Annotation
Example: `internal.config.kubernetes.io/index: "2"`
Used on: All objects
This annotation records the zero-indexed position of the YAML document that contains the object
within the manifest file the object was loaded from. Note that YAML documents are separated by
three dashes (`---`) and can each contain one object. When this annotation is not specified, a
value of 0 is implied.
This annotation is part of the Kubernetes Resource Model (KRM) Functions Specification,
which is used by Kustomize and similar third-party tools.
A KRM Function **should not** modify this annotation on input objects unless it is modifying the
referenced files. A KRM Function **may** include this annotation on objects it generates.
### kube-scheduler-simulator.sigs.k8s.io/bind-result
Type: Annotation
Example: `kube-scheduler-simulator.sigs.k8s.io/bind-result: '{"DefaultBinder":"success"}'`
Used on: Pod
This annotation records the result of bind scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/filter-result
Type: Annotation
Example:
```yaml
kube-scheduler-simulator.sigs.k8s.io/filter-result: >-
{"node-282x7":{"AzureDiskLimits":"passed","EBSLimits":"passed","GCEPDLimits":"passed","InterPodAffinity":"passed","NodeAffinity":"passed","NodeName":"passed","NodePorts":"passed","NodeResourcesFit":"passed","NodeUnschedulable":"passed","NodeVolumeLimits":"passed","PodTopologySpread":"passed","TaintToleration":"passed","VolumeBinding":"passed","VolumeRestrictions":"passed","VolumeZone":"passed"},"node-gp9t4":{"AzureDiskLimits":"passed","EBSLimits":"passed","GCEPDLimits":"passed","InterPodAffinity":"passed","NodeAffinity":"passed","NodeName":"passed","NodePorts":"passed","NodeResourcesFit":"passed","NodeUnschedulable":"passed","NodeVolumeLimits":"passed","PodTopologySpread":"passed","TaintToleration":"passed","VolumeBinding":"passed","VolumeRestrictions":"passed","VolumeZone":"passed"}}
```
Used on: Pod
This annotation records the result of filter scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/finalscore-result
Type: Annotation
Example:
```yaml
kube-scheduler-simulator.sigs.k8s.io/finalscore-result: >-
{"node-282x7":{"ImageLocality":"0","InterPodAffinity":"0","NodeAffinity":"0","NodeNumber":"0","NodeResourcesBalancedAllocation":"76","NodeResourcesFit":"73","PodTopologySpread":"200","TaintToleration":"300","VolumeBinding":"0"},"node-gp9t4":{"ImageLocality":"0","InterPodAffinity":"0","NodeAffinity":"0","NodeNumber":"0","NodeResourcesBalancedAllocation":"76","NodeResourcesFit":"73","PodTopologySpread":"200","TaintToleration":"300","VolumeBinding":"0"}}
```
Used on: Pod
This annotation records the final scores that the scheduler calculates from the scores from score scheduler plugins,
used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/permit-result
Type: Annotation
Example: `kube-scheduler-simulator.sigs.k8s.io/permit-result: '{"CustomPermitPlugin":"success"}'`
Used on: Pod
This annotation records the result of permit scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/permit-result-timeout
Type: Annotation
Example: `kube-scheduler-simulator.sigs.k8s.io/permit-result-timeout: '{"CustomPermitPlugin":"10s"}'`
Used on: Pod
This annotation records the timeouts returned from permit scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/postfilter-result
Type: Annotation
Example: `kube-scheduler-simulator.sigs.k8s.io/postfilter-result: '{"DefaultPreemption":"success"}'`
Used on: Pod
This annotation records the result of postfilter scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/prebind-result
Type: Annotation
Example: `kube-scheduler-simulator.sigs.k8s.io/prebind-result: '{"VolumeBinding":"success"}'`
Used on: Pod
This annotation records the result of prebind scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/prefilter-result
Type: Annotation
Example: `kube-scheduler-simulator.sigs.k8s.io/prebind-result: '{"NodeAffinity":"[\"node-\a"]"}'`
Used on: Pod
This annotation records the PreFilter result of prefilter scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/prefilter-result-status
Type: Annotation
Example:
```yaml
kube-scheduler-simulator.sigs.k8s.io/prefilter-result-status: >-
{"InterPodAffinity":"success","NodeAffinity":"success","NodePorts":"success","NodeResourcesFit":"success","PodTopologySpread":"success","VolumeBinding":"success","VolumeRestrictions":"success"}
```
Used on: Pod
This annotation records the result of prefilter scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/prescore-result
Type: Annotation
Example:
```yaml
kube-scheduler-simulator.sigs.k8s.io/prescore-result: >-
{"InterPodAffinity":"success","NodeAffinity":"success","NodeNumber":"success","PodTopologySpread":"success","TaintToleration":"success"}
```
Used on: Pod
This annotation records the result of prefilter scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/reserve-result
Type: Annotation
Example: `kube-scheduler-simulator.sigs.k8s.io/reserve-result: '{"VolumeBinding":"success"}'`
Used on: Pod
This annotation records the result of reserve scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/result-history
Type: Annotation
Example: `kube-scheduler-simulator.sigs.k8s.io/result-history: '[]'`
Used on: Pod
This annotation records all the past scheduling results from scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/score-result
Type: Annotation
```yaml
kube-scheduler-simulator.sigs.k8s.io/score-result: >-
{"node-282x7":{"ImageLocality":"0","InterPodAffinity":"0","NodeAffinity":"0","NodeNumber":"0","NodeResourcesBalancedAllocation":"76","NodeResourcesFit":"73","PodTopologySpread":"0","TaintToleration":"0","VolumeBinding":"0"},"node-gp9t4":{"ImageLocality":"0","InterPodAffinity":"0","NodeAffinity":"0","NodeNumber":"0","NodeResourcesBalancedAllocation":"76","NodeResourcesFit":"73","PodTopologySpread":"0","TaintToleration":"0","VolumeBinding":"0"}}
```
Used on: Pod
This annotation records the result of score scheduler plugins, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kube-scheduler-simulator.sigs.k8s.io/selected-node
Type: Annotation
Example: `kube-scheduler-simulator.sigs.k8s.io/selected-node: node-282x7`
Used on: Pod
This annotation records the node that is selected by the scheduling cycle, used by https://sigs.k8s.io/kube-scheduler-simulator.
### kubernetes.io/arch
Type: Label
Example: `kubernetes.io/arch: "amd64"`
Used on: Node
The Kubelet populates this with `runtime.GOARCH` as defined by Go.
This can be handy if you are mixing ARM and x86 nodes.
### kubernetes.io/os
Type: Label
Example: `kubernetes.io/os: "linux"`
Used on: Node, Pod
For nodes, the kubelet populates this with `runtime.GOOS` as defined by Go. This can be handy if you are
mixing operating systems in your cluster (for example: mixing Linux and Windows nodes).
You can also set this label on a Pod. Kubernetes allows you to set any value for this label;
if you use this label, you should nevertheless set it to the Go `runtime.GOOS` string for the operating
system that this Pod actually works with.
When the `kubernetes.io/os` label value for a Pod does not match the label value on a Node,
the kubelet on the node will not admit the Pod. However, this is not taken into account by
the kube-scheduler. Alternatively, the kubelet refuses to run a Pod where you have specified a Pod OS, if
this isn't the same as the operating system for the node where that kubelet is running. Just
look for [Pods OS](/docs/concepts/workloads/pods/#pod-os) for more details.
### kubernetes.io/metadata.name
Type: Label
Example: `kubernetes.io/metadata.name: "mynamespace"`
Used on: Namespaces
The Kubernetes API server (part of the )
sets this label on all namespaces. The label value is set
to the name of the namespace. You can't change this label's value.
This is useful if you want to target a specific namespace with a label
.
### kubernetes.io/limit-ranger
Type: Annotation
Example: `kubernetes.io/limit-ranger: "LimitRanger plugin set: cpu, memory request for container nginx; cpu, memory limit for container nginx"`
Used on: Pod
Kubernetes by default doesn't provide any resource limit, that means unless you explicitly define
limits, your container can consume unlimited CPU and memory.
You can define a default request or default limit for pods. You do this by creating a LimitRange
in the relevant namespace. Pods deployed after you define a LimitRange will have these limits
applied to them.
The annotation `kubernetes.io/limit-ranger` records that resource defaults were specified for the Pod,
and they were applied successfully.
For more details, read about [LimitRanges](/docs/concepts/policy/limit-range).
### kubernetes.io/config.hash
Type: Annotation
Example: `kubernetes.io/config.hash: "df7cc47f8477b6b1226d7d23a904867b"`
Used on: Pod
When the kubelet creates a static Pod based on a given manifest, it attaches this annotation
to the static Pod. The value of the annotation is the UID of the Pod.
Note that the kubelet also sets the `.spec.nodeName` to the current node name as if the Pod
was scheduled to the node.
### kubernetes.io/config.mirror
Type: Annotation
Example: `kubernetes.io/config.mirror: "df7cc47f8477b6b1226d7d23a904867b"`
Used on: Pod
For a static Pod created by the kubelet on a node, a
is created on the API server. The kubelet adds an annotation to indicate that this Pod is
actually a mirror Pod. The annotation value is copied from the [`kubernetes.io/config.hash`](#kubernetes-io-config-hash)
annotation, which is the UID of the Pod.
When updating a Pod with this annotation set, the annotation cannot be changed or removed.
If a Pod doesn't have this annotation, it cannot be added during a Pod update.
### kubernetes.io/config.source
Type: Annotation
Example: `kubernetes.io/config.source: "file"`
Used on: Pod
This annotation is added by the kubelet to indicate where the Pod comes from.
For static Pods, the annotation value could be one of `file` or `http` depending
on where the Pod manifest is located. For a Pod created on the API server and then
scheduled to the current node, the annotation value is `api`.
### kubernetes.io/config.seen
Type: Annotation
Example: `kubernetes.io/config.seen: "2023-10-27T04:04:56.011314488Z"`
Used on: Pod
When the kubelet sees a Pod for the first time, it may add this annotation to
the Pod with a value of current timestamp in the RFC3339 format.
### addonmanager.kubernetes.io/mode
Type: Label
Example: `addonmanager.kubernetes.io/mode: "Reconcile"`
Used on: All objects
To specify how an add-on should be managed, you can use the `addonmanager.kubernetes.io/mode` label.
This label can have one of three values: `Reconcile`, `EnsureExists`, or `Ignore`.
- `Reconcile`: Addon resources will be periodically reconciled with the expected state.
If there are any differences, the add-on manager will recreate, reconfigure or delete
the resources as needed. This is the default mode if no label is specified.
- `EnsureExists`: Addon resources will be checked for existence only but will not be modified
after creation. The add-on manager will create or re-create the resources when there is
no instance of the resource with that name.
- `Ignore`: Addon resources will be ignored. This mode is useful for add-ons that are not
compatible with the add-on manager or that are managed by another controller.
For more details, see [Addon-manager](https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/addon-manager/README.md).
### beta.kubernetes.io/arch (deprecated)
Type: Label
This label has been deprecated. Please use [`kubernetes.io/arch`](#kubernetes-io-arch) instead.
### beta.kubernetes.io/os (deprecated)
Type: Label
This label has been deprecated. Please use [`kubernetes.io/os`](#kubernetes-io-os) instead.
### kube-aggregator.kubernetes.io/automanaged {#kube-aggregator-kubernetesio-automanaged}
Type: Label
Example: `kube-aggregator.kubernetes.io/automanaged: "onstart"`
Used on: APIService
The `kube-apiserver` sets this label on any APIService object that the API server
has created automatically. The label marks how the control plane should manage that
APIService. You should not add, modify, or remove this label by yourself.
Automanaged APIService objects are deleted by kube-apiserver when it has no built-in
or custom resource API corresponding to the API group/version of the APIService.
There are two possible values:
- `onstart`: The APIService should be reconciled when an API server starts up, but not otherwise.
- `true`: The API server should reconcile this APIService continuously.
### service.alpha.kubernetes.io/tolerate-unready-endpoints (deprecated)
Type: Annotation
Used on: StatefulSet
This annotation on a Service denotes if the Endpoints controller should go ahead and create
Endpoints for unready Pods. Endpoints of these Services retain their DNS records and continue
receiving traffic for the Service from the moment the kubelet starts all containers in the pod
and marks it _Running_, til the kubelet stops all containers and deletes the pod from
the API server.
### autoscaling.alpha.kubernetes.io/behavior (deprecated) {#autoscaling-alpha-kubernetes-io-behavior}
Type: Annotation
Used on: HorizontalPodAutoscaler
This annotation was used to configure the scaling behavior for a HorizontalPodAutoscaler (HPA) in earlier Kubernetes versions.
It allowed you to specify how the HPA should scale pods up or down, including setting stabilization windows and scaling policies.
Setting this annotation has no effect in any supported release of Kubernetes.
### kubernetes.io/hostname {#kubernetesiohostname}
Type: Label
Example: `kubernetes.io/hostname: "ip-172-20-114-199.ec2.internal"`
Used on: Node
The Kubelet populates this label with the hostname of the node. Note that the hostname
can be changed from the "actual" hostname by passing the `--hostname-override` flag to
the `kubelet`.
This label is also used as part of the topology hierarchy.
See [topology.kubernetes.io/zone](#topologykubernetesiozone) for more information.
### kubernetes.io/change-cause {#change-cause}
Type: Annotation
Example: `kubernetes.io/change-cause: "kubectl edit --record deployment foo"`
Used on: All Objects
This annotation is a best guess at why something was changed.
It is populated when adding `--record` to a `kubectl` command that may change an object.
### kubernetes.io/description {#description}
Type: Annotation
Example: `kubernetes.io/description: "Description of K8s object."`
Used on: All Objects
This annotation is used for describing specific behaviour of given object.
### kubernetes.io/enforce-mountable-secrets {#enforce-mountable-secrets}
Type: Annotation
Example: `kubernetes.io/enforce-mountable-secrets: "true"`
Used on: ServiceAccount
The value for this annotation must be **true** to take effect.
When you set this annotation to "true", Kubernetes enforces the following rules for
Pods running as this ServiceAccount:
1. Secrets mounted as volumes must be listed in the ServiceAccount's `secrets` field.
1. Secrets referenced in `envFrom` for containers (including sidecar containers and init containers)
must also be listed in the ServiceAccount's secrets field.
If any container in a Pod references a Secret not listed in the ServiceAccount's `secrets` field
(and even if the reference is marked as `optional`), then the Pod will fail to start,
and an error indicating the non-compliant secret reference will be generated.
1. Secrets referenced in a Pod's `imagePullSecrets` must be present in the
ServiceAccount's `imagePullSecrets` field, the Pod will fail to start,
and an error indicating the non-compliant image pull secret reference will be generated.
When you create or update a Pod, these rules are checked. If a Pod doesn't follow them, it won't start and you'll see an error message.
If a Pod is already running and you change the `kubernetes.io/enforce-mountable-secrets` annotation
to true, or you edit the associated ServiceAccount to remove the reference to a Secret
that the Pod is already using, the Pod continues to run.
### node.kubernetes.io/exclude-from-external-load-balancers
Type: Label
Example: `node.kubernetes.io/exclude-from-external-load-balancers`
Used on: Node
You can add labels to particular worker nodes to exclude them from the list of backend servers used by external load balancers.
The following command can be used to exclude a worker node from the list of backend servers in a
backend set:
```shell
kubectl label nodes <node-name> node.kubernetes.io/exclude-from-external-load-balancers=true
```
### controller.kubernetes.io/pod-deletion-cost {#pod-deletion-cost}
Type: Annotation
Example: `controller.kubernetes.io/pod-deletion-cost: "10"`
Used on: Pod
This annotation is used to set [Pod Deletion Cost](/docs/concepts/workloads/controllers/replicaset/#pod-deletion-cost)
which allows users to influence ReplicaSet downscaling order.
The annotation value parses into an `int32` type.
### cluster-autoscaler.kubernetes.io/enable-ds-eviction
Type: Annotation
Example: `cluster-autoscaler.kubernetes.io/enable-ds-eviction: "true"`
Used on: Pod
This annotation controls whether a DaemonSet pod should be evicted by a ClusterAutoscaler.
This annotation needs to be specified on DaemonSet pods in a DaemonSet manifest.
When this annotation is set to `"true"`, the ClusterAutoscaler is allowed to evict
a DaemonSet Pod, even if other rules would normally prevent that.
To disallow the ClusterAutoscaler from evicting DaemonSet pods,
you can set this annotation to `"false"` for important DaemonSet pods.
If this annotation is not set, then the ClusterAutoscaler follows its overall behavior
(i.e evict the DaemonSets based on its configuration).
This annotation only impacts DaemonSet Pods.
### kubernetes.io/ingress-bandwidth
Type: Annotation
Example: `kubernetes.io/ingress-bandwidth: 10M`
Used on: Pod
You can apply quality-of-service traffic shaping to a pod and effectively limit its available
bandwidth. Ingress traffic to a Pod is handled by shaping queued packets to effectively
handle data. To limit the bandwidth on a Pod, write an object definition JSON file and specify
the data traffic speed using `kubernetes.io/ingress-bandwidth` annotation. The unit used for
specifying ingress rate is bits per second, as a
[Quantity](/docs/reference/kubernetes-api/common-definitions/quantity/).
For example, `10M` means 10 megabits per second.
Ingress traffic shaping annotation is an experimental feature.
If you want to enable traffic shaping support, you must add the `bandwidth` plugin to your CNI
configuration file (default `/etc/cni/net.d`) and ensure that the binary is included in your CNI
bin dir (default `/opt/cni/bin`).
### kubernetes.io/egress-bandwidth
Type: Annotation
Example: `kubernetes.io/egress-bandwidth: 10M`
Used on: Pod
Egress traffic from a Pod is handled by policing, which simply drops packets in excess of the
configured rate. The limits you place on a Pod do not affect the bandwidth of other Pods.
To limit the bandwidth on a Pod, write an object definition JSON file and specify the data traffic
speed using `kubernetes.io/egress-bandwidth` annotation. The unit used for specifying egress rate
is bits per second, as a [Quantity](/docs/reference/kubernetes-api/common-definitions/quantity/).
For example, `10M` means 10 megabits per second.
Egress traffic shaping annotation is an experimental feature.
If you want to enable traffic shaping support, you must add the `bandwidth` plugin to your CNI
configuration file (default `/etc/cni/net.d`) and ensure that the binary is included in your CNI
bin dir (default `/opt/cni/bin`).
### beta.kubernetes.io/instance-type (deprecated)
Type: Label
Starting in v1.17, this label is deprecated in favor of
[node.kubernetes.io/instance-type](#nodekubernetesioinstance-type).
### node.kubernetes.io/instance-type {#nodekubernetesioinstance-type}
Type: Label
Example: `node.kubernetes.io/instance-type: "m3.medium"`
Used on: Node
The Kubelet populates this with the instance type as defined by the cloud provider.
This will be set only if you are using a cloud provider. This setting is handy
if you want to target certain workloads to certain instance types, but typically you want
to rely on the Kubernetes scheduler to perform resource-based scheduling.
You should aim to schedule based on properties rather than on instance types
(for example: require a GPU, instead of requiring a `g2.2xlarge`).
### failure-domain.beta.kubernetes.io/region (deprecated) {#failure-domainbetakubernetesioregion}
Type: Label
Starting in v1.17, this label is deprecated in favor of
[topology.kubernetes.io/region](#topologykubernetesioregion).
### failure-domain.beta.kubernetes.io/zone (deprecated) {#failure-domainbetakubernetesiozone}
Type: Label
Starting in v1.17, this label is deprecated in favor of
[topology.kubernetes.io/zone](#topologykubernetesiozone).
### pv.kubernetes.io/bind-completed {#pv-kubernetesiobind-completed}
Type: Annotation
Example: `pv.kubernetes.io/bind-completed: "yes"`
Used on: PersistentVolumeClaim
When this annotation is set on a PersistentVolumeClaim (PVC), that indicates that the lifecycle
of the PVC has passed through initial binding setup. When present, that information changes
how the control plane interprets the state of PVC objects.
The value of this annotation does not matter to Kubernetes.
### pv.kubernetes.io/bound-by-controller {#pv-kubernetesioboundby-controller}
Type: Annotation
Example: `pv.kubernetes.io/bound-by-controller: "yes"`
Used on: PersistentVolume, PersistentVolumeClaim
If this annotation is set on a PersistentVolume or PersistentVolumeClaim, it indicates that a
storage binding (PersistentVolume → PersistentVolumeClaim, or PersistentVolumeClaim → PersistentVolume)
was installed by the .
If the annotation isn't set, and there is a storage binding in place, the absence of that
annotation means that the binding was done manually.
The value of this annotation does not matter.
### pv.kubernetes.io/provisioned-by {#pv-kubernetesiodynamically-provisioned}
Type: Annotation
Example: `pv.kubernetes.io/provisioned-by: "kubernetes.io/rbd"`
Used on: PersistentVolume
This annotation is added to a PersistentVolume(PV) that has been dynamically provisioned by Kubernetes.
Its value is the name of volume plugin that created the volume. It serves both users (to show where a PV
comes from) and Kubernetes (to recognize dynamically provisioned PVs in its decisions).
### pv.kubernetes.io/migrated-to {#pv-kubernetesio-migratedto}
Type: Annotation
Example: `pv.kubernetes.io/migrated-to: pd.csi.storage.gke.io`
Used on: PersistentVolume, PersistentVolumeClaim
It is added to a PersistentVolume(PV) and PersistentVolumeClaim(PVC) that is supposed to be
dynamically provisioned/deleted by its corresponding CSI driver through the `CSIMigration` feature gate.
When this annotation is set, the Kubernetes components will "stand-down" and the
`external-provisioner` will act on the objects.
### statefulset.kubernetes.io/pod-name {#statefulsetkubernetesiopod-name}
Type: Label
Example: `statefulset.kubernetes.io/pod-name: "mystatefulset-7"`
Used on: Pod
When a StatefulSet controller creates a Pod for the StatefulSet, the control plane
sets this label on that Pod. The value of the label is the name of the Pod being created.
See [Pod Name Label](/docs/concepts/workloads/controllers/statefulset/#pod-name-label)
in the StatefulSet topic for more details.
### scheduler.alpha.kubernetes.io/node-selector {#schedulerkubernetesnode-selector}
Type: Annotation
Example: `scheduler.alpha.kubernetes.io/node-selector: "name-of-node-selector"`
Used on: Namespace
The [PodNodeSelector](/docs/reference/access-authn-authz/admission-controllers/#podnodeselector)
uses this annotation key to assign node selectors to pods in namespaces.
### topology.kubernetes.io/region {#topologykubernetesioregion}
Type: Label
Example: `topology.kubernetes.io/region: "us-east-1"`
Used on: Node, PersistentVolume
See [topology.kubernetes.io/zone](#topologykubernetesiozone).
### topology.kubernetes.io/zone {#topologykubernetesiozone}
Type: Label
Example: `topology.kubernetes.io/zone: "us-east-1c"`
Used on: Node, PersistentVolume
**On Node**: The `kubelet` or the external `cloud-controller-manager` populates this
with the information from the cloud provider. This will be set only if you are using
a cloud provider. However, you can consider setting this on nodes if it makes sense
in your topology.
**On PersistentVolume**: topology-aware volume provisioners will automatically set
node affinity constraints on a `PersistentVolume`.
A zone represents a logical failure domain. It is common for Kubernetes clusters to
span multiple zones for increased availability. While the exact definition of a zone
is left to infrastructure implementations, common properties of a zone include
very low network latency within a zone, no-cost network traffic within a zone, and
failure independence from other zones.
For example, nodes within a zone might share a network switch, but nodes in different
zones should not.
A region represents a larger domain, made up of one or more zones.
It is uncommon for Kubernetes clusters to span multiple regions,
While the exact definition of a zone or region is left to infrastructure implementations,
common properties of a region include higher network latency between them than within them,
non-zero cost for network traffic between them, and failure independence from other zones or regions.
For example, nodes within a region might share power infrastructure (e.g. a UPS or generator),
but nodes in different regions typically would not.
Kubernetes makes a few assumptions about the structure of zones and regions:
1. regions and zones are hierarchical: zones are strict subsets of regions and
no zone can be in 2 regions
2. zone names are unique across regions; for example region "africa-east-1" might be comprised
of zones "africa-east-1a" and "africa-east-1b"
It should be safe to assume that topology labels do not change.
Even though labels are strictly mutable, consumers of them can assume that a given node
is not going to be moved between zones without being destroyed and recreated.
Kubernetes can use this information in various ways.
For example, the scheduler automatically tries to spread the Pods in a ReplicaSet across nodes
in a single-zone cluster (to reduce the impact of node failures, see
[kubernetes.io/hostname](#kubernetesiohostname)).
With multiple-zone clusters, this spreading behavior also applies to zones (to reduce the impact of zone failures).
This is achieved via _SelectorSpreadPriority_.
_SelectorSpreadPriority_ is a best effort placement. If the zones in your cluster are
heterogeneous (for example: different numbers of nodes, different types of nodes, or different pod
resource requirements), this placement might prevent equal spreading of your Pods across zones.
If desired, you can use homogeneous zones (same number and types of nodes) to reduce the probability
of unequal spreading.
The scheduler (through the _VolumeZonePredicate_ predicate) also will ensure that Pods,
that claim a given volume, are only placed into the same zone as that volume.
Volumes cannot be attached across zones.
If `PersistentVolumeLabel` does not support automatic labeling of your PersistentVolumes,
you should consider adding the labels manually (or adding support for `PersistentVolumeLabel`).
With `PersistentVolumeLabel`, the scheduler prevents Pods from mounting volumes in a different zone.
If your infrastructure doesn't have this constraint, you don't need to add the zone labels to the volumes at all.
### volume.beta.kubernetes.io/storage-provisioner (deprecated)
Type: Annotation
Example: `volume.beta.kubernetes.io/storage-provisioner: "k8s.io/minikube-hostpath"`
Used on: PersistentVolumeClaim
This annotation has been deprecated since v1.23.
See [volume.kubernetes.io/storage-provisioner](#volume-kubernetes-io-storage-provisioner).
### volume.beta.kubernetes.io/storage-class (deprecated)
Type: Annotation
Example: `volume.beta.kubernetes.io/storage-class: "example-class"`
Used on: PersistentVolume, PersistentVolumeClaim
This annotation can be used for PersistentVolume(PV) or PersistentVolumeClaim(PVC)
to specify the name of [StorageClass](/docs/concepts/storage/storage-classes/).
When both the `storageClassName` attribute and the `volume.beta.kubernetes.io/storage-class`
annotation are specified, the annotation `volume.beta.kubernetes.io/storage-class`
takes precedence over the `storageClassName` attribute.
This annotation has been deprecated. Instead, set the
[`storageClassName` field](/docs/concepts/storage/persistent-volumes/#class)
for the PersistentVolumeClaim or PersistentVolume.
### volume.beta.kubernetes.io/mount-options (deprecated) {#mount-options}
Type: Annotation
Example : `volume.beta.kubernetes.io/mount-options: "ro,soft"`
Used on: PersistentVolume
A Kubernetes administrator can specify additional
[mount options](/docs/concepts/storage/persistent-volumes/#mount-options)
for when a PersistentVolume is mounted on a node.
### volume.kubernetes.io/storage-provisioner {#volume-kubernetes-io-storage-provisioner}
Type: Annotation
Used on: PersistentVolumeClaim
This annotation is added to a PVC that is supposed to be dynamically provisioned.
Its value is the name of a volume plugin that is supposed to provision a volume
for this PVC.
### volume.kubernetes.io/selected-node
Type: Annotation
Used on: PersistentVolumeClaim
This annotation is added to a PVC that is triggered by a scheduler to be
dynamically provisioned. Its value is the name of the selected node.
### volumes.kubernetes.io/controller-managed-attach-detach
Type: Annotation
Used on: Node
If a node has the annotation `volumes.kubernetes.io/controller-managed-attach-detach`,
its storage attach and detach operations are being managed by the _volume attach/detach_
.
The value of the annotation isn't important.
### node.kubernetes.io/windows-build {#nodekubernetesiowindows-build}
Type: Label
Example: `node.kubernetes.io/windows-build: "10.0.17763"`
Used on: Node
When the kubelet is running on Microsoft Windows, it automatically labels its Node
to record the version of Windows Server in use.
The label's value is in the format "MajorVersion.MinorVersion.BuildNumber".
### storage.alpha.kubernetes.io/migrated-plugins {#storagealphakubernetesiomigrated-plugins}
Type: Annotation
Example:`storage.alpha.kubernetes.io/migrated-plugins: "kubernetes.io/cinder"`
Used on: CSINode (an extension API)
This annotation is automatically added for the CSINode object that maps to a node that
installs CSIDriver. This annotation shows the in-tree plugin name of the migrated plugin. Its
value depends on your cluster's in-tree cloud provider storage type.
For example, if the in-tree cloud provider storage type is `CSIMigrationvSphere`, the CSINodes instance for the node should be updated with:
`storage.alpha.kubernetes.io/migrated-plugins: "kubernetes.io/vsphere-volume"`
### service.kubernetes.io/headless {#servicekubernetesioheadless}
Type: Label
Example: `service.kubernetes.io/headless: ""`
Used on: Endpoints
The control plane adds this label to an Endpoints object when the owning Service is headless.
To learn more, read [Headless Services](/docs/concepts/services-networking/service/#headless-services).
### service.kubernetes.io/topology-aware-hints (deprecated) {#servicekubernetesiotopology-aware-hints}
Example: `service.kubernetes.io/topology-aware-hints: "Auto"`
Used on: Service
This annotation was used for enabling _topology aware hints_ on Services. Topology aware
hints have since been renamed: the concept is now called
[topology aware routing](/docs/concepts/services-networking/topology-aware-routing/).
Setting the annotation to `Auto`, on a Service, configured the Kubernetes control plane to
add topology hints on EndpointSlices associated with that Service. You can also explicitly
set the annotation to `Disabled`.
If you are running a version of Kubernetes older than ,
check the documentation for that Kubernetes version to see how topology aware routing
works in that release.
There are no other valid values for this annotation. If you don't want topology aware hints
for a Service, don't add this annotation.
### service.kubernetes.io/topology-mode
Type: Annotation
Example: `service.kubernetes.io/topology-mode: Auto`
Used on: Service
This annotation provides a way to define how Services handle network topology;
for example, you can configure a Service so that Kubernetes prefers keeping traffic between
a client and server within a single topology zone.
In some cases this can help reduce costs or improve network performance.
See [Topology Aware Routing](/docs/concepts/services-networking/topology-aware-routing/)
for more details.
### kubernetes.io/service-name {#kubernetesioservice-name}
Type: Label
Example: `kubernetes.io/service-name: "my-website"`
Used on: EndpointSlice
Kubernetes associates [EndpointSlices](/docs/concepts/services-networking/endpoint-slices/) with
[Services](/docs/concepts/services-networking/service/) using this label.
This label records the of the
Service that the EndpointSlice is backing. All EndpointSlices should have this label set to
the name of their associated Service.
### kubernetes.io/service-account.name
Type: Annotation
Example: `kubernetes.io/service-account.name: "sa-name"`
Used on: Secret
This annotation records the of the
ServiceAccount that the token (stored in the Secret of type `kubernetes.io/service-account-token`)
represents.
### kubernetes.io/service-account.uid
Type: Annotation
Example: `kubernetes.io/service-account.uid: da68f9c6-9d26-11e7-b84e-002dc52800da`
Used on: Secret
This annotation records the of the
ServiceAccount that the token (stored in the Secret of type `kubernetes.io/service-account-token`)
represents.
### kubernetes.io/legacy-token-last-used
Type: Label
Example: `kubernetes.io/legacy-token-last-used: 2022-10-24`
Used on: Secret
The control plane only adds this label to Secrets that have the type
`kubernetes.io/service-account-token`.
The value of this label records the date (ISO 8601 format, UTC time zone) when the control plane
last saw a request where the client authenticated using the service account token.
If a legacy token was last used before the cluster gained the feature (added in Kubernetes v1.26),
then the label isn't set.
### kubernetes.io/legacy-token-invalid-since
Type: Label
Example: `kubernetes.io/legacy-token-invalid-since: 2023-10-27`
Used on: Secret
The control plane automatically adds this label to auto-generated Secrets that
have the type `kubernetes.io/service-account-token`. This label marks the
Secret-based token as invalid for authentication. The value of this label
records the date (ISO 8601 format, UTC time zone) when the control plane detects
that the auto-generated Secret has not been used for a specified duration
(defaults to one year).
### endpointslice.kubernetes.io/managed-by {#endpointslicekubernetesiomanaged-by}
Type: Label
Example: `endpointslice.kubernetes.io/managed-by: endpointslice-controller.k8s.io`
Used on: EndpointSlices
The label is used to indicate the controller or entity that manages the EndpointSlice. This label
aims to enable different EndpointSlice objects to be managed by different controllers or entities
within the same cluster.
### endpointslice.kubernetes.io/skip-mirror {#endpointslicekubernetesioskip-mirror}
Type: Label
Example: `endpointslice.kubernetes.io/skip-mirror: "true"`
Used on: Endpoints
The label can be set to `"true"` on an Endpoints resource to indicate that the
EndpointSliceMirroring controller should not mirror this resource with EndpointSlices.
### service.kubernetes.io/service-proxy-name {#servicekubernetesioservice-proxy-name}
Type: Label
Example: `service.kubernetes.io/service-proxy-name: "foo-bar"`
Used on: Service
The kube-proxy has this label for custom proxy, which delegates service control to custom proxy.
### experimental.windows.kubernetes.io/isolation-type (deprecated) {#experimental-windows-kubernetes-io-isolation-type}
Type: Annotation
Example: `experimental.windows.kubernetes.io/isolation-type: "hyperv"`
Used on: Pod
The annotation is used to run Windows containers with Hyper-V isolation.
Starting from v1.20, this annotation is deprecated.
Experimental Hyper-V support was removed in 1.21.
### ingressclass.kubernetes.io/is-default-class
Type: Annotation
Example: `ingressclass.kubernetes.io/is-default-class: "true"`
Used on: IngressClass
When a IngressClass resource has this annotation set to `"true"`, new Ingress resource
without a class specified will be assigned this default class.
### nginx.ingress.kubernetes.io/configuration-snippet
Type: Annotation
Example: `nginx.ingress.kubernetes.io/configuration-snippet: " more_set_headers \"Request-Id: $req_id\";\nmore_set_headers \"Example: 42\";\n"`
Used on: Ingress
You can use this annotation to set extra configuration on an Ingress that
uses the [NGINX Ingress Controller](https://github.com/kubernetes/ingress-nginx/).
The `configuration-snippet` annotation is ignored
by default since version 1.9.0 of the ingress controller.
The NGINX ingress controller setting `allow-snippet-annotations.`
has to be explicitly enabled to use this annotation.
Enabling the annotation can be dangerous in a multi-tenant cluster, as it can lead people with otherwise
limited permissions being able to retrieve all Secrets in the cluster.
### kubernetes.io/ingress.class (deprecated)
Type: Annotation
Used on: Ingress
Starting in v1.18, this annotation is deprecated in favor of `spec.ingressClassName`.
### storageclass.kubernetes.io/is-default-class
Type: Annotation
Example: `storageclass.kubernetes.io/is-default-class: "true"`
Used on: StorageClass
When a single StorageClass resource has this annotation set to `"true"`, new PersistentVolumeClaim
resource without a class specified will be assigned this default class.
### alpha.kubernetes.io/provided-node-ip (alpha) {#alpha-kubernetes-io-provided-node-ip}
Type: Annotation
Example: `alpha.kubernetes.io/provided-node-ip: "10.0.0.1"`
Used on: Node
The kubelet can set this annotation on a Node to denote its configured IPv4 and/or IPv6 address.
When kubelet is started with the `--cloud-provider` flag set to any value (includes both external
and legacy in-tree cloud providers), it sets this annotation on the Node to denote an IP address
set from the command line flag (`--node-ip`). This IP is verified with the cloud provider as valid
by the cloud-controller-manager.
### batch.kubernetes.io/job-completion-index
Type: Annotation, Label
Example: `batch.kubernetes.io/job-completion-index: "3"`
Used on: Pod
The Job controller in the kube-controller-manager sets this as a label and annotation for Pods
created with Indexed [completion mode](/docs/concepts/workloads/controllers/job/#completion-mode).
Note the [PodIndexLabel](/docs/reference/command-line-tools-reference/feature-gates/)
feature gate must be enabled for this to be added as a pod **label**,
otherwise it will just be an annotation.
### batch.kubernetes.io/cronjob-scheduled-timestamp
Type: Annotation
Example: `batch.kubernetes.io/cronjob-scheduled-timestamp: "2016-05-19T03:00:00-07:00"`
Used on: Jobs and Pods controlled by CronJobs
This annotation is used to record the original (expected) creation timestamp for a Job,
when that Job is part of a CronJob.
The control plane sets the value to that timestamp in RFC3339 format. If the Job belongs to a CronJob
with a timezone specified, then the timestamp is in that timezone. Otherwise, the timestamp is in controller-manager's local time.
### kubectl.kubernetes.io/default-container
Type: Annotation
Example: `kubectl.kubernetes.io/default-container: "front-end-app"`
The value of the annotation is the container name that is default for this Pod.
For example, `kubectl logs` or `kubectl exec` without `-c` or `--container` flag
will use this default container.
### kubectl.kubernetes.io/default-logs-container (deprecated)
Type: Annotation
Example: `kubectl.kubernetes.io/default-logs-container: "front-end-app"`
The value of the annotation is the container name that is the default logging container for this
Pod. For example, `kubectl logs` without `-c` or `--container` flag will use this default
container.
This annotation is deprecated. You should use the
[`kubectl.kubernetes.io/default-container`](#kubectl-kubernetes-io-default-container)
annotation instead. Kubernetes versions 1.25 and newer ignore this annotation.
### kubectl.kubernetes.io/last-applied-configuration
Type: Annotation
Example: _see following snippet_
```yaml
kubectl.kubernetes.io/last-applied-configuration: >
{"apiVersion":"apps/v1","kind":"Deployment","metadata":{"annotations":{},"name":"example","namespace":"default"},"spec":{"selector":{"matchLabels":{"app.kubernetes.io/name":foo}},"template":{"metadata":{"labels":{"app.kubernetes.io/name":"foo"}},"spec":{"containers":[{"image":"container-registry.example/foo-bar:1.42","name":"foo-bar","ports":[{"containerPort":42}]}]}}}}
```
Used on: all objects
The kubectl command line tool uses this annotation as a legacy mechanism
to track changes. That mechanism has been superseded by
[Server-side apply](/docs/reference/using-api/server-side-apply/).
### kubectl.kubernetes.io/restartedAt {#kubectl-k8s-io-restart-at}
Type: Annotation
Example: `kubectl.kubernetes.io/restartedAt: "2024-06-21T17:27:41Z"`
Used on: Deployment, ReplicaSet, StatefulSet, DaemonSet, Pod
This annotation contains the latest restart time of a resource (Deployment, ReplicaSet, StatefulSet or DaemonSet),
where kubectl triggered a rollout in order to force creation of new Pods.
The command `kubectl rollout restart <RESOURCE>` triggers a restart by patching the template
metadata of all the pods of resource with this annotation. In above example the latest restart time is shown as 21st June 2024 at 17:27:41 UTC.
You should not assume that this annotation represents the date / time of the most recent update;
a separate change could have been made since the last manually triggered rollout.
If you manually set this annotation on a Pod, nothing happens. The restarting side effect comes from
how workload management and Pod templating works.
### endpoints.kubernetes.io/over-capacity
Type: Annotation
Example: `endpoints.kubernetes.io/over-capacity:truncated`
Used on: Endpoints
The adds this annotation to
an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object if the associated
has more than 1000 backing endpoints.
The annotation indicates that the Endpoints object is over capacity and the number of endpoints
has been truncated to 1000.
If the number of backend endpoints falls below 1000, the control plane removes this annotation.
### endpoints.kubernetes.io/last-change-trigger-time
Type: Annotation
Example: `endpoints.kubernetes.io/last-change-trigger-time: "2023-07-20T04:45:21Z"`
Used on: Endpoints
This annotation set to an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object that
represents the timestamp (The timestamp is stored in RFC 3339 date-time string format. For example, '2018-10-22T19:32:52.1Z'). This is timestamp
of the last change in some Pod or Service object, that triggered the change to the Endpoints object.
### control-plane.alpha.kubernetes.io/leader (deprecated) {#control-plane-alpha-kubernetes-io-leader}
Type: Annotation
Example: `control-plane.alpha.kubernetes.io/leader={"holderIdentity":"controller-0","leaseDurationSeconds":15,"acquireTime":"2023-01-19T13:12:57Z","renewTime":"2023-01-19T13:13:54Z","leaderTransitions":1}`
Used on: Endpoints
The previously set annotation on
an [Endpoints](/docs/concepts/services-networking/service/#endpoints) object. This annotation provided
the following detail:
- Who is the current leader.
- The time when the current leadership was acquired.
- The duration of the lease (of the leadership) in seconds.
- The time the current lease (the current leadership) should be renewed.
- The number of leadership transitions that happened in the past.
Kubernetes now uses [Leases](/docs/concepts/architecture/leases/) to
manage leader assignment for the Kubernetes control plane.
### batch.kubernetes.io/job-tracking (deprecated) {#batch-kubernetes-io-job-tracking}
Type: Annotation
Example: `batch.kubernetes.io/job-tracking: ""`
Used on: Jobs
The presence of this annotation on a Job used to indicate that the control plane is
[tracking the Job status using finalizers](/docs/concepts/workloads/controllers/job/#job-tracking-with-finalizers).
Adding or removing this annotation no longer has an effect (Kubernetes v1.27 and later)
All Jobs are tracked with finalizers.
### job-name (deprecated) {#job-name}
Type: Label
Example: `job-name: "pi"`
Used on: Jobs and Pods controlled by Jobs
Starting from Kubernetes 1.27, this label is deprecated.
Kubernetes 1.27 and newer ignore this label and use the prefixed `job-name` label.
### controller-uid (deprecated) {#controller-uid}
Type: Label
Example: `controller-uid: "$UID"`
Used on: Jobs and Pods controlled by Jobs
Starting from Kubernetes 1.27, this label is deprecated.
Kubernetes 1.27 and newer ignore this label and use the prefixed `controller-uid` label.
### batch.kubernetes.io/job-name {#batchkubernetesio-job-name}
Type: Label
Example: `batch.kubernetes.io/job-name: "pi"`
Used on: Jobs and Pods controlled by Jobs
This label is used as a user-friendly way to get Pods corresponding to a Job.
The `job-name` comes from the `name` of the Job and allows for an easy way to
get Pods corresponding to the Job.
### batch.kubernetes.io/controller-uid {#batchkubernetesio-controller-uid}
Type: Label
Example: `batch.kubernetes.io/controller-uid: "$UID"`
Used on: Jobs and Pods controlled by Jobs
This label is used as a programmatic way to get all Pods corresponding to a Job.
The `controller-uid` is a unique identifier that gets set in the `selector` field so the Job
controller can get all the corresponding Pods.
### scheduler.alpha.kubernetes.io/defaultTolerations {#scheduleralphakubernetesio-defaulttolerations}
Type: Annotation
Example: `scheduler.alpha.kubernetes.io/defaultTolerations: '[{"operator": "Equal", "value": "value1", "effect": "NoSchedule", "key": "dedicated-node"}]'`
Used on: Namespace
This annotation requires the [PodTolerationRestriction](/docs/reference/access-authn-authz/admission-controllers/#podtolerationrestriction)
admission controller to be enabled. This annotation key allows assigning tolerations to a
namespace and any new pods created in this namespace would get these tolerations added.
### scheduler.alpha.kubernetes.io/tolerationsWhitelist {#schedulerkubernetestolerations-whitelist}
Type: Annotation
Example: `scheduler.alpha.kubernetes.io/tolerationsWhitelist: '[{"operator": "Exists", "effect": "NoSchedule", "key": "dedicated-node"}]'`
Used on: Namespace
This annotation is only useful when the (Alpha)
[PodTolerationRestriction](/docs/reference/access-authn-authz/admission-controllers/#podtolerationrestriction)
admission controller is enabled. The annotation value is a JSON document that defines a list of
allowed tolerations for the namespace it annotates. When you create a Pod or modify its
tolerations, the API server checks the tolerations to see if they are mentioned in the allow list.
The pod is admitted only if the check succeeds.
### scheduler.alpha.kubernetes.io/preferAvoidPods (deprecated) {#scheduleralphakubernetesio-preferavoidpods}
Type: Annotation
Used on: Node
This annotation requires the [NodePreferAvoidPods scheduling plugin](/docs/reference/scheduling/config/#scheduling-plugins)
to be enabled. The plugin is deprecated since Kubernetes 1.22.
Use [Taints and Tolerations](/docs/concepts/scheduling-eviction/taint-and-toleration/) instead.
### node.kubernetes.io/not-ready
Type: Taint
Example: `node.kubernetes.io/not-ready: "NoExecute"`
Used on: Node
The Node controller detects whether a Node is ready by monitoring its health
and adds or removes this taint accordingly.
### node.kubernetes.io/unreachable
Type: Taint
Example: `node.kubernetes.io/unreachable: "NoExecute"`
Used on: Node
The Node controller adds the taint to a Node corresponding to the
[NodeCondition](/docs/concepts/architecture/nodes/#condition) `Ready` being `Unknown`.
### node.kubernetes.io/unschedulable
Type: Taint
Example: `node.kubernetes.io/unschedulable: "NoSchedule"`
Used on: Node
The taint will be added to a node when initializing the node to avoid race condition.
### node.kubernetes.io/memory-pressure
Type: Taint
Example: `node.kubernetes.io/memory-pressure: "NoSchedule"`
Used on: Node
The kubelet detects memory pressure based on `memory.available` and `allocatableMemory.available`
observed on a Node. The observed values are then compared to the corresponding thresholds that can
be set on the kubelet to determine if the Node condition and taint should be added/removed.
### node.kubernetes.io/disk-pressure
Type: Taint
Example: `node.kubernetes.io/disk-pressure :"NoSchedule"`
Used on: Node
The kubelet detects disk pressure based on `imagefs.available`, `imagefs.inodesFree`,
`nodefs.available` and `nodefs.inodesFree`(Linux only) observed on a Node.
The observed values are then compared to the corresponding thresholds that can be set on the
kubelet to determine if the Node condition and taint should be added/removed.
### node.kubernetes.io/network-unavailable
Type: Taint
Example: `node.kubernetes.io/network-unavailable: "NoSchedule"`
Used on: Node
This is initially set by the kubelet when the cloud provider used indicates a requirement for
additional network configuration. Only when the route on the cloud is configured properly will the
taint be removed by the cloud provider.
### node.kubernetes.io/pid-pressure
Type: Taint
Example: `node.kubernetes.io/pid-pressure: "NoSchedule"`
Used on: Node
The kubelet checks D-value of the size of `/proc/sys/kernel/pid_max` and the PIDs consumed by
Kubernetes on a node to get the number of available PIDs that referred to as the `pid.available`
metric. The metric is then compared to the corresponding threshold that can be set on the kubelet
to determine if the node condition and taint should be added/removed.
### node.kubernetes.io/out-of-service
Type: Taint
Example: `node.kubernetes.io/out-of-service:NoExecute`
Used on: Node
A user can manually add the taint to a Node marking it out-of-service.
If the `NodeOutOfServiceVolumeDetach`
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
is enabled on `kube-controller-manager`, and a Node is marked out-of-service with this taint,
the Pods on the node will be forcefully deleted if there are no matching tolerations on it and
volume detach operations for the Pods terminating on the node will happen immediately.
This allows the Pods on the out-of-service node to recover quickly on a different node.
Refer to [Non-graceful node shutdown](/docs/concepts/architecture/nodes/#non-graceful-node-shutdown)
for further details about when and how to use this taint.
### node.cloudprovider.kubernetes.io/uninitialized
Type: Taint
Example: `node.cloudprovider.kubernetes.io/uninitialized: "NoSchedule"`
Used on: Node
Sets this taint on a Node to mark it as unusable, when kubelet is started with the "external"
cloud provider, until a controller from the cloud-controller-manager initializes this Node, and
then removes the taint.
### node.cloudprovider.kubernetes.io/shutdown
Type: Taint
Example: `node.cloudprovider.kubernetes.io/shutdown: "NoSchedule"`
Used on: Node
If a Node is in a cloud provider specified shutdown state, the Node gets tainted accordingly
with `node.cloudprovider.kubernetes.io/shutdown` and the taint effect of `NoSchedule`.
### feature.node.kubernetes.io/*
Type: Label
Example: `feature.node.kubernetes.io/network-sriov.capable: "true"`
Used on: Node
These labels are used by the Node Feature Discovery (NFD) component to advertise
features on a node. All built-in labels use the `feature.node.kubernetes.io` label
namespace and have the format `feature.node.kubernetes.io/<feature-name>: "true"`.
NFD has many extension points for creating vendor and application-specific labels.
For details, see the [customization guide](https://kubernetes-sigs.github.io/node-feature-discovery/v0.12/usage/customization-guide).
### nfd.node.kubernetes.io/master.version
Type: Annotation
Example: `nfd.node.kubernetes.io/master.version: "v0.6.0"`
Used on: Node
For node(s) where the Node Feature Discovery (NFD)
[master](https://kubernetes-sigs.github.io/node-feature-discovery/stable/usage/nfd-master.html)
is scheduled, this annotation records the version of the NFD master.
It is used for informative use only.
### nfd.node.kubernetes.io/worker.version
Type: Annotation
Example: `nfd.node.kubernetes.io/worker.version: "v0.4.0"`
Used on: Nodes
This annotation records the version for a Node Feature Discovery's
[worker](https://kubernetes-sigs.github.io/node-feature-discovery/stable/usage/nfd-worker.html)
if there is one running on a node. It's used for informative use only.
### nfd.node.kubernetes.io/feature-labels
Type: Annotation
Example: `nfd.node.kubernetes.io/feature-labels: "cpu-cpuid.ADX,cpu-cpuid.AESNI,cpu-hardware_multithreading,kernel-version.full"`
Used on: Nodes
This annotation records a comma-separated list of node feature labels managed by
[Node Feature Discovery](https://kubernetes-sigs.github.io/node-feature-discovery/) (NFD).
NFD uses this for an internal mechanism. You should not edit this annotation yourself.
### nfd.node.kubernetes.io/extended-resources
Type: Annotation
Example: `nfd.node.kubernetes.io/extended-resources: "accelerator.acme.example/q500,example.com/coprocessor-fx5"`
Used on: Nodes
This annotation records a comma-separated list of
[extended resources](/docs/concepts/configuration/manage-resources-containers/#extended-resources)
managed by [Node Feature Discovery](https://kubernetes-sigs.github.io/node-feature-discovery/) (NFD).
NFD uses this for an internal mechanism. You should not edit this annotation yourself.
### nfd.node.kubernetes.io/node-name
Type: Label
Example: `nfd.node.kubernetes.io/node-name: node-1`
Used on: Nodes
It specifies which node the NodeFeature object is targeting.
Creators of NodeFeature objects must set this label and
consumers of the objects are supposed to use the label for
filtering features designated for a certain node.
These Node Feature Discovery (NFD) labels or annotations only apply to
the nodes where NFD is running. To learn more about NFD and
its components go to its official [documentation](https://kubernetes-sigs.github.io/node-feature-discovery/stable/get-started/).
### service.beta.kubernetes.io/aws-load-balancer-access-log-emit-interval (beta) {#service-beta-kubernetes-io-aws-load-balancer-access-log-emit-interval}
Example: `service.beta.kubernetes.io/aws-load-balancer-access-log-emit-interval: "5"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
the load balancer for a Service based on this annotation. The value determines
how often the load balancer writes log entries. For example, if you set the value
to 5, the log writes occur 5 seconds apart.
### service.beta.kubernetes.io/aws-load-balancer-access-log-enabled (beta) {#service-beta-kubernetes-io-aws-load-balancer-access-log-enabled}
Example: `service.beta.kubernetes.io/aws-load-balancer-access-log-enabled: "false"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
the load balancer for a Service based on this annotation. Access logging is enabled
if you set the annotation to "true".
### service.beta.kubernetes.io/aws-load-balancer-access-log-s3-bucket-name (beta) {#service-beta-kubernetes-io-aws-load-balancer-access-log-s3-bucket-name}
Example: `service.beta.kubernetes.io/aws-load-balancer-access-log-enabled: example`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
the load balancer for a Service based on this annotation. The load balancer
writes logs to an S3 bucket with the name you specify.
### service.beta.kubernetes.io/aws-load-balancer-access-log-s3-bucket-prefix (beta) {#service-beta-kubernetes-io-aws-load-balancer-access-log-s3-bucket-prefix}
Example: `service.beta.kubernetes.io/aws-load-balancer-access-log-enabled: "/example"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
the load balancer for a Service based on this annotation. The load balancer
writes log objects with the prefix that you specify.
### service.beta.kubernetes.io/aws-load-balancer-additional-resource-tags (beta) {#service-beta-kubernetes-io-aws-load-balancer-additional-resource-tags}
Example: `service.beta.kubernetes.io/aws-load-balancer-additional-resource-tags: "Environment=demo,Project=example"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
tags (an AWS concept) for a load balancer based on the comma-separated key/value
pairs in the value of this annotation.
### service.beta.kubernetes.io/aws-load-balancer-alpn-policy (beta) {#service-beta-kubernetes-io-aws-load-balancer-alpn-policy}
Example: `service.beta.kubernetes.io/aws-load-balancer-alpn-policy: HTTP2Optional`
Used on: Service
The [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
uses this annotation.
See [annotations](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/)
in the AWS load balancer controller documentation.
### service.beta.kubernetes.io/aws-load-balancer-attributes (beta) {#service-beta-kubernetes-io-aws-load-balancer-attributes}
Example: `service.beta.kubernetes.io/aws-load-balancer-attributes: "deletion_protection.enabled=true"`
Used on: Service
The [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
uses this annotation.
See [annotations](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/)
in the AWS load balancer controller documentation.
### service.beta.kubernetes.io/aws-load-balancer-backend-protocol (beta) {#service-beta-kubernetes-io-aws-load-balancer-backend-protocol}
Example: `service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
the load balancer listener based on the value of this annotation.
### service.beta.kubernetes.io/aws-load-balancer-connection-draining-enabled (beta) {#service-beta-kubernetes-io-aws-load-balancer-connection-draining-enabled}
Example: `service.beta.kubernetes.io/aws-load-balancer-connection-draining-enabled: "false"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
the load balancer based on this annotation. The load balancer's connection draining
setting depends on the value you set.
### service.beta.kubernetes.io/aws-load-balancer-connection-draining-timeout (beta) {#service-beta-kubernetes-io-aws-load-balancer-connection-draining-timeout}
Example: `service.beta.kubernetes.io/aws-load-balancer-connection-draining-timeout: "60"`
Used on: Service
If you configure [connection draining](#service-beta-kubernetes-io-aws-load-balancer-connection-draining-enabled)
for a Service of `type: LoadBalancer`, and you use the AWS cloud, the integration configures
the draining period based on this annotation. The value you set determines the draining
timeout in seconds.
### service.beta.kubernetes.io/aws-load-balancer-ip-address-type (beta) {#service-beta-kubernetes-io-aws-load-balancer-ip-address-type}
Example: `service.beta.kubernetes.io/aws-load-balancer-ip-address-type: ipv4`
Used on: Service
The [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
uses this annotation.
See [annotations](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/)
in the AWS load balancer controller documentation.
### service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout (beta) {#service-beta-kubernetes-io-aws-load-balancer-connection-idle-timeout}
Example: `service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout: "60"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The load balancer has a configured idle
timeout period (in seconds) that applies to its connections. If no data has been
sent or received by the time that the idle timeout period elapses, the load balancer
closes the connection.
### service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled (beta) {#service-beta-kubernetes-io-aws-load-balancer-cross-zone-load-balancing-enabled}
Example: `service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: "true"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. If you set this annotation to "true",
each load balancer node distributes requests evenly across the registered targets
in all enabled [availability zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones).
If you disable cross-zone load balancing, each load balancer node distributes requests
evenly across the registered targets in its availability zone only.
### service.beta.kubernetes.io/aws-load-balancer-eip-allocations (beta) {#service-beta-kubernetes-io-aws-load-balancer-eip-allocations}
Example: `service.beta.kubernetes.io/aws-load-balancer-eip-allocations: "eipalloc-01bcdef23bcdef456,eipalloc-def1234abc4567890"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The value is a comma-separated list
of elastic IP address allocation IDs.
This annotation is only relevant for Services of `type: LoadBalancer`, where
the load balancer is an AWS Network Load Balancer.
### service.beta.kubernetes.io/aws-load-balancer-extra-security-groups (beta) {#service-beta-kubernetes-io-aws-load-balancer-extra-security-groups}
Example: `service.beta.kubernetes.io/aws-load-balancer-extra-security-groups: "sg-12abcd3456,sg-34dcba6543"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The annotation value is a comma-separated
list of extra AWS VPC security groups to configure for the load balancer.
### service.beta.kubernetes.io/aws-load-balancer-healthcheck-healthy-threshold (beta) {#service-beta-kubernetes-io-aws-load-balancer-healthcheck-healthy-threshold}
Example: `service.beta.kubernetes.io/aws-load-balancer-healthcheck-healthy-threshold: "3"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The annotation value specifies the number of
successive successful health checks required for a backend to be considered healthy
for traffic.
### service.beta.kubernetes.io/aws-load-balancer-healthcheck-interval (beta) {#service-beta-kubernetes-io-aws-load-balancer-healthcheck-interval}
Example: `service.beta.kubernetes.io/aws-load-balancer-healthcheck-interval: "30"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The annotation value specifies the interval,
in seconds, between health check probes made by the load balancer.
### service.beta.kubernetes.io/aws-load-balancer-healthcheck-path (beta) {#service-beta-kubernetes-io-aws-load-balancer-healthcheck-papth}
Example: `service.beta.kubernetes.io/aws-load-balancer-healthcheck-path: /healthcheck`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The annotation value determines the
path part of the URL that is used for HTTP health checks.
### service.beta.kubernetes.io/aws-load-balancer-healthcheck-port (beta) {#service-beta-kubernetes-io-aws-load-balancer-healthcheck-port}
Example: `service.beta.kubernetes.io/aws-load-balancer-healthcheck-port: "24"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The annotation value determines which
port the load balancer connects to when performing health checks.
### service.beta.kubernetes.io/aws-load-balancer-healthcheck-protocol (beta) {#service-beta-kubernetes-io-aws-load-balancer-healthcheck-protocol}
Example: `service.beta.kubernetes.io/aws-load-balancer-healthcheck-protocol: TCP`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The annotation value determines how the
load balancer checks the health of backend targets.
### service.beta.kubernetes.io/aws-load-balancer-healthcheck-timeout (beta) {#service-beta-kubernetes-io-aws-load-balancer-healthcheck-timeout}
Example: `service.beta.kubernetes.io/aws-load-balancer-healthcheck-timeout: "3"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The annotation value specifies the number
of seconds before a probe that hasn't yet succeeded is automatically treated as
having failed.
### service.beta.kubernetes.io/aws-load-balancer-healthcheck-unhealthy-threshold (beta) {#service-beta-kubernetes-io-aws-load-balancer-healthcheck-unhealthy-threshold}
Example: `service.beta.kubernetes.io/aws-load-balancer-healthcheck-unhealthy-threshold: "3"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. The annotation value specifies the number of
successive unsuccessful health checks required for a backend to be considered unhealthy
for traffic.
### service.beta.kubernetes.io/aws-load-balancer-internal (beta) {#service-beta-kubernetes-io-aws-load-balancer-internal}
Example: `service.beta.kubernetes.io/aws-load-balancer-internal: "true"`
Used on: Service
The cloud controller manager integration with AWS elastic load balancing configures
a load balancer based on this annotation. When you set this annotation to "true",
the integration configures an internal load balancer.
If you use the [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/),
see [`service.beta.kubernetes.io/aws-load-balancer-scheme`](#service-beta-kubernetes-io-aws-load-balancer-scheme).
### service.beta.kubernetes.io/aws-load-balancer-manage-backend-security-group-rules (beta) {#service-beta-kubernetes-io-aws-load-balancer-manage-backend-security-group-rules}
Example: `service.beta.kubernetes.io/aws-load-balancer-manage-backend-security-group-rules: "true"`
Used on: Service
The [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
uses this annotation.
See [annotations](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/)
in the AWS load balancer controller documentation.
### service.beta.kubernetes.io/aws-load-balancer-name (beta) {#service-beta-kubernetes-io-aws-load-balancer-name}
Example: `service.beta.kubernetes.io/aws-load-balancer-name: my-elb`
Used on: Service
If you set this annotation on a Service, and you also annotate that Service with
`service.beta.kubernetes.io/aws-load-balancer-type: "external"`, and you use the
[AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
in your cluster, then the AWS load balancer controller sets the name of that load
balancer to the value you set for _this_ annotation.
See [annotations](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/)
in the AWS load balancer controller documentation.
### service.beta.kubernetes.io/aws-load-balancer-nlb-target-type (beta) {#service-beta-kubernetes-io-aws-load-balancer-nlb-target-type}
Example: `service.beta.kubernetes.io/aws-load-balancer-nlb-target-type: "true"`
Used on: Service
The [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
uses this annotation.
See [annotations](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/)
in the AWS load balancer controller documentation.
### service.beta.kubernetes.io/aws-load-balancer-private-ipv4-addresses (beta) {#service-beta-kubernetes-io-aws-load-balancer-private-ipv4-addresses}
Example: `service.beta.kubernetes.io/aws-load-balancer-private-ipv4-addresses: "198.51.100.0,198.51.100.64"`
Used on: Service
The [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
uses this annotation.
See [annotations](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/)
in the AWS load balancer controller documentation.
### service.beta.kubernetes.io/aws-load-balancer-proxy-protocol (beta) {#service-beta-kubernetes-io-aws-load-balancer-proxy-protocol}
Example: `service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: "*"`
Used on: Service
The official Kubernetes integration with AWS elastic load balancing configures
a load balancer based on this annotation. The only permitted value is `"*"`,
which indicates that the load balancer should wrap TCP connections to the backend
Pod with the PROXY protocol.
### service.beta.kubernetes.io/aws-load-balancer-scheme (beta) {#service-beta-kubernetes-io-aws-load-balancer-scheme}
Example: `service.beta.kubernetes.io/aws-load-balancer-scheme: internal`
Used on: Service
The [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
uses this annotation.
See [annotations](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/)
in the AWS load balancer controller documentation.
### service.beta.kubernetes.io/aws-load-balancer-security-groups (deprecated) {#service-beta-kubernetes-io-aws-load-balancer-security-groups}
Example: `service.beta.kubernetes.io/aws-load-balancer-security-groups: "sg-53fae93f,sg-8725gr62r"`
Used on: Service
The AWS load balancer controller uses this annotation to specify a comma separated list
of security groups you want to attach to an AWS load balancer. Both name and ID of security
are supported where name matches a `Name` tag, not the `groupName` attribute.
When this annotation is added to a Service, the load-balancer controller attaches the security groups
referenced by the annotation to the load balancer. If you omit this annotation, the AWS load balancer
controller automatically creates a new security group and attaches it to the load balancer.
Kubernetes v1.27 and later do not directly set or read this annotation. However, the AWS
load balancer controller (part of the Kubernetes project) does still use the
`service.beta.kubernetes.io/aws-load-balancer-security-groups` annotation.
### service.beta.kubernetes.io/load-balancer-source-ranges (deprecated) {#service-beta-kubernetes-io-load-balancer-source-ranges}
Example: `service.beta.kubernetes.io/load-balancer-source-ranges: "192.0.2.0/25"`
Used on: Service
The [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
uses this annotation. You should set `.spec.loadBalancerSourceRanges` for the Service instead.
### service.beta.kubernetes.io/aws-load-balancer-ssl-cert (beta) {#service-beta-kubernetes-io-aws-load-balancer-ssl-cert}
Example: `service.beta.kubernetes.io/aws-load-balancer-ssl-cert: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"`
Used on: Service
The official integration with AWS elastic load balancing configures TLS for a Service of
`type: LoadBalancer` based on this annotation. The value of the annotation is the
AWS Resource Name (ARN) of the X.509 certificate that the load balancer listener should
use.
(The TLS protocol is based on an older technology that abbreviates to SSL.)
### service.beta.kubernetes.io/aws-load-balancer-ssl-negotiation-policy (beta) {#service-beta-kubernetes-io-aws-load-balancer-ssl-negotiation-policy}
Example: `service.beta.kubernetes.io/aws-load-balancer-ssl-negotiation-policy: ELBSecurityPolicy-TLS-1-2-2017-01`
The official integration with AWS elastic load balancing configures TLS for a Service of
`type: LoadBalancer` based on this annotation. The value of the annotation is the name
of an AWS policy for negotiating TLS with a client peer.
### service.beta.kubernetes.io/aws-load-balancer-ssl-ports (beta) {#service-beta-kubernetes-io-aws-load-balancer-ssl-ports}
Example: `service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "*"`
The official integration with AWS elastic load balancing configures TLS for a Service of
`type: LoadBalancer` based on this annotation. The value of the annotation is either `"*"`,
which means that all the load balancer's ports should use TLS, or it is a comma separated
list of port numbers.
### service.beta.kubernetes.io/aws-load-balancer-subnets (beta) {#service-beta-kubernetes-io-aws-load-balancer-subnets}
Example: `service.beta.kubernetes.io/aws-load-balancer-subnets: "private-a,private-b"`
Kubernetes' official integration with AWS uses this annotation to configure a
load balancer and determine in which AWS availability zones to deploy the managed
load balancing service. The value is either a comma separated list of subnet names, or a
comma separated list of subnet IDs.
### service.beta.kubernetes.io/aws-load-balancer-target-group-attributes (beta) {#service-beta-kubernetes-io-aws-load-balancer-target-group-attributes}
Example: `service.beta.kubernetes.io/aws-load-balancer-target-group-attributes: "stickiness.enabled=true,stickiness.type=source_ip"`
Used on: Service
The [AWS load balancer controller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/)
uses this annotation.
See [annotations](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/)
in the AWS load balancer controller documentation.
### service.beta.kubernetes.io/aws-load-balancer-target-node-labels (beta) {#service-beta-kubernetes-io-aws-target-node-labels}
Example: `service.beta.kubernetes.io/aws-load-balancer-target-node-labels: "kubernetes.io/os=Linux,topology.kubernetes.io/region=us-east-2"`
Kubernetes' official integration with AWS uses this annotation to determine which
nodes in your cluster should be considered as valid targets for the load balancer.
### service.beta.kubernetes.io/aws-load-balancer-type (beta) {#service-beta-kubernetes-io-aws-load-balancer-type}
Example: `service.beta.kubernetes.io/aws-load-balancer-type: external`
Kubernetes' official integrations with AWS use this annotation to determine
whether the AWS cloud provider integration should manage a Service of
`type: LoadBalancer`.
There are two permitted values:
`nlb`
: the cloud controller manager configures a Network Load Balancer
`external`
: the cloud controller manager does not configure any load balancer
If you deploy a Service of `type: LoadBalancer` on AWS, and you don't set any
`service.beta.kubernetes.io/aws-load-balancer-type` annotation,
the AWS integration deploys a classic Elastic Load Balancer. This behavior,
with no annotation present, is the default unless you specify otherwise.
When you set this annotation to `external` on a Service of `type: LoadBalancer`,
and your cluster has a working deployment of the AWS Load Balancer controller,
then the AWS Load Balancer controller attempts to deploy a load balancer based
on the Service specification.
Do not modify or add the `service.beta.kubernetes.io/aws-load-balancer-type` annotation
on an existing Service object. See the AWS documentation on this topic for more
details.
### service.beta.kubernetes.io/azure-load-balancer-disable-tcp-reset (deprecated) {#service-beta-kubernetes-azure-load-balancer-disble-tcp-reset}
Example: `service.beta.kubernetes.io/azure-load-balancer-disable-tcp-reset: "false"`
Used on: Service
This annotation only works for Azure standard load balancer backed service.
This annotation is used on the Service to specify whether the load balancer
should disable or enable TCP reset on idle timeout. If enabled, it helps
applications to behave more predictably, to detect the termination of a connection,
remove expired connections and initiate new connections.
You can set the value to be either true or false.
See [Load Balancer TCP Reset](https://learn.microsoft.com/en-gb/azure/load-balancer/load-balancer-tcp-reset) for more information.
This annotation is deprecated.
### pod-security.kubernetes.io/enforce
Type: Label
Example: `pod-security.kubernetes.io/enforce: "baseline"`
Used on: Namespace
Value **must** be one of `privileged`, `baseline`, or `restricted` which correspond to
[Pod Security Standard](/docs/concepts/security/pod-security-standards) levels.
Specifically, the `enforce` label _prohibits_ the creation of any Pod in the labeled
Namespace which does not meet the requirements outlined in the indicated level.
See [Enforcing Pod Security at the Namespace Level](/docs/concepts/security/pod-security-admission)
for more information.
### pod-security.kubernetes.io/enforce-version
Type: Label
Example: `pod-security.kubernetes.io/enforce-version: ""`
Used on: Namespace
Value **must** be `latest` or a valid Kubernetes version in the format `v<major>.<minor>`.
This determines the version of the
[Pod Security Standard](/docs/concepts/security/pod-security-standards)
policies to apply when validating a Pod.
See [Enforcing Pod Security at the Namespace Level](/docs/concepts/security/pod-security-admission)
for more information.
### pod-security.kubernetes.io/audit
Type: Label
Example: `pod-security.kubernetes.io/audit: "baseline"`
Used on: Namespace
Value **must** be one of `privileged`, `baseline`, or `restricted` which correspond to
[Pod Security Standard](/docs/concepts/security/pod-security-standards) levels.
Specifically, the `audit` label does not prevent the creation of a Pod in the labeled
Namespace which does not meet the requirements outlined in the indicated level,
but adds an this annotation to the Pod.
See [Enforcing Pod Security at the Namespace Level](/docs/concepts/security/pod-security-admission)
for more information.
### pod-security.kubernetes.io/audit-version
Type: Label
Example: `pod-security.kubernetes.io/audit-version: ""`
Used on: Namespace
Value **must** be `latest` or a valid Kubernetes version in the format `v<major>.<minor>`.
This determines the version of the
[Pod Security Standard](/docs/concepts/security/pod-security-standards)
policies to apply when validating a Pod.
See [Enforcing Pod Security at the Namespace Level](/docs/concepts/security/pod-security-admission)
for more information.
### pod-security.kubernetes.io/warn
Type: Label
Example: `pod-security.kubernetes.io/warn: "baseline"`
Used on: Namespace
Value **must** be one of `privileged`, `baseline`, or `restricted` which correspond to
[Pod Security Standard](/docs/concepts/security/pod-security-standards) levels.
Specifically, the `warn` label does not prevent the creation of a Pod in the labeled
Namespace which does not meet the requirements outlined in the indicated level,
but returns a warning to the user after doing so.
Note that warnings are also displayed when creating or updating objects that contain
Pod templates, such as Deployments, Jobs, StatefulSets, etc.
See [Enforcing Pod Security at the Namespace Level](/docs/concepts/security/pod-security-admission)
for more information.
### pod-security.kubernetes.io/warn-version
Type: Label
Example: `pod-security.kubernetes.io/warn-version: ""`
Used on: Namespace
Value **must** be `latest` or a valid Kubernetes version in the format `v<major>.<minor>`.
This determines the version of the [Pod Security Standard](/docs/concepts/security/pod-security-standards)
policies to apply when validating a submitted Pod.
Note that warnings are also displayed when creating or updating objects that contain
Pod templates, such as Deployments, Jobs, StatefulSets, etc.
See [Enforcing Pod Security at the Namespace Level](/docs/concepts/security/pod-security-admission)
for more information.
### rbac.authorization.kubernetes.io/autoupdate
Type: Annotation
Example: `rbac.authorization.kubernetes.io/autoupdate: "false"`
Used on: ClusterRole, ClusterRoleBinding, Role, RoleBinding
When this annotation is set to `"true"` on default RBAC objects created by the API server,
they are automatically updated at server start to add missing permissions and subjects
(extra permissions and subjects are left in place).
To prevent autoupdating a particular role or rolebinding, set this annotation to `"false"`.
If you create your own RBAC objects and set this annotation to `"false"`, `kubectl auth reconcile`
(which allows reconciling arbitrary RBAC objects in a )
respects this annotation and does not automatically add missing permissions and subjects.
### kubernetes.io/psp (deprecated) {#kubernetes-io-psp}
Type: Annotation
Example: `kubernetes.io/psp: restricted`
Used on: Pod
This annotation was only relevant if you were using
[PodSecurityPolicy](/docs/concepts/security/pod-security-policy/) objects.
Kubernetes v does not support the PodSecurityPolicy API.
When the PodSecurityPolicy admission controller admitted a Pod, the admission controller
modified the Pod to have this annotation.
The value of the annotation was the name of the PodSecurityPolicy that was used for validation.
### seccomp.security.alpha.kubernetes.io/pod (non-functional) {#seccomp-security-alpha-kubernetes-io-pod}
Type: Annotation
Used on: Pod
Kubernetes before v1.25 allowed you to configure seccomp behavior using this annotation.
See [Restrict a Container's Syscalls with seccomp](/docs/tutorials/security/seccomp/) to
learn the supported way to specify seccomp restrictions for a Pod.
### container.seccomp.security.alpha.kubernetes.io/[NAME] (non-functional) {#container-seccomp-security-alpha-kubernetes-io}
Type: Annotation
Used on: Pod
Kubernetes before v1.25 allowed you to configure seccomp behavior using this annotation.
See [Restrict a Container's Syscalls with seccomp](/docs/tutorials/security/seccomp/) to
learn the supported way to specify seccomp restrictions for a Pod.
### snapshot.storage.kubernetes.io/allow-volume-mode-change
Type: Annotation
Example: `snapshot.storage.kubernetes.io/allow-volume-mode-change: "true"`
Used on: VolumeSnapshotContent
Value can either be `true` or `false`. This determines whether a user can modify
the mode of the source volume when a PersistentVolumeClaim is being created from
a VolumeSnapshot.
Refer to [Converting the volume mode of a Snapshot](/docs/concepts/storage/volume-snapshots/#convert-volume-mode)
and the [Kubernetes CSI Developer Documentation](https://kubernetes-csi.github.io/docs/)
for more information.
### scheduler.alpha.kubernetes.io/critical-pod (deprecated)
Type: Annotation
Example: `scheduler.alpha.kubernetes.io/critical-pod: ""`
Used on: Pod
This annotation lets Kubernetes control plane know about a Pod being a critical Pod
so that the descheduler will not remove this Pod.
Starting in v1.16, this annotation was removed in favor of
[Pod Priority](/docs/concepts/scheduling-eviction/pod-priority-preemption/).
## Annotations used for audit
<!-- sorted by annotation -->
- [`authorization.k8s.io/decision`](/docs/reference/labels-annotations-taints/audit-annotations/#authorization-k8s-io-decision)
- [`authorization.k8s.io/reason`](/docs/reference/labels-annotations-taints/audit-annotations/#authorization-k8s-io-reason)
- [`insecure-sha1.invalid-cert.kubernetes.io/$hostname`](/docs/reference/labels-annotations-taints/audit-annotations/#insecure-sha1-invalid-cert-kubernetes-io-hostname)
- [`missing-san.invalid-cert.kubernetes.io/$hostname`](/docs/reference/labels-annotations-taints/audit-annotations/#missing-san-invalid-cert-kubernetes-io-hostname)
- [`pod-security.kubernetes.io/audit-violations`](/docs/reference/labels-annotations-taints/audit-annotations/#pod-security-kubernetes-io-audit-violations)
- [`pod-security.kubernetes.io/enforce-policy`](/docs/reference/labels-annotations-taints/audit-annotations/#pod-security-kubernetes-io-enforce-policy)
- [`pod-security.kubernetes.io/exempt`](/docs/reference/labels-annotations-taints/audit-annotations/#pod-security-kubernetes-io-exempt)
- [`validation.policy.admission.k8s.io/validation_failure`](/docs/reference/labels-annotations-taints/audit-annotations/#validation-policy-admission-k8s-io-validation-failure)
See more details on [Audit Annotations](/docs/reference/labels-annotations-taints/audit-annotations/).
## kubeadm
### kubeadm.alpha.kubernetes.io/cri-socket
Type: Annotation
Example: `kubeadm.alpha.kubernetes.io/cri-socket: unix:///run/containerd/container.sock`
Used on: Node
Annotation that kubeadm uses to preserve the CRI socket information given to kubeadm at
`init`/`join` time for later use. kubeadm annotates the Node object with this information.
The annotation remains "alpha", since ideally this should be a field in KubeletConfiguration
instead.
### kubeadm.kubernetes.io/etcd.advertise-client-urls
Type: Annotation
Example: `kubeadm.kubernetes.io/etcd.advertise-client-urls: https://172.17.0.18:2379`
Used on: Pod
Annotation that kubeadm places on locally managed etcd Pods to keep track of
a list of URLs where etcd clients should connect to.
This is used mainly for etcd cluster health check purposes.
### kubeadm.kubernetes.io/kube-apiserver.advertise-address.endpoint
Type: Annotation
Example: `kubeadm.kubernetes.io/kube-apiserver.advertise-address.endpoint: https://172.17.0.18:6443`
Used on: Pod
Annotation that kubeadm places on locally managed `kube-apiserver` Pods to keep track
of the exposed advertise address/port endpoint for that API server instance.
### kubeadm.kubernetes.io/component-config.hash
Type: Annotation
Example: `kubeadm.kubernetes.io/component-config.hash: 2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae`
Used on: ConfigMap
Annotation that kubeadm places on ConfigMaps that it manages for configuring components.
It contains a hash (SHA-256) used to determine if the user has applied settings different
from the kubeadm defaults for a particular component.
### node-role.kubernetes.io/control-plane
Type: Label
Used on: Node
A marker label to indicate that the node is used to run control plane components.
The kubeadm tool applies this label to the control plane nodes that it manages.
Other cluster management tools typically also set this taint.
You can label control plane nodes with this label to make it easier to schedule Pods
only onto these nodes, or to avoid running Pods on the control plane.
If this label is set, the [EndpointSlice controller](/docs/concepts/services-networking/topology-aware-routing/#implementation-control-plane)
ignores that node while calculating Topology Aware Hints.
### node-role.kubernetes.io/control-plane {#node-role-kubernetes-io-control-plane-taint}
Type: Taint
Example: `node-role.kubernetes.io/control-plane:NoSchedule`
Used on: Node
Taint that kubeadm applies on control plane nodes to restrict placing Pods and
allow only specific pods to schedule on them.
If this Taint is applied, control plane nodes allow only critical workloads to
be scheduled onto them. You can manually remove this taint with the following
command on a specific node.
```shell
kubectl taint nodes <node-name> node-role.kubernetes.io/control-plane:NoSchedule-
```
### node-role.kubernetes.io/master (deprecated) {#node-role-kubernetes-io-master-taint}
Type: Taint
Used on: Node
Example: `node-role.kubernetes.io/master:NoSchedule`
Taint that kubeadm previously applied on control plane nodes to allow only critical
workloads to schedule on them. Replaced by the
[`node-role.kubernetes.io/control-plane`](#node-role-kubernetes-io-control-plane-taint)
taint. kubeadm no longer sets or uses this deprecated taint. | kubernetes reference | title Well Known Labels Annotations and Taints content type concept weight 40 no list true card name reference weight 30 anchors anchor labels annotations and taints used on api objects title Labels annotations and taints overview Kubernetes reserves all labels annotations and taints in the kubernetes io and k8s io namespaces This document serves both as a reference to the values and as a coordination point for assigning values body Labels annotations and taints used on API objects apf kubernetes io autoupdate spec Type Annotation Example apf kubernetes io autoupdate spec true Used on FlowSchema and PriorityLevelConfiguration Objects docs concepts cluster administration flow control defaults If this annotation is set to true on a FlowSchema or PriorityLevelConfiguration the spec for that object is managed by the kube apiserver If the API server does not recognize an APF object and you annotate it for automatic update the API server deletes the entire object Otherwise the API server does not manage the object spec For more details read Maintenance of the Mandatory and Suggested Configuration Objects docs concepts cluster administration flow control maintenance of the mandatory and suggested configuration objects app kubernetes io component Type Label Example app kubernetes io component database Used on All Objects typically used on workload resources docs reference kubernetes api workload resources The component within the application architecture One of the recommended labels docs concepts overview working with objects common labels labels app kubernetes io created by deprecated Type Label Example app kubernetes io created by controller manager Used on All Objects typically used on workload resources docs reference kubernetes api workload resources The controller user who created this resource Starting from v1 9 this label is deprecated app kubernetes io instance Type Label Example app kubernetes io instance mysql abcxyz Used on All Objects typically used on workload resources docs reference kubernetes api workload resources A unique name identifying the instance of an application To assign a non unique name use app kubernetes io name app kubernetes io name One of the recommended labels docs concepts overview working with objects common labels labels app kubernetes io managed by Type Label Example app kubernetes io managed by helm Used on All Objects typically used on workload resources docs reference kubernetes api workload resources The tool being used to manage the operation of an application One of the recommended labels docs concepts overview working with objects common labels labels app kubernetes io name Type Label Example app kubernetes io name mysql Used on All Objects typically used on workload resources docs reference kubernetes api workload resources The name of the application One of the recommended labels docs concepts overview working with objects common labels labels app kubernetes io part of Type Label Example app kubernetes io part of wordpress Used on All Objects typically used on workload resources docs reference kubernetes api workload resources The name of a higher level application this object is part of One of the recommended labels docs concepts overview working with objects common labels labels app kubernetes io version Type Label Example app kubernetes io version 5 7 21 Used on All Objects typically used on workload resources docs reference kubernetes api workload resources The current version of the application Common forms of values include semantic version https semver org spec v1 0 0 html the Git revision hash https git scm com book en v2 Git Tools Revision Selection single revisions for the source code One of the recommended labels docs concepts overview working with objects common labels labels applyset kubernetes io additional namespaces alpha applyset kubernetes io additional namespaces Type Annotation Example applyset kubernetes io additional namespaces namespace1 namespace2 Used on Objects being used as ApplySet parents Use of this annotation is Alpha For Kubernetes version you can use this annotation on Secrets ConfigMaps or custom resources if the defining them has the applyset kubernetes io is parent type label Part of the specification used to implement ApplySet based pruning in kubectl docs tasks manage kubernetes objects declarative config alternative kubectl apply f directory prune This annotation is applied to the parent object used to track an ApplySet to extend the scope of the ApplySet beyond the parent object s own namespace if any The value is a comma separated list of the names of namespaces other than the parent s namespace in which objects are found applyset kubernetes io contains group kinds alpha applyset kubernetes io contains group kinds Type Annotation Example applyset kubernetes io contains group kinds certificates cert manager io configmaps deployments apps secrets services Used on Objects being used as ApplySet parents Use of this annotation is Alpha For Kubernetes version you can use this annotation on Secrets ConfigMaps or custom resources if the CustomResourceDefinition defining them has the applyset kubernetes io is parent type label Part of the specification used to implement ApplySet based pruning in kubectl docs tasks manage kubernetes objects declarative config alternative kubectl apply f directory prune This annotation is applied to the parent object used to track an ApplySet to optimize listing of ApplySet member objects It is optional in the ApplySet specification as tools can perform discovery or use a different optimization However as of Kubernetes version it is required by kubectl When present the value of this annotation must be a comma separated list of the group kinds in the fully qualified name format i e resource group applyset kubernetes io contains group resources deprecated applyset kubernetes io contains group resources Type Annotation Example applyset kubernetes io contains group resources certificates cert manager io configmaps deployments apps secrets services Used on Objects being used as ApplySet parents For Kubernetes version you can use this annotation on Secrets ConfigMaps or custom resources if the CustomResourceDefinition defining them has the applyset kubernetes io is parent type label Part of the specification used to implement ApplySet based pruning in kubectl docs tasks manage kubernetes objects declarative config alternative kubectl apply f directory prune This annotation is applied to the parent object used to track an ApplySet to optimize listing of ApplySet member objects It is optional in the ApplySet specification as tools can perform discovery or use a different optimization However in Kubernetes version it is required by kubectl When present the value of this annotation must be a comma separated list of the group kinds in the fully qualified name format i e resource group This annotation is currently deprecated and replaced by applyset kubernetes io contains group kinds applyset kubernetes io contains group kinds support for this will be removed in applyset beta or GA applyset kubernetes io id alpha applyset kubernetes io id Type Label Example applyset kubernetes io id applyset 0eFHV8ySqp7XoShsGvyWFQD3s96yqwHmzc4e0HR1dsY v1 Used on Objects being used as ApplySet parents Use of this label is Alpha For Kubernetes version you can use this label on Secrets ConfigMaps or custom resources if the CustomResourceDefinition defining them has the applyset kubernetes io is parent type label Part of the specification used to implement ApplySet based pruning in kubectl docs tasks manage kubernetes objects declarative config alternative kubectl apply f directory prune This label is what makes an object an ApplySet parent object Its value is the unique ID of the ApplySet which is derived from the identity of the parent object itself This ID must be the base64 encoding using the URL safe encoding of RFC4648 of the hash of the group kind name namespace of the object it is on in the form base64 sha256 name namespace kind group There is no relation between the value of this label and object UID applyset kubernetes io is parent type alpha applyset kubernetes io is parent type Type Label Example applyset kubernetes io is parent type true Used on Custom Resource Definition CRD Use of this label is Alpha Part of the specification used to implement ApplySet based pruning in kubectl docs tasks manage kubernetes objects declarative config alternative kubectl apply f directory prune You can set this label on a CustomResourceDefinition CRD to identify the custom resource type it defines not the CRD itself as an allowed parent for an ApplySet The only permitted value for this label is true if you want to mark a CRD as not being a valid parent for ApplySets omit this label applyset kubernetes io part of alpha applyset kubernetes io part of Type Label Example applyset kubernetes io part of applyset 0eFHV8ySqp7XoShsGvyWFQD3s96yqwHmzc4e0HR1dsY v1 Used on All objects Use of this label is Alpha Part of the specification used to implement ApplySet based pruning in kubectl docs tasks manage kubernetes objects declarative config alternative kubectl apply f directory prune This label is what makes an object a member of an ApplySet The value of the label must match the value of the applyset kubernetes io id label on the parent object applyset kubernetes io tooling alpha applyset kubernetes io tooling Type Annotation Example applyset kubernetes io tooling kubectl v Used on Objects being used as ApplySet parents Use of this annotation is Alpha For Kubernetes version you can use this annotation on Secrets ConfigMaps or custom resources if the CustomResourceDefinitiondefining them has the applyset kubernetes io is parent type label Part of the specification used to implement ApplySet based pruning in kubectl docs tasks manage kubernetes objects declarative config alternative kubectl apply f directory prune This annotation is applied to the parent object used to track an ApplySet to indicate which tooling manages that ApplySet Tooling should refuse to mutate ApplySets belonging to other tools The value must be in the format toolname semver apps kubernetes io pod index beta apps kubernetes io pod index Type Label Example apps kubernetes io pod index 0 Used on Pod When a StatefulSet controller creates a Pod for the StatefulSet it sets this label on that Pod The value of the label is the ordinal index of the pod being created See Pod Index Label docs concepts workloads controllers statefulset pod index label in the StatefulSet topic for more details Note the PodIndexLabel docs reference command line tools reference feature gates feature gate must be enabled for this label to be added to pods resource kubernetes io pod claim name Type Annotation Example resource kubernetes io pod claim name my pod claim Used on ResourceClaim This annotation is assigned to generated ResourceClaims Its value corresponds to the name of the resource claim in the spec of any Pod s for which the ResourceClaim was created This annotation is an internal implementation detail of dynamic resource allocation docs concepts scheduling eviction dynamic resource allocation You should not need to read or modify the value of this annotation cluster autoscaler kubernetes io safe to evict Type Annotation Example cluster autoscaler kubernetes io safe to evict true Used on Pod When this annotation is set to true the cluster autoscaler is allowed to evict a Pod even if other rules would normally prevent that The cluster autoscaler never evicts Pods that have this annotation explicitly set to false you could set that on an important Pod that you want to keep running If this annotation is not set then the cluster autoscaler follows its Pod level behavior config kubernetes io local config Type Annotation Example config kubernetes io local config true Used on All objects This annotation is used in manifests to mark an object as local configuration that should not be submitted to the Kubernetes API A value of true for this annotation declares that the object is only consumed by client side tooling and should not be submitted to the API server A value of false can be used to declare that the object should be submitted to the API server even when it would otherwise be assumed to be local This annotation is part of the Kubernetes Resource Model KRM Functions Specification which is used by Kustomize and similar third party tools For example Kustomize removes objects with this annotation from its final build output container apparmor security beta kubernetes io deprecated container apparmor security beta kubernetes io Type Annotation Example container apparmor security beta kubernetes io my container my custom profile Used on Pods This annotation allows you to specify the AppArmor security profile for a container within a Kubernetes pod As of Kubernetes v1 30 this should be set with the appArmorProfile field instead To learn more see the AppArmor docs tutorials security apparmor tutorial The tutorial illustrates using AppArmor to restrict a container s abilities and access The profile specified dictates the set of rules and restrictions that the containerized process must adhere to This helps enforce security policies and isolation for your containers internal config kubernetes io reserved prefix internal config kubernetes io reserved wildcard Type Annotation Used on All objects This prefix is reserved for internal use by tools that act as orchestrators in accordance with the Kubernetes Resource Model KRM Functions Specification Annotations with this prefix are internal to the orchestration process and are not persisted to the manifests on the filesystem In other words the orchestrator tool should set these annotations when reading files from the local filesystem and remove them when writing the output of functions back to the filesystem A KRM function must not modify annotations with this prefix unless otherwise specified for a given annotation This enables orchestrator tools to add additional internal annotations without requiring changes to existing functions internal config kubernetes io path Type Annotation Example internal config kubernetes io path relative file path yaml Used on All objects This annotation records the slash delimited OS agnostic relative path to the manifest file the object was loaded from The path is relative to a fixed location on the filesystem determined by the orchestrator tool This annotation is part of the Kubernetes Resource Model KRM Functions Specification which is used by Kustomize and similar third party tools A KRM Function should not modify this annotation on input objects unless it is modifying the referenced files A KRM Function may include this annotation on objects it generates internal config kubernetes io index Type Annotation Example internal config kubernetes io index 2 Used on All objects This annotation records the zero indexed position of the YAML document that contains the object within the manifest file the object was loaded from Note that YAML documents are separated by three dashes and can each contain one object When this annotation is not specified a value of 0 is implied This annotation is part of the Kubernetes Resource Model KRM Functions Specification which is used by Kustomize and similar third party tools A KRM Function should not modify this annotation on input objects unless it is modifying the referenced files A KRM Function may include this annotation on objects it generates kube scheduler simulator sigs k8s io bind result Type Annotation Example kube scheduler simulator sigs k8s io bind result DefaultBinder success Used on Pod This annotation records the result of bind scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io filter result Type Annotation Example yaml kube scheduler simulator sigs k8s io filter result node 282x7 AzureDiskLimits passed EBSLimits passed GCEPDLimits passed InterPodAffinity passed NodeAffinity passed NodeName passed NodePorts passed NodeResourcesFit passed NodeUnschedulable passed NodeVolumeLimits passed PodTopologySpread passed TaintToleration passed VolumeBinding passed VolumeRestrictions passed VolumeZone passed node gp9t4 AzureDiskLimits passed EBSLimits passed GCEPDLimits passed InterPodAffinity passed NodeAffinity passed NodeName passed NodePorts passed NodeResourcesFit passed NodeUnschedulable passed NodeVolumeLimits passed PodTopologySpread passed TaintToleration passed VolumeBinding passed VolumeRestrictions passed VolumeZone passed Used on Pod This annotation records the result of filter scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io finalscore result Type Annotation Example yaml kube scheduler simulator sigs k8s io finalscore result node 282x7 ImageLocality 0 InterPodAffinity 0 NodeAffinity 0 NodeNumber 0 NodeResourcesBalancedAllocation 76 NodeResourcesFit 73 PodTopologySpread 200 TaintToleration 300 VolumeBinding 0 node gp9t4 ImageLocality 0 InterPodAffinity 0 NodeAffinity 0 NodeNumber 0 NodeResourcesBalancedAllocation 76 NodeResourcesFit 73 PodTopologySpread 200 TaintToleration 300 VolumeBinding 0 Used on Pod This annotation records the final scores that the scheduler calculates from the scores from score scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io permit result Type Annotation Example kube scheduler simulator sigs k8s io permit result CustomPermitPlugin success Used on Pod This annotation records the result of permit scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io permit result timeout Type Annotation Example kube scheduler simulator sigs k8s io permit result timeout CustomPermitPlugin 10s Used on Pod This annotation records the timeouts returned from permit scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io postfilter result Type Annotation Example kube scheduler simulator sigs k8s io postfilter result DefaultPreemption success Used on Pod This annotation records the result of postfilter scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io prebind result Type Annotation Example kube scheduler simulator sigs k8s io prebind result VolumeBinding success Used on Pod This annotation records the result of prebind scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io prefilter result Type Annotation Example kube scheduler simulator sigs k8s io prebind result NodeAffinity node a Used on Pod This annotation records the PreFilter result of prefilter scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io prefilter result status Type Annotation Example yaml kube scheduler simulator sigs k8s io prefilter result status InterPodAffinity success NodeAffinity success NodePorts success NodeResourcesFit success PodTopologySpread success VolumeBinding success VolumeRestrictions success Used on Pod This annotation records the result of prefilter scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io prescore result Type Annotation Example yaml kube scheduler simulator sigs k8s io prescore result InterPodAffinity success NodeAffinity success NodeNumber success PodTopologySpread success TaintToleration success Used on Pod This annotation records the result of prefilter scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io reserve result Type Annotation Example kube scheduler simulator sigs k8s io reserve result VolumeBinding success Used on Pod This annotation records the result of reserve scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io result history Type Annotation Example kube scheduler simulator sigs k8s io result history Used on Pod This annotation records all the past scheduling results from scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io score result Type Annotation yaml kube scheduler simulator sigs k8s io score result node 282x7 ImageLocality 0 InterPodAffinity 0 NodeAffinity 0 NodeNumber 0 NodeResourcesBalancedAllocation 76 NodeResourcesFit 73 PodTopologySpread 0 TaintToleration 0 VolumeBinding 0 node gp9t4 ImageLocality 0 InterPodAffinity 0 NodeAffinity 0 NodeNumber 0 NodeResourcesBalancedAllocation 76 NodeResourcesFit 73 PodTopologySpread 0 TaintToleration 0 VolumeBinding 0 Used on Pod This annotation records the result of score scheduler plugins used by https sigs k8s io kube scheduler simulator kube scheduler simulator sigs k8s io selected node Type Annotation Example kube scheduler simulator sigs k8s io selected node node 282x7 Used on Pod This annotation records the node that is selected by the scheduling cycle used by https sigs k8s io kube scheduler simulator kubernetes io arch Type Label Example kubernetes io arch amd64 Used on Node The Kubelet populates this with runtime GOARCH as defined by Go This can be handy if you are mixing ARM and x86 nodes kubernetes io os Type Label Example kubernetes io os linux Used on Node Pod For nodes the kubelet populates this with runtime GOOS as defined by Go This can be handy if you are mixing operating systems in your cluster for example mixing Linux and Windows nodes You can also set this label on a Pod Kubernetes allows you to set any value for this label if you use this label you should nevertheless set it to the Go runtime GOOS string for the operating system that this Pod actually works with When the kubernetes io os label value for a Pod does not match the label value on a Node the kubelet on the node will not admit the Pod However this is not taken into account by the kube scheduler Alternatively the kubelet refuses to run a Pod where you have specified a Pod OS if this isn t the same as the operating system for the node where that kubelet is running Just look for Pods OS docs concepts workloads pods pod os for more details kubernetes io metadata name Type Label Example kubernetes io metadata name mynamespace Used on Namespaces The Kubernetes API server part of the sets this label on all namespaces The label value is set to the name of the namespace You can t change this label s value This is useful if you want to target a specific namespace with a label kubernetes io limit ranger Type Annotation Example kubernetes io limit ranger LimitRanger plugin set cpu memory request for container nginx cpu memory limit for container nginx Used on Pod Kubernetes by default doesn t provide any resource limit that means unless you explicitly define limits your container can consume unlimited CPU and memory You can define a default request or default limit for pods You do this by creating a LimitRange in the relevant namespace Pods deployed after you define a LimitRange will have these limits applied to them The annotation kubernetes io limit ranger records that resource defaults were specified for the Pod and they were applied successfully For more details read about LimitRanges docs concepts policy limit range kubernetes io config hash Type Annotation Example kubernetes io config hash df7cc47f8477b6b1226d7d23a904867b Used on Pod When the kubelet creates a static Pod based on a given manifest it attaches this annotation to the static Pod The value of the annotation is the UID of the Pod Note that the kubelet also sets the spec nodeName to the current node name as if the Pod was scheduled to the node kubernetes io config mirror Type Annotation Example kubernetes io config mirror df7cc47f8477b6b1226d7d23a904867b Used on Pod For a static Pod created by the kubelet on a node a is created on the API server The kubelet adds an annotation to indicate that this Pod is actually a mirror Pod The annotation value is copied from the kubernetes io config hash kubernetes io config hash annotation which is the UID of the Pod When updating a Pod with this annotation set the annotation cannot be changed or removed If a Pod doesn t have this annotation it cannot be added during a Pod update kubernetes io config source Type Annotation Example kubernetes io config source file Used on Pod This annotation is added by the kubelet to indicate where the Pod comes from For static Pods the annotation value could be one of file or http depending on where the Pod manifest is located For a Pod created on the API server and then scheduled to the current node the annotation value is api kubernetes io config seen Type Annotation Example kubernetes io config seen 2023 10 27T04 04 56 011314488Z Used on Pod When the kubelet sees a Pod for the first time it may add this annotation to the Pod with a value of current timestamp in the RFC3339 format addonmanager kubernetes io mode Type Label Example addonmanager kubernetes io mode Reconcile Used on All objects To specify how an add on should be managed you can use the addonmanager kubernetes io mode label This label can have one of three values Reconcile EnsureExists or Ignore Reconcile Addon resources will be periodically reconciled with the expected state If there are any differences the add on manager will recreate reconfigure or delete the resources as needed This is the default mode if no label is specified EnsureExists Addon resources will be checked for existence only but will not be modified after creation The add on manager will create or re create the resources when there is no instance of the resource with that name Ignore Addon resources will be ignored This mode is useful for add ons that are not compatible with the add on manager or that are managed by another controller For more details see Addon manager https github com kubernetes kubernetes blob master cluster addons addon manager README md beta kubernetes io arch deprecated Type Label This label has been deprecated Please use kubernetes io arch kubernetes io arch instead beta kubernetes io os deprecated Type Label This label has been deprecated Please use kubernetes io os kubernetes io os instead kube aggregator kubernetes io automanaged kube aggregator kubernetesio automanaged Type Label Example kube aggregator kubernetes io automanaged onstart Used on APIService The kube apiserver sets this label on any APIService object that the API server has created automatically The label marks how the control plane should manage that APIService You should not add modify or remove this label by yourself Automanaged APIService objects are deleted by kube apiserver when it has no built in or custom resource API corresponding to the API group version of the APIService There are two possible values onstart The APIService should be reconciled when an API server starts up but not otherwise true The API server should reconcile this APIService continuously service alpha kubernetes io tolerate unready endpoints deprecated Type Annotation Used on StatefulSet This annotation on a Service denotes if the Endpoints controller should go ahead and create Endpoints for unready Pods Endpoints of these Services retain their DNS records and continue receiving traffic for the Service from the moment the kubelet starts all containers in the pod and marks it Running til the kubelet stops all containers and deletes the pod from the API server autoscaling alpha kubernetes io behavior deprecated autoscaling alpha kubernetes io behavior Type Annotation Used on HorizontalPodAutoscaler This annotation was used to configure the scaling behavior for a HorizontalPodAutoscaler HPA in earlier Kubernetes versions It allowed you to specify how the HPA should scale pods up or down including setting stabilization windows and scaling policies Setting this annotation has no effect in any supported release of Kubernetes kubernetes io hostname kubernetesiohostname Type Label Example kubernetes io hostname ip 172 20 114 199 ec2 internal Used on Node The Kubelet populates this label with the hostname of the node Note that the hostname can be changed from the actual hostname by passing the hostname override flag to the kubelet This label is also used as part of the topology hierarchy See topology kubernetes io zone topologykubernetesiozone for more information kubernetes io change cause change cause Type Annotation Example kubernetes io change cause kubectl edit record deployment foo Used on All Objects This annotation is a best guess at why something was changed It is populated when adding record to a kubectl command that may change an object kubernetes io description description Type Annotation Example kubernetes io description Description of K8s object Used on All Objects This annotation is used for describing specific behaviour of given object kubernetes io enforce mountable secrets enforce mountable secrets Type Annotation Example kubernetes io enforce mountable secrets true Used on ServiceAccount The value for this annotation must be true to take effect When you set this annotation to true Kubernetes enforces the following rules for Pods running as this ServiceAccount 1 Secrets mounted as volumes must be listed in the ServiceAccount s secrets field 1 Secrets referenced in envFrom for containers including sidecar containers and init containers must also be listed in the ServiceAccount s secrets field If any container in a Pod references a Secret not listed in the ServiceAccount s secrets field and even if the reference is marked as optional then the Pod will fail to start and an error indicating the non compliant secret reference will be generated 1 Secrets referenced in a Pod s imagePullSecrets must be present in the ServiceAccount s imagePullSecrets field the Pod will fail to start and an error indicating the non compliant image pull secret reference will be generated When you create or update a Pod these rules are checked If a Pod doesn t follow them it won t start and you ll see an error message If a Pod is already running and you change the kubernetes io enforce mountable secrets annotation to true or you edit the associated ServiceAccount to remove the reference to a Secret that the Pod is already using the Pod continues to run node kubernetes io exclude from external load balancers Type Label Example node kubernetes io exclude from external load balancers Used on Node You can add labels to particular worker nodes to exclude them from the list of backend servers used by external load balancers The following command can be used to exclude a worker node from the list of backend servers in a backend set shell kubectl label nodes node name node kubernetes io exclude from external load balancers true controller kubernetes io pod deletion cost pod deletion cost Type Annotation Example controller kubernetes io pod deletion cost 10 Used on Pod This annotation is used to set Pod Deletion Cost docs concepts workloads controllers replicaset pod deletion cost which allows users to influence ReplicaSet downscaling order The annotation value parses into an int32 type cluster autoscaler kubernetes io enable ds eviction Type Annotation Example cluster autoscaler kubernetes io enable ds eviction true Used on Pod This annotation controls whether a DaemonSet pod should be evicted by a ClusterAutoscaler This annotation needs to be specified on DaemonSet pods in a DaemonSet manifest When this annotation is set to true the ClusterAutoscaler is allowed to evict a DaemonSet Pod even if other rules would normally prevent that To disallow the ClusterAutoscaler from evicting DaemonSet pods you can set this annotation to false for important DaemonSet pods If this annotation is not set then the ClusterAutoscaler follows its overall behavior i e evict the DaemonSets based on its configuration This annotation only impacts DaemonSet Pods kubernetes io ingress bandwidth Type Annotation Example kubernetes io ingress bandwidth 10M Used on Pod You can apply quality of service traffic shaping to a pod and effectively limit its available bandwidth Ingress traffic to a Pod is handled by shaping queued packets to effectively handle data To limit the bandwidth on a Pod write an object definition JSON file and specify the data traffic speed using kubernetes io ingress bandwidth annotation The unit used for specifying ingress rate is bits per second as a Quantity docs reference kubernetes api common definitions quantity For example 10M means 10 megabits per second Ingress traffic shaping annotation is an experimental feature If you want to enable traffic shaping support you must add the bandwidth plugin to your CNI configuration file default etc cni net d and ensure that the binary is included in your CNI bin dir default opt cni bin kubernetes io egress bandwidth Type Annotation Example kubernetes io egress bandwidth 10M Used on Pod Egress traffic from a Pod is handled by policing which simply drops packets in excess of the configured rate The limits you place on a Pod do not affect the bandwidth of other Pods To limit the bandwidth on a Pod write an object definition JSON file and specify the data traffic speed using kubernetes io egress bandwidth annotation The unit used for specifying egress rate is bits per second as a Quantity docs reference kubernetes api common definitions quantity For example 10M means 10 megabits per second Egress traffic shaping annotation is an experimental feature If you want to enable traffic shaping support you must add the bandwidth plugin to your CNI configuration file default etc cni net d and ensure that the binary is included in your CNI bin dir default opt cni bin beta kubernetes io instance type deprecated Type Label Starting in v1 17 this label is deprecated in favor of node kubernetes io instance type nodekubernetesioinstance type node kubernetes io instance type nodekubernetesioinstance type Type Label Example node kubernetes io instance type m3 medium Used on Node The Kubelet populates this with the instance type as defined by the cloud provider This will be set only if you are using a cloud provider This setting is handy if you want to target certain workloads to certain instance types but typically you want to rely on the Kubernetes scheduler to perform resource based scheduling You should aim to schedule based on properties rather than on instance types for example require a GPU instead of requiring a g2 2xlarge failure domain beta kubernetes io region deprecated failure domainbetakubernetesioregion Type Label Starting in v1 17 this label is deprecated in favor of topology kubernetes io region topologykubernetesioregion failure domain beta kubernetes io zone deprecated failure domainbetakubernetesiozone Type Label Starting in v1 17 this label is deprecated in favor of topology kubernetes io zone topologykubernetesiozone pv kubernetes io bind completed pv kubernetesiobind completed Type Annotation Example pv kubernetes io bind completed yes Used on PersistentVolumeClaim When this annotation is set on a PersistentVolumeClaim PVC that indicates that the lifecycle of the PVC has passed through initial binding setup When present that information changes how the control plane interprets the state of PVC objects The value of this annotation does not matter to Kubernetes pv kubernetes io bound by controller pv kubernetesioboundby controller Type Annotation Example pv kubernetes io bound by controller yes Used on PersistentVolume PersistentVolumeClaim If this annotation is set on a PersistentVolume or PersistentVolumeClaim it indicates that a storage binding PersistentVolume PersistentVolumeClaim or PersistentVolumeClaim PersistentVolume was installed by the If the annotation isn t set and there is a storage binding in place the absence of that annotation means that the binding was done manually The value of this annotation does not matter pv kubernetes io provisioned by pv kubernetesiodynamically provisioned Type Annotation Example pv kubernetes io provisioned by kubernetes io rbd Used on PersistentVolume This annotation is added to a PersistentVolume PV that has been dynamically provisioned by Kubernetes Its value is the name of volume plugin that created the volume It serves both users to show where a PV comes from and Kubernetes to recognize dynamically provisioned PVs in its decisions pv kubernetes io migrated to pv kubernetesio migratedto Type Annotation Example pv kubernetes io migrated to pd csi storage gke io Used on PersistentVolume PersistentVolumeClaim It is added to a PersistentVolume PV and PersistentVolumeClaim PVC that is supposed to be dynamically provisioned deleted by its corresponding CSI driver through the CSIMigration feature gate When this annotation is set the Kubernetes components will stand down and the external provisioner will act on the objects statefulset kubernetes io pod name statefulsetkubernetesiopod name Type Label Example statefulset kubernetes io pod name mystatefulset 7 Used on Pod When a StatefulSet controller creates a Pod for the StatefulSet the control plane sets this label on that Pod The value of the label is the name of the Pod being created See Pod Name Label docs concepts workloads controllers statefulset pod name label in the StatefulSet topic for more details scheduler alpha kubernetes io node selector schedulerkubernetesnode selector Type Annotation Example scheduler alpha kubernetes io node selector name of node selector Used on Namespace The PodNodeSelector docs reference access authn authz admission controllers podnodeselector uses this annotation key to assign node selectors to pods in namespaces topology kubernetes io region topologykubernetesioregion Type Label Example topology kubernetes io region us east 1 Used on Node PersistentVolume See topology kubernetes io zone topologykubernetesiozone topology kubernetes io zone topologykubernetesiozone Type Label Example topology kubernetes io zone us east 1c Used on Node PersistentVolume On Node The kubelet or the external cloud controller manager populates this with the information from the cloud provider This will be set only if you are using a cloud provider However you can consider setting this on nodes if it makes sense in your topology On PersistentVolume topology aware volume provisioners will automatically set node affinity constraints on a PersistentVolume A zone represents a logical failure domain It is common for Kubernetes clusters to span multiple zones for increased availability While the exact definition of a zone is left to infrastructure implementations common properties of a zone include very low network latency within a zone no cost network traffic within a zone and failure independence from other zones For example nodes within a zone might share a network switch but nodes in different zones should not A region represents a larger domain made up of one or more zones It is uncommon for Kubernetes clusters to span multiple regions While the exact definition of a zone or region is left to infrastructure implementations common properties of a region include higher network latency between them than within them non zero cost for network traffic between them and failure independence from other zones or regions For example nodes within a region might share power infrastructure e g a UPS or generator but nodes in different regions typically would not Kubernetes makes a few assumptions about the structure of zones and regions 1 regions and zones are hierarchical zones are strict subsets of regions and no zone can be in 2 regions 2 zone names are unique across regions for example region africa east 1 might be comprised of zones africa east 1a and africa east 1b It should be safe to assume that topology labels do not change Even though labels are strictly mutable consumers of them can assume that a given node is not going to be moved between zones without being destroyed and recreated Kubernetes can use this information in various ways For example the scheduler automatically tries to spread the Pods in a ReplicaSet across nodes in a single zone cluster to reduce the impact of node failures see kubernetes io hostname kubernetesiohostname With multiple zone clusters this spreading behavior also applies to zones to reduce the impact of zone failures This is achieved via SelectorSpreadPriority SelectorSpreadPriority is a best effort placement If the zones in your cluster are heterogeneous for example different numbers of nodes different types of nodes or different pod resource requirements this placement might prevent equal spreading of your Pods across zones If desired you can use homogeneous zones same number and types of nodes to reduce the probability of unequal spreading The scheduler through the VolumeZonePredicate predicate also will ensure that Pods that claim a given volume are only placed into the same zone as that volume Volumes cannot be attached across zones If PersistentVolumeLabel does not support automatic labeling of your PersistentVolumes you should consider adding the labels manually or adding support for PersistentVolumeLabel With PersistentVolumeLabel the scheduler prevents Pods from mounting volumes in a different zone If your infrastructure doesn t have this constraint you don t need to add the zone labels to the volumes at all volume beta kubernetes io storage provisioner deprecated Type Annotation Example volume beta kubernetes io storage provisioner k8s io minikube hostpath Used on PersistentVolumeClaim This annotation has been deprecated since v1 23 See volume kubernetes io storage provisioner volume kubernetes io storage provisioner volume beta kubernetes io storage class deprecated Type Annotation Example volume beta kubernetes io storage class example class Used on PersistentVolume PersistentVolumeClaim This annotation can be used for PersistentVolume PV or PersistentVolumeClaim PVC to specify the name of StorageClass docs concepts storage storage classes When both the storageClassName attribute and the volume beta kubernetes io storage class annotation are specified the annotation volume beta kubernetes io storage class takes precedence over the storageClassName attribute This annotation has been deprecated Instead set the storageClassName field docs concepts storage persistent volumes class for the PersistentVolumeClaim or PersistentVolume volume beta kubernetes io mount options deprecated mount options Type Annotation Example volume beta kubernetes io mount options ro soft Used on PersistentVolume A Kubernetes administrator can specify additional mount options docs concepts storage persistent volumes mount options for when a PersistentVolume is mounted on a node volume kubernetes io storage provisioner volume kubernetes io storage provisioner Type Annotation Used on PersistentVolumeClaim This annotation is added to a PVC that is supposed to be dynamically provisioned Its value is the name of a volume plugin that is supposed to provision a volume for this PVC volume kubernetes io selected node Type Annotation Used on PersistentVolumeClaim This annotation is added to a PVC that is triggered by a scheduler to be dynamically provisioned Its value is the name of the selected node volumes kubernetes io controller managed attach detach Type Annotation Used on Node If a node has the annotation volumes kubernetes io controller managed attach detach its storage attach and detach operations are being managed by the volume attach detach The value of the annotation isn t important node kubernetes io windows build nodekubernetesiowindows build Type Label Example node kubernetes io windows build 10 0 17763 Used on Node When the kubelet is running on Microsoft Windows it automatically labels its Node to record the version of Windows Server in use The label s value is in the format MajorVersion MinorVersion BuildNumber storage alpha kubernetes io migrated plugins storagealphakubernetesiomigrated plugins Type Annotation Example storage alpha kubernetes io migrated plugins kubernetes io cinder Used on CSINode an extension API This annotation is automatically added for the CSINode object that maps to a node that installs CSIDriver This annotation shows the in tree plugin name of the migrated plugin Its value depends on your cluster s in tree cloud provider storage type For example if the in tree cloud provider storage type is CSIMigrationvSphere the CSINodes instance for the node should be updated with storage alpha kubernetes io migrated plugins kubernetes io vsphere volume service kubernetes io headless servicekubernetesioheadless Type Label Example service kubernetes io headless Used on Endpoints The control plane adds this label to an Endpoints object when the owning Service is headless To learn more read Headless Services docs concepts services networking service headless services service kubernetes io topology aware hints deprecated servicekubernetesiotopology aware hints Example service kubernetes io topology aware hints Auto Used on Service This annotation was used for enabling topology aware hints on Services Topology aware hints have since been renamed the concept is now called topology aware routing docs concepts services networking topology aware routing Setting the annotation to Auto on a Service configured the Kubernetes control plane to add topology hints on EndpointSlices associated with that Service You can also explicitly set the annotation to Disabled If you are running a version of Kubernetes older than check the documentation for that Kubernetes version to see how topology aware routing works in that release There are no other valid values for this annotation If you don t want topology aware hints for a Service don t add this annotation service kubernetes io topology mode Type Annotation Example service kubernetes io topology mode Auto Used on Service This annotation provides a way to define how Services handle network topology for example you can configure a Service so that Kubernetes prefers keeping traffic between a client and server within a single topology zone In some cases this can help reduce costs or improve network performance See Topology Aware Routing docs concepts services networking topology aware routing for more details kubernetes io service name kubernetesioservice name Type Label Example kubernetes io service name my website Used on EndpointSlice Kubernetes associates EndpointSlices docs concepts services networking endpoint slices with Services docs concepts services networking service using this label This label records the of the Service that the EndpointSlice is backing All EndpointSlices should have this label set to the name of their associated Service kubernetes io service account name Type Annotation Example kubernetes io service account name sa name Used on Secret This annotation records the of the ServiceAccount that the token stored in the Secret of type kubernetes io service account token represents kubernetes io service account uid Type Annotation Example kubernetes io service account uid da68f9c6 9d26 11e7 b84e 002dc52800da Used on Secret This annotation records the of the ServiceAccount that the token stored in the Secret of type kubernetes io service account token represents kubernetes io legacy token last used Type Label Example kubernetes io legacy token last used 2022 10 24 Used on Secret The control plane only adds this label to Secrets that have the type kubernetes io service account token The value of this label records the date ISO 8601 format UTC time zone when the control plane last saw a request where the client authenticated using the service account token If a legacy token was last used before the cluster gained the feature added in Kubernetes v1 26 then the label isn t set kubernetes io legacy token invalid since Type Label Example kubernetes io legacy token invalid since 2023 10 27 Used on Secret The control plane automatically adds this label to auto generated Secrets that have the type kubernetes io service account token This label marks the Secret based token as invalid for authentication The value of this label records the date ISO 8601 format UTC time zone when the control plane detects that the auto generated Secret has not been used for a specified duration defaults to one year endpointslice kubernetes io managed by endpointslicekubernetesiomanaged by Type Label Example endpointslice kubernetes io managed by endpointslice controller k8s io Used on EndpointSlices The label is used to indicate the controller or entity that manages the EndpointSlice This label aims to enable different EndpointSlice objects to be managed by different controllers or entities within the same cluster endpointslice kubernetes io skip mirror endpointslicekubernetesioskip mirror Type Label Example endpointslice kubernetes io skip mirror true Used on Endpoints The label can be set to true on an Endpoints resource to indicate that the EndpointSliceMirroring controller should not mirror this resource with EndpointSlices service kubernetes io service proxy name servicekubernetesioservice proxy name Type Label Example service kubernetes io service proxy name foo bar Used on Service The kube proxy has this label for custom proxy which delegates service control to custom proxy experimental windows kubernetes io isolation type deprecated experimental windows kubernetes io isolation type Type Annotation Example experimental windows kubernetes io isolation type hyperv Used on Pod The annotation is used to run Windows containers with Hyper V isolation Starting from v1 20 this annotation is deprecated Experimental Hyper V support was removed in 1 21 ingressclass kubernetes io is default class Type Annotation Example ingressclass kubernetes io is default class true Used on IngressClass When a IngressClass resource has this annotation set to true new Ingress resource without a class specified will be assigned this default class nginx ingress kubernetes io configuration snippet Type Annotation Example nginx ingress kubernetes io configuration snippet more set headers Request Id req id nmore set headers Example 42 n Used on Ingress You can use this annotation to set extra configuration on an Ingress that uses the NGINX Ingress Controller https github com kubernetes ingress nginx The configuration snippet annotation is ignored by default since version 1 9 0 of the ingress controller The NGINX ingress controller setting allow snippet annotations has to be explicitly enabled to use this annotation Enabling the annotation can be dangerous in a multi tenant cluster as it can lead people with otherwise limited permissions being able to retrieve all Secrets in the cluster kubernetes io ingress class deprecated Type Annotation Used on Ingress Starting in v1 18 this annotation is deprecated in favor of spec ingressClassName storageclass kubernetes io is default class Type Annotation Example storageclass kubernetes io is default class true Used on StorageClass When a single StorageClass resource has this annotation set to true new PersistentVolumeClaim resource without a class specified will be assigned this default class alpha kubernetes io provided node ip alpha alpha kubernetes io provided node ip Type Annotation Example alpha kubernetes io provided node ip 10 0 0 1 Used on Node The kubelet can set this annotation on a Node to denote its configured IPv4 and or IPv6 address When kubelet is started with the cloud provider flag set to any value includes both external and legacy in tree cloud providers it sets this annotation on the Node to denote an IP address set from the command line flag node ip This IP is verified with the cloud provider as valid by the cloud controller manager batch kubernetes io job completion index Type Annotation Label Example batch kubernetes io job completion index 3 Used on Pod The Job controller in the kube controller manager sets this as a label and annotation for Pods created with Indexed completion mode docs concepts workloads controllers job completion mode Note the PodIndexLabel docs reference command line tools reference feature gates feature gate must be enabled for this to be added as a pod label otherwise it will just be an annotation batch kubernetes io cronjob scheduled timestamp Type Annotation Example batch kubernetes io cronjob scheduled timestamp 2016 05 19T03 00 00 07 00 Used on Jobs and Pods controlled by CronJobs This annotation is used to record the original expected creation timestamp for a Job when that Job is part of a CronJob The control plane sets the value to that timestamp in RFC3339 format If the Job belongs to a CronJob with a timezone specified then the timestamp is in that timezone Otherwise the timestamp is in controller manager s local time kubectl kubernetes io default container Type Annotation Example kubectl kubernetes io default container front end app The value of the annotation is the container name that is default for this Pod For example kubectl logs or kubectl exec without c or container flag will use this default container kubectl kubernetes io default logs container deprecated Type Annotation Example kubectl kubernetes io default logs container front end app The value of the annotation is the container name that is the default logging container for this Pod For example kubectl logs without c or container flag will use this default container This annotation is deprecated You should use the kubectl kubernetes io default container kubectl kubernetes io default container annotation instead Kubernetes versions 1 25 and newer ignore this annotation kubectl kubernetes io last applied configuration Type Annotation Example see following snippet yaml kubectl kubernetes io last applied configuration apiVersion apps v1 kind Deployment metadata annotations name example namespace default spec selector matchLabels app kubernetes io name foo template metadata labels app kubernetes io name foo spec containers image container registry example foo bar 1 42 name foo bar ports containerPort 42 Used on all objects The kubectl command line tool uses this annotation as a legacy mechanism to track changes That mechanism has been superseded by Server side apply docs reference using api server side apply kubectl kubernetes io restartedAt kubectl k8s io restart at Type Annotation Example kubectl kubernetes io restartedAt 2024 06 21T17 27 41Z Used on Deployment ReplicaSet StatefulSet DaemonSet Pod This annotation contains the latest restart time of a resource Deployment ReplicaSet StatefulSet or DaemonSet where kubectl triggered a rollout in order to force creation of new Pods The command kubectl rollout restart RESOURCE triggers a restart by patching the template metadata of all the pods of resource with this annotation In above example the latest restart time is shown as 21st June 2024 at 17 27 41 UTC You should not assume that this annotation represents the date time of the most recent update a separate change could have been made since the last manually triggered rollout If you manually set this annotation on a Pod nothing happens The restarting side effect comes from how workload management and Pod templating works endpoints kubernetes io over capacity Type Annotation Example endpoints kubernetes io over capacity truncated Used on Endpoints The adds this annotation to an Endpoints docs concepts services networking service endpoints object if the associated has more than 1000 backing endpoints The annotation indicates that the Endpoints object is over capacity and the number of endpoints has been truncated to 1000 If the number of backend endpoints falls below 1000 the control plane removes this annotation endpoints kubernetes io last change trigger time Type Annotation Example endpoints kubernetes io last change trigger time 2023 07 20T04 45 21Z Used on Endpoints This annotation set to an Endpoints docs concepts services networking service endpoints object that represents the timestamp The timestamp is stored in RFC 3339 date time string format For example 2018 10 22T19 32 52 1Z This is timestamp of the last change in some Pod or Service object that triggered the change to the Endpoints object control plane alpha kubernetes io leader deprecated control plane alpha kubernetes io leader Type Annotation Example control plane alpha kubernetes io leader holderIdentity controller 0 leaseDurationSeconds 15 acquireTime 2023 01 19T13 12 57Z renewTime 2023 01 19T13 13 54Z leaderTransitions 1 Used on Endpoints The previously set annotation on an Endpoints docs concepts services networking service endpoints object This annotation provided the following detail Who is the current leader The time when the current leadership was acquired The duration of the lease of the leadership in seconds The time the current lease the current leadership should be renewed The number of leadership transitions that happened in the past Kubernetes now uses Leases docs concepts architecture leases to manage leader assignment for the Kubernetes control plane batch kubernetes io job tracking deprecated batch kubernetes io job tracking Type Annotation Example batch kubernetes io job tracking Used on Jobs The presence of this annotation on a Job used to indicate that the control plane is tracking the Job status using finalizers docs concepts workloads controllers job job tracking with finalizers Adding or removing this annotation no longer has an effect Kubernetes v1 27 and later All Jobs are tracked with finalizers job name deprecated job name Type Label Example job name pi Used on Jobs and Pods controlled by Jobs Starting from Kubernetes 1 27 this label is deprecated Kubernetes 1 27 and newer ignore this label and use the prefixed job name label controller uid deprecated controller uid Type Label Example controller uid UID Used on Jobs and Pods controlled by Jobs Starting from Kubernetes 1 27 this label is deprecated Kubernetes 1 27 and newer ignore this label and use the prefixed controller uid label batch kubernetes io job name batchkubernetesio job name Type Label Example batch kubernetes io job name pi Used on Jobs and Pods controlled by Jobs This label is used as a user friendly way to get Pods corresponding to a Job The job name comes from the name of the Job and allows for an easy way to get Pods corresponding to the Job batch kubernetes io controller uid batchkubernetesio controller uid Type Label Example batch kubernetes io controller uid UID Used on Jobs and Pods controlled by Jobs This label is used as a programmatic way to get all Pods corresponding to a Job The controller uid is a unique identifier that gets set in the selector field so the Job controller can get all the corresponding Pods scheduler alpha kubernetes io defaultTolerations scheduleralphakubernetesio defaulttolerations Type Annotation Example scheduler alpha kubernetes io defaultTolerations operator Equal value value1 effect NoSchedule key dedicated node Used on Namespace This annotation requires the PodTolerationRestriction docs reference access authn authz admission controllers podtolerationrestriction admission controller to be enabled This annotation key allows assigning tolerations to a namespace and any new pods created in this namespace would get these tolerations added scheduler alpha kubernetes io tolerationsWhitelist schedulerkubernetestolerations whitelist Type Annotation Example scheduler alpha kubernetes io tolerationsWhitelist operator Exists effect NoSchedule key dedicated node Used on Namespace This annotation is only useful when the Alpha PodTolerationRestriction docs reference access authn authz admission controllers podtolerationrestriction admission controller is enabled The annotation value is a JSON document that defines a list of allowed tolerations for the namespace it annotates When you create a Pod or modify its tolerations the API server checks the tolerations to see if they are mentioned in the allow list The pod is admitted only if the check succeeds scheduler alpha kubernetes io preferAvoidPods deprecated scheduleralphakubernetesio preferavoidpods Type Annotation Used on Node This annotation requires the NodePreferAvoidPods scheduling plugin docs reference scheduling config scheduling plugins to be enabled The plugin is deprecated since Kubernetes 1 22 Use Taints and Tolerations docs concepts scheduling eviction taint and toleration instead node kubernetes io not ready Type Taint Example node kubernetes io not ready NoExecute Used on Node The Node controller detects whether a Node is ready by monitoring its health and adds or removes this taint accordingly node kubernetes io unreachable Type Taint Example node kubernetes io unreachable NoExecute Used on Node The Node controller adds the taint to a Node corresponding to the NodeCondition docs concepts architecture nodes condition Ready being Unknown node kubernetes io unschedulable Type Taint Example node kubernetes io unschedulable NoSchedule Used on Node The taint will be added to a node when initializing the node to avoid race condition node kubernetes io memory pressure Type Taint Example node kubernetes io memory pressure NoSchedule Used on Node The kubelet detects memory pressure based on memory available and allocatableMemory available observed on a Node The observed values are then compared to the corresponding thresholds that can be set on the kubelet to determine if the Node condition and taint should be added removed node kubernetes io disk pressure Type Taint Example node kubernetes io disk pressure NoSchedule Used on Node The kubelet detects disk pressure based on imagefs available imagefs inodesFree nodefs available and nodefs inodesFree Linux only observed on a Node The observed values are then compared to the corresponding thresholds that can be set on the kubelet to determine if the Node condition and taint should be added removed node kubernetes io network unavailable Type Taint Example node kubernetes io network unavailable NoSchedule Used on Node This is initially set by the kubelet when the cloud provider used indicates a requirement for additional network configuration Only when the route on the cloud is configured properly will the taint be removed by the cloud provider node kubernetes io pid pressure Type Taint Example node kubernetes io pid pressure NoSchedule Used on Node The kubelet checks D value of the size of proc sys kernel pid max and the PIDs consumed by Kubernetes on a node to get the number of available PIDs that referred to as the pid available metric The metric is then compared to the corresponding threshold that can be set on the kubelet to determine if the node condition and taint should be added removed node kubernetes io out of service Type Taint Example node kubernetes io out of service NoExecute Used on Node A user can manually add the taint to a Node marking it out of service If the NodeOutOfServiceVolumeDetach feature gate docs reference command line tools reference feature gates is enabled on kube controller manager and a Node is marked out of service with this taint the Pods on the node will be forcefully deleted if there are no matching tolerations on it and volume detach operations for the Pods terminating on the node will happen immediately This allows the Pods on the out of service node to recover quickly on a different node Refer to Non graceful node shutdown docs concepts architecture nodes non graceful node shutdown for further details about when and how to use this taint node cloudprovider kubernetes io uninitialized Type Taint Example node cloudprovider kubernetes io uninitialized NoSchedule Used on Node Sets this taint on a Node to mark it as unusable when kubelet is started with the external cloud provider until a controller from the cloud controller manager initializes this Node and then removes the taint node cloudprovider kubernetes io shutdown Type Taint Example node cloudprovider kubernetes io shutdown NoSchedule Used on Node If a Node is in a cloud provider specified shutdown state the Node gets tainted accordingly with node cloudprovider kubernetes io shutdown and the taint effect of NoSchedule feature node kubernetes io Type Label Example feature node kubernetes io network sriov capable true Used on Node These labels are used by the Node Feature Discovery NFD component to advertise features on a node All built in labels use the feature node kubernetes io label namespace and have the format feature node kubernetes io feature name true NFD has many extension points for creating vendor and application specific labels For details see the customization guide https kubernetes sigs github io node feature discovery v0 12 usage customization guide nfd node kubernetes io master version Type Annotation Example nfd node kubernetes io master version v0 6 0 Used on Node For node s where the Node Feature Discovery NFD master https kubernetes sigs github io node feature discovery stable usage nfd master html is scheduled this annotation records the version of the NFD master It is used for informative use only nfd node kubernetes io worker version Type Annotation Example nfd node kubernetes io worker version v0 4 0 Used on Nodes This annotation records the version for a Node Feature Discovery s worker https kubernetes sigs github io node feature discovery stable usage nfd worker html if there is one running on a node It s used for informative use only nfd node kubernetes io feature labels Type Annotation Example nfd node kubernetes io feature labels cpu cpuid ADX cpu cpuid AESNI cpu hardware multithreading kernel version full Used on Nodes This annotation records a comma separated list of node feature labels managed by Node Feature Discovery https kubernetes sigs github io node feature discovery NFD NFD uses this for an internal mechanism You should not edit this annotation yourself nfd node kubernetes io extended resources Type Annotation Example nfd node kubernetes io extended resources accelerator acme example q500 example com coprocessor fx5 Used on Nodes This annotation records a comma separated list of extended resources docs concepts configuration manage resources containers extended resources managed by Node Feature Discovery https kubernetes sigs github io node feature discovery NFD NFD uses this for an internal mechanism You should not edit this annotation yourself nfd node kubernetes io node name Type Label Example nfd node kubernetes io node name node 1 Used on Nodes It specifies which node the NodeFeature object is targeting Creators of NodeFeature objects must set this label and consumers of the objects are supposed to use the label for filtering features designated for a certain node These Node Feature Discovery NFD labels or annotations only apply to the nodes where NFD is running To learn more about NFD and its components go to its official documentation https kubernetes sigs github io node feature discovery stable get started service beta kubernetes io aws load balancer access log emit interval beta service beta kubernetes io aws load balancer access log emit interval Example service beta kubernetes io aws load balancer access log emit interval 5 Used on Service The cloud controller manager integration with AWS elastic load balancing configures the load balancer for a Service based on this annotation The value determines how often the load balancer writes log entries For example if you set the value to 5 the log writes occur 5 seconds apart service beta kubernetes io aws load balancer access log enabled beta service beta kubernetes io aws load balancer access log enabled Example service beta kubernetes io aws load balancer access log enabled false Used on Service The cloud controller manager integration with AWS elastic load balancing configures the load balancer for a Service based on this annotation Access logging is enabled if you set the annotation to true service beta kubernetes io aws load balancer access log s3 bucket name beta service beta kubernetes io aws load balancer access log s3 bucket name Example service beta kubernetes io aws load balancer access log enabled example Used on Service The cloud controller manager integration with AWS elastic load balancing configures the load balancer for a Service based on this annotation The load balancer writes logs to an S3 bucket with the name you specify service beta kubernetes io aws load balancer access log s3 bucket prefix beta service beta kubernetes io aws load balancer access log s3 bucket prefix Example service beta kubernetes io aws load balancer access log enabled example Used on Service The cloud controller manager integration with AWS elastic load balancing configures the load balancer for a Service based on this annotation The load balancer writes log objects with the prefix that you specify service beta kubernetes io aws load balancer additional resource tags beta service beta kubernetes io aws load balancer additional resource tags Example service beta kubernetes io aws load balancer additional resource tags Environment demo Project example Used on Service The cloud controller manager integration with AWS elastic load balancing configures tags an AWS concept for a load balancer based on the comma separated key value pairs in the value of this annotation service beta kubernetes io aws load balancer alpn policy beta service beta kubernetes io aws load balancer alpn policy Example service beta kubernetes io aws load balancer alpn policy HTTP2Optional Used on Service The AWS load balancer controller https kubernetes sigs github io aws load balancer controller uses this annotation See annotations https kubernetes sigs github io aws load balancer controller latest guide service annotations in the AWS load balancer controller documentation service beta kubernetes io aws load balancer attributes beta service beta kubernetes io aws load balancer attributes Example service beta kubernetes io aws load balancer attributes deletion protection enabled true Used on Service The AWS load balancer controller https kubernetes sigs github io aws load balancer controller uses this annotation See annotations https kubernetes sigs github io aws load balancer controller latest guide service annotations in the AWS load balancer controller documentation service beta kubernetes io aws load balancer backend protocol beta service beta kubernetes io aws load balancer backend protocol Example service beta kubernetes io aws load balancer backend protocol tcp Used on Service The cloud controller manager integration with AWS elastic load balancing configures the load balancer listener based on the value of this annotation service beta kubernetes io aws load balancer connection draining enabled beta service beta kubernetes io aws load balancer connection draining enabled Example service beta kubernetes io aws load balancer connection draining enabled false Used on Service The cloud controller manager integration with AWS elastic load balancing configures the load balancer based on this annotation The load balancer s connection draining setting depends on the value you set service beta kubernetes io aws load balancer connection draining timeout beta service beta kubernetes io aws load balancer connection draining timeout Example service beta kubernetes io aws load balancer connection draining timeout 60 Used on Service If you configure connection draining service beta kubernetes io aws load balancer connection draining enabled for a Service of type LoadBalancer and you use the AWS cloud the integration configures the draining period based on this annotation The value you set determines the draining timeout in seconds service beta kubernetes io aws load balancer ip address type beta service beta kubernetes io aws load balancer ip address type Example service beta kubernetes io aws load balancer ip address type ipv4 Used on Service The AWS load balancer controller https kubernetes sigs github io aws load balancer controller uses this annotation See annotations https kubernetes sigs github io aws load balancer controller latest guide service annotations in the AWS load balancer controller documentation service beta kubernetes io aws load balancer connection idle timeout beta service beta kubernetes io aws load balancer connection idle timeout Example service beta kubernetes io aws load balancer connection idle timeout 60 Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The load balancer has a configured idle timeout period in seconds that applies to its connections If no data has been sent or received by the time that the idle timeout period elapses the load balancer closes the connection service beta kubernetes io aws load balancer cross zone load balancing enabled beta service beta kubernetes io aws load balancer cross zone load balancing enabled Example service beta kubernetes io aws load balancer cross zone load balancing enabled true Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation If you set this annotation to true each load balancer node distributes requests evenly across the registered targets in all enabled availability zones https docs aws amazon com AWSEC2 latest UserGuide using regions availability zones html concepts availability zones If you disable cross zone load balancing each load balancer node distributes requests evenly across the registered targets in its availability zone only service beta kubernetes io aws load balancer eip allocations beta service beta kubernetes io aws load balancer eip allocations Example service beta kubernetes io aws load balancer eip allocations eipalloc 01bcdef23bcdef456 eipalloc def1234abc4567890 Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The value is a comma separated list of elastic IP address allocation IDs This annotation is only relevant for Services of type LoadBalancer where the load balancer is an AWS Network Load Balancer service beta kubernetes io aws load balancer extra security groups beta service beta kubernetes io aws load balancer extra security groups Example service beta kubernetes io aws load balancer extra security groups sg 12abcd3456 sg 34dcba6543 Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The annotation value is a comma separated list of extra AWS VPC security groups to configure for the load balancer service beta kubernetes io aws load balancer healthcheck healthy threshold beta service beta kubernetes io aws load balancer healthcheck healthy threshold Example service beta kubernetes io aws load balancer healthcheck healthy threshold 3 Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The annotation value specifies the number of successive successful health checks required for a backend to be considered healthy for traffic service beta kubernetes io aws load balancer healthcheck interval beta service beta kubernetes io aws load balancer healthcheck interval Example service beta kubernetes io aws load balancer healthcheck interval 30 Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The annotation value specifies the interval in seconds between health check probes made by the load balancer service beta kubernetes io aws load balancer healthcheck path beta service beta kubernetes io aws load balancer healthcheck papth Example service beta kubernetes io aws load balancer healthcheck path healthcheck Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The annotation value determines the path part of the URL that is used for HTTP health checks service beta kubernetes io aws load balancer healthcheck port beta service beta kubernetes io aws load balancer healthcheck port Example service beta kubernetes io aws load balancer healthcheck port 24 Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The annotation value determines which port the load balancer connects to when performing health checks service beta kubernetes io aws load balancer healthcheck protocol beta service beta kubernetes io aws load balancer healthcheck protocol Example service beta kubernetes io aws load balancer healthcheck protocol TCP Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The annotation value determines how the load balancer checks the health of backend targets service beta kubernetes io aws load balancer healthcheck timeout beta service beta kubernetes io aws load balancer healthcheck timeout Example service beta kubernetes io aws load balancer healthcheck timeout 3 Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The annotation value specifies the number of seconds before a probe that hasn t yet succeeded is automatically treated as having failed service beta kubernetes io aws load balancer healthcheck unhealthy threshold beta service beta kubernetes io aws load balancer healthcheck unhealthy threshold Example service beta kubernetes io aws load balancer healthcheck unhealthy threshold 3 Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation The annotation value specifies the number of successive unsuccessful health checks required for a backend to be considered unhealthy for traffic service beta kubernetes io aws load balancer internal beta service beta kubernetes io aws load balancer internal Example service beta kubernetes io aws load balancer internal true Used on Service The cloud controller manager integration with AWS elastic load balancing configures a load balancer based on this annotation When you set this annotation to true the integration configures an internal load balancer If you use the AWS load balancer controller https kubernetes sigs github io aws load balancer controller see service beta kubernetes io aws load balancer scheme service beta kubernetes io aws load balancer scheme service beta kubernetes io aws load balancer manage backend security group rules beta service beta kubernetes io aws load balancer manage backend security group rules Example service beta kubernetes io aws load balancer manage backend security group rules true Used on Service The AWS load balancer controller https kubernetes sigs github io aws load balancer controller uses this annotation See annotations https kubernetes sigs github io aws load balancer controller latest guide service annotations in the AWS load balancer controller documentation service beta kubernetes io aws load balancer name beta service beta kubernetes io aws load balancer name Example service beta kubernetes io aws load balancer name my elb Used on Service If you set this annotation on a Service and you also annotate that Service with service beta kubernetes io aws load balancer type external and you use the AWS load balancer controller https kubernetes sigs github io aws load balancer controller in your cluster then the AWS load balancer controller sets the name of that load balancer to the value you set for this annotation See annotations https kubernetes sigs github io aws load balancer controller latest guide service annotations in the AWS load balancer controller documentation service beta kubernetes io aws load balancer nlb target type beta service beta kubernetes io aws load balancer nlb target type Example service beta kubernetes io aws load balancer nlb target type true Used on Service The AWS load balancer controller https kubernetes sigs github io aws load balancer controller uses this annotation See annotations https kubernetes sigs github io aws load balancer controller latest guide service annotations in the AWS load balancer controller documentation service beta kubernetes io aws load balancer private ipv4 addresses beta service beta kubernetes io aws load balancer private ipv4 addresses Example service beta kubernetes io aws load balancer private ipv4 addresses 198 51 100 0 198 51 100 64 Used on Service The AWS load balancer controller https kubernetes sigs github io aws load balancer controller uses this annotation See annotations https kubernetes sigs github io aws load balancer controller latest guide service annotations in the AWS load balancer controller documentation service beta kubernetes io aws load balancer proxy protocol beta service beta kubernetes io aws load balancer proxy protocol Example service beta kubernetes io aws load balancer proxy protocol Used on Service The official Kubernetes integration with AWS elastic load balancing configures a load balancer based on this annotation The only permitted value is which indicates that the load balancer should wrap TCP connections to the backend Pod with the PROXY protocol service beta kubernetes io aws load balancer scheme beta service beta kubernetes io aws load balancer scheme Example service beta kubernetes io aws load balancer scheme internal Used on Service The AWS load balancer controller https kubernetes sigs github io aws load balancer controller uses this annotation See annotations https kubernetes sigs github io aws load balancer controller latest guide service annotations in the AWS load balancer controller documentation service beta kubernetes io aws load balancer security groups deprecated service beta kubernetes io aws load balancer security groups Example service beta kubernetes io aws load balancer security groups sg 53fae93f sg 8725gr62r Used on Service The AWS load balancer controller uses this annotation to specify a comma separated list of security groups you want to attach to an AWS load balancer Both name and ID of security are supported where name matches a Name tag not the groupName attribute When this annotation is added to a Service the load balancer controller attaches the security groups referenced by the annotation to the load balancer If you omit this annotation the AWS load balancer controller automatically creates a new security group and attaches it to the load balancer Kubernetes v1 27 and later do not directly set or read this annotation However the AWS load balancer controller part of the Kubernetes project does still use the service beta kubernetes io aws load balancer security groups annotation service beta kubernetes io load balancer source ranges deprecated service beta kubernetes io load balancer source ranges Example service beta kubernetes io load balancer source ranges 192 0 2 0 25 Used on Service The AWS load balancer controller https kubernetes sigs github io aws load balancer controller uses this annotation You should set spec loadBalancerSourceRanges for the Service instead service beta kubernetes io aws load balancer ssl cert beta service beta kubernetes io aws load balancer ssl cert Example service beta kubernetes io aws load balancer ssl cert arn aws acm us east 1 123456789012 certificate 12345678 1234 1234 1234 123456789012 Used on Service The official integration with AWS elastic load balancing configures TLS for a Service of type LoadBalancer based on this annotation The value of the annotation is the AWS Resource Name ARN of the X 509 certificate that the load balancer listener should use The TLS protocol is based on an older technology that abbreviates to SSL service beta kubernetes io aws load balancer ssl negotiation policy beta service beta kubernetes io aws load balancer ssl negotiation policy Example service beta kubernetes io aws load balancer ssl negotiation policy ELBSecurityPolicy TLS 1 2 2017 01 The official integration with AWS elastic load balancing configures TLS for a Service of type LoadBalancer based on this annotation The value of the annotation is the name of an AWS policy for negotiating TLS with a client peer service beta kubernetes io aws load balancer ssl ports beta service beta kubernetes io aws load balancer ssl ports Example service beta kubernetes io aws load balancer ssl ports The official integration with AWS elastic load balancing configures TLS for a Service of type LoadBalancer based on this annotation The value of the annotation is either which means that all the load balancer s ports should use TLS or it is a comma separated list of port numbers service beta kubernetes io aws load balancer subnets beta service beta kubernetes io aws load balancer subnets Example service beta kubernetes io aws load balancer subnets private a private b Kubernetes official integration with AWS uses this annotation to configure a load balancer and determine in which AWS availability zones to deploy the managed load balancing service The value is either a comma separated list of subnet names or a comma separated list of subnet IDs service beta kubernetes io aws load balancer target group attributes beta service beta kubernetes io aws load balancer target group attributes Example service beta kubernetes io aws load balancer target group attributes stickiness enabled true stickiness type source ip Used on Service The AWS load balancer controller https kubernetes sigs github io aws load balancer controller uses this annotation See annotations https kubernetes sigs github io aws load balancer controller latest guide service annotations in the AWS load balancer controller documentation service beta kubernetes io aws load balancer target node labels beta service beta kubernetes io aws target node labels Example service beta kubernetes io aws load balancer target node labels kubernetes io os Linux topology kubernetes io region us east 2 Kubernetes official integration with AWS uses this annotation to determine which nodes in your cluster should be considered as valid targets for the load balancer service beta kubernetes io aws load balancer type beta service beta kubernetes io aws load balancer type Example service beta kubernetes io aws load balancer type external Kubernetes official integrations with AWS use this annotation to determine whether the AWS cloud provider integration should manage a Service of type LoadBalancer There are two permitted values nlb the cloud controller manager configures a Network Load Balancer external the cloud controller manager does not configure any load balancer If you deploy a Service of type LoadBalancer on AWS and you don t set any service beta kubernetes io aws load balancer type annotation the AWS integration deploys a classic Elastic Load Balancer This behavior with no annotation present is the default unless you specify otherwise When you set this annotation to external on a Service of type LoadBalancer and your cluster has a working deployment of the AWS Load Balancer controller then the AWS Load Balancer controller attempts to deploy a load balancer based on the Service specification Do not modify or add the service beta kubernetes io aws load balancer type annotation on an existing Service object See the AWS documentation on this topic for more details service beta kubernetes io azure load balancer disable tcp reset deprecated service beta kubernetes azure load balancer disble tcp reset Example service beta kubernetes io azure load balancer disable tcp reset false Used on Service This annotation only works for Azure standard load balancer backed service This annotation is used on the Service to specify whether the load balancer should disable or enable TCP reset on idle timeout If enabled it helps applications to behave more predictably to detect the termination of a connection remove expired connections and initiate new connections You can set the value to be either true or false See Load Balancer TCP Reset https learn microsoft com en gb azure load balancer load balancer tcp reset for more information This annotation is deprecated pod security kubernetes io enforce Type Label Example pod security kubernetes io enforce baseline Used on Namespace Value must be one of privileged baseline or restricted which correspond to Pod Security Standard docs concepts security pod security standards levels Specifically the enforce label prohibits the creation of any Pod in the labeled Namespace which does not meet the requirements outlined in the indicated level See Enforcing Pod Security at the Namespace Level docs concepts security pod security admission for more information pod security kubernetes io enforce version Type Label Example pod security kubernetes io enforce version Used on Namespace Value must be latest or a valid Kubernetes version in the format v major minor This determines the version of the Pod Security Standard docs concepts security pod security standards policies to apply when validating a Pod See Enforcing Pod Security at the Namespace Level docs concepts security pod security admission for more information pod security kubernetes io audit Type Label Example pod security kubernetes io audit baseline Used on Namespace Value must be one of privileged baseline or restricted which correspond to Pod Security Standard docs concepts security pod security standards levels Specifically the audit label does not prevent the creation of a Pod in the labeled Namespace which does not meet the requirements outlined in the indicated level but adds an this annotation to the Pod See Enforcing Pod Security at the Namespace Level docs concepts security pod security admission for more information pod security kubernetes io audit version Type Label Example pod security kubernetes io audit version Used on Namespace Value must be latest or a valid Kubernetes version in the format v major minor This determines the version of the Pod Security Standard docs concepts security pod security standards policies to apply when validating a Pod See Enforcing Pod Security at the Namespace Level docs concepts security pod security admission for more information pod security kubernetes io warn Type Label Example pod security kubernetes io warn baseline Used on Namespace Value must be one of privileged baseline or restricted which correspond to Pod Security Standard docs concepts security pod security standards levels Specifically the warn label does not prevent the creation of a Pod in the labeled Namespace which does not meet the requirements outlined in the indicated level but returns a warning to the user after doing so Note that warnings are also displayed when creating or updating objects that contain Pod templates such as Deployments Jobs StatefulSets etc See Enforcing Pod Security at the Namespace Level docs concepts security pod security admission for more information pod security kubernetes io warn version Type Label Example pod security kubernetes io warn version Used on Namespace Value must be latest or a valid Kubernetes version in the format v major minor This determines the version of the Pod Security Standard docs concepts security pod security standards policies to apply when validating a submitted Pod Note that warnings are also displayed when creating or updating objects that contain Pod templates such as Deployments Jobs StatefulSets etc See Enforcing Pod Security at the Namespace Level docs concepts security pod security admission for more information rbac authorization kubernetes io autoupdate Type Annotation Example rbac authorization kubernetes io autoupdate false Used on ClusterRole ClusterRoleBinding Role RoleBinding When this annotation is set to true on default RBAC objects created by the API server they are automatically updated at server start to add missing permissions and subjects extra permissions and subjects are left in place To prevent autoupdating a particular role or rolebinding set this annotation to false If you create your own RBAC objects and set this annotation to false kubectl auth reconcile which allows reconciling arbitrary RBAC objects in a respects this annotation and does not automatically add missing permissions and subjects kubernetes io psp deprecated kubernetes io psp Type Annotation Example kubernetes io psp restricted Used on Pod This annotation was only relevant if you were using PodSecurityPolicy docs concepts security pod security policy objects Kubernetes v does not support the PodSecurityPolicy API When the PodSecurityPolicy admission controller admitted a Pod the admission controller modified the Pod to have this annotation The value of the annotation was the name of the PodSecurityPolicy that was used for validation seccomp security alpha kubernetes io pod non functional seccomp security alpha kubernetes io pod Type Annotation Used on Pod Kubernetes before v1 25 allowed you to configure seccomp behavior using this annotation See Restrict a Container s Syscalls with seccomp docs tutorials security seccomp to learn the supported way to specify seccomp restrictions for a Pod container seccomp security alpha kubernetes io NAME non functional container seccomp security alpha kubernetes io Type Annotation Used on Pod Kubernetes before v1 25 allowed you to configure seccomp behavior using this annotation See Restrict a Container s Syscalls with seccomp docs tutorials security seccomp to learn the supported way to specify seccomp restrictions for a Pod snapshot storage kubernetes io allow volume mode change Type Annotation Example snapshot storage kubernetes io allow volume mode change true Used on VolumeSnapshotContent Value can either be true or false This determines whether a user can modify the mode of the source volume when a PersistentVolumeClaim is being created from a VolumeSnapshot Refer to Converting the volume mode of a Snapshot docs concepts storage volume snapshots convert volume mode and the Kubernetes CSI Developer Documentation https kubernetes csi github io docs for more information scheduler alpha kubernetes io critical pod deprecated Type Annotation Example scheduler alpha kubernetes io critical pod Used on Pod This annotation lets Kubernetes control plane know about a Pod being a critical Pod so that the descheduler will not remove this Pod Starting in v1 16 this annotation was removed in favor of Pod Priority docs concepts scheduling eviction pod priority preemption Annotations used for audit sorted by annotation authorization k8s io decision docs reference labels annotations taints audit annotations authorization k8s io decision authorization k8s io reason docs reference labels annotations taints audit annotations authorization k8s io reason insecure sha1 invalid cert kubernetes io hostname docs reference labels annotations taints audit annotations insecure sha1 invalid cert kubernetes io hostname missing san invalid cert kubernetes io hostname docs reference labels annotations taints audit annotations missing san invalid cert kubernetes io hostname pod security kubernetes io audit violations docs reference labels annotations taints audit annotations pod security kubernetes io audit violations pod security kubernetes io enforce policy docs reference labels annotations taints audit annotations pod security kubernetes io enforce policy pod security kubernetes io exempt docs reference labels annotations taints audit annotations pod security kubernetes io exempt validation policy admission k8s io validation failure docs reference labels annotations taints audit annotations validation policy admission k8s io validation failure See more details on Audit Annotations docs reference labels annotations taints audit annotations kubeadm kubeadm alpha kubernetes io cri socket Type Annotation Example kubeadm alpha kubernetes io cri socket unix run containerd container sock Used on Node Annotation that kubeadm uses to preserve the CRI socket information given to kubeadm at init join time for later use kubeadm annotates the Node object with this information The annotation remains alpha since ideally this should be a field in KubeletConfiguration instead kubeadm kubernetes io etcd advertise client urls Type Annotation Example kubeadm kubernetes io etcd advertise client urls https 172 17 0 18 2379 Used on Pod Annotation that kubeadm places on locally managed etcd Pods to keep track of a list of URLs where etcd clients should connect to This is used mainly for etcd cluster health check purposes kubeadm kubernetes io kube apiserver advertise address endpoint Type Annotation Example kubeadm kubernetes io kube apiserver advertise address endpoint https 172 17 0 18 6443 Used on Pod Annotation that kubeadm places on locally managed kube apiserver Pods to keep track of the exposed advertise address port endpoint for that API server instance kubeadm kubernetes io component config hash Type Annotation Example kubeadm kubernetes io component config hash 2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae Used on ConfigMap Annotation that kubeadm places on ConfigMaps that it manages for configuring components It contains a hash SHA 256 used to determine if the user has applied settings different from the kubeadm defaults for a particular component node role kubernetes io control plane Type Label Used on Node A marker label to indicate that the node is used to run control plane components The kubeadm tool applies this label to the control plane nodes that it manages Other cluster management tools typically also set this taint You can label control plane nodes with this label to make it easier to schedule Pods only onto these nodes or to avoid running Pods on the control plane If this label is set the EndpointSlice controller docs concepts services networking topology aware routing implementation control plane ignores that node while calculating Topology Aware Hints node role kubernetes io control plane node role kubernetes io control plane taint Type Taint Example node role kubernetes io control plane NoSchedule Used on Node Taint that kubeadm applies on control plane nodes to restrict placing Pods and allow only specific pods to schedule on them If this Taint is applied control plane nodes allow only critical workloads to be scheduled onto them You can manually remove this taint with the following command on a specific node shell kubectl taint nodes node name node role kubernetes io control plane NoSchedule node role kubernetes io master deprecated node role kubernetes io master taint Type Taint Used on Node Example node role kubernetes io master NoSchedule Taint that kubeadm previously applied on control plane nodes to allow only critical workloads to schedule on them Replaced by the node role kubernetes io control plane node role kubernetes io control plane taint taint kubeadm no longer sets or uses this deprecated taint |
kubernetes reference contenttype tool reference Resource Types title Kubernetes Custom Metrics v1beta2 package custom metrics k8s io v1beta2 p Package v1beta2 is the v1beta2 version of the custommetrics API p autogenerated true | ---
title: Kubernetes Custom Metrics (v1beta2)
content_type: tool-reference
package: custom.metrics.k8s.io/v1beta2
auto_generated: true
---
<p>Package v1beta2 is the v1beta2 version of the custom_metrics API.</p>
## Resource Types
- [MetricListOptions](#custom-metrics-k8s-io-v1beta2-MetricListOptions)
- [MetricValue](#custom-metrics-k8s-io-v1beta2-MetricValue)
- [MetricValueList](#custom-metrics-k8s-io-v1beta2-MetricValueList)
## `MetricListOptions` {#custom-metrics-k8s-io-v1beta2-MetricListOptions}
<p>MetricListOptions is used to select metrics by their label selectors</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>custom.metrics.k8s.io/v1beta2</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>MetricListOptions</code></td></tr>
<tr><td><code>labelSelector</code><br/>
<code>string</code>
</td>
<td>
<p>A selector to restrict the list of returned objects by their labels.
Defaults to everything.</p>
</td>
</tr>
<tr><td><code>metricLabelSelector</code><br/>
<code>string</code>
</td>
<td>
<p>A selector to restrict the list of returned metrics by their labels</p>
</td>
</tr>
</tbody>
</table>
## `MetricValue` {#custom-metrics-k8s-io-v1beta2-MetricValue}
**Appears in:**
- [MetricValueList](#custom-metrics-k8s-io-v1beta2-MetricValueList)
<p>MetricValue is the metric value for some object</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>custom.metrics.k8s.io/v1beta2</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>MetricValue</code></td></tr>
<tr><td><code>describedObject</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectreference-v1-core"><code>core/v1.ObjectReference</code></a>
</td>
<td>
<p>a reference to the described object</p>
</td>
</tr>
<tr><td><code>metric</code> <B>[Required]</B><br/>
<a href="#custom-metrics-k8s-io-v1beta2-MetricIdentifier"><code>MetricIdentifier</code></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>timestamp</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta"><code>meta/v1.Time</code></a>
</td>
<td>
<p>indicates the time at which the metrics were produced</p>
</td>
</tr>
<tr><td><code>windowSeconds</code> <B>[Required]</B><br/>
<code>int64</code>
</td>
<td>
<p>indicates the window ([Timestamp-Window, Timestamp]) from
which these metrics were calculated, when returning rate
metrics calculated from cumulative metrics (or zero for
non-calculated instantaneous metrics).</p>
</td>
</tr>
<tr><td><code>value</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity"><code>k8s.io/apimachinery/pkg/api/resource.Quantity</code></a>
</td>
<td>
<p>the value of the metric for this</p>
</td>
</tr>
</tbody>
</table>
## `MetricValueList` {#custom-metrics-k8s-io-v1beta2-MetricValueList}
<p>MetricValueList is a list of values for a given metric for some set of objects</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>custom.metrics.k8s.io/v1beta2</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>MetricValueList</code></td></tr>
<tr><td><code>metadata</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>items</code> <B>[Required]</B><br/>
<a href="#custom-metrics-k8s-io-v1beta2-MetricValue"><code>[]MetricValue</code></a>
</td>
<td>
<p>the value of the metric across the described objects</p>
</td>
</tr>
</tbody>
</table>
## `MetricIdentifier` {#custom-metrics-k8s-io-v1beta2-MetricIdentifier}
**Appears in:**
- [MetricValue](#custom-metrics-k8s-io-v1beta2-MetricValue)
<p>MetricIdentifier identifies a metric by name and, optionally, selector</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 given metric</p>
</td>
</tr>
<tr><td><code>selector</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#labelselector-v1-meta"><code>meta/v1.LabelSelector</code></a>
</td>
<td>
<p>selector represents the label selector that could be used to select
this metric, and will generally just be the selector passed in to
the query used to fetch this metric.
When left blank, only the metric's Name will be used to gather metrics.</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title Kubernetes Custom Metrics v1beta2 content type tool reference package custom metrics k8s io v1beta2 auto generated true p Package v1beta2 is the v1beta2 version of the custom metrics API p Resource Types MetricListOptions custom metrics k8s io v1beta2 MetricListOptions MetricValue custom metrics k8s io v1beta2 MetricValue MetricValueList custom metrics k8s io v1beta2 MetricValueList MetricListOptions custom metrics k8s io v1beta2 MetricListOptions p MetricListOptions is used to select metrics by their label selectors 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 custom metrics k8s io v1beta2 code td tr tr td code kind code br string td td code MetricListOptions code td tr tr td code labelSelector code br code string code td td p A selector to restrict the list of returned objects by their labels Defaults to everything p td tr tr td code metricLabelSelector code br code string code td td p A selector to restrict the list of returned metrics by their labels p td tr tbody table MetricValue custom metrics k8s io v1beta2 MetricValue Appears in MetricValueList custom metrics k8s io v1beta2 MetricValueList p MetricValue is the metric value for some object 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 custom metrics k8s io v1beta2 code td tr tr td code kind code br string td td code MetricValue code td tr tr td code describedObject code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 objectreference v1 core code core v1 ObjectReference code a td td p a reference to the described object p td tr tr td code metric code B Required B br a href custom metrics k8s io v1beta2 MetricIdentifier code MetricIdentifier code a td td span class text muted No description provided span td tr tr td code timestamp code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 time v1 meta code meta v1 Time code a td td p indicates the time at which the metrics were produced p td tr tr td code windowSeconds code B Required B br code int64 code td td p indicates the window Timestamp Window Timestamp from which these metrics were calculated when returning rate metrics calculated from cumulative metrics or zero for non calculated instantaneous metrics p td tr tr td code value code B Required B br a href https pkg go dev k8s io apimachinery pkg api resource Quantity code k8s io apimachinery pkg api resource Quantity code a td td p the value of the metric for this p td tr tbody table MetricValueList custom metrics k8s io v1beta2 MetricValueList p MetricValueList is a list of values for a given metric for some set of objects 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 custom metrics k8s io v1beta2 code td tr tr td code kind code br string td td code MetricValueList code td tr tr td code metadata code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 listmeta v1 meta code meta v1 ListMeta code a td td span class text muted No description provided span td tr tr td code items code B Required B br a href custom metrics k8s io v1beta2 MetricValue code MetricValue code a td td p the value of the metric across the described objects p td tr tbody table MetricIdentifier custom metrics k8s io v1beta2 MetricIdentifier Appears in MetricValue custom metrics k8s io v1beta2 MetricValue p MetricIdentifier identifies a metric by name and optionally selector 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 given metric p td tr tr td code selector code br a href https kubernetes io docs reference generated kubernetes api v1 28 labelselector v1 meta code meta v1 LabelSelector code a td td p selector represents the label selector that could be used to select this metric and will generally just be the selector passed in to the query used to fetch this metric When left blank only the metric s Name will be used to gather metrics p td tr tbody table |
kubernetes reference contenttype tool reference package metrics k8s io v1beta1 title Kubernetes Metrics v1beta1 Resource Types p Package v1beta1 is the v1beta1 version of the metrics API p autogenerated true | ---
title: Kubernetes Metrics (v1beta1)
content_type: tool-reference
package: metrics.k8s.io/v1beta1
auto_generated: true
---
<p>Package v1beta1 is the v1beta1 version of the metrics API.</p>
## Resource Types
- [NodeMetrics](#metrics-k8s-io-v1beta1-NodeMetrics)
- [NodeMetricsList](#metrics-k8s-io-v1beta1-NodeMetricsList)
- [PodMetrics](#metrics-k8s-io-v1beta1-PodMetrics)
- [PodMetricsList](#metrics-k8s-io-v1beta1-PodMetricsList)
## `NodeMetrics` {#metrics-k8s-io-v1beta1-NodeMetrics}
**Appears in:**
- [NodeMetricsList](#metrics-k8s-io-v1beta1-NodeMetricsList)
<p>NodeMetrics sets resource usage metrics of a 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>metrics.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>NodeMetrics</code></td></tr>
<tr><td><code>metadata</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#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>timestamp</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta"><code>meta/v1.Time</code></a>
</td>
<td>
<p>The following fields define time interval from which metrics were
collected from the interval [Timestamp-Window, Timestamp].</p>
</td>
</tr>
<tr><td><code>window</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>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>usage</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcelist-v1-core"><code>core/v1.ResourceList</code></a>
</td>
<td>
<p>The memory usage is the memory working set.</p>
</td>
</tr>
</tbody>
</table>
## `NodeMetricsList` {#metrics-k8s-io-v1beta1-NodeMetricsList}
<p>NodeMetricsList is a list of NodeMetrics.</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>metrics.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>NodeMetricsList</code></td></tr>
<tr><td><code>metadata</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
</td>
<td>
<p>Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</p>
</td>
</tr>
<tr><td><code>items</code> <B>[Required]</B><br/>
<a href="#metrics-k8s-io-v1beta1-NodeMetrics"><code>[]NodeMetrics</code></a>
</td>
<td>
<p>List of node metrics.</p>
</td>
</tr>
</tbody>
</table>
## `PodMetrics` {#metrics-k8s-io-v1beta1-PodMetrics}
**Appears in:**
- [PodMetricsList](#metrics-k8s-io-v1beta1-PodMetricsList)
<p>PodMetrics sets resource usage metrics of a pod.</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>metrics.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>PodMetrics</code></td></tr>
<tr><td><code>metadata</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#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>timestamp</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta"><code>meta/v1.Time</code></a>
</td>
<td>
<p>The following fields define time interval from which metrics were
collected from the interval [Timestamp-Window, Timestamp].</p>
</td>
</tr>
<tr><td><code>window</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>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>containers</code> <B>[Required]</B><br/>
<a href="#metrics-k8s-io-v1beta1-ContainerMetrics"><code>[]ContainerMetrics</code></a>
</td>
<td>
<p>Metrics for all containers are collected within the same time window.</p>
</td>
</tr>
</tbody>
</table>
## `PodMetricsList` {#metrics-k8s-io-v1beta1-PodMetricsList}
<p>PodMetricsList is a list of PodMetrics.</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>metrics.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>PodMetricsList</code></td></tr>
<tr><td><code>metadata</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
</td>
<td>
<p>Standard list metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</p>
</td>
</tr>
<tr><td><code>items</code> <B>[Required]</B><br/>
<a href="#metrics-k8s-io-v1beta1-PodMetrics"><code>[]PodMetrics</code></a>
</td>
<td>
<p>List of pod metrics.</p>
</td>
</tr>
</tbody>
</table>
## `ContainerMetrics` {#metrics-k8s-io-v1beta1-ContainerMetrics}
**Appears in:**
- [PodMetrics](#metrics-k8s-io-v1beta1-PodMetrics)
<p>ContainerMetrics sets resource usage metrics of a container.</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>Container name corresponding to the one from pod.spec.containers.</p>
</td>
</tr>
<tr><td><code>usage</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcelist-v1-core"><code>core/v1.ResourceList</code></a>
</td>
<td>
<p>The memory usage is the memory working set.</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title Kubernetes Metrics v1beta1 content type tool reference package metrics k8s io v1beta1 auto generated true p Package v1beta1 is the v1beta1 version of the metrics API p Resource Types NodeMetrics metrics k8s io v1beta1 NodeMetrics NodeMetricsList metrics k8s io v1beta1 NodeMetricsList PodMetrics metrics k8s io v1beta1 PodMetrics PodMetricsList metrics k8s io v1beta1 PodMetricsList NodeMetrics metrics k8s io v1beta1 NodeMetrics Appears in NodeMetricsList metrics k8s io v1beta1 NodeMetricsList p NodeMetrics sets resource usage metrics of a 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 metrics k8s io v1beta1 code td tr tr td code kind code br string td td code NodeMetrics code td tr tr td code metadata code br a href https kubernetes io docs reference generated kubernetes api v1 28 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 timestamp code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 time v1 meta code meta v1 Time code a td td p The following fields define time interval from which metrics were collected from the interval Timestamp Window Timestamp p td tr tr td code window 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 span class text muted No description provided span td tr tr td code usage code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 resourcelist v1 core code core v1 ResourceList code a td td p The memory usage is the memory working set p td tr tbody table NodeMetricsList metrics k8s io v1beta1 NodeMetricsList p NodeMetricsList is a list of NodeMetrics 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 metrics k8s io v1beta1 code td tr tr td code kind code br string td td code NodeMetricsList code td tr tr td code metadata code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 listmeta v1 meta code meta v1 ListMeta code a td td p Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds p td tr tr td code items code B Required B br a href metrics k8s io v1beta1 NodeMetrics code NodeMetrics code a td td p List of node metrics p td tr tbody table PodMetrics metrics k8s io v1beta1 PodMetrics Appears in PodMetricsList metrics k8s io v1beta1 PodMetricsList p PodMetrics sets resource usage metrics of a pod 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 metrics k8s io v1beta1 code td tr tr td code kind code br string td td code PodMetrics code td tr tr td code metadata code br a href https kubernetes io docs reference generated kubernetes api v1 28 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 timestamp code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 time v1 meta code meta v1 Time code a td td p The following fields define time interval from which metrics were collected from the interval Timestamp Window Timestamp p td tr tr td code window 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 span class text muted No description provided span td tr tr td code containers code B Required B br a href metrics k8s io v1beta1 ContainerMetrics code ContainerMetrics code a td td p Metrics for all containers are collected within the same time window p td tr tbody table PodMetricsList metrics k8s io v1beta1 PodMetricsList p PodMetricsList is a list of PodMetrics 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 metrics k8s io v1beta1 code td tr tr td code kind code br string td td code PodMetricsList code td tr tr td code metadata code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 listmeta v1 meta code meta v1 ListMeta code a td td p Standard list metadata More info https git k8s io community contributors devel sig architecture api conventions md types kinds p td tr tr td code items code B Required B br a href metrics k8s io v1beta1 PodMetrics code PodMetrics code a td td p List of pod metrics p td tr tbody table ContainerMetrics metrics k8s io v1beta1 ContainerMetrics Appears in PodMetrics metrics k8s io v1beta1 PodMetrics p ContainerMetrics sets resource usage metrics of a container 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 Container name corresponding to the one from pod spec containers p td tr tr td code usage code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 resourcelist v1 core code core v1 ResourceList code a td td p The memory usage is the memory working set p td tr tbody table |
kubernetes reference title Kubernetes External Metrics v1beta1 contenttype tool reference p Package v1beta1 is the v1beta1 version of the external metrics API p Resource Types package external metrics k8s io v1beta1 autogenerated true | ---
title: Kubernetes External Metrics (v1beta1)
content_type: tool-reference
package: external.metrics.k8s.io/v1beta1
auto_generated: true
---
<p>Package v1beta1 is the v1beta1 version of the external metrics API.</p>
## Resource Types
- [ExternalMetricValue](#external-metrics-k8s-io-v1beta1-ExternalMetricValue)
- [ExternalMetricValueList](#external-metrics-k8s-io-v1beta1-ExternalMetricValueList)
## `ExternalMetricValue` {#external-metrics-k8s-io-v1beta1-ExternalMetricValue}
**Appears in:**
- [ExternalMetricValueList](#external-metrics-k8s-io-v1beta1-ExternalMetricValueList)
<p>ExternalMetricValue is a metric value for external metric
A single metric value is identified by metric name and a set of string labels.
For one metric there can be multiple values with different sets of labels.</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>external.metrics.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>ExternalMetricValue</code></td></tr>
<tr><td><code>metricName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>the name of the metric</p>
</td>
</tr>
<tr><td><code>metricLabels</code> <B>[Required]</B><br/>
<code>map[string]string</code>
</td>
<td>
<p>a set of labels that identify a single time series for the metric</p>
</td>
</tr>
<tr><td><code>timestamp</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta"><code>meta/v1.Time</code></a>
</td>
<td>
<p>indicates the time at which the metrics were produced</p>
</td>
</tr>
<tr><td><code>window</code> <B>[Required]</B><br/>
<code>int64</code>
</td>
<td>
<p>indicates the window ([Timestamp-Window, Timestamp]) from
which these metrics were calculated, when returning rate
metrics calculated from cumulative metrics (or zero for
non-calculated instantaneous metrics).</p>
</td>
</tr>
<tr><td><code>value</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity"><code>k8s.io/apimachinery/pkg/api/resource.Quantity</code></a>
</td>
<td>
<p>the value of the metric</p>
</td>
</tr>
</tbody>
</table>
## `ExternalMetricValueList` {#external-metrics-k8s-io-v1beta1-ExternalMetricValueList}
<p>ExternalMetricValueList is a list of values for a given metric for some set labels</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>external.metrics.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>ExternalMetricValueList</code></td></tr>
<tr><td><code>metadata</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>items</code> <B>[Required]</B><br/>
<a href="#external-metrics-k8s-io-v1beta1-ExternalMetricValue"><code>[]ExternalMetricValue</code></a>
</td>
<td>
<p>value of the metric matching a given set of labels</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title Kubernetes External Metrics v1beta1 content type tool reference package external metrics k8s io v1beta1 auto generated true p Package v1beta1 is the v1beta1 version of the external metrics API p Resource Types ExternalMetricValue external metrics k8s io v1beta1 ExternalMetricValue ExternalMetricValueList external metrics k8s io v1beta1 ExternalMetricValueList ExternalMetricValue external metrics k8s io v1beta1 ExternalMetricValue Appears in ExternalMetricValueList external metrics k8s io v1beta1 ExternalMetricValueList p ExternalMetricValue is a metric value for external metric A single metric value is identified by metric name and a set of string labels For one metric there can be multiple values with different sets of labels 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 external metrics k8s io v1beta1 code td tr tr td code kind code br string td td code ExternalMetricValue code td tr tr td code metricName code B Required B br code string code td td p the name of the metric p td tr tr td code metricLabels code B Required B br code map string string code td td p a set of labels that identify a single time series for the metric p td tr tr td code timestamp code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 time v1 meta code meta v1 Time code a td td p indicates the time at which the metrics were produced p td tr tr td code window code B Required B br code int64 code td td p indicates the window Timestamp Window Timestamp from which these metrics were calculated when returning rate metrics calculated from cumulative metrics or zero for non calculated instantaneous metrics p td tr tr td code value code B Required B br a href https pkg go dev k8s io apimachinery pkg api resource Quantity code k8s io apimachinery pkg api resource Quantity code a td td p the value of the metric p td tr tbody table ExternalMetricValueList external metrics k8s io v1beta1 ExternalMetricValueList p ExternalMetricValueList is a list of values for a given metric for some set labels 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 external metrics k8s io v1beta1 code td tr tr td code kind code br string td td code ExternalMetricValueList code td tr tr td code metadata code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 28 listmeta v1 meta code meta v1 ListMeta code a td td span class text muted No description provided span td tr tr td code items code B Required B br a href external metrics k8s io v1beta1 ExternalMetricValue code ExternalMetricValue code a td td p value of the metric matching a given set of labels p td tr tbody table |
kubernetes reference weight 20 file and passing its path as a command line argument feature state fork8sversion v1 25 state stable You can customize the behavior of the by writing a configuration contenttype concept title Scheduler Configuration | ---
title: Scheduler Configuration
content_type: concept
weight: 20
---
You can customize the behavior of the `kube-scheduler` by writing a configuration
file and passing its path as a command line argument.
<!-- overview -->
<!-- body -->
A scheduling Profile allows you to configure the different stages of scheduling
in the .
Each stage is exposed in an extension point. Plugins provide scheduling behaviors
by implementing one or more of these extension points.
You can specify scheduling profiles by running `kube-scheduler --config <filename>`,
using the
KubeSchedulerConfiguration [v1](/docs/reference/config-api/kube-scheduler-config.v1/)
struct.
A minimal configuration looks as follows:
```yaml
apiVersion: kubescheduler.config.k8s.io/v1
kind: KubeSchedulerConfiguration
clientConnection:
kubeconfig: /etc/srv/kubernetes/kube-scheduler/kubeconfig
```
KubeSchedulerConfiguration v1beta3 is deprecated in v1.26 and is removed in v1.29.
Please migrate KubeSchedulerConfiguration to [v1](/docs/reference/config-api/kube-scheduler-config.v1/).
## Profiles
A scheduling Profile allows you to configure the different stages of scheduling
in the .
Each stage is exposed in an [extension point](#extension-points).
[Plugins](#scheduling-plugins) provide scheduling behaviors by implementing one
or more of these extension points.
You can configure a single instance of `kube-scheduler` to run
[multiple profiles](#multiple-profiles).
### Extension points
Scheduling happens in a series of stages that are exposed through the following
extension points:
1. `queueSort`: These plugins provide an ordering function that is used to
sort pending Pods in the scheduling queue. Exactly one queue sort plugin
may be enabled at a time.
1. `preFilter`: These plugins are used to pre-process or check information
about a Pod or the cluster before filtering. They can mark a pod as
unschedulable.
1. `filter`: These plugins are the equivalent of Predicates in a scheduling
Policy and are used to filter out nodes that can not run the Pod. Filters
are called in the configured order. A pod is marked as unschedulable if no
nodes pass all the filters.
1. `postFilter`: These plugins are called in their configured order when no
feasible nodes were found for the pod. If any `postFilter` plugin marks the
Pod _schedulable_, the remaining plugins are not called.
1. `preScore`: This is an informational extension point that can be used
for doing pre-scoring work.
1. `score`: These plugins provide a score to each node that has passed the
filtering phase. The scheduler will then select the node with the highest
weighted scores sum.
1. `reserve`: This is an informational extension point that notifies plugins
when resources have been reserved for a given Pod. Plugins also implement an
`Unreserve` call that gets called in the case of failure during or after
`Reserve`.
1. `permit`: These plugins can prevent or delay the binding of a Pod.
1. `preBind`: These plugins perform any work required before a Pod is bound.
1. `bind`: The plugins bind a Pod to a Node. `bind` plugins are called in order
and once one has done the binding, the remaining plugins are skipped. At
least one bind plugin is required.
1. `postBind`: This is an informational extension point that is called after
a Pod has been bound.
1. `multiPoint`: This is a config-only field that allows plugins to be enabled
or disabled for all of their applicable extension points simultaneously.
For each extension point, you could disable specific [default plugins](#scheduling-plugins)
or enable your own. For example:
```yaml
apiVersion: kubescheduler.config.k8s.io/v1
kind: KubeSchedulerConfiguration
profiles:
- plugins:
score:
disabled:
- name: PodTopologySpread
enabled:
- name: MyCustomPluginA
weight: 2
- name: MyCustomPluginB
weight: 1
```
You can use `*` as name in the disabled array to disable all default plugins
for that extension point. This can also be used to rearrange plugins order, if
desired.
### Scheduling plugins
The following plugins, enabled by default, implement one or more of these
extension points:
- `ImageLocality`: Favors nodes that already have the container images that the
Pod runs.
Extension points: `score`.
- `TaintToleration`: Implements
[taints and tolerations](/docs/concepts/scheduling-eviction/taint-and-toleration/).
Implements extension points: `filter`, `preScore`, `score`.
- `NodeName`: Checks if a Pod spec node name matches the current node.
Extension points: `filter`.
- `NodePorts`: Checks if a node has free ports for the requested Pod ports.
Extension points: `preFilter`, `filter`.
- `NodeAffinity`: Implements
[node selectors](/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector)
and [node affinity](/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity).
Extension points: `filter`, `score`.
- `PodTopologySpread`: Implements
[Pod topology spread](/docs/concepts/scheduling-eviction/topology-spread-constraints/).
Extension points: `preFilter`, `filter`, `preScore`, `score`.
- `NodeUnschedulable`: Filters out nodes that have `.spec.unschedulable` set to
true.
Extension points: `filter`.
- `NodeResourcesFit`: Checks if the node has all the resources that the Pod is
requesting. The score can use one of three strategies: `LeastAllocated`
(default), `MostAllocated` and `RequestedToCapacityRatio`.
Extension points: `preFilter`, `filter`, `score`.
- `NodeResourcesBalancedAllocation`: Favors nodes that would obtain a more
balanced resource usage if the Pod is scheduled there.
Extension points: `score`.
- `VolumeBinding`: Checks if the node has or if it can bind the requested
.
Extension points: `preFilter`, `filter`, `reserve`, `preBind`, `score`.
`score` extension point is enabled when `VolumeCapacityPriority` feature is
enabled. It prioritizes the smallest PVs that can fit the requested volume
size.
- `VolumeRestrictions`: Checks that volumes mounted in the node satisfy
restrictions that are specific to the volume provider.
Extension points: `filter`.
- `VolumeZone`: Checks that volumes requested satisfy any zone requirements they
might have.
Extension points: `filter`.
- `NodeVolumeLimits`: Checks that CSI volume limits can be satisfied for the
node.
Extension points: `filter`.
- `EBSLimits`: Checks that AWS EBS volume limits can be satisfied for the node.
Extension points: `filter`.
- `GCEPDLimits`: Checks that GCP-PD volume limits can be satisfied for the node.
Extension points: `filter`.
- `AzureDiskLimits`: Checks that Azure disk volume limits can be satisfied for
the node.
Extension points: `filter`.
- `InterPodAffinity`: Implements
[inter-Pod affinity and anti-affinity](/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity).
Extension points: `preFilter`, `filter`, `preScore`, `score`.
- `PrioritySort`: Provides the default priority based sorting.
Extension points: `queueSort`.
- `DefaultBinder`: Provides the default binding mechanism.
Extension points: `bind`.
- `DefaultPreemption`: Provides the default preemption mechanism.
Extension points: `postFilter`.
You can also enable the following plugins, through the component config APIs,
that are not enabled by default:
- `CinderLimits`: Checks that [OpenStack Cinder](https://docs.openstack.org/cinder/)
volume limits can be satisfied for the node.
Extension points: `filter`.
### Multiple profiles
You can configure `kube-scheduler` to run more than one profile.
Each profile has an associated scheduler name and can have a different set of
plugins configured in its [extension points](#extension-points).
With the following sample configuration, the scheduler will run with two
profiles: one with the default plugins and one with all scoring plugins
disabled.
```yaml
apiVersion: kubescheduler.config.k8s.io/v1
kind: KubeSchedulerConfiguration
profiles:
- schedulerName: default-scheduler
- schedulerName: no-scoring-scheduler
plugins:
preScore:
disabled:
- name: '*'
score:
disabled:
- name: '*'
```
Pods that want to be scheduled according to a specific profile can include
the corresponding scheduler name in its `.spec.schedulerName`.
By default, one profile with the scheduler name `default-scheduler` is created.
This profile includes the default plugins described above. When declaring more
than one profile, a unique scheduler name for each of them is required.
If a Pod doesn't specify a scheduler name, kube-apiserver will set it to
`default-scheduler`. Therefore, a profile with this scheduler name should exist
to get those pods scheduled.
Pod's scheduling events have `.spec.schedulerName` as their `reportingController`.
Events for leader election use the scheduler name of the first profile in the list.
For more information, please refer to the `reportingController` section under
[Event API Reference](/docs/reference/kubernetes-api/cluster-resources/event-v1/).
All profiles must use the same plugin in the `queueSort` extension point and have
the same configuration parameters (if applicable). This is because the scheduler
only has one pending pods queue.
### Plugins that apply to multiple extension points {#multipoint}
Starting from `kubescheduler.config.k8s.io/v1beta3`, there is an additional field in the
profile config, `multiPoint`, which allows for easily enabling or disabling a plugin
across several extension points. The intent of `multiPoint` config is to simplify the
configuration needed for users and administrators when using custom profiles.
Consider a plugin, `MyPlugin`, which implements the `preScore`, `score`, `preFilter`,
and `filter` extension points. To enable `MyPlugin` for all its available extension
points, the profile config looks like:
```yaml
apiVersion: kubescheduler.config.k8s.io/v1
kind: KubeSchedulerConfiguration
profiles:
- schedulerName: multipoint-scheduler
plugins:
multiPoint:
enabled:
- name: MyPlugin
```
This would equate to manually enabling `MyPlugin` for all of its extension
points, like so:
```yaml
apiVersion: kubescheduler.config.k8s.io/v1
kind: KubeSchedulerConfiguration
profiles:
- schedulerName: non-multipoint-scheduler
plugins:
preScore:
enabled:
- name: MyPlugin
score:
enabled:
- name: MyPlugin
preFilter:
enabled:
- name: MyPlugin
filter:
enabled:
- name: MyPlugin
```
One benefit of using `multiPoint` here is that if `MyPlugin` implements another
extension point in the future, the `multiPoint` config will automatically enable it
for the new extension.
Specific extension points can be excluded from `MultiPoint` expansion using
the `disabled` field for that extension point. This works with disabling default
plugins, non-default plugins, or with the wildcard (`'*'`) to disable all plugins.
An example of this, disabling `Score` and `PreScore`, would be:
```yaml
apiVersion: kubescheduler.config.k8s.io/v1
kind: KubeSchedulerConfiguration
profiles:
- schedulerName: non-multipoint-scheduler
plugins:
multiPoint:
enabled:
- name: 'MyPlugin'
preScore:
disabled:
- name: '*'
score:
disabled:
- name: '*'
```
Starting from `kubescheduler.config.k8s.io/v1beta3`, all [default plugins](#scheduling-plugins)
are enabled internally through `MultiPoint`.
However, individual extension points are still available to allow flexible
reconfiguration of the default values (such as ordering and Score weights). For
example, consider two Score plugins `DefaultScore1` and `DefaultScore2`, each with
a weight of `1`. They can be reordered with different weights like so:
```yaml
apiVersion: kubescheduler.config.k8s.io/v1
kind: KubeSchedulerConfiguration
profiles:
- schedulerName: multipoint-scheduler
plugins:
score:
enabled:
- name: 'DefaultScore2'
weight: 5
```
In this example, it's unnecessary to specify the plugins in `MultiPoint` explicitly
because they are default plugins. And the only plugin specified in `Score` is `DefaultScore2`.
This is because plugins set through specific extension points will always take precedence
over `MultiPoint` plugins. So, this snippet essentially re-orders the two plugins
without needing to specify both of them.
The general hierarchy for precedence when configuring `MultiPoint` plugins is as follows:
1. Specific extension points run first, and their settings override whatever is set elsewhere
2. Plugins manually configured through `MultiPoint` and their settings
3. Default plugins and their default settings
To demonstrate the above hierarchy, the following example is based on these plugins:
|Plugin|Extension Points|
|---|---|
|`DefaultQueueSort`|`QueueSort`|
|`CustomQueueSort`|`QueueSort`|
|`DefaultPlugin1`|`Score`, `Filter`|
|`DefaultPlugin2`|`Score`|
|`CustomPlugin1`|`Score`, `Filter`|
|`CustomPlugin2`|`Score`, `Filter`|
A valid sample configuration for these plugins would be:
```yaml
apiVersion: kubescheduler.config.k8s.io/v1
kind: KubeSchedulerConfiguration
profiles:
- schedulerName: multipoint-scheduler
plugins:
multiPoint:
enabled:
- name: 'CustomQueueSort'
- name: 'CustomPlugin1'
weight: 3
- name: 'CustomPlugin2'
disabled:
- name: 'DefaultQueueSort'
filter:
disabled:
- name: 'DefaultPlugin1'
score:
enabled:
- name: 'DefaultPlugin2'
```
Note that there is no error for re-declaring a `MultiPoint` plugin in a specific
extension point. The re-declaration is ignored (and logged), as specific extension points
take precedence.
Besides keeping most of the config in one spot, this sample does a few things:
* Enables the custom `queueSort` plugin and disables the default one
* Enables `CustomPlugin1` and `CustomPlugin2`, which will run first for all of their extension points
* Disables `DefaultPlugin1`, but only for `filter`
* Reorders `DefaultPlugin2` to run first in `score` (even before the custom plugins)
In versions of the config before `v1beta3`, without `multiPoint`, the above snippet would equate to this:
```yaml
apiVersion: kubescheduler.config.k8s.io/v1beta2
kind: KubeSchedulerConfiguration
profiles:
- schedulerName: multipoint-scheduler
plugins:
# Disable the default QueueSort plugin
queueSort:
enabled:
- name: 'CustomQueueSort'
disabled:
- name: 'DefaultQueueSort'
# Enable custom Filter plugins
filter:
enabled:
- name: 'CustomPlugin1'
- name: 'CustomPlugin2'
- name: 'DefaultPlugin2'
disabled:
- name: 'DefaultPlugin1'
# Enable and reorder custom score plugins
score:
enabled:
- name: 'DefaultPlugin2'
weight: 1
- name: 'DefaultPlugin1'
weight: 3
```
While this is a complicated example, it demonstrates the flexibility of `MultiPoint` config
as well as its seamless integration with the existing methods for configuring extension points.
## Scheduler configuration migrations
* With the v1beta2 configuration version, you can use a new score extension for the
`NodeResourcesFit` plugin.
The new extension combines the functionalities of the `NodeResourcesLeastAllocated`,
`NodeResourcesMostAllocated` and `RequestedToCapacityRatio` plugins.
For example, if you previously used the `NodeResourcesMostAllocated` plugin, you
would instead use `NodeResourcesFit` (enabled by default) and add a `pluginConfig`
with a `scoreStrategy` that is similar to:
```yaml
apiVersion: kubescheduler.config.k8s.io/v1beta2
kind: KubeSchedulerConfiguration
profiles:
- pluginConfig:
- args:
scoringStrategy:
resources:
- name: cpu
weight: 1
type: MostAllocated
name: NodeResourcesFit
```
* The scheduler plugin `NodeLabel` is deprecated; instead, use the [`NodeAffinity`](/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) plugin (enabled by default) to achieve similar behavior.
* The scheduler plugin `ServiceAffinity` is deprecated; instead, use the [`InterPodAffinity`](/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity) plugin (enabled by default) to achieve similar behavior.
* The scheduler plugin `NodePreferAvoidPods` is deprecated; instead, use [node taints](/docs/concepts/scheduling-eviction/taint-and-toleration/) to achieve similar behavior.
* A plugin enabled in a v1beta2 configuration file takes precedence over the default configuration for that plugin.
* Invalid `host` or `port` configured for scheduler healthz and metrics bind address will cause validation failure.
* Three plugins' weight are increased by default:
* `InterPodAffinity` from 1 to 2
* `NodeAffinity` from 1 to 2
* `TaintToleration` from 1 to 3
* The scheduler plugin `SelectorSpread` is removed, instead, use the `PodTopologySpread` plugin (enabled by default)
to achieve similar behavior.
##
* Read the [kube-scheduler reference](/docs/reference/command-line-tools-reference/kube-scheduler/)
* Learn about [scheduling](/docs/concepts/scheduling-eviction/kube-scheduler/)
* Read the [kube-scheduler configuration (v1)](/docs/reference/config-api/kube-scheduler-config.v1/) reference | kubernetes reference | title Scheduler Configuration content type concept weight 20 You can customize the behavior of the kube scheduler by writing a configuration file and passing its path as a command line argument overview body A scheduling Profile allows you to configure the different stages of scheduling in the Each stage is exposed in an extension point Plugins provide scheduling behaviors by implementing one or more of these extension points You can specify scheduling profiles by running kube scheduler config filename using the KubeSchedulerConfiguration v1 docs reference config api kube scheduler config v1 struct A minimal configuration looks as follows yaml apiVersion kubescheduler config k8s io v1 kind KubeSchedulerConfiguration clientConnection kubeconfig etc srv kubernetes kube scheduler kubeconfig KubeSchedulerConfiguration v1beta3 is deprecated in v1 26 and is removed in v1 29 Please migrate KubeSchedulerConfiguration to v1 docs reference config api kube scheduler config v1 Profiles A scheduling Profile allows you to configure the different stages of scheduling in the Each stage is exposed in an extension point extension points Plugins scheduling plugins provide scheduling behaviors by implementing one or more of these extension points You can configure a single instance of kube scheduler to run multiple profiles multiple profiles Extension points Scheduling happens in a series of stages that are exposed through the following extension points 1 queueSort These plugins provide an ordering function that is used to sort pending Pods in the scheduling queue Exactly one queue sort plugin may be enabled at a time 1 preFilter These plugins are used to pre process or check information about a Pod or the cluster before filtering They can mark a pod as unschedulable 1 filter These plugins are the equivalent of Predicates in a scheduling Policy and are used to filter out nodes that can not run the Pod Filters are called in the configured order A pod is marked as unschedulable if no nodes pass all the filters 1 postFilter These plugins are called in their configured order when no feasible nodes were found for the pod If any postFilter plugin marks the Pod schedulable the remaining plugins are not called 1 preScore This is an informational extension point that can be used for doing pre scoring work 1 score These plugins provide a score to each node that has passed the filtering phase The scheduler will then select the node with the highest weighted scores sum 1 reserve This is an informational extension point that notifies plugins when resources have been reserved for a given Pod Plugins also implement an Unreserve call that gets called in the case of failure during or after Reserve 1 permit These plugins can prevent or delay the binding of a Pod 1 preBind These plugins perform any work required before a Pod is bound 1 bind The plugins bind a Pod to a Node bind plugins are called in order and once one has done the binding the remaining plugins are skipped At least one bind plugin is required 1 postBind This is an informational extension point that is called after a Pod has been bound 1 multiPoint This is a config only field that allows plugins to be enabled or disabled for all of their applicable extension points simultaneously For each extension point you could disable specific default plugins scheduling plugins or enable your own For example yaml apiVersion kubescheduler config k8s io v1 kind KubeSchedulerConfiguration profiles plugins score disabled name PodTopologySpread enabled name MyCustomPluginA weight 2 name MyCustomPluginB weight 1 You can use as name in the disabled array to disable all default plugins for that extension point This can also be used to rearrange plugins order if desired Scheduling plugins The following plugins enabled by default implement one or more of these extension points ImageLocality Favors nodes that already have the container images that the Pod runs Extension points score TaintToleration Implements taints and tolerations docs concepts scheduling eviction taint and toleration Implements extension points filter preScore score NodeName Checks if a Pod spec node name matches the current node Extension points filter NodePorts Checks if a node has free ports for the requested Pod ports Extension points preFilter filter NodeAffinity Implements node selectors docs concepts scheduling eviction assign pod node nodeselector and node affinity docs concepts scheduling eviction assign pod node node affinity Extension points filter score PodTopologySpread Implements Pod topology spread docs concepts scheduling eviction topology spread constraints Extension points preFilter filter preScore score NodeUnschedulable Filters out nodes that have spec unschedulable set to true Extension points filter NodeResourcesFit Checks if the node has all the resources that the Pod is requesting The score can use one of three strategies LeastAllocated default MostAllocated and RequestedToCapacityRatio Extension points preFilter filter score NodeResourcesBalancedAllocation Favors nodes that would obtain a more balanced resource usage if the Pod is scheduled there Extension points score VolumeBinding Checks if the node has or if it can bind the requested Extension points preFilter filter reserve preBind score score extension point is enabled when VolumeCapacityPriority feature is enabled It prioritizes the smallest PVs that can fit the requested volume size VolumeRestrictions Checks that volumes mounted in the node satisfy restrictions that are specific to the volume provider Extension points filter VolumeZone Checks that volumes requested satisfy any zone requirements they might have Extension points filter NodeVolumeLimits Checks that CSI volume limits can be satisfied for the node Extension points filter EBSLimits Checks that AWS EBS volume limits can be satisfied for the node Extension points filter GCEPDLimits Checks that GCP PD volume limits can be satisfied for the node Extension points filter AzureDiskLimits Checks that Azure disk volume limits can be satisfied for the node Extension points filter InterPodAffinity Implements inter Pod affinity and anti affinity docs concepts scheduling eviction assign pod node inter pod affinity and anti affinity Extension points preFilter filter preScore score PrioritySort Provides the default priority based sorting Extension points queueSort DefaultBinder Provides the default binding mechanism Extension points bind DefaultPreemption Provides the default preemption mechanism Extension points postFilter You can also enable the following plugins through the component config APIs that are not enabled by default CinderLimits Checks that OpenStack Cinder https docs openstack org cinder volume limits can be satisfied for the node Extension points filter Multiple profiles You can configure kube scheduler to run more than one profile Each profile has an associated scheduler name and can have a different set of plugins configured in its extension points extension points With the following sample configuration the scheduler will run with two profiles one with the default plugins and one with all scoring plugins disabled yaml apiVersion kubescheduler config k8s io v1 kind KubeSchedulerConfiguration profiles schedulerName default scheduler schedulerName no scoring scheduler plugins preScore disabled name score disabled name Pods that want to be scheduled according to a specific profile can include the corresponding scheduler name in its spec schedulerName By default one profile with the scheduler name default scheduler is created This profile includes the default plugins described above When declaring more than one profile a unique scheduler name for each of them is required If a Pod doesn t specify a scheduler name kube apiserver will set it to default scheduler Therefore a profile with this scheduler name should exist to get those pods scheduled Pod s scheduling events have spec schedulerName as their reportingController Events for leader election use the scheduler name of the first profile in the list For more information please refer to the reportingController section under Event API Reference docs reference kubernetes api cluster resources event v1 All profiles must use the same plugin in the queueSort extension point and have the same configuration parameters if applicable This is because the scheduler only has one pending pods queue Plugins that apply to multiple extension points multipoint Starting from kubescheduler config k8s io v1beta3 there is an additional field in the profile config multiPoint which allows for easily enabling or disabling a plugin across several extension points The intent of multiPoint config is to simplify the configuration needed for users and administrators when using custom profiles Consider a plugin MyPlugin which implements the preScore score preFilter and filter extension points To enable MyPlugin for all its available extension points the profile config looks like yaml apiVersion kubescheduler config k8s io v1 kind KubeSchedulerConfiguration profiles schedulerName multipoint scheduler plugins multiPoint enabled name MyPlugin This would equate to manually enabling MyPlugin for all of its extension points like so yaml apiVersion kubescheduler config k8s io v1 kind KubeSchedulerConfiguration profiles schedulerName non multipoint scheduler plugins preScore enabled name MyPlugin score enabled name MyPlugin preFilter enabled name MyPlugin filter enabled name MyPlugin One benefit of using multiPoint here is that if MyPlugin implements another extension point in the future the multiPoint config will automatically enable it for the new extension Specific extension points can be excluded from MultiPoint expansion using the disabled field for that extension point This works with disabling default plugins non default plugins or with the wildcard to disable all plugins An example of this disabling Score and PreScore would be yaml apiVersion kubescheduler config k8s io v1 kind KubeSchedulerConfiguration profiles schedulerName non multipoint scheduler plugins multiPoint enabled name MyPlugin preScore disabled name score disabled name Starting from kubescheduler config k8s io v1beta3 all default plugins scheduling plugins are enabled internally through MultiPoint However individual extension points are still available to allow flexible reconfiguration of the default values such as ordering and Score weights For example consider two Score plugins DefaultScore1 and DefaultScore2 each with a weight of 1 They can be reordered with different weights like so yaml apiVersion kubescheduler config k8s io v1 kind KubeSchedulerConfiguration profiles schedulerName multipoint scheduler plugins score enabled name DefaultScore2 weight 5 In this example it s unnecessary to specify the plugins in MultiPoint explicitly because they are default plugins And the only plugin specified in Score is DefaultScore2 This is because plugins set through specific extension points will always take precedence over MultiPoint plugins So this snippet essentially re orders the two plugins without needing to specify both of them The general hierarchy for precedence when configuring MultiPoint plugins is as follows 1 Specific extension points run first and their settings override whatever is set elsewhere 2 Plugins manually configured through MultiPoint and their settings 3 Default plugins and their default settings To demonstrate the above hierarchy the following example is based on these plugins Plugin Extension Points DefaultQueueSort QueueSort CustomQueueSort QueueSort DefaultPlugin1 Score Filter DefaultPlugin2 Score CustomPlugin1 Score Filter CustomPlugin2 Score Filter A valid sample configuration for these plugins would be yaml apiVersion kubescheduler config k8s io v1 kind KubeSchedulerConfiguration profiles schedulerName multipoint scheduler plugins multiPoint enabled name CustomQueueSort name CustomPlugin1 weight 3 name CustomPlugin2 disabled name DefaultQueueSort filter disabled name DefaultPlugin1 score enabled name DefaultPlugin2 Note that there is no error for re declaring a MultiPoint plugin in a specific extension point The re declaration is ignored and logged as specific extension points take precedence Besides keeping most of the config in one spot this sample does a few things Enables the custom queueSort plugin and disables the default one Enables CustomPlugin1 and CustomPlugin2 which will run first for all of their extension points Disables DefaultPlugin1 but only for filter Reorders DefaultPlugin2 to run first in score even before the custom plugins In versions of the config before v1beta3 without multiPoint the above snippet would equate to this yaml apiVersion kubescheduler config k8s io v1beta2 kind KubeSchedulerConfiguration profiles schedulerName multipoint scheduler plugins Disable the default QueueSort plugin queueSort enabled name CustomQueueSort disabled name DefaultQueueSort Enable custom Filter plugins filter enabled name CustomPlugin1 name CustomPlugin2 name DefaultPlugin2 disabled name DefaultPlugin1 Enable and reorder custom score plugins score enabled name DefaultPlugin2 weight 1 name DefaultPlugin1 weight 3 While this is a complicated example it demonstrates the flexibility of MultiPoint config as well as its seamless integration with the existing methods for configuring extension points Scheduler configuration migrations With the v1beta2 configuration version you can use a new score extension for the NodeResourcesFit plugin The new extension combines the functionalities of the NodeResourcesLeastAllocated NodeResourcesMostAllocated and RequestedToCapacityRatio plugins For example if you previously used the NodeResourcesMostAllocated plugin you would instead use NodeResourcesFit enabled by default and add a pluginConfig with a scoreStrategy that is similar to yaml apiVersion kubescheduler config k8s io v1beta2 kind KubeSchedulerConfiguration profiles pluginConfig args scoringStrategy resources name cpu weight 1 type MostAllocated name NodeResourcesFit The scheduler plugin NodeLabel is deprecated instead use the NodeAffinity docs concepts scheduling eviction assign pod node affinity and anti affinity plugin enabled by default to achieve similar behavior The scheduler plugin ServiceAffinity is deprecated instead use the InterPodAffinity docs concepts scheduling eviction assign pod node inter pod affinity and anti affinity plugin enabled by default to achieve similar behavior The scheduler plugin NodePreferAvoidPods is deprecated instead use node taints docs concepts scheduling eviction taint and toleration to achieve similar behavior A plugin enabled in a v1beta2 configuration file takes precedence over the default configuration for that plugin Invalid host or port configured for scheduler healthz and metrics bind address will cause validation failure Three plugins weight are increased by default InterPodAffinity from 1 to 2 NodeAffinity from 1 to 2 TaintToleration from 1 to 3 The scheduler plugin SelectorSpread is removed instead use the PodTopologySpread plugin enabled by default to achieve similar behavior Read the kube scheduler reference docs reference command line tools reference kube scheduler Learn about scheduling docs concepts scheduling eviction kube scheduler Read the kube scheduler configuration v1 docs reference config api kube scheduler config v1 reference |
kubernetes reference contenttype reference title Virtual IPs and Service Proxies glossarytooltip termid cluster text cluster runs a overview weight 50 Every glossarytooltip termid node text node in a Kubernetes | ---
title: Virtual IPs and Service Proxies
content_type: reference
weight: 50
---
<!-- overview -->
Every in a Kubernetes
runs a
[kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/)
(unless you have deployed your own alternative component in place of `kube-proxy`).
The `kube-proxy` component is responsible for implementing a _virtual IP_
mechanism for
of `type` other than
[`ExternalName`](/docs/concepts/services-networking/service/#externalname).
Each instance of kube-proxy watches the Kubernetes for the addition and
removal of Service and EndpointSlice . For each Service, kube-proxy
calls appropriate APIs (depending on the kube-proxy mode) to configure
the node to capture traffic to the Service's `clusterIP` and `port`,
and redirect that traffic to one of the Service's endpoints
(usually a Pod, but possibly an arbitrary user-provided IP address). A control
loop ensures that the rules on each node are reliably synchronized with
the Service and EndpointSlice state as indicated by the API server.
A question that pops up every now and then is why Kubernetes relies on
proxying to forward inbound traffic to backends. What about other
approaches? For example, would it be possible to configure DNS records that
have multiple A values (or AAAA for IPv6), and rely on round-robin name
resolution?
There are a few reasons for using proxying for Services:
* There is a long history of DNS implementations not respecting record TTLs,
and caching the results of name lookups after they should have expired.
* Some apps do DNS lookups only once and cache the results indefinitely.
* Even if apps and libraries did proper re-resolution, the low or zero TTLs
on the DNS records could impose a high load on DNS that then becomes
difficult to manage.
Later in this page you can read about how various kube-proxy implementations work.
Overall, you should note that, when running `kube-proxy`, kernel level rules may be modified
(for example, iptables rules might get created), which won't get cleaned up, in some
cases until you reboot. Thus, running kube-proxy is something that should only be done
by an administrator which understands the consequences of having a low level, privileged
network proxying service on a computer. Although the `kube-proxy` executable supports a
`cleanup` function, this function is not an official feature and thus is only available
to use as-is.
<a id="example"></a>
Some of the details in this reference refer to an example: the backend
for a stateless
image-processing workloads, running with
three replicas. Those replicas are
fungible—frontends do not care which backend they use. While the actual Pods that
compose the backend set may change, the frontend clients should not need to be aware of that,
nor should they need to keep track of the set of backends themselves.
<!-- body -->
## Proxy modes
The kube-proxy starts up in different modes, which are determined by its configuration.
On Linux nodes, the available modes for kube-proxy are:
[`iptables`](#proxy-mode-iptables)
: A mode where the kube-proxy configures packet forwarding rules using iptables.
[`ipvs`](#proxy-mode-ipvs)
: a mode where the kube-proxy configures packet forwarding rules using ipvs.
[`nftables`](#proxy-mode-nftables)
: a mode where the kube-proxy configures packet forwarding rules using nftables.
There is only one mode available for kube-proxy on Windows:
[`kernelspace`](#proxy-mode-kernelspace)
: a mode where the kube-proxy configures packet forwarding rules in the Windows kernel
### `iptables` proxy mode {#proxy-mode-iptables}
_This proxy mode is only available on Linux nodes._
In this mode, kube-proxy configures packet forwarding rules using the
iptables API of the kernel netfilter subsystem. For each endpoint, it
installs iptables rules which, by default, select a backend Pod at
random.
#### Example {#packet-processing-iptables}
As an example, consider the image processing application described [earlier](#example)
in the page.
When the backend Service is created, the Kubernetes control plane assigns a virtual
IP address, for example 10.0.0.1. For this example, assume that the
Service port is 1234.
All of the kube-proxy instances in the cluster observe the creation of the new
Service.
When kube-proxy on a node sees a new Service, it installs a series of iptables rules
which redirect from the virtual IP address to more iptables rules, defined per Service.
The per-Service rules link to further rules for each backend endpoint, and the per-
endpoint rules redirect traffic (using destination NAT) to the backends.
When a client connects to the Service's virtual IP address the iptables rule kicks in.
A backend is chosen (either based on session affinity or randomly) and packets are
redirected to the backend without rewriting the client IP address.
This same basic flow executes when traffic comes in through a node-port or
through a load-balancer, though in those cases the client IP address does get altered.
#### Optimizing iptables mode performance
In iptables mode, kube-proxy creates a few iptables rules for every
Service, and a few iptables rules for each endpoint IP address. In
clusters with tens of thousands of Pods and Services, this means tens
of thousands of iptables rules, and kube-proxy may take a long time to update the rules
in the kernel when Services (or their EndpointSlices) change. You can adjust the syncing
behavior of kube-proxy via options in the [`iptables` section](/docs/reference/config-api/kube-proxy-config.v1alpha1/#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPTablesConfiguration)
of the
kube-proxy [configuration file](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
(which you specify via `kube-proxy --config <path>`):
```yaml
...
iptables:
minSyncPeriod: 1s
syncPeriod: 30s
...
```
##### `minSyncPeriod`
The `minSyncPeriod` parameter sets the minimum duration between
attempts to resynchronize iptables rules with the kernel. If it is
`0s`, then kube-proxy will always immediately synchronize the rules
every time any Service or Endpoint changes. This works fine in very
small clusters, but it results in a lot of redundant work when lots of
things change in a small time period. For example, if you have a
Service backed by a
with 100 pods, and you delete the
Deployment, then with `minSyncPeriod: 0s`, kube-proxy would end up
removing the Service's endpoints from the iptables rules one by one,
for a total of 100 updates. With a larger `minSyncPeriod`, multiple
Pod deletion events would get aggregated
together, so kube-proxy might
instead end up making, say, 5 updates, each removing 20 endpoints,
which will be much more efficient in terms of CPU, and result in the
full set of changes being synchronized faster.
The larger the value of `minSyncPeriod`, the more work that can be
aggregated, but the downside is that each individual change may end up
waiting up to the full `minSyncPeriod` before being processed, meaning
that the iptables rules spend more time being out-of-sync with the
current API server state.
The default value of `1s` should work well in most clusters, but in very
large clusters it may be necessary to set it to a larger value.
Especially, if kube-proxy's `sync_proxy_rules_duration_seconds` metric
indicates an average time much larger than 1 second, then bumping up
`minSyncPeriod` may make updates more efficient.
##### Updating legacy `minSyncPeriod` configuration {#minimize-iptables-restore}
Older versions of kube-proxy updated all the rules for all Services on
every sync; this led to performance issues (update lag) in large
clusters, and the recommended solution was to set a larger
`minSyncPeriod`. Since Kubernetes v1.28, the iptables mode of
kube-proxy uses a more minimal approach, only making updates where
Services or EndpointSlices have actually changed.
If you were previously overriding `minSyncPeriod`, you should try
removing that override and letting kube-proxy use the default value
(`1s`) or at least a smaller value than you were using before upgrading.
If you are not running kube-proxy from Kubernetes , check
the behavior and associated advice for the version that you are actually running.
##### `syncPeriod`
The `syncPeriod` parameter controls a handful of synchronization
operations that are not directly related to changes in individual
Services and EndpointSlices. In particular, it controls how quickly
kube-proxy notices if an external component has interfered with
kube-proxy's iptables rules. In large clusters, kube-proxy also only
performs certain cleanup operations once every `syncPeriod` to avoid
unnecessary work.
For the most part, increasing `syncPeriod` is not expected to have much
impact on performance, but in the past, it was sometimes useful to set
it to a very large value (eg, `1h`). This is no longer recommended,
and is likely to hurt functionality more than it improves performance.
### IPVS proxy mode {#proxy-mode-ipvs}
_This proxy mode is only available on Linux nodes._
In `ipvs` mode, kube-proxy uses the kernel IPVS and iptables APIs to
create rules to redirect traffic from Service IPs to endpoint IPs.
The IPVS proxy mode is based on netfilter hook function that is similar to
iptables mode, but uses a hash table as the underlying data structure and works
in the kernel space.
That means kube-proxy in IPVS mode redirects traffic with lower latency than
kube-proxy in iptables mode, with much better performance when synchronizing
proxy rules. Compared to the iptables proxy mode, IPVS mode also supports a
higher throughput of network traffic.
IPVS provides more options for balancing traffic to backend Pods;
these are:
* `rr` (Round Robin): Traffic is equally distributed amongst the backing servers.
* `wrr` (Weighted Round Robin): Traffic is routed to the backing servers based on
the weights of the servers. Servers with higher weights receive new connections
and get more requests than servers with lower weights.
* `lc` (Least Connection): More traffic is assigned to servers with fewer active connections.
* `wlc` (Weighted Least Connection): More traffic is routed to servers with fewer connections
relative to their weights, that is, connections divided by weight.
* `lblc` (Locality based Least Connection): Traffic for the same IP address is sent to the
same backing server if the server is not overloaded and available; otherwise the traffic
is sent to servers with fewer connections, and keep it for future assignment.
* `lblcr` (Locality Based Least Connection with Replication): Traffic for the same IP
address is sent to the server with least connections. If all the backing servers are
overloaded, it picks up one with fewer connections and add it to the target set.
If the target set has not changed for the specified time, the most loaded server
is removed from the set, in order to avoid high degree of replication.
* `sh` (Source Hashing): Traffic is sent to a backing server by looking up a statically
assigned hash table based on the source IP addresses.
* `dh` (Destination Hashing): Traffic is sent to a backing server by looking up a
statically assigned hash table based on their destination addresses.
* `sed` (Shortest Expected Delay): Traffic forwarded to a backing server with the shortest
expected delay. The expected delay is `(C + 1) / U` if sent to a server, where `C` is
the number of connections on the server and `U` is the fixed service rate (weight) of
the server.
* `nq` (Never Queue): Traffic is sent to an idle server if there is one, instead of
waiting for a fast one; if all servers are busy, the algorithm falls back to the `sed`
behavior.
* `mh` (Maglev Hashing): Assigns incoming jobs based on
[Google's Maglev hashing algorithm](https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/44824.pdf),
This scheduler has two flags: `mh-fallback`, which enables fallback to a different
server if the selected server is unavailable, and `mh-port`, which adds the source port number to
the hash computation. When using `mh`, kube-proxy always sets the `mh-port` flag and does not
enable the `mh-fallback` flag.
In proxy-mode=ipvs `mh` will work as source-hashing (`sh`), but with ports.
These scheduling algorithms are configured through the
[`ipvs.scheduler`](/docs/reference/config-api/kube-proxy-config.v1alpha1/#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPVSConfiguration)
field in the kube-proxy configuration.
To run kube-proxy in IPVS mode, you must make IPVS available on
the node before starting kube-proxy.
When kube-proxy starts in IPVS proxy mode, it verifies whether IPVS
kernel modules are available. If the IPVS kernel modules are not detected, then kube-proxy
exits with an error.
### `nftables` proxy mode {#proxy-mode-nftables}
_This proxy mode is only available on Linux nodes, and requires kernel
5.13 or later._
In this mode, kube-proxy configures packet forwarding rules using the
nftables API of the kernel netfilter subsystem. For each endpoint, it
installs nftables rules which, by default, select a backend Pod at
random.
The nftables API is the successor to the iptables API and is designed
to provide better performance and scalability than iptables. The
`nftables` proxy mode is able to process changes to service endpoints
faster and more efficiently than the `iptables` mode, and is also able
to more efficiently process packets in the kernel (though this only
becomes noticeable in clusters with tens of thousands of services).
As of Kubernetes , the `nftables` mode is
still relatively new, and may not be compatible with all network
plugins; consult the documentation for your network plugin.
#### Migrating from `iptables` mode to `nftables`
Users who want to switch from the default `iptables` mode to the
`nftables` mode should be aware that some features work slightly
differently the `nftables` mode:
- **NodePort interfaces**: In `iptables` mode, by default,
[NodePort services](/docs/concepts/services-networking/service/#type-nodeport)
are reachable on all local IP addresses. This is usually not what
users want, so the `nftables` mode defaults to
`--nodeport-addresses primary`, meaning NodePort services are only
reachable on the node's primary IPv4 and/or IPv6 addresses. You can
override this by specifying an explicit value for that option:
e.g., `--nodeport-addresses 0.0.0.0/0` to listen on all (local)
IPv4 IPs.
- **NodePort services on `127.0.0.1`**: In `iptables` mode, if the
`--nodeport-addresses` range includes `127.0.0.1` (and the option
`--iptables-localhost-nodeports false` option is not passed), then
NodePort services are reachable even on "localhost" (`127.0.0.1`).
In `nftables` mode (and `ipvs` mode), this will not work. If you
are not sure if you are depending on this functionality, you can
check kube-proxy's
`iptables_localhost_nodeports_accepted_packets_total` metric; if it
is non-0, that means that some client has connected to a NodePort
service via `127.0.0.1`.
- **NodePort interaction with firewalls**: The `iptables` mode of
kube-proxy tries to be compatible with overly-agressive firewalls;
for each NodePort service, it will add rules to accept inbound
traffic on that port, in case that traffic would otherwise be
blocked by a firewall. This approach will not work with firewalls
based on nftables, so kube-proxy's `nftables` mode does not do
anything here; if you have a local firewall, you must ensure that
it is properly configured to allow Kubernetes traffic through
(e.g., by allowing inbound traffic on the entire NodePort range).
- **Conntrack bug workarounds**: Linux kernels prior to 6.1 have a
bug that can result in long-lived TCP connections to service IPs
being closed with the error "Connection reset by peer". The
`iptables` mode of kube-proxy installs a workaround for this bug,
but this workaround was later found to cause other problems in some
clusters. The `nftables` mode does not install any workaround by
default, but you can check kube-proxy's
`iptables_ct_state_invalid_dropped_packets_total` metric to see if
your cluster is depending on the workaround, and if so, you can run
kube-proxy with the option `--conntrack-tcp-be-liberal` to work
around the problem in `nftables` mode.
### `kernelspace` proxy mode {#proxy-mode-kernelspace}
_This proxy mode is only available on Windows nodes._
The kube-proxy configures packet filtering rules in the Windows _Virtual Filtering Platform_ (VFP),
an extension to Windows vSwitch. These rules process encapsulated packets within the node-level
virtual networks, and rewrite packets so that the destination IP address (and layer 2 information)
is correct for getting the packet routed to the correct destination.
The Windows VFP is analogous to tools such as Linux `nftables` or `iptables`. The Windows VFP extends
the _Hyper-V Switch_, which was initially implemented to support virtual machine networking.
When a Pod on a node sends traffic to a virtual IP address, and the kube-proxy selects a Pod on
a different node as the load balancing target, the `kernelspace` proxy mode rewrites that packet
to be destined to the target backend Pod. The Windows _Host Networking Service_ (HNS) ensures that
packet rewriting rules are configured so that the return traffic appears to come from the virtual
IP address and not the specific backend Pod.
#### Direct server return for `kernelspace` mode {#windows-direct-server-return}
As an alternative to the basic operation, a node that hosts the backend Pod for a Service can
apply the packet rewriting directly, rather than placing this burden on the node where the client
Pod is running. This is called _direct server return_.
To use this, you must run kube-proxy with the `--enable-dsr` command line argument **and**
enable the `WinDSR` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/).
Direct server return also optimizes the case for Pod return traffic even when both Pods
are running on the same node.
## Session affinity
In these proxy models, the traffic bound for the Service's IP:Port is
proxied to an appropriate backend without the clients knowing anything
about Kubernetes or Services or Pods.
If you want to make sure that connections from a particular client
are passed to the same Pod each time, you can select the session affinity based
on the client's IP addresses by setting `.spec.sessionAffinity` to `ClientIP`
for a Service (the default is `None`).
### Session stickiness timeout
You can also set the maximum session sticky time by setting
`.spec.sessionAffinityConfig.clientIP.timeoutSeconds` appropriately for a Service.
(the default value is 10800, which works out to be 3 hours).
On Windows, setting the maximum session sticky time for Services is not supported.
## IP address assignment to Services
Unlike Pod IP addresses, which actually route to a fixed destination,
Service IPs are not actually answered by a single host. Instead, kube-proxy
uses packet processing logic (such as Linux iptables) to define _virtual_ IP
addresses which are transparently redirected as needed.
When clients connect to the VIP, their traffic is automatically transported to an
appropriate endpoint. The environment variables and DNS for Services are actually
populated in terms of the Service's virtual IP address (and port).
### Avoiding collisions
One of the primary philosophies of Kubernetes is that you should not be
exposed to situations that could cause your actions to fail through no fault
of your own. For the design of the Service resource, this means not making
you choose your own IP address if that choice might collide with
someone else's choice. That is an isolation failure.
In order to allow you to choose an IP address for your Services, we must
ensure that no two Services can collide. Kubernetes does that by allocating each
Service its own IP address from within the `service-cluster-ip-range`
CIDR range that is configured for the .
### IP address allocation tracking
To ensure each Service receives a unique IP address, an internal allocator atomically
updates a global allocation map in
prior to creating each Service. The map object must exist in the registry for
Services to get IP address assignments, otherwise creations will
fail with a message indicating an IP address could not be allocated.
In the control plane, a background controller is responsible for creating that
map (needed to support migrating from older versions of Kubernetes that used
in-memory locking). Kubernetes also uses controllers to check for invalid
assignments (for example: due to administrator intervention) and for cleaning up allocated
IP addresses that are no longer used by any Services.
#### IP address allocation tracking using the Kubernetes API {#ip-address-objects}
If you enable the `MultiCIDRServiceAllocator`
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) and the
[`networking.k8s.io/v1alpha1` API group](/docs/tasks/administer-cluster/enable-disable-api/),
the control plane replaces the existing etcd allocator with a revised implementation
that uses IPAddress and ServiceCIDR objects instead of an internal global allocation map.
Each cluster IP address associated to a Service then references an IPAddress object.
Enabling the feature gate also replaces a background controller with an alternative
that handles the IPAddress objects and supports migration from the old allocator model.
Kubernetes does not support migrating from IPAddress
objects to the internal allocation map.
One of the main benefits of the revised allocator is that it removes the size limitations
for the IP address range that can be used for the cluster IP address of Services.
With `MultiCIDRServiceAllocator` enabled, there are no limitations for IPv4, and for IPv6
you can use IP address netmasks that are a /64 or smaller (as opposed to /108 with the
legacy implementation).
Making IP address allocations available via the API means that you as a cluster administrator
can allow users to inspect the IP addresses assigned to their Services.
Kubernetes extensions, such as the [Gateway API](/docs/concepts/services-networking/gateway/),
can use the IPAddress API to extend Kubernetes' inherent networking capabilities.
Here is a brief example of a user querying for IP addresses:
```shell
kubectl get services
```
```
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
kubernetes ClusterIP 2001:db8:1:2::1 <none> 443/TCP 3d1h
```
```shell
kubectl get ipaddresses
```
```
NAME PARENTREF
2001:db8:1:2::1 services/default/kubernetes
2001:db8:1:2::a services/kube-system/kube-dns
```
Kubernetes also allow users to dynamically define the available IP ranges for Services using
ServiceCIDR objects. During bootstrap, a default ServiceCIDR object named `kubernetes` is created
from the value of the `--service-cluster-ip-range` command line argument to kube-apiserver:
```shell
kubectl get servicecidrs
```
```
NAME CIDRS AGE
kubernetes 10.96.0.0/28 17m
```
Users can create or delete new ServiceCIDR objects to manage the available IP ranges for Services:
```shell
cat <<'EOF' | kubectl apply -f -
apiVersion: networking.k8s.io/v1beta1
kind: ServiceCIDR
metadata:
name: newservicecidr
spec:
cidrs:
- 10.96.0.0/24
EOF
```
```
servicecidr.networking.k8s.io/newcidr1 created
```
```shell
kubectl get servicecidrs
```
```
NAME CIDRS AGE
kubernetes 10.96.0.0/28 17m
newservicecidr 10.96.0.0/24 7m
```
### IP address ranges for Service virtual IP addresses {#service-ip-static-sub-range}
Kubernetes divides the `ClusterIP` range into two bands, based on
the size of the configured `service-cluster-ip-range` by using the following formula
`min(max(16, cidrSize / 16), 256)`. That formula paraphrases as _never less than 16 or
more than 256, with a graduated step function between them_.
Kubernetes prefers to allocate dynamic IP addresses to Services by choosing from the upper band,
which means that if you want to assign a specific IP address to a `type: ClusterIP`
Service, you should manually assign an IP address from the **lower** band. That approach
reduces the risk of a conflict over allocation.
## Traffic policies
You can set the `.spec.internalTrafficPolicy` and `.spec.externalTrafficPolicy` fields
to control how Kubernetes routes traffic to healthy (“ready”) backends.
### Internal traffic policy
You can set the `.spec.internalTrafficPolicy` field to control how traffic from
internal sources is routed. Valid values are `Cluster` and `Local`. Set the field to
`Cluster` to route internal traffic to all ready endpoints and `Local` to only route
to ready node-local endpoints. If the traffic policy is `Local` and there are no
node-local endpoints, traffic is dropped by kube-proxy.
### External traffic policy
You can set the `.spec.externalTrafficPolicy` field to control how traffic from
external sources is routed. Valid values are `Cluster` and `Local`. Set the field
to `Cluster` to route external traffic to all ready endpoints and `Local` to only
route to ready node-local endpoints. If the traffic policy is `Local` and there are
are no node-local endpoints, the kube-proxy does not forward any traffic for the
relevant Service.
If `Cluster` is specified all nodes are eligible load balancing targets _as long as_
the node is not being deleted and kube-proxy is healthy. In this mode: load balancer
health checks are configured to target the service proxy's readiness port and path.
In the case of kube-proxy this evaluates to: `${NODE_IP}:10256/healthz`. kube-proxy
will return either an HTTP code 200 or 503. kube-proxy's load balancer health check
endpoint returns 200 if:
1. kube-proxy is healthy, meaning:
- it's able to progress programming the network and isn't timing out while doing
so (the timeout is defined to be: **2 × `iptables.syncPeriod`**); and
2. the node is not being deleted (there is no deletion timestamp set for the Node).
The reason why kube-proxy returns 503 and marks the node as not
eligible when it's being deleted, is because kube-proxy supports connection
draining for terminating nodes. A couple of important things occur from the point
of view of a Kubernetes-managed load balancer when a node _is being_ / _is_ deleted.
While deleting:
* kube-proxy will start failing its readiness probe and essentially mark the
node as not eligible for load balancer traffic. The load balancer health
check failing causes load balancers which support connection draining to
allow existing connections to terminate, and block new connections from
establishing.
When deleted:
* The service controller in the Kubernetes cloud controller manager removes the
node from the referenced set of eligible targets. Removing any instance from
the load balancer's set of backend targets immediately terminates all
connections. This is also the reason kube-proxy first fails the health check
while the node is deleting.
It's important to note for Kubernetes vendors that if any vendor configures the
kube-proxy readiness probe as a liveness probe: that kube-proxy will start
restarting continuously when a node is deleting until it has been fully deleted.
kube-proxy exposes a `/livez` path which, as opposed to the `/healthz` one, does
**not** consider the Node's deleting state and only its progress programming the
network. `/livez` is therefore the recommended path for anyone looking to define
a livenessProbe for kube-proxy.
Users deploying kube-proxy can inspect both the readiness / liveness state by
evaluating the metrics: `proxy_livez_total` / `proxy_healthz_total`. Both
metrics publish two series, one with the 200 label and one with the 503 one.
For `Local` Services: kube-proxy will return 200 if
1. kube-proxy is healthy/ready, and
2. has a local endpoint on the node in question.
Node deletion does **not** have an impact on kube-proxy's return
code for what concerns load balancer health checks. The reason for this is:
deleting nodes could end up causing an ingress outage should all endpoints
simultaneously be running on said nodes.
The Kubernetes project recommends that cloud provider integration code
configures load balancer health checks that target the service proxy's healthz
port. If you are using or implementing your own virtual IP implementation,
that people can use instead of kube-proxy, you should set up a similar health
checking port with logic that matches the kube-proxy implementation.
### Traffic to terminating endpoints
If the `ProxyTerminatingEndpoints`
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
is enabled in kube-proxy and the traffic policy is `Local`, that node's
kube-proxy uses a more complicated algorithm to select endpoints for a Service.
With the feature enabled, kube-proxy checks if the node
has local endpoints and whether or not all the local endpoints are marked as terminating.
If there are local endpoints and **all** of them are terminating, then kube-proxy
will forward traffic to those terminating endpoints. Otherwise, kube-proxy will always
prefer forwarding traffic to endpoints that are not terminating.
This forwarding behavior for terminating endpoints exist to allow `NodePort` and `LoadBalancer`
Services to gracefully drain connections when using `externalTrafficPolicy: Local`.
As a deployment goes through a rolling update, nodes backing a load balancer may transition from
N to 0 replicas of that deployment. In some cases, external load balancers can send traffic to
a node with 0 replicas in between health check probes. Routing traffic to terminating endpoints
ensures that Node's that are scaling down Pods can gracefully receive and drain traffic to
those terminating Pods. By the time the Pod completes termination, the external load balancer
should have seen the node's health check failing and fully removed the node from the backend
pool.
## Traffic Distribution
The `spec.trafficDistribution` field within a Kubernetes Service allows you to
express preferences for how traffic should be routed to Service endpoints.
Implementations like kube-proxy use the `spec.trafficDistribution` field as a
guideline. The behavior associated with a given preference may subtly differ
between implementations.
`PreferClose` with kube-proxy
: For kube-proxy, this means prioritizing sending traffic to endpoints within
the same zone as the client. The EndpointSlice controller updates
EndpointSlices with `hints` to communicate this preference, which kube-proxy
then uses for routing decisions. If a client's zone does not have any
available endpoints, traffic will be routed cluster-wide for that client.
In the absence of any value for `trafficDistribution`, the default routing
strategy for kube-proxy is to distribute traffic to any endpoint in the cluster.
### Comparison with `service.kubernetes.io/topology-mode: Auto`
The `trafficDistribution` field with `PreferClose` and the
`service.kubernetes.io/topology-mode: Auto` annotation both aim to prioritize
same-zone traffic. However, there are key differences in their approaches:
* `service.kubernetes.io/topology-mode: Auto`: Attempts to distribute traffic
proportionally across zones based on allocatable CPU resources. This heuristic
includes safeguards (such as the [fallback
behavior](/docs/concepts/services-networking/topology-aware-routing/#three-or-more-endpoints-per-zone)
for small numbers of endpoints) and could lead to the feature being disabled
in certain scenarios for load-balancing reasons. This approach sacrifices some
predictability in favor of potential load balancing.
* `trafficDistribution: PreferClose`: This approach aims to be slightly simpler
and more predictable: "If there are endpoints in the zone, they will receive
all traffic for that zone, if there are no endpoints in a zone, the traffic
will be distributed to other zones". While the approach may offer more
predictability, it does mean that you are in control of managing a [potential
overload](#considerations-for-using-traffic-distribution-control).
If the `service.kubernetes.io/topology-mode` annotation is set to `Auto`, it
will take precedence over `trafficDistribution`. (The annotation may be deprecated
in the future in favour of the `trafficDistribution` field).
### Interaction with Traffic Policies
When compared to the `trafficDistribution` field, the traffic policy fields
(`externalTrafficPolicy` and `internalTrafficPolicy`) are meant to offer a
stricter traffic locality requirements. Here's how `trafficDistribution`
interacts with them:
* Precedence of Traffic Policies: For a given Service, if a traffic policy
(`externalTrafficPolicy` or `internalTrafficPolicy`) is set to `Local`, it
takes precedence over `trafficDistribution: PreferClose` for the corresponding
traffic type (external or internal, respectively).
* `trafficDistribution` Influence: For a given Service, if a traffic policy
(`externalTrafficPolicy` or `internalTrafficPolicy`) is set to `Cluster` (the
default), or if the fields are not set, then `trafficDistribution:
PreferClose` guides the routing behavior for the corresponding traffic type
(external or internal, respectively). This means that an attempt will be made
to route traffic to an endpoint that is in the same zone as the client.
### Considerations for using traffic distribution control
* **Increased Probability of Overloaded Endpoints:** The `PreferClose`
heuristic will attempt to route traffic to the closest healthy endpoints
instead of spreading that traffic evenly across all endpoints. If you do not
have a sufficient number of endpoints within a zone, they may become
overloaded. This is especially likely if incoming traffic is not
proportionally distributed across zones. To mitigate this, consider the
following strategies:
* [Pod Topology Spread
Constraints](/docs/concepts/scheduling-eviction/topology-spread-constraints/):
Use Pod Topology Spread Constraints to distribute your pods more evenly
across zones.
* Zone-specific Deployments: If you expect to see skewed traffic patterns,
create a separate Deployment for each zone. This approach allows the
separate workloads to scale independently. There are also workload
management addons available from the ecosystem, outside the Kubernetes
project itself, that can help here.
* **Implementation-specific behavior:** Each dataplane implementation may handle
this field slightly differently. If you're using an implementation other than
kube-proxy, refer the documentation specific to that implementation to
understand how this field is being handled.
##
To learn more about Services,
read [Connecting Applications with Services](/docs/tutorials/services/connect-applications-service/).
You can also:
* Read about [Services](/docs/concepts/services-networking/service/) as a concept
* Read about [Ingresses](/docs/concepts/services-networking/ingress/) as a concept
* Read the [API reference](/docs/reference/kubernetes-api/service-resources/service-v1/) for the Service API
| kubernetes reference | title Virtual IPs and Service Proxies content type reference weight 50 overview Every in a Kubernetes runs a kube proxy docs reference command line tools reference kube proxy unless you have deployed your own alternative component in place of kube proxy The kube proxy component is responsible for implementing a virtual IP mechanism for of type other than ExternalName docs concepts services networking service externalname Each instance of kube proxy watches the Kubernetes for the addition and removal of Service and EndpointSlice For each Service kube proxy calls appropriate APIs depending on the kube proxy mode to configure the node to capture traffic to the Service s clusterIP and port and redirect that traffic to one of the Service s endpoints usually a Pod but possibly an arbitrary user provided IP address A control loop ensures that the rules on each node are reliably synchronized with the Service and EndpointSlice state as indicated by the API server A question that pops up every now and then is why Kubernetes relies on proxying to forward inbound traffic to backends What about other approaches For example would it be possible to configure DNS records that have multiple A values or AAAA for IPv6 and rely on round robin name resolution There are a few reasons for using proxying for Services There is a long history of DNS implementations not respecting record TTLs and caching the results of name lookups after they should have expired Some apps do DNS lookups only once and cache the results indefinitely Even if apps and libraries did proper re resolution the low or zero TTLs on the DNS records could impose a high load on DNS that then becomes difficult to manage Later in this page you can read about how various kube proxy implementations work Overall you should note that when running kube proxy kernel level rules may be modified for example iptables rules might get created which won t get cleaned up in some cases until you reboot Thus running kube proxy is something that should only be done by an administrator which understands the consequences of having a low level privileged network proxying service on a computer Although the kube proxy executable supports a cleanup function this function is not an official feature and thus is only available to use as is a id example a Some of the details in this reference refer to an example the backend for a stateless image processing workloads running with three replicas Those replicas are fungible mdash frontends do not care which backend they use While the actual Pods that compose the backend set may change the frontend clients should not need to be aware of that nor should they need to keep track of the set of backends themselves body Proxy modes The kube proxy starts up in different modes which are determined by its configuration On Linux nodes the available modes for kube proxy are iptables proxy mode iptables A mode where the kube proxy configures packet forwarding rules using iptables ipvs proxy mode ipvs a mode where the kube proxy configures packet forwarding rules using ipvs nftables proxy mode nftables a mode where the kube proxy configures packet forwarding rules using nftables There is only one mode available for kube proxy on Windows kernelspace proxy mode kernelspace a mode where the kube proxy configures packet forwarding rules in the Windows kernel iptables proxy mode proxy mode iptables This proxy mode is only available on Linux nodes In this mode kube proxy configures packet forwarding rules using the iptables API of the kernel netfilter subsystem For each endpoint it installs iptables rules which by default select a backend Pod at random Example packet processing iptables As an example consider the image processing application described earlier example in the page When the backend Service is created the Kubernetes control plane assigns a virtual IP address for example 10 0 0 1 For this example assume that the Service port is 1234 All of the kube proxy instances in the cluster observe the creation of the new Service When kube proxy on a node sees a new Service it installs a series of iptables rules which redirect from the virtual IP address to more iptables rules defined per Service The per Service rules link to further rules for each backend endpoint and the per endpoint rules redirect traffic using destination NAT to the backends When a client connects to the Service s virtual IP address the iptables rule kicks in A backend is chosen either based on session affinity or randomly and packets are redirected to the backend without rewriting the client IP address This same basic flow executes when traffic comes in through a node port or through a load balancer though in those cases the client IP address does get altered Optimizing iptables mode performance In iptables mode kube proxy creates a few iptables rules for every Service and a few iptables rules for each endpoint IP address In clusters with tens of thousands of Pods and Services this means tens of thousands of iptables rules and kube proxy may take a long time to update the rules in the kernel when Services or their EndpointSlices change You can adjust the syncing behavior of kube proxy via options in the iptables section docs reference config api kube proxy config v1alpha1 kubeproxy config k8s io v1alpha1 KubeProxyIPTablesConfiguration of the kube proxy configuration file docs reference config api kube proxy config v1alpha1 which you specify via kube proxy config path yaml iptables minSyncPeriod 1s syncPeriod 30s minSyncPeriod The minSyncPeriod parameter sets the minimum duration between attempts to resynchronize iptables rules with the kernel If it is 0s then kube proxy will always immediately synchronize the rules every time any Service or Endpoint changes This works fine in very small clusters but it results in a lot of redundant work when lots of things change in a small time period For example if you have a Service backed by a with 100 pods and you delete the Deployment then with minSyncPeriod 0s kube proxy would end up removing the Service s endpoints from the iptables rules one by one for a total of 100 updates With a larger minSyncPeriod multiple Pod deletion events would get aggregated together so kube proxy might instead end up making say 5 updates each removing 20 endpoints which will be much more efficient in terms of CPU and result in the full set of changes being synchronized faster The larger the value of minSyncPeriod the more work that can be aggregated but the downside is that each individual change may end up waiting up to the full minSyncPeriod before being processed meaning that the iptables rules spend more time being out of sync with the current API server state The default value of 1s should work well in most clusters but in very large clusters it may be necessary to set it to a larger value Especially if kube proxy s sync proxy rules duration seconds metric indicates an average time much larger than 1 second then bumping up minSyncPeriod may make updates more efficient Updating legacy minSyncPeriod configuration minimize iptables restore Older versions of kube proxy updated all the rules for all Services on every sync this led to performance issues update lag in large clusters and the recommended solution was to set a larger minSyncPeriod Since Kubernetes v1 28 the iptables mode of kube proxy uses a more minimal approach only making updates where Services or EndpointSlices have actually changed If you were previously overriding minSyncPeriod you should try removing that override and letting kube proxy use the default value 1s or at least a smaller value than you were using before upgrading If you are not running kube proxy from Kubernetes check the behavior and associated advice for the version that you are actually running syncPeriod The syncPeriod parameter controls a handful of synchronization operations that are not directly related to changes in individual Services and EndpointSlices In particular it controls how quickly kube proxy notices if an external component has interfered with kube proxy s iptables rules In large clusters kube proxy also only performs certain cleanup operations once every syncPeriod to avoid unnecessary work For the most part increasing syncPeriod is not expected to have much impact on performance but in the past it was sometimes useful to set it to a very large value eg 1h This is no longer recommended and is likely to hurt functionality more than it improves performance IPVS proxy mode proxy mode ipvs This proxy mode is only available on Linux nodes In ipvs mode kube proxy uses the kernel IPVS and iptables APIs to create rules to redirect traffic from Service IPs to endpoint IPs The IPVS proxy mode is based on netfilter hook function that is similar to iptables mode but uses a hash table as the underlying data structure and works in the kernel space That means kube proxy in IPVS mode redirects traffic with lower latency than kube proxy in iptables mode with much better performance when synchronizing proxy rules Compared to the iptables proxy mode IPVS mode also supports a higher throughput of network traffic IPVS provides more options for balancing traffic to backend Pods these are rr Round Robin Traffic is equally distributed amongst the backing servers wrr Weighted Round Robin Traffic is routed to the backing servers based on the weights of the servers Servers with higher weights receive new connections and get more requests than servers with lower weights lc Least Connection More traffic is assigned to servers with fewer active connections wlc Weighted Least Connection More traffic is routed to servers with fewer connections relative to their weights that is connections divided by weight lblc Locality based Least Connection Traffic for the same IP address is sent to the same backing server if the server is not overloaded and available otherwise the traffic is sent to servers with fewer connections and keep it for future assignment lblcr Locality Based Least Connection with Replication Traffic for the same IP address is sent to the server with least connections If all the backing servers are overloaded it picks up one with fewer connections and add it to the target set If the target set has not changed for the specified time the most loaded server is removed from the set in order to avoid high degree of replication sh Source Hashing Traffic is sent to a backing server by looking up a statically assigned hash table based on the source IP addresses dh Destination Hashing Traffic is sent to a backing server by looking up a statically assigned hash table based on their destination addresses sed Shortest Expected Delay Traffic forwarded to a backing server with the shortest expected delay The expected delay is C 1 U if sent to a server where C is the number of connections on the server and U is the fixed service rate weight of the server nq Never Queue Traffic is sent to an idle server if there is one instead of waiting for a fast one if all servers are busy the algorithm falls back to the sed behavior mh Maglev Hashing Assigns incoming jobs based on Google s Maglev hashing algorithm https static googleusercontent com media research google com en pubs archive 44824 pdf This scheduler has two flags mh fallback which enables fallback to a different server if the selected server is unavailable and mh port which adds the source port number to the hash computation When using mh kube proxy always sets the mh port flag and does not enable the mh fallback flag In proxy mode ipvs mh will work as source hashing sh but with ports These scheduling algorithms are configured through the ipvs scheduler docs reference config api kube proxy config v1alpha1 kubeproxy config k8s io v1alpha1 KubeProxyIPVSConfiguration field in the kube proxy configuration To run kube proxy in IPVS mode you must make IPVS available on the node before starting kube proxy When kube proxy starts in IPVS proxy mode it verifies whether IPVS kernel modules are available If the IPVS kernel modules are not detected then kube proxy exits with an error nftables proxy mode proxy mode nftables This proxy mode is only available on Linux nodes and requires kernel 5 13 or later In this mode kube proxy configures packet forwarding rules using the nftables API of the kernel netfilter subsystem For each endpoint it installs nftables rules which by default select a backend Pod at random The nftables API is the successor to the iptables API and is designed to provide better performance and scalability than iptables The nftables proxy mode is able to process changes to service endpoints faster and more efficiently than the iptables mode and is also able to more efficiently process packets in the kernel though this only becomes noticeable in clusters with tens of thousands of services As of Kubernetes the nftables mode is still relatively new and may not be compatible with all network plugins consult the documentation for your network plugin Migrating from iptables mode to nftables Users who want to switch from the default iptables mode to the nftables mode should be aware that some features work slightly differently the nftables mode NodePort interfaces In iptables mode by default NodePort services docs concepts services networking service type nodeport are reachable on all local IP addresses This is usually not what users want so the nftables mode defaults to nodeport addresses primary meaning NodePort services are only reachable on the node s primary IPv4 and or IPv6 addresses You can override this by specifying an explicit value for that option e g nodeport addresses 0 0 0 0 0 to listen on all local IPv4 IPs NodePort services on 127 0 0 1 In iptables mode if the nodeport addresses range includes 127 0 0 1 and the option iptables localhost nodeports false option is not passed then NodePort services are reachable even on localhost 127 0 0 1 In nftables mode and ipvs mode this will not work If you are not sure if you are depending on this functionality you can check kube proxy s iptables localhost nodeports accepted packets total metric if it is non 0 that means that some client has connected to a NodePort service via 127 0 0 1 NodePort interaction with firewalls The iptables mode of kube proxy tries to be compatible with overly agressive firewalls for each NodePort service it will add rules to accept inbound traffic on that port in case that traffic would otherwise be blocked by a firewall This approach will not work with firewalls based on nftables so kube proxy s nftables mode does not do anything here if you have a local firewall you must ensure that it is properly configured to allow Kubernetes traffic through e g by allowing inbound traffic on the entire NodePort range Conntrack bug workarounds Linux kernels prior to 6 1 have a bug that can result in long lived TCP connections to service IPs being closed with the error Connection reset by peer The iptables mode of kube proxy installs a workaround for this bug but this workaround was later found to cause other problems in some clusters The nftables mode does not install any workaround by default but you can check kube proxy s iptables ct state invalid dropped packets total metric to see if your cluster is depending on the workaround and if so you can run kube proxy with the option conntrack tcp be liberal to work around the problem in nftables mode kernelspace proxy mode proxy mode kernelspace This proxy mode is only available on Windows nodes The kube proxy configures packet filtering rules in the Windows Virtual Filtering Platform VFP an extension to Windows vSwitch These rules process encapsulated packets within the node level virtual networks and rewrite packets so that the destination IP address and layer 2 information is correct for getting the packet routed to the correct destination The Windows VFP is analogous to tools such as Linux nftables or iptables The Windows VFP extends the Hyper V Switch which was initially implemented to support virtual machine networking When a Pod on a node sends traffic to a virtual IP address and the kube proxy selects a Pod on a different node as the load balancing target the kernelspace proxy mode rewrites that packet to be destined to the target backend Pod The Windows Host Networking Service HNS ensures that packet rewriting rules are configured so that the return traffic appears to come from the virtual IP address and not the specific backend Pod Direct server return for kernelspace mode windows direct server return As an alternative to the basic operation a node that hosts the backend Pod for a Service can apply the packet rewriting directly rather than placing this burden on the node where the client Pod is running This is called direct server return To use this you must run kube proxy with the enable dsr command line argument and enable the WinDSR feature gate docs reference command line tools reference feature gates Direct server return also optimizes the case for Pod return traffic even when both Pods are running on the same node Session affinity In these proxy models the traffic bound for the Service s IP Port is proxied to an appropriate backend without the clients knowing anything about Kubernetes or Services or Pods If you want to make sure that connections from a particular client are passed to the same Pod each time you can select the session affinity based on the client s IP addresses by setting spec sessionAffinity to ClientIP for a Service the default is None Session stickiness timeout You can also set the maximum session sticky time by setting spec sessionAffinityConfig clientIP timeoutSeconds appropriately for a Service the default value is 10800 which works out to be 3 hours On Windows setting the maximum session sticky time for Services is not supported IP address assignment to Services Unlike Pod IP addresses which actually route to a fixed destination Service IPs are not actually answered by a single host Instead kube proxy uses packet processing logic such as Linux iptables to define virtual IP addresses which are transparently redirected as needed When clients connect to the VIP their traffic is automatically transported to an appropriate endpoint The environment variables and DNS for Services are actually populated in terms of the Service s virtual IP address and port Avoiding collisions One of the primary philosophies of Kubernetes is that you should not be exposed to situations that could cause your actions to fail through no fault of your own For the design of the Service resource this means not making you choose your own IP address if that choice might collide with someone else s choice That is an isolation failure In order to allow you to choose an IP address for your Services we must ensure that no two Services can collide Kubernetes does that by allocating each Service its own IP address from within the service cluster ip range CIDR range that is configured for the IP address allocation tracking To ensure each Service receives a unique IP address an internal allocator atomically updates a global allocation map in prior to creating each Service The map object must exist in the registry for Services to get IP address assignments otherwise creations will fail with a message indicating an IP address could not be allocated In the control plane a background controller is responsible for creating that map needed to support migrating from older versions of Kubernetes that used in memory locking Kubernetes also uses controllers to check for invalid assignments for example due to administrator intervention and for cleaning up allocated IP addresses that are no longer used by any Services IP address allocation tracking using the Kubernetes API ip address objects If you enable the MultiCIDRServiceAllocator feature gate docs reference command line tools reference feature gates and the networking k8s io v1alpha1 API group docs tasks administer cluster enable disable api the control plane replaces the existing etcd allocator with a revised implementation that uses IPAddress and ServiceCIDR objects instead of an internal global allocation map Each cluster IP address associated to a Service then references an IPAddress object Enabling the feature gate also replaces a background controller with an alternative that handles the IPAddress objects and supports migration from the old allocator model Kubernetes does not support migrating from IPAddress objects to the internal allocation map One of the main benefits of the revised allocator is that it removes the size limitations for the IP address range that can be used for the cluster IP address of Services With MultiCIDRServiceAllocator enabled there are no limitations for IPv4 and for IPv6 you can use IP address netmasks that are a 64 or smaller as opposed to 108 with the legacy implementation Making IP address allocations available via the API means that you as a cluster administrator can allow users to inspect the IP addresses assigned to their Services Kubernetes extensions such as the Gateway API docs concepts services networking gateway can use the IPAddress API to extend Kubernetes inherent networking capabilities Here is a brief example of a user querying for IP addresses shell kubectl get services NAME TYPE CLUSTER IP EXTERNAL IP PORT S AGE kubernetes ClusterIP 2001 db8 1 2 1 none 443 TCP 3d1h shell kubectl get ipaddresses NAME PARENTREF 2001 db8 1 2 1 services default kubernetes 2001 db8 1 2 a services kube system kube dns Kubernetes also allow users to dynamically define the available IP ranges for Services using ServiceCIDR objects During bootstrap a default ServiceCIDR object named kubernetes is created from the value of the service cluster ip range command line argument to kube apiserver shell kubectl get servicecidrs NAME CIDRS AGE kubernetes 10 96 0 0 28 17m Users can create or delete new ServiceCIDR objects to manage the available IP ranges for Services shell cat EOF kubectl apply f apiVersion networking k8s io v1beta1 kind ServiceCIDR metadata name newservicecidr spec cidrs 10 96 0 0 24 EOF servicecidr networking k8s io newcidr1 created shell kubectl get servicecidrs NAME CIDRS AGE kubernetes 10 96 0 0 28 17m newservicecidr 10 96 0 0 24 7m IP address ranges for Service virtual IP addresses service ip static sub range Kubernetes divides the ClusterIP range into two bands based on the size of the configured service cluster ip range by using the following formula min max 16 cidrSize 16 256 That formula paraphrases as never less than 16 or more than 256 with a graduated step function between them Kubernetes prefers to allocate dynamic IP addresses to Services by choosing from the upper band which means that if you want to assign a specific IP address to a type ClusterIP Service you should manually assign an IP address from the lower band That approach reduces the risk of a conflict over allocation Traffic policies You can set the spec internalTrafficPolicy and spec externalTrafficPolicy fields to control how Kubernetes routes traffic to healthy ready backends Internal traffic policy You can set the spec internalTrafficPolicy field to control how traffic from internal sources is routed Valid values are Cluster and Local Set the field to Cluster to route internal traffic to all ready endpoints and Local to only route to ready node local endpoints If the traffic policy is Local and there are no node local endpoints traffic is dropped by kube proxy External traffic policy You can set the spec externalTrafficPolicy field to control how traffic from external sources is routed Valid values are Cluster and Local Set the field to Cluster to route external traffic to all ready endpoints and Local to only route to ready node local endpoints If the traffic policy is Local and there are are no node local endpoints the kube proxy does not forward any traffic for the relevant Service If Cluster is specified all nodes are eligible load balancing targets as long as the node is not being deleted and kube proxy is healthy In this mode load balancer health checks are configured to target the service proxy s readiness port and path In the case of kube proxy this evaluates to NODE IP 10256 healthz kube proxy will return either an HTTP code 200 or 503 kube proxy s load balancer health check endpoint returns 200 if 1 kube proxy is healthy meaning it s able to progress programming the network and isn t timing out while doing so the timeout is defined to be 2 iptables syncPeriod and 2 the node is not being deleted there is no deletion timestamp set for the Node The reason why kube proxy returns 503 and marks the node as not eligible when it s being deleted is because kube proxy supports connection draining for terminating nodes A couple of important things occur from the point of view of a Kubernetes managed load balancer when a node is being is deleted While deleting kube proxy will start failing its readiness probe and essentially mark the node as not eligible for load balancer traffic The load balancer health check failing causes load balancers which support connection draining to allow existing connections to terminate and block new connections from establishing When deleted The service controller in the Kubernetes cloud controller manager removes the node from the referenced set of eligible targets Removing any instance from the load balancer s set of backend targets immediately terminates all connections This is also the reason kube proxy first fails the health check while the node is deleting It s important to note for Kubernetes vendors that if any vendor configures the kube proxy readiness probe as a liveness probe that kube proxy will start restarting continuously when a node is deleting until it has been fully deleted kube proxy exposes a livez path which as opposed to the healthz one does not consider the Node s deleting state and only its progress programming the network livez is therefore the recommended path for anyone looking to define a livenessProbe for kube proxy Users deploying kube proxy can inspect both the readiness liveness state by evaluating the metrics proxy livez total proxy healthz total Both metrics publish two series one with the 200 label and one with the 503 one For Local Services kube proxy will return 200 if 1 kube proxy is healthy ready and 2 has a local endpoint on the node in question Node deletion does not have an impact on kube proxy s return code for what concerns load balancer health checks The reason for this is deleting nodes could end up causing an ingress outage should all endpoints simultaneously be running on said nodes The Kubernetes project recommends that cloud provider integration code configures load balancer health checks that target the service proxy s healthz port If you are using or implementing your own virtual IP implementation that people can use instead of kube proxy you should set up a similar health checking port with logic that matches the kube proxy implementation Traffic to terminating endpoints If the ProxyTerminatingEndpoints feature gate docs reference command line tools reference feature gates is enabled in kube proxy and the traffic policy is Local that node s kube proxy uses a more complicated algorithm to select endpoints for a Service With the feature enabled kube proxy checks if the node has local endpoints and whether or not all the local endpoints are marked as terminating If there are local endpoints and all of them are terminating then kube proxy will forward traffic to those terminating endpoints Otherwise kube proxy will always prefer forwarding traffic to endpoints that are not terminating This forwarding behavior for terminating endpoints exist to allow NodePort and LoadBalancer Services to gracefully drain connections when using externalTrafficPolicy Local As a deployment goes through a rolling update nodes backing a load balancer may transition from N to 0 replicas of that deployment In some cases external load balancers can send traffic to a node with 0 replicas in between health check probes Routing traffic to terminating endpoints ensures that Node s that are scaling down Pods can gracefully receive and drain traffic to those terminating Pods By the time the Pod completes termination the external load balancer should have seen the node s health check failing and fully removed the node from the backend pool Traffic Distribution The spec trafficDistribution field within a Kubernetes Service allows you to express preferences for how traffic should be routed to Service endpoints Implementations like kube proxy use the spec trafficDistribution field as a guideline The behavior associated with a given preference may subtly differ between implementations PreferClose with kube proxy For kube proxy this means prioritizing sending traffic to endpoints within the same zone as the client The EndpointSlice controller updates EndpointSlices with hints to communicate this preference which kube proxy then uses for routing decisions If a client s zone does not have any available endpoints traffic will be routed cluster wide for that client In the absence of any value for trafficDistribution the default routing strategy for kube proxy is to distribute traffic to any endpoint in the cluster Comparison with service kubernetes io topology mode Auto The trafficDistribution field with PreferClose and the service kubernetes io topology mode Auto annotation both aim to prioritize same zone traffic However there are key differences in their approaches service kubernetes io topology mode Auto Attempts to distribute traffic proportionally across zones based on allocatable CPU resources This heuristic includes safeguards such as the fallback behavior docs concepts services networking topology aware routing three or more endpoints per zone for small numbers of endpoints and could lead to the feature being disabled in certain scenarios for load balancing reasons This approach sacrifices some predictability in favor of potential load balancing trafficDistribution PreferClose This approach aims to be slightly simpler and more predictable If there are endpoints in the zone they will receive all traffic for that zone if there are no endpoints in a zone the traffic will be distributed to other zones While the approach may offer more predictability it does mean that you are in control of managing a potential overload considerations for using traffic distribution control If the service kubernetes io topology mode annotation is set to Auto it will take precedence over trafficDistribution The annotation may be deprecated in the future in favour of the trafficDistribution field Interaction with Traffic Policies When compared to the trafficDistribution field the traffic policy fields externalTrafficPolicy and internalTrafficPolicy are meant to offer a stricter traffic locality requirements Here s how trafficDistribution interacts with them Precedence of Traffic Policies For a given Service if a traffic policy externalTrafficPolicy or internalTrafficPolicy is set to Local it takes precedence over trafficDistribution PreferClose for the corresponding traffic type external or internal respectively trafficDistribution Influence For a given Service if a traffic policy externalTrafficPolicy or internalTrafficPolicy is set to Cluster the default or if the fields are not set then trafficDistribution PreferClose guides the routing behavior for the corresponding traffic type external or internal respectively This means that an attempt will be made to route traffic to an endpoint that is in the same zone as the client Considerations for using traffic distribution control Increased Probability of Overloaded Endpoints The PreferClose heuristic will attempt to route traffic to the closest healthy endpoints instead of spreading that traffic evenly across all endpoints If you do not have a sufficient number of endpoints within a zone they may become overloaded This is especially likely if incoming traffic is not proportionally distributed across zones To mitigate this consider the following strategies Pod Topology Spread Constraints docs concepts scheduling eviction topology spread constraints Use Pod Topology Spread Constraints to distribute your pods more evenly across zones Zone specific Deployments If you expect to see skewed traffic patterns create a separate Deployment for each zone This approach allows the separate workloads to scale independently There are also workload management addons available from the ecosystem outside the Kubernetes project itself that can help here Implementation specific behavior Each dataplane implementation may handle this field slightly differently If you re using an implementation other than kube proxy refer the documentation specific to that implementation to understand how this field is being handled To learn more about Services read Connecting Applications with Services docs tutorials services connect applications service You can also Read about Services docs concepts services networking service as a concept Read about Ingresses docs concepts services networking ingress as a concept Read the API reference docs reference kubernetes api service resources service v1 for the Service API |
kubernetes reference title Protocols for Services weight 10 you can select from any network protocol that Kubernetes supports If you configure a glossarytooltip text Service termid service contenttype reference overview | ---
title: Protocols for Services
content_type: reference
weight: 10
---
<!-- overview -->
If you configure a ,
you can select from any network protocol that Kubernetes supports.
Kubernetes supports the following protocols with Services:
- [`SCTP`](#protocol-sctp)
- [`TCP`](#protocol-tcp) _(the default)_
- [`UDP`](#protocol-udp)
When you define a Service, you can also specify the
[application protocol](/docs/concepts/services-networking/service/#application-protocol)
that it uses.
This document details some special cases, all of them typically using TCP
as a transport protocol:
- [HTTP](#protocol-http-special) and [HTTPS](#protocol-http-special)
- [PROXY protocol](#protocol-proxy-special)
- [TLS](#protocol-tls-special) termination at the load balancer
<!-- body -->
## Supported protocols {#protocol-support}
There are 3 valid values for the `protocol` of a port for a Service:
### `SCTP` {#protocol-sctp}
When using a network plugin that supports SCTP traffic, you can use SCTP for
most Services. For `type: LoadBalancer` Services, SCTP support depends on the cloud
provider offering this facility. (Most do not).
SCTP is not supported on nodes that run Windows.
#### Support for multihomed SCTP associations {#caveat-sctp-multihomed}
The support of multihomed SCTP associations requires that the CNI plugin can support the assignment of multiple interfaces and IP addresses to a Pod.
NAT for multihomed SCTP associations requires special logic in the corresponding kernel modules.
### `TCP` {#protocol-tcp}
You can use TCP for any kind of Service, and it's the default network protocol.
### `UDP` {#protocol-udp}
You can use UDP for most Services. For `type: LoadBalancer` Services,
UDP support depends on the cloud provider offering this facility.
## Special cases
### HTTP {#protocol-http-special}
If your cloud provider supports it, you can use a Service in LoadBalancer mode to
configure a load balancer outside of your Kubernetes cluster, in a special mode
where your cloud provider's load balancer implements HTTP / HTTPS reverse proxying,
with traffic forwarded to the backend endpoints for that Service.
Typically, you set the protocol for the Service to `TCP` and add an
(usually specific to your cloud provider) that configures the load balancer
to handle traffic at the HTTP level.
This configuration might also include serving HTTPS (HTTP over TLS) and
reverse-proxying plain HTTP to your workload.
You can also use an to expose
HTTP/HTTPS Services.
You might additionally want to specify that the
[application protocol](/docs/concepts/services-networking/service/#application-protocol)
of the connection is `http` or `https`. Use `http` if the session from the
load balancer to your workload is HTTP without TLS, and use `https` if the
session from the load balancer to your workload uses TLS encryption.
### PROXY protocol {#protocol-proxy-special}
If your cloud provider supports it, you can use a Service set to `type: LoadBalancer`
to configure a load balancer outside of Kubernetes itself, that will forward connections
wrapped with the
[PROXY protocol](https://www.haproxy.org/download/2.5/doc/proxy-protocol.txt).
The load balancer then sends an initial series of octets describing the
incoming connection, similar to this example (PROXY protocol v1):
```
PROXY TCP4 192.0.2.202 10.0.42.7 12345 7\r\n
```
The data after the proxy protocol preamble are the original
data from the client. When either side closes the connection,
the load balancer also triggers a connection close and sends
any remaining data where feasible.
Typically, you define a Service with the protocol to `TCP`.
You also set an annotation, specific to your
cloud provider, that configures the load balancer to wrap each incoming connection in the PROXY protocol.
### TLS {#protocol-tls-special}
If your cloud provider supports it, you can use a Service set to `type: LoadBalancer` as
a way to set up external reverse proxying, where the connection from client to load
balancer is TLS encrypted and the load balancer is the TLS server peer.
The connection from the load balancer to your workload can also be TLS,
or might be plain text. The exact options available to you depend on your
cloud provider or custom Service implementation.
Typically, you set the protocol to `TCP` and set an annotation
(usually specific to your cloud provider) that configures the load balancer
to act as a TLS server. You would configure the TLS identity (as server,
and possibly also as a client that connects to your workload) using
mechanisms that are specific to your cloud provider. | kubernetes reference | title Protocols for Services content type reference weight 10 overview If you configure a you can select from any network protocol that Kubernetes supports Kubernetes supports the following protocols with Services SCTP protocol sctp TCP protocol tcp the default UDP protocol udp When you define a Service you can also specify the application protocol docs concepts services networking service application protocol that it uses This document details some special cases all of them typically using TCP as a transport protocol HTTP protocol http special and HTTPS protocol http special PROXY protocol protocol proxy special TLS protocol tls special termination at the load balancer body Supported protocols protocol support There are 3 valid values for the protocol of a port for a Service SCTP protocol sctp When using a network plugin that supports SCTP traffic you can use SCTP for most Services For type LoadBalancer Services SCTP support depends on the cloud provider offering this facility Most do not SCTP is not supported on nodes that run Windows Support for multihomed SCTP associations caveat sctp multihomed The support of multihomed SCTP associations requires that the CNI plugin can support the assignment of multiple interfaces and IP addresses to a Pod NAT for multihomed SCTP associations requires special logic in the corresponding kernel modules TCP protocol tcp You can use TCP for any kind of Service and it s the default network protocol UDP protocol udp You can use UDP for most Services For type LoadBalancer Services UDP support depends on the cloud provider offering this facility Special cases HTTP protocol http special If your cloud provider supports it you can use a Service in LoadBalancer mode to configure a load balancer outside of your Kubernetes cluster in a special mode where your cloud provider s load balancer implements HTTP HTTPS reverse proxying with traffic forwarded to the backend endpoints for that Service Typically you set the protocol for the Service to TCP and add an usually specific to your cloud provider that configures the load balancer to handle traffic at the HTTP level This configuration might also include serving HTTPS HTTP over TLS and reverse proxying plain HTTP to your workload You can also use an to expose HTTP HTTPS Services You might additionally want to specify that the application protocol docs concepts services networking service application protocol of the connection is http or https Use http if the session from the load balancer to your workload is HTTP without TLS and use https if the session from the load balancer to your workload uses TLS encryption PROXY protocol protocol proxy special If your cloud provider supports it you can use a Service set to type LoadBalancer to configure a load balancer outside of Kubernetes itself that will forward connections wrapped with the PROXY protocol https www haproxy org download 2 5 doc proxy protocol txt The load balancer then sends an initial series of octets describing the incoming connection similar to this example PROXY protocol v1 PROXY TCP4 192 0 2 202 10 0 42 7 12345 7 r n The data after the proxy protocol preamble are the original data from the client When either side closes the connection the load balancer also triggers a connection close and sends any remaining data where feasible Typically you define a Service with the protocol to TCP You also set an annotation specific to your cloud provider that configures the load balancer to wrap each incoming connection in the PROXY protocol TLS protocol tls special If your cloud provider supports it you can use a Service set to type LoadBalancer as a way to set up external reverse proxying where the connection from client to load balancer is TLS encrypted and the load balancer is the TLS server peer The connection from the load balancer to your workload can also be TLS or might be plain text The exact options available to you depend on your cloud provider or custom Service implementation Typically you set the protocol to TCP and set an annotation usually specific to your cloud provider that configures the load balancer to act as a TLS server You would configure the TLS identity as server and possibly also as a client that connects to your workload using mechanisms that are specific to your cloud provider |
kubernetes reference package kubeadm k8s io v1beta3 p Package v1beta3 defines the v1beta3 version of the kubeadm configuration file format contenttype tool reference h2 Overview h2 title kubeadm Configuration v1beta3 p A list of changes since v1beta2 p This version improves on the v1beta2 format by fixing some minor issues and adding a few new fields p autogenerated true | ---
title: kubeadm Configuration (v1beta3)
content_type: tool-reference
package: kubeadm.k8s.io/v1beta3
auto_generated: true
---
<h2>Overview</h2>
<p>Package v1beta3 defines the v1beta3 version of the kubeadm configuration file format.
This version improves on the v1beta2 format by fixing some minor issues and adding a few new fields.</p>
<p>A list of changes since v1beta2:</p>
<ul>
<li>The deprecated "ClusterConfiguration.useHyperKubeImage" field has been removed.
Kubeadm no longer supports the hyperkube image.</li>
<li>The "ClusterConfiguration.dns.type" field has been removed since CoreDNS is the only supported
DNS server type by kubeadm.</li>
<li>Include "datapolicy" tags on the fields that hold secrets.
This would result in the field values to be omitted when API structures are printed with klog.</li>
<li>Add "InitConfiguration.skipPhases", "JoinConfiguration.skipPhases" to allow skipping
a list of phases during kubeadm init/join command execution.</li>
<li>Add "InitConfiguration.nodeRegistration.imagePullPolicy" and "JoinConfiguration.nodeRegistration.imagePullPolicy"
to allow specifying the images pull policy during kubeadm "init" and "join".
The value must be one of "Always", "Never" or "IfNotPresent".
"IfNotPresent" is the default, which has been the existing behavior prior to this addition.</li>
<li>Add "InitConfiguration.patches.directory", "JoinConfiguration.patches.directory" to allow
the user to configure a directory from which to take patches for components deployed by kubeadm.</li>
<li>Move the BootstrapToken* API and related utilities out of the "kubeadm" API group to a new group
"bootstraptoken". The kubeadm API version v1beta3 no longer contains the BootstrapToken* structures.</li>
</ul>
<p>Migration from old kubeadm config versions</p>
<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>
</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 style="background-color:#fff"><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta3<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:#bbb"></span><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta3<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:#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:#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:#bbb"></span><span style="color:#000;font-weight:bold">apiVersion</span>:<span style="color:#bbb"> </span>kubeadm.k8s.io/v1beta3<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></pre><p>To print the defaults for "init" and "join" actions use the following commands:</p>
<pre style="background-color:#fff">kubeadm config print init-defaults
kubeadm config print join-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/v1beta3<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/v1beta3<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/v1beta3<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:#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">"/var/run/dockershim.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">v</span>:<span style="color:#bbb"> </span><span style="color:#099">4</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">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>- addon/kube-proxy<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/v1beta3<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:#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">listen-client-urls</span>:<span style="color:#bbb"> </span><span style="color:#d14">"http://10.100.0.1:2379"</span><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:#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">authorization-mode</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">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:#000;font-weight:bold">timeoutForControlPlane</span>:<span style="color:#bbb"> </span>4m0s<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">"node-cidr-mask-size": </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:#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">bind-address</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:#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:#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 <code>kubeadm join</code> with the <code>--config</code> 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/v1beta3<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:#bbb">
</span></pre><p>The JoinConfiguration type should be used to configure runtime settings, that in case of <code>kubeadm join</code>
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>
## Resource Types
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-ClusterConfiguration)
- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration)
- [JoinConfiguration](#kubeadm-k8s-io-v1beta3-JoinConfiguration)
## `BootstrapToken` {#BootstrapToken}
**Appears in:**
- [InitConfiguration](#kubeadm-k8s-io-v1beta3-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-v1beta3-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/v1beta3</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-v1beta3-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-v1beta3-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-v1beta3-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-v1beta3-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-v1beta3-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-v1beta3-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>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>
</tbody>
</table>
## `InitConfiguration` {#kubeadm-k8s-io-v1beta3-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/v1beta3</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>nodeRegistration</code><br/>
<a href="#kubeadm-k8s-io-v1beta3-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-v1beta3-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
load-balances 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 "--skip-phases" takes precedence over this field.</p>
</td>
</tr>
<tr><td><code>patches</code><br/>
<a href="#kubeadm-k8s-io-v1beta3-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>
</tbody>
</table>
## `JoinConfiguration` {#kubeadm-k8s-io-v1beta3-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/v1beta3</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>JoinConfiguration</code></td></tr>
<tr><td><code>nodeRegistration</code><br/>
<a href="#kubeadm-k8s-io-v1beta3-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 a node and the 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-v1beta3-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-v1beta3-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-v1beta3-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>
</tbody>
</table>
## `APIEndpoint` {#kubeadm-k8s-io-v1beta3-APIEndpoint}
**Appears in:**
- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration)
- [JoinControlPlane](#kubeadm-k8s-io-v1beta3-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>advertiseAddress</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-v1beta3-APIServer}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-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-v1beta3-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>
<tr><td><code>timeoutForControlPlane</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>timeoutForControlPlane</code> controls the timeout that we wait for API server to appear.</p>
</td>
</tr>
</tbody>
</table>
## `BootstrapTokenDiscovery` {#kubeadm-k8s-io-v1beta3-BootstrapTokenDiscovery}
**Appears in:**
- [Discovery](#kubeadm-k8s-io-v1beta3-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-v1beta3-ControlPlaneComponent}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-ClusterConfiguration)
- [APIServer](#kubeadm-k8s-io-v1beta3-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/>
<code>map[string]string</code>
</td>
<td>
<p><code>extraArgs</code> is an extra set of flags to pass to the control plane component.
A key in this map is the flag name as it appears on the command line except
without leading dash(es).</p>
</td>
</tr>
<tr><td><code>extraVolumes</code><br/>
<a href="#kubeadm-k8s-io-v1beta3-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>
</tbody>
</table>
## `DNS` {#kubeadm-k8s-io-v1beta3-DNS}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-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-v1beta3-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 component.</p>
</td>
</tr>
</tbody>
</table>
## `Discovery` {#kubeadm-k8s-io-v1beta3-Discovery}
**Appears in:**
- [JoinConfiguration](#kubeadm-k8s-io-v1beta3-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-v1beta3-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-v1beta3-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>
<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><code>timeout</code> modifies the discovery timeout.</p>
</td>
</tr>
</tbody>
</table>
## `Etcd` {#kubeadm-k8s-io-v1beta3-Etcd}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-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-v1beta3-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-v1beta3-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-v1beta3-ExternalEtcd}
**Appears in:**
- [Etcd](#kubeadm-k8s-io-v1beta3-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-v1beta3-FileDiscovery}
**Appears in:**
- [Discovery](#kubeadm-k8s-io-v1beta3-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-v1beta3-HostPathMount}
**Appears in:**
- [ControlPlaneComponent](#kubeadm-k8s-io-v1beta3-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-v1beta3-ImageMeta}
**Appears in:**
- [DNS](#kubeadm-k8s-io-v1beta3-DNS)
- [LocalEtcd](#kubeadm-k8s-io-v1beta3-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-v1beta3-JoinControlPlane}
**Appears in:**
- [JoinConfiguration](#kubeadm-k8s-io-v1beta3-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-v1beta3-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-v1beta3-LocalEtcd}
**Appears in:**
- [Etcd](#kubeadm-k8s-io-v1beta3-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-v1beta3-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><br/>
<code>map[string]string</code>
</td>
<td>
<p><code>extraArgs</code> are extra arguments provided to the etcd binary when run
inside a static Pod. A key in this map is the flag name as it appears on the
command line except without leading dash(es).</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-v1beta3-Networking}
**Appears in:**
- [ClusterConfiguration](#kubeadm-k8s-io-v1beta3-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-v1beta3-NodeRegistrationOptions}
**Appears in:**
- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration)
- [JoinConfiguration](#kubeadm-k8s-io-v1beta3-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/>
<code>map[string]string</code>
</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. A key in this map is the flag name as it appears on the
command line except without leading dash(es).</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 when
the current node is registered, e.g. <code>IsPrevilegedUser,Swap</code>.
Value <code>all</code> 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 "init" and
"join" operations.
The value of this field must be one of "Always", "IfNotPresent" or "Never".
If this field is not set, kubeadm will default it to "IfNotPresent", or pull the required
images if not present on the host.</p>
</td>
</tr>
</tbody>
</table>
## `Patches` {#kubeadm-k8s-io-v1beta3-Patches}
**Appears in:**
- [InitConfiguration](#kubeadm-k8s-io-v1beta3-InitConfiguration)
- [JoinConfiguration](#kubeadm-k8s-io-v1beta3-JoinConfiguration)
<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". "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>
| kubernetes reference | title kubeadm Configuration v1beta3 content type tool reference package kubeadm k8s io v1beta3 auto generated true h2 Overview h2 p Package v1beta3 defines the v1beta3 version of the kubeadm configuration file format This version improves on the v1beta2 format by fixing some minor issues and adding a few new fields p p A list of changes since v1beta2 p ul li The deprecated quot ClusterConfiguration useHyperKubeImage quot field has been removed Kubeadm no longer supports the hyperkube image li li The quot ClusterConfiguration dns type quot field has been removed since CoreDNS is the only supported DNS server type by kubeadm li li Include quot datapolicy quot tags on the fields that hold secrets This would result in the field values to be omitted when API structures are printed with klog li li Add quot InitConfiguration skipPhases quot quot JoinConfiguration skipPhases quot to allow skipping a list of phases during kubeadm init join command execution li li Add quot InitConfiguration nodeRegistration imagePullPolicy quot and quot JoinConfiguration nodeRegistration imagePullPolicy quot to allow specifying the images pull policy during kubeadm quot init quot and quot join quot The value must be one of quot Always quot quot Never quot or quot IfNotPresent quot quot IfNotPresent quot is the default which has been the existing behavior prior to this addition li li Add quot InitConfiguration patches directory quot quot JoinConfiguration patches directory quot to allow the user to configure a directory from which to take patches for components deployed by kubeadm li li Move the BootstrapToken API and related utilities out of the quot kubeadm quot API group to a new group quot bootstraptoken quot The kubeadm API version v1beta3 no longer contains the BootstrapToken structures li ul p Migration from old kubeadm config versions p 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 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 style background color fff span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta3 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 bbb span span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta3 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 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 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 bbb span span style color 000 font weight bold apiVersion span span style color bbb span kubeadm k8s io v1beta3 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 pre p To print the defaults for quot init quot and quot join quot actions use the following commands p pre style background color fff kubeadm config print init defaults kubeadm config print join 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 v1beta3 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 v1beta3 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 v1beta3 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 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 var run dockershim 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 v span span style color bbb span span style color 099 4 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 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 addon kube proxy 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 v1beta3 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 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 listen client urls span span style color bbb span span style color d14 34 http 10 100 0 1 2379 34 span 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 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 authorization mode 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 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 000 font weight bold timeoutForControlPlane span span style color bbb span 4m0s 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 34 node cidr mask size 34 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 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 bind address 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 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 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 code kubeadm join code with the code config code 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 v1beta3 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 bbb span pre p The JoinConfiguration type should be used to configure runtime settings that in case of code kubeadm join code 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 Resource Types ClusterConfiguration kubeadm k8s io v1beta3 ClusterConfiguration InitConfiguration kubeadm k8s io v1beta3 InitConfiguration JoinConfiguration kubeadm k8s io v1beta3 JoinConfiguration BootstrapToken BootstrapToken Appears in InitConfiguration kubeadm k8s io v1beta3 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 v1beta3 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 v1beta3 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 v1beta3 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 v1beta3 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 v1beta3 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 v1beta3 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 v1beta3 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 v1beta3 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 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 tbody table InitConfiguration kubeadm k8s io v1beta3 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 v1beta3 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 nodeRegistration code br a href kubeadm k8s io v1beta3 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 v1beta3 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 load balances 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 quot skip phases quot takes precedence over this field p td tr tr td code patches code br a href kubeadm k8s io v1beta3 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 tbody table JoinConfiguration kubeadm k8s io v1beta3 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 v1beta3 code td tr tr td code kind code br string td td code JoinConfiguration code td tr tr td code nodeRegistration code br a href kubeadm k8s io v1beta3 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 a node and the 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 v1beta3 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 v1beta3 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 v1beta3 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 tbody table APIEndpoint kubeadm k8s io v1beta3 APIEndpoint Appears in InitConfiguration kubeadm k8s io v1beta3 InitConfiguration JoinControlPlane kubeadm k8s io v1beta3 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 advertiseAddress 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 v1beta3 APIServer Appears in ClusterConfiguration kubeadm k8s io v1beta3 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 v1beta3 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 tr td code timeoutForControlPlane 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 timeoutForControlPlane code controls the timeout that we wait for API server to appear p td tr tbody table BootstrapTokenDiscovery kubeadm k8s io v1beta3 BootstrapTokenDiscovery Appears in Discovery kubeadm k8s io v1beta3 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 v1beta3 ControlPlaneComponent Appears in ClusterConfiguration kubeadm k8s io v1beta3 ClusterConfiguration APIServer kubeadm k8s io v1beta3 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 code map string string code td td p code extraArgs code is an extra set of flags to pass to the control plane component A key in this map is the flag name as it appears on the command line except without leading dash es p td tr tr td code extraVolumes code br a href kubeadm k8s io v1beta3 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 tbody table DNS kubeadm k8s io v1beta3 DNS Appears in ClusterConfiguration kubeadm k8s io v1beta3 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 v1beta3 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 component p td tr tbody table Discovery kubeadm k8s io v1beta3 Discovery Appears in JoinConfiguration kubeadm k8s io v1beta3 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 v1beta3 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 v1beta3 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 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 code timeout code modifies the discovery timeout p td tr tbody table Etcd kubeadm k8s io v1beta3 Etcd Appears in ClusterConfiguration kubeadm k8s io v1beta3 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 v1beta3 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 v1beta3 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 v1beta3 ExternalEtcd Appears in Etcd kubeadm k8s io v1beta3 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 v1beta3 FileDiscovery Appears in Discovery kubeadm k8s io v1beta3 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 v1beta3 HostPathMount Appears in ControlPlaneComponent kubeadm k8s io v1beta3 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 v1beta3 ImageMeta Appears in DNS kubeadm k8s io v1beta3 DNS LocalEtcd kubeadm k8s io v1beta3 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 v1beta3 JoinControlPlane Appears in JoinConfiguration kubeadm k8s io v1beta3 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 v1beta3 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 v1beta3 LocalEtcd Appears in Etcd kubeadm k8s io v1beta3 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 v1beta3 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 br code map string string code td td p code extraArgs code are extra arguments provided to the etcd binary when run inside a static Pod A key in this map is the flag name as it appears on the command line except without leading dash es 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 v1beta3 Networking Appears in ClusterConfiguration kubeadm k8s io v1beta3 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 v1beta3 NodeRegistrationOptions Appears in InitConfiguration kubeadm k8s io v1beta3 InitConfiguration JoinConfiguration kubeadm k8s io v1beta3 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 code map string string code 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 A key in this map is the flag name as it appears on the command line except without leading dash es 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 when the current node is registered e g code IsPrevilegedUser Swap code Value code all code 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 quot init quot and quot join quot operations The value of this field must be one of quot Always quot quot IfNotPresent quot or quot Never quot If this field is not set kubeadm will default it to quot IfNotPresent quot or pull the required images if not present on the host p td tr tbody table Patches kubeadm k8s io v1beta3 Patches Appears in InitConfiguration kubeadm k8s io v1beta3 InitConfiguration JoinConfiguration kubeadm k8s io v1beta3 JoinConfiguration 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 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 |
kubernetes reference title kube apiserver Audit Configuration v1 contenttype tool reference Resource Types package audit k8s io v1 autogenerated true | ---
title: kube-apiserver Audit Configuration (v1)
content_type: tool-reference
package: audit.k8s.io/v1
auto_generated: true
---
## Resource Types
- [Event](#audit-k8s-io-v1-Event)
- [EventList](#audit-k8s-io-v1-EventList)
- [Policy](#audit-k8s-io-v1-Policy)
- [PolicyList](#audit-k8s-io-v1-PolicyList)
## `Event` {#audit-k8s-io-v1-Event}
**Appears in:**
- [EventList](#audit-k8s-io-v1-EventList)
<p>Event captures all the information that can be included in an API audit log.</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>audit.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>Event</code></td></tr>
<tr><td><code>level</code> <B>[Required]</B><br/>
<a href="#audit-k8s-io-v1-Level"><code>Level</code></a>
</td>
<td>
<p>AuditLevel at which event was generated</p>
</td>
</tr>
<tr><td><code>auditID</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID"><code>k8s.io/apimachinery/pkg/types.UID</code></a>
</td>
<td>
<p>Unique audit ID, generated for each request.</p>
</td>
</tr>
<tr><td><code>stage</code> <B>[Required]</B><br/>
<a href="#audit-k8s-io-v1-Stage"><code>Stage</code></a>
</td>
<td>
<p>Stage of the request handling when this event instance was generated.</p>
</td>
</tr>
<tr><td><code>requestURI</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>RequestURI is the request URI as sent by the client to a server.</p>
</td>
</tr>
<tr><td><code>verb</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Verb is the kubernetes verb associated with the request.
For non-resource requests, this is the lower-cased HTTP method.</p>
</td>
</tr>
<tr><td><code>user</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
</td>
<td>
<p>Authenticated user information.</p>
</td>
</tr>
<tr><td><code>impersonatedUser</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
</td>
<td>
<p>Impersonated user information.</p>
</td>
</tr>
<tr><td><code>sourceIPs</code><br/>
<code>[]string</code>
</td>
<td>
<p>Source IPs, from where the request originated and intermediate proxies.
The source IPs are listed from (in order):</p>
<ol>
<li>X-Forwarded-For request header IPs</li>
<li>X-Real-Ip header, if not present in the X-Forwarded-For list</li>
<li>The remote address for the connection, if it doesn't match the last
IP in the list up to here (X-Forwarded-For or X-Real-Ip).
Note: All but the last IP can be arbitrarily set by the client.</li>
</ol>
</td>
</tr>
<tr><td><code>userAgent</code><br/>
<code>string</code>
</td>
<td>
<p>UserAgent records the user agent string reported by the client.
Note that the UserAgent is provided by the client, and must not be trusted.</p>
</td>
</tr>
<tr><td><code>objectRef</code><br/>
<a href="#audit-k8s-io-v1-ObjectReference"><code>ObjectReference</code></a>
</td>
<td>
<p>Object reference this request is targeted at.
Does not apply for List-type requests, or non-resource requests.</p>
</td>
</tr>
<tr><td><code>responseStatus</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#status-v1-meta"><code>meta/v1.Status</code></a>
</td>
<td>
<p>The response status, populated even when the ResponseObject is not a Status type.
For successful responses, this will only include the Code and StatusSuccess.
For non-status type error responses, this will be auto-populated with the error Message.</p>
</td>
</tr>
<tr><td><code>requestObject</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>API object from the request, in JSON format. The RequestObject is recorded as-is in the request
(possibly re-encoded as JSON), prior to version conversion, defaulting, admission or
merging. It is an external versioned object type, and may not be a valid object on its own.
Omitted for non-resource requests. Only logged at Request Level and higher.</p>
</td>
</tr>
<tr><td><code>responseObject</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>API object returned in the response, in JSON. The ResponseObject is recorded after conversion
to the external type, and serialized as JSON. Omitted for non-resource requests. Only logged
at Response Level.</p>
</td>
</tr>
<tr><td><code>requestReceivedTimestamp</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
</td>
<td>
<p>Time the request reached the apiserver.</p>
</td>
</tr>
<tr><td><code>stageTimestamp</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a>
</td>
<td>
<p>Time the request reached current audit stage.</p>
</td>
</tr>
<tr><td><code>annotations</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>Annotations is an unstructured key value map stored with an audit event that may be set by
plugins invoked in the request serving chain, including authentication, authorization and
admission plugins. Note that these annotations are for the audit event, and do not correspond
to the metadata.annotations of the submitted object. Keys should uniquely identify the informing
component to avoid name collisions (e.g. podsecuritypolicy.admission.k8s.io/policy). Values
should be short. Annotations are included in the Metadata level.</p>
</td>
</tr>
</tbody>
</table>
## `EventList` {#audit-k8s-io-v1-EventList}
<p>EventList is a list of audit Events.</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>audit.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>EventList</code></td></tr>
<tr><td><code>metadata</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>items</code> <B>[Required]</B><br/>
<a href="#audit-k8s-io-v1-Event"><code>[]Event</code></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `Policy` {#audit-k8s-io-v1-Policy}
**Appears in:**
- [PolicyList](#audit-k8s-io-v1-PolicyList)
<p>Policy defines the configuration of audit logging, and the rules for how different request
categories are logged.</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>audit.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>Policy</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>ObjectMeta is included for interoperability with API infrastructure.</p>
Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.</td>
</tr>
<tr><td><code>rules</code> <B>[Required]</B><br/>
<a href="#audit-k8s-io-v1-PolicyRule"><code>[]PolicyRule</code></a>
</td>
<td>
<p>Rules specify the audit Level a request should be recorded at.
A request may match multiple rules, in which case the FIRST matching rule is used.
The default audit level is None, but can be overridden by a catch-all rule at the end of the list.
PolicyRules are strictly ordered.</p>
</td>
</tr>
<tr><td><code>omitStages</code><br/>
<a href="#audit-k8s-io-v1-Stage"><code>[]Stage</code></a>
</td>
<td>
<p>OmitStages is a list of stages for which no events are created. Note that this can also
be specified per rule in which case the union of both are omitted.</p>
</td>
</tr>
<tr><td><code>omitManagedFields</code><br/>
<code>bool</code>
</td>
<td>
<p>OmitManagedFields indicates whether to omit the managed fields of the request
and response bodies from being written to the API audit log.
This is used as a global default - a value of 'true' will omit the managed fileds,
otherwise the managed fields will be included in the API audit log.
Note that this can also be specified per rule in which case the value specified
in a rule will override the global default.</p>
</td>
</tr>
</tbody>
</table>
## `PolicyList` {#audit-k8s-io-v1-PolicyList}
<p>PolicyList is a list of audit Policies.</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>audit.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>PolicyList</code></td></tr>
<tr><td><code>metadata</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>items</code> <B>[Required]</B><br/>
<a href="#audit-k8s-io-v1-Policy"><code>[]Policy</code></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `GroupResources` {#audit-k8s-io-v1-GroupResources}
**Appears in:**
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
<p>GroupResources represents resource kinds in an API group.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>group</code><br/>
<code>string</code>
</td>
<td>
<p>Group is the name of the API group that contains the resources.
The empty string represents the core API group.</p>
</td>
</tr>
<tr><td><code>resources</code><br/>
<code>[]string</code>
</td>
<td>
<p>Resources is a list of resources this rule applies to.</p>
<p>For example:</p>
<ul>
<li><code>pods</code> matches pods.</li>
<li><code>pods/log</code> matches the log subresource of pods.</li>
<li><code>*</code> matches all resources and their subresources.</li>
<li><code>pods/*</code> matches all subresources of pods.</li>
<li><code>*/scale</code> matches all scale subresources.</li>
</ul>
<p>If wildcard is present, the validation rule will ensure resources do not
overlap with each other.</p>
<p>An empty list implies all resources and subresources in this API groups apply.</p>
</td>
</tr>
<tr><td><code>resourceNames</code><br/>
<code>[]string</code>
</td>
<td>
<p>ResourceNames is a list of resource instance names that the policy matches.
Using this field requires Resources to be specified.
An empty list implies that every instance of the resource is matched.</p>
</td>
</tr>
</tbody>
</table>
## `Level` {#audit-k8s-io-v1-Level}
(Alias of `string`)
**Appears in:**
- [Event](#audit-k8s-io-v1-Event)
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
<p>Level defines the amount of information logged during auditing</p>
## `ObjectReference` {#audit-k8s-io-v1-ObjectReference}
**Appears in:**
- [Event](#audit-k8s-io-v1-Event)
<p>ObjectReference contains enough information to let you inspect or modify the referred object.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>resource</code><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>namespace</code><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>name</code><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>uid</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID"><code>k8s.io/apimachinery/pkg/types.UID</code></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>apiGroup</code><br/>
<code>string</code>
</td>
<td>
<p>APIGroup is the name of the API group that contains the referred object.
The empty string represents the core API group.</p>
</td>
</tr>
<tr><td><code>apiVersion</code><br/>
<code>string</code>
</td>
<td>
<p>APIVersion is the version of the API group that contains the referred object.</p>
</td>
</tr>
<tr><td><code>resourceVersion</code><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>subresource</code><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `PolicyRule` {#audit-k8s-io-v1-PolicyRule}
**Appears in:**
- [Policy](#audit-k8s-io-v1-Policy)
<p>PolicyRule maps requests based off metadata to an audit Level.
Requests must match the rules of every field (an intersection of rules).</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>level</code> <B>[Required]</B><br/>
<a href="#audit-k8s-io-v1-Level"><code>Level</code></a>
</td>
<td>
<p>The Level that requests matching this rule are recorded at.</p>
</td>
</tr>
<tr><td><code>users</code><br/>
<code>[]string</code>
</td>
<td>
<p>The users (by authenticated user name) this rule applies to.
An empty list implies every user.</p>
</td>
</tr>
<tr><td><code>userGroups</code><br/>
<code>[]string</code>
</td>
<td>
<p>The user groups this rule applies to. A user is considered matching
if it is a member of any of the UserGroups.
An empty list implies every user group.</p>
</td>
</tr>
<tr><td><code>verbs</code><br/>
<code>[]string</code>
</td>
<td>
<p>The verbs that match this rule.
An empty list implies every verb.</p>
</td>
</tr>
<tr><td><code>resources</code><br/>
<a href="#audit-k8s-io-v1-GroupResources"><code>[]GroupResources</code></a>
</td>
<td>
<p>Resources that this rule matches. An empty list implies all kinds in all API groups.</p>
</td>
</tr>
<tr><td><code>namespaces</code><br/>
<code>[]string</code>
</td>
<td>
<p>Namespaces that this rule matches.
The empty string "" matches non-namespaced resources.
An empty list implies every namespace.</p>
</td>
</tr>
<tr><td><code>nonResourceURLs</code><br/>
<code>[]string</code>
</td>
<td>
<p>NonResourceURLs is a set of URL paths that should be audited.
<code>*</code>s are allowed, but only as the full, final step in the path.
Examples:</p>
<ul>
<li><code>/metrics</code> - Log requests for apiserver metrics</li>
<li><code>/healthz*</code> - Log all health checks</li>
</ul>
</td>
</tr>
<tr><td><code>omitStages</code><br/>
<a href="#audit-k8s-io-v1-Stage"><code>[]Stage</code></a>
</td>
<td>
<p>OmitStages is a list of stages for which no events are created. Note that this can also
be specified policy wide in which case the union of both are omitted.
An empty list means no restrictions will apply.</p>
</td>
</tr>
<tr><td><code>omitManagedFields</code><br/>
<code>bool</code>
</td>
<td>
<p>OmitManagedFields indicates whether to omit the managed fields of the request
and response bodies from being written to the API audit log.</p>
<ul>
<li>a value of 'true' will drop the managed fields from the API audit log</li>
<li>a value of 'false' indicates that the managed fileds should be included
in the API audit log
Note that the value, if specified, in this rule will override the global default
If a value is not specified then the global default specified in
Policy.OmitManagedFields will stand.</li>
</ul>
</td>
</tr>
</tbody>
</table>
## `Stage` {#audit-k8s-io-v1-Stage}
(Alias of `string`)
**Appears in:**
- [Event](#audit-k8s-io-v1-Event)
- [Policy](#audit-k8s-io-v1-Policy)
- [PolicyRule](#audit-k8s-io-v1-PolicyRule)
<p>Stage defines the stages in request handling that audit events may be generated.</p>
| kubernetes reference | title kube apiserver Audit Configuration v1 content type tool reference package audit k8s io v1 auto generated true Resource Types Event audit k8s io v1 Event EventList audit k8s io v1 EventList Policy audit k8s io v1 Policy PolicyList audit k8s io v1 PolicyList Event audit k8s io v1 Event Appears in EventList audit k8s io v1 EventList p Event captures all the information that can be included in an API audit log 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 audit k8s io v1 code td tr tr td code kind code br string td td code Event code td tr tr td code level code B Required B br a href audit k8s io v1 Level code Level code a td td p AuditLevel at which event was generated p td tr tr td code auditID code B Required B br a href https pkg go dev k8s io apimachinery pkg types UID code k8s io apimachinery pkg types UID code a td td p Unique audit ID generated for each request p td tr tr td code stage code B Required B br a href audit k8s io v1 Stage code Stage code a td td p Stage of the request handling when this event instance was generated p td tr tr td code requestURI code B Required B br code string code td td p RequestURI is the request URI as sent by the client to a server p td tr tr td code verb code B Required B br code string code td td p Verb is the kubernetes verb associated with the request For non resource requests this is the lower cased HTTP method p td tr tr td code user code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 31 userinfo v1 authentication k8s io code authentication v1 UserInfo code a td td p Authenticated user information p td tr tr td code impersonatedUser code br a href https kubernetes io docs reference generated kubernetes api v1 31 userinfo v1 authentication k8s io code authentication v1 UserInfo code a td td p Impersonated user information p td tr tr td code sourceIPs code br code string code td td p Source IPs from where the request originated and intermediate proxies The source IPs are listed from in order p ol li X Forwarded For request header IPs li li X Real Ip header if not present in the X Forwarded For list li li The remote address for the connection if it doesn t match the last IP in the list up to here X Forwarded For or X Real Ip Note All but the last IP can be arbitrarily set by the client li ol td tr tr td code userAgent code br code string code td td p UserAgent records the user agent string reported by the client Note that the UserAgent is provided by the client and must not be trusted p td tr tr td code objectRef code br a href audit k8s io v1 ObjectReference code ObjectReference code a td td p Object reference this request is targeted at Does not apply for List type requests or non resource requests p td tr tr td code responseStatus code br a href https kubernetes io docs reference generated kubernetes api v1 31 status v1 meta code meta v1 Status code a td td p The response status populated even when the ResponseObject is not a Status type For successful responses this will only include the Code and StatusSuccess For non status type error responses this will be auto populated with the error Message p td tr tr td code requestObject 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 API object from the request in JSON format The RequestObject is recorded as is in the request possibly re encoded as JSON prior to version conversion defaulting admission or merging It is an external versioned object type and may not be a valid object on its own Omitted for non resource requests Only logged at Request Level and higher p td tr tr td code responseObject 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 API object returned in the response in JSON The ResponseObject is recorded after conversion to the external type and serialized as JSON Omitted for non resource requests Only logged at Response Level p td tr tr td code requestReceivedTimestamp code br a href https kubernetes io docs reference generated kubernetes api v1 31 microtime v1 meta code meta v1 MicroTime code a td td p Time the request reached the apiserver p td tr tr td code stageTimestamp code br a href https kubernetes io docs reference generated kubernetes api v1 31 microtime v1 meta code meta v1 MicroTime code a td td p Time the request reached current audit stage p td tr tr td code annotations code br code map string string code td td p Annotations is an unstructured key value map stored with an audit event that may be set by plugins invoked in the request serving chain including authentication authorization and admission plugins Note that these annotations are for the audit event and do not correspond to the metadata annotations of the submitted object Keys should uniquely identify the informing component to avoid name collisions e g podsecuritypolicy admission k8s io policy Values should be short Annotations are included in the Metadata level p td tr tbody table EventList audit k8s io v1 EventList p EventList is a list of audit Events 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 audit k8s io v1 code td tr tr td code kind code br string td td code EventList code td tr tr td code metadata code br a href https kubernetes io docs reference generated kubernetes api v1 31 listmeta v1 meta code meta v1 ListMeta code a td td span class text muted No description provided span td tr tr td code items code B Required B br a href audit k8s io v1 Event code Event code a td td span class text muted No description provided span td tr tbody table Policy audit k8s io v1 Policy Appears in PolicyList audit k8s io v1 PolicyList p Policy defines the configuration of audit logging and the rules for how different request categories are logged 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 audit k8s io v1 code td tr tr td code kind code br string td td code Policy 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 ObjectMeta is included for interoperability with API infrastructure p Refer to the Kubernetes API documentation for the fields of the code metadata code field td tr tr td code rules code B Required B br a href audit k8s io v1 PolicyRule code PolicyRule code a td td p Rules specify the audit Level a request should be recorded at A request may match multiple rules in which case the FIRST matching rule is used The default audit level is None but can be overridden by a catch all rule at the end of the list PolicyRules are strictly ordered p td tr tr td code omitStages code br a href audit k8s io v1 Stage code Stage code a td td p OmitStages is a list of stages for which no events are created Note that this can also be specified per rule in which case the union of both are omitted p td tr tr td code omitManagedFields code br code bool code td td p OmitManagedFields indicates whether to omit the managed fields of the request and response bodies from being written to the API audit log This is used as a global default a value of true will omit the managed fileds otherwise the managed fields will be included in the API audit log Note that this can also be specified per rule in which case the value specified in a rule will override the global default p td tr tbody table PolicyList audit k8s io v1 PolicyList p PolicyList is a list of audit Policies 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 audit k8s io v1 code td tr tr td code kind code br string td td code PolicyList code td tr tr td code metadata code br a href https kubernetes io docs reference generated kubernetes api v1 31 listmeta v1 meta code meta v1 ListMeta code a td td span class text muted No description provided span td tr tr td code items code B Required B br a href audit k8s io v1 Policy code Policy code a td td span class text muted No description provided span td tr tbody table GroupResources audit k8s io v1 GroupResources Appears in PolicyRule audit k8s io v1 PolicyRule p GroupResources represents resource kinds in an API group p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code group code br code string code td td p Group is the name of the API group that contains the resources The empty string represents the core API group p td tr tr td code resources code br code string code td td p Resources is a list of resources this rule applies to p p For example p ul li code pods code matches pods li li code pods log code matches the log subresource of pods li li code code matches all resources and their subresources li li code pods code matches all subresources of pods li li code scale code matches all scale subresources li ul p If wildcard is present the validation rule will ensure resources do not overlap with each other p p An empty list implies all resources and subresources in this API groups apply p td tr tr td code resourceNames code br code string code td td p ResourceNames is a list of resource instance names that the policy matches Using this field requires Resources to be specified An empty list implies that every instance of the resource is matched p td tr tbody table Level audit k8s io v1 Level Alias of string Appears in Event audit k8s io v1 Event PolicyRule audit k8s io v1 PolicyRule p Level defines the amount of information logged during auditing p ObjectReference audit k8s io v1 ObjectReference Appears in Event audit k8s io v1 Event p ObjectReference contains enough information to let you inspect or modify the referred object p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code resource code br code string code td td span class text muted No description provided span td tr tr td code namespace code br code string code td td span class text muted No description provided span td tr tr td code name code br code string code td td span class text muted No description provided span td tr tr td code uid code br a href https pkg go dev k8s io apimachinery pkg types UID code k8s io apimachinery pkg types UID code a td td span class text muted No description provided span td tr tr td code apiGroup code br code string code td td p APIGroup is the name of the API group that contains the referred object The empty string represents the core API group p td tr tr td code apiVersion code br code string code td td p APIVersion is the version of the API group that contains the referred object p td tr tr td code resourceVersion code br code string code td td span class text muted No description provided span td tr tr td code subresource code br code string code td td span class text muted No description provided span td tr tbody table PolicyRule audit k8s io v1 PolicyRule Appears in Policy audit k8s io v1 Policy p PolicyRule maps requests based off metadata to an audit Level Requests must match the rules of every field an intersection of rules p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code level code B Required B br a href audit k8s io v1 Level code Level code a td td p The Level that requests matching this rule are recorded at p td tr tr td code users code br code string code td td p The users by authenticated user name this rule applies to An empty list implies every user p td tr tr td code userGroups code br code string code td td p The user groups this rule applies to A user is considered matching if it is a member of any of the UserGroups An empty list implies every user group p td tr tr td code verbs code br code string code td td p The verbs that match this rule An empty list implies every verb p td tr tr td code resources code br a href audit k8s io v1 GroupResources code GroupResources code a td td p Resources that this rule matches An empty list implies all kinds in all API groups p td tr tr td code namespaces code br code string code td td p Namespaces that this rule matches The empty string quot quot matches non namespaced resources An empty list implies every namespace p td tr tr td code nonResourceURLs code br code string code td td p NonResourceURLs is a set of URL paths that should be audited code code s are allowed but only as the full final step in the path Examples p ul li code metrics code Log requests for apiserver metrics li li code healthz code Log all health checks li ul td tr tr td code omitStages code br a href audit k8s io v1 Stage code Stage code a td td p OmitStages is a list of stages for which no events are created Note that this can also be specified policy wide in which case the union of both are omitted An empty list means no restrictions will apply p td tr tr td code omitManagedFields code br code bool code td td p OmitManagedFields indicates whether to omit the managed fields of the request and response bodies from being written to the API audit log p ul li a value of true will drop the managed fields from the API audit log li li a value of false indicates that the managed fileds should be included in the API audit log Note that the value if specified in this rule will override the global default If a value is not specified then the global default specified in Policy OmitManagedFields will stand li ul td tr tbody table Stage audit k8s io v1 Stage Alias of string Appears in Event audit k8s io v1 Event Policy audit k8s io v1 Policy PolicyRule audit k8s io v1 PolicyRule p Stage defines the stages in request handling that audit events may be generated p |
kubernetes reference contenttype tool reference Resource Types title Client Authentication v1beta1 package client authentication k8s io v1beta1 autogenerated true | ---
title: Client Authentication (v1beta1)
content_type: tool-reference
package: client.authentication.k8s.io/v1beta1
auto_generated: true
---
## Resource Types
- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential)
## `ExecCredential` {#client-authentication-k8s-io-v1beta1-ExecCredential}
<p>ExecCredential is used by exec-based plugins to communicate credentials to
HTTP transports.</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>client.authentication.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>ExecCredential</code></td></tr>
<tr><td><code>spec</code> <B>[Required]</B><br/>
<a href="#client-authentication-k8s-io-v1beta1-ExecCredentialSpec"><code>ExecCredentialSpec</code></a>
</td>
<td>
<p>Spec holds information passed to the plugin by the transport.</p>
</td>
</tr>
<tr><td><code>status</code><br/>
<a href="#client-authentication-k8s-io-v1beta1-ExecCredentialStatus"><code>ExecCredentialStatus</code></a>
</td>
<td>
<p>Status is filled in by the plugin and holds the credentials that the transport
should use to contact the API.</p>
</td>
</tr>
</tbody>
</table>
## `Cluster` {#client-authentication-k8s-io-v1beta1-Cluster}
**Appears in:**
- [ExecCredentialSpec](#client-authentication-k8s-io-v1beta1-ExecCredentialSpec)
<p>Cluster contains information to allow an exec plugin to communicate
with the kubernetes cluster being authenticated to.</p>
<p>To ensure that this struct contains everything someone would need to communicate
with a kubernetes cluster (just like they would via a kubeconfig), the fields
should shadow "k8s.io/client-go/tools/clientcmd/api/v1".Cluster, with the exception
of CertificateAuthority, since CA data will always be passed to the plugin as bytes.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>server</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Server is the address of the kubernetes cluster (https://hostname:port).</p>
</td>
</tr>
<tr><td><code>tls-server-name</code><br/>
<code>string</code>
</td>
<td>
<p>TLSServerName is passed to the server for SNI and is used in the client to
check server certificates against. If ServerName is empty, the hostname
used to contact the server is used.</p>
</td>
</tr>
<tr><td><code>insecure-skip-tls-verify</code><br/>
<code>bool</code>
</td>
<td>
<p>InsecureSkipTLSVerify skips the validity check for the server's certificate.
This will make your HTTPS connections insecure.</p>
</td>
</tr>
<tr><td><code>certificate-authority-data</code><br/>
<code>[]byte</code>
</td>
<td>
<p>CAData contains PEM-encoded certificate authority certificates.
If empty, system roots should be used.</p>
</td>
</tr>
<tr><td><code>proxy-url</code><br/>
<code>string</code>
</td>
<td>
<p>ProxyURL is the URL to the proxy to be used for all requests to this
cluster.</p>
</td>
</tr>
<tr><td><code>disable-compression</code><br/>
<code>bool</code>
</td>
<td>
<p>DisableCompression allows client to opt-out of response compression for all requests to the server. This is useful
to speed up requests (specifically lists) when client-server network bandwidth is ample, by saving time on
compression (server-side) and decompression (client-side): https://github.com/kubernetes/kubernetes/issues/112296.</p>
</td>
</tr>
<tr><td><code>config</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
</td>
<td>
<p>Config holds additional config data that is specific to the exec
plugin with regards to the cluster being authenticated to.</p>
<p>This data is sourced from the clientcmd Cluster object's
extensions[client.authentication.k8s.io/exec] field:</p>
<p>clusters:</p>
<ul>
<li>name: my-cluster
cluster:
...
extensions:
<ul>
<li>name: client.authentication.k8s.io/exec # reserved extension name for per cluster exec config
extension:
audience: 06e3fbd18de8 # arbitrary config</li>
</ul>
</li>
</ul>
<p>In some environments, the user config may be exactly the same across many clusters
(i.e. call this exec plugin) minus some details that are specific to each cluster
such as the audience. This field allows the per cluster config to be directly
specified with the cluster info. Using this field to store secret data is not
recommended as one of the prime benefits of exec plugins is that no secrets need
to be stored directly in the kubeconfig.</p>
</td>
</tr>
</tbody>
</table>
## `ExecCredentialSpec` {#client-authentication-k8s-io-v1beta1-ExecCredentialSpec}
**Appears in:**
- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential)
<p>ExecCredentialSpec holds request and runtime specific information provided by
the transport.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>cluster</code><br/>
<a href="#client-authentication-k8s-io-v1beta1-Cluster"><code>Cluster</code></a>
</td>
<td>
<p>Cluster contains information to allow an exec plugin to communicate with the
kubernetes cluster being authenticated to. Note that Cluster is non-nil only
when provideClusterInfo is set to true in the exec provider config (i.e.,
ExecConfig.ProvideClusterInfo).</p>
</td>
</tr>
<tr><td><code>interactive</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>Interactive declares whether stdin has been passed to this exec plugin.</p>
</td>
</tr>
</tbody>
</table>
## `ExecCredentialStatus` {#client-authentication-k8s-io-v1beta1-ExecCredentialStatus}
**Appears in:**
- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential)
<p>ExecCredentialStatus holds credentials for the transport to use.</p>
<p>Token and ClientKeyData are sensitive fields. This data should only be
transmitted in-memory between client and exec plugin process. Exec plugin
itself should at least be protected via file permissions.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>expirationTimestamp</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>ExpirationTimestamp indicates a time when the provided credentials expire.</p>
</td>
</tr>
<tr><td><code>token</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Token is a bearer token used by the client for request authentication.</p>
</td>
</tr>
<tr><td><code>clientCertificateData</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>PEM-encoded client TLS certificates (including intermediates, if any).</p>
</td>
</tr>
<tr><td><code>clientKeyData</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>PEM-encoded private key for the above certificate.</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title Client Authentication v1beta1 content type tool reference package client authentication k8s io v1beta1 auto generated true Resource Types ExecCredential client authentication k8s io v1beta1 ExecCredential ExecCredential client authentication k8s io v1beta1 ExecCredential p ExecCredential is used by exec based plugins to communicate credentials to HTTP transports 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 client authentication k8s io v1beta1 code td tr tr td code kind code br string td td code ExecCredential code td tr tr td code spec code B Required B br a href client authentication k8s io v1beta1 ExecCredentialSpec code ExecCredentialSpec code a td td p Spec holds information passed to the plugin by the transport p td tr tr td code status code br a href client authentication k8s io v1beta1 ExecCredentialStatus code ExecCredentialStatus code a td td p Status is filled in by the plugin and holds the credentials that the transport should use to contact the API p td tr tbody table Cluster client authentication k8s io v1beta1 Cluster Appears in ExecCredentialSpec client authentication k8s io v1beta1 ExecCredentialSpec p Cluster contains information to allow an exec plugin to communicate with the kubernetes cluster being authenticated to p p To ensure that this struct contains everything someone would need to communicate with a kubernetes cluster just like they would via a kubeconfig the fields should shadow quot k8s io client go tools clientcmd api v1 quot Cluster with the exception of CertificateAuthority since CA data will always be passed to the plugin as bytes p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code server code B Required B br code string code td td p Server is the address of the kubernetes cluster https hostname port p td tr tr td code tls server name code br code string code td td p TLSServerName is passed to the server for SNI and is used in the client to check server certificates against If ServerName is empty the hostname used to contact the server is used p td tr tr td code insecure skip tls verify code br code bool code td td p InsecureSkipTLSVerify skips the validity check for the server s certificate This will make your HTTPS connections insecure p td tr tr td code certificate authority data code br code byte code td td p CAData contains PEM encoded certificate authority certificates If empty system roots should be used p td tr tr td code proxy url code br code string code td td p ProxyURL is the URL to the proxy to be used for all requests to this cluster p td tr tr td code disable compression code br code bool code td td p DisableCompression allows client to opt out of response compression for all requests to the server This is useful to speed up requests specifically lists when client server network bandwidth is ample by saving time on compression server side and decompression client side https github com kubernetes kubernetes issues 112296 p td tr tr td code config code br a href https pkg go dev k8s io apimachinery pkg runtime RawExtension code k8s io apimachinery pkg runtime RawExtension code a td td p Config holds additional config data that is specific to the exec plugin with regards to the cluster being authenticated to p p This data is sourced from the clientcmd Cluster object s extensions client authentication k8s io exec field p p clusters p ul li name my cluster cluster extensions ul li name client authentication k8s io exec reserved extension name for per cluster exec config extension audience 06e3fbd18de8 arbitrary config li ul li ul p In some environments the user config may be exactly the same across many clusters i e call this exec plugin minus some details that are specific to each cluster such as the audience This field allows the per cluster config to be directly specified with the cluster info Using this field to store secret data is not recommended as one of the prime benefits of exec plugins is that no secrets need to be stored directly in the kubeconfig p td tr tbody table ExecCredentialSpec client authentication k8s io v1beta1 ExecCredentialSpec Appears in ExecCredential client authentication k8s io v1beta1 ExecCredential p ExecCredentialSpec holds request and runtime specific information provided by the transport p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code cluster code br a href client authentication k8s io v1beta1 Cluster code Cluster code a td td p Cluster contains information to allow an exec plugin to communicate with the kubernetes cluster being authenticated to Note that Cluster is non nil only when provideClusterInfo is set to true in the exec provider config i e ExecConfig ProvideClusterInfo p td tr tr td code interactive code B Required B br code bool code td td p Interactive declares whether stdin has been passed to this exec plugin p td tr tbody table ExecCredentialStatus client authentication k8s io v1beta1 ExecCredentialStatus Appears in ExecCredential client authentication k8s io v1beta1 ExecCredential p ExecCredentialStatus holds credentials for the transport to use p p Token and ClientKeyData are sensitive fields This data should only be transmitted in memory between client and exec plugin process Exec plugin itself should at least be protected via file permissions p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code expirationTimestamp 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 ExpirationTimestamp indicates a time when the provided credentials expire p td tr tr td code token code B Required B br code string code td td p Token is a bearer token used by the client for request authentication p td tr tr td code clientCertificateData code B Required B br code string code td td p PEM encoded client TLS certificates including intermediates if any p td tr tr td code clientKeyData code B Required B br code string code td td p PEM encoded private key for the above certificate p td tr tbody table |
kubernetes reference contenttype tool reference Resource Types title Kubelet Configuration v1beta1 package kubelet config k8s io v1beta1 autogenerated true | ---
title: Kubelet Configuration (v1beta1)
content_type: tool-reference
package: kubelet.config.k8s.io/v1beta1
auto_generated: true
---
## Resource Types
- [CredentialProviderConfig](#kubelet-config-k8s-io-v1beta1-CredentialProviderConfig)
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
- [SerializedNodeConfigSource](#kubelet-config-k8s-io-v1beta1-SerializedNodeConfigSource)
## `FormatOptions` {#FormatOptions}
**Appears in:**
- [LoggingConfiguration](#LoggingConfiguration)
<p>FormatOptions contains options for the different logging formats.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>text</code> <B>[Required]</B><br/>
<a href="#TextOptions"><code>TextOptions</code></a>
</td>
<td>
<p>[Alpha] Text contains options for logging format "text".
Only available when the LoggingAlphaOptions feature gate is enabled.</p>
</td>
</tr>
<tr><td><code>json</code> <B>[Required]</B><br/>
<a href="#JSONOptions"><code>JSONOptions</code></a>
</td>
<td>
<p>[Alpha] JSON contains options for logging format "json".
Only available when the LoggingAlphaOptions feature gate is enabled.</p>
</td>
</tr>
</tbody>
</table>
## `JSONOptions` {#JSONOptions}
**Appears in:**
- [FormatOptions](#FormatOptions)
<p>JSONOptions contains options for logging format "json".</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>OutputRoutingOptions</code> <B>[Required]</B><br/>
<a href="#OutputRoutingOptions"><code>OutputRoutingOptions</code></a>
</td>
<td>(Members of <code>OutputRoutingOptions</code> are embedded into this type.)
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `LogFormatFactory` {#LogFormatFactory}
<p>LogFormatFactory provides support for a certain additional,
non-default log format.</p>
## `LoggingConfiguration` {#LoggingConfiguration}
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
<p>LoggingConfiguration contains logging options.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>format</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Format Flag specifies the structure of log messages.
default value of format is <code>text</code></p>
</td>
</tr>
<tr><td><code>flushFrequency</code> <B>[Required]</B><br/>
<a href="#TimeOrMetaDuration"><code>TimeOrMetaDuration</code></a>
</td>
<td>
<p>Maximum time between log flushes.
If a string, parsed as a duration (i.e. "1s")
If an int, the maximum number of nanoseconds (i.e. 1s = 1000000000).
Ignored if the selected logging backend writes log messages without buffering.</p>
</td>
</tr>
<tr><td><code>verbosity</code> <B>[Required]</B><br/>
<a href="#VerbosityLevel"><code>VerbosityLevel</code></a>
</td>
<td>
<p>Verbosity is the threshold that determines which log messages are
logged. Default is zero which logs only the most important
messages. Higher values enable additional messages. Error messages
are always logged.</p>
</td>
</tr>
<tr><td><code>vmodule</code> <B>[Required]</B><br/>
<a href="#VModuleConfiguration"><code>VModuleConfiguration</code></a>
</td>
<td>
<p>VModule overrides the verbosity threshold for individual files.
Only supported for "text" log format.</p>
</td>
</tr>
<tr><td><code>options</code> <B>[Required]</B><br/>
<a href="#FormatOptions"><code>FormatOptions</code></a>
</td>
<td>
<p>[Alpha] Options holds additional parameters that are specific
to the different logging formats. Only the options for the selected
format get used, but all of them get validated.
Only available when the LoggingAlphaOptions feature gate is enabled.</p>
</td>
</tr>
</tbody>
</table>
## `LoggingOptions` {#LoggingOptions}
<p>LoggingOptions can be used with ValidateAndApplyWithOptions to override
certain global defaults.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ErrorStream</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/io#Writer"><code>io.Writer</code></a>
</td>
<td>
<p>ErrorStream can be used to override the os.Stderr default.</p>
</td>
</tr>
<tr><td><code>InfoStream</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/io#Writer"><code>io.Writer</code></a>
</td>
<td>
<p>InfoStream can be used to override the os.Stdout default.</p>
</td>
</tr>
</tbody>
</table>
## `OutputRoutingOptions` {#OutputRoutingOptions}
**Appears in:**
- [JSONOptions](#JSONOptions)
- [TextOptions](#TextOptions)
<p>OutputRoutingOptions contains options that are supported by both "text" and "json".</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>splitStream</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>[Alpha] SplitStream redirects error messages to stderr while
info messages go to stdout, with buffering. The default is to write
both to stdout, without buffering. Only available when
the LoggingAlphaOptions feature gate is enabled.</p>
</td>
</tr>
<tr><td><code>infoBufferSize</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#QuantityValue"><code>k8s.io/apimachinery/pkg/api/resource.QuantityValue</code></a>
</td>
<td>
<p>[Alpha] InfoBufferSize sets the size of the info stream when
using split streams. The default is zero, which disables buffering.
Only available when the LoggingAlphaOptions feature gate is enabled.</p>
</td>
</tr>
</tbody>
</table>
## `TextOptions` {#TextOptions}
**Appears in:**
- [FormatOptions](#FormatOptions)
<p>TextOptions contains options for logging format "text".</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>OutputRoutingOptions</code> <B>[Required]</B><br/>
<a href="#OutputRoutingOptions"><code>OutputRoutingOptions</code></a>
</td>
<td>(Members of <code>OutputRoutingOptions</code> are embedded into this type.)
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `TimeOrMetaDuration` {#TimeOrMetaDuration}
**Appears in:**
- [LoggingConfiguration](#LoggingConfiguration)
<p>TimeOrMetaDuration is present only for backwards compatibility for the
flushFrequency field, and new fields should use metav1.Duration.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>Duration</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>Duration holds the duration</p>
</td>
</tr>
<tr><td><code>-</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>SerializeAsString controls whether the value is serialized as a string or an integer</p>
</td>
</tr>
</tbody>
</table>
## `TracingConfiguration` {#TracingConfiguration}
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
<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>
## `VModuleConfiguration` {#VModuleConfiguration}
(Alias of `[]k8s.io/component-base/logs/api/v1.VModuleItem`)
**Appears in:**
- [LoggingConfiguration](#LoggingConfiguration)
<p>VModuleConfiguration is a collection of individual file names or patterns
and the corresponding verbosity threshold.</p>
## `VerbosityLevel` {#VerbosityLevel}
(Alias of `uint32`)
**Appears in:**
- [LoggingConfiguration](#LoggingConfiguration)
<p>VerbosityLevel represents a klog or logr verbosity threshold.</p>
## `CredentialProviderConfig` {#kubelet-config-k8s-io-v1beta1-CredentialProviderConfig}
<p>CredentialProviderConfig is the configuration containing information about
each exec credential provider. Kubelet reads this configuration from disk and enables
each provider as specified by the CredentialProvider type.</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>kubelet.config.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>CredentialProviderConfig</code></td></tr>
<tr><td><code>providers</code> <B>[Required]</B><br/>
<a href="#kubelet-config-k8s-io-v1beta1-CredentialProvider"><code>[]CredentialProvider</code></a>
</td>
<td>
<p>providers is a list of credential provider plugins that will be enabled by the kubelet.
Multiple providers may match against a single image, in which case credentials
from all providers will be returned to the kubelet. If multiple providers are called
for a single image, the results are combined. If providers return overlapping
auth keys, the value from the provider earlier in this list is used.</p>
</td>
</tr>
</tbody>
</table>
## `KubeletConfiguration` {#kubelet-config-k8s-io-v1beta1-KubeletConfiguration}
<p>KubeletConfiguration contains the configuration for the Kubelet</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>kubelet.config.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>KubeletConfiguration</code></td></tr>
<tr><td><code>enableServer</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enableServer enables Kubelet's secured server.
Note: Kubelet's insecure port is controlled by the readOnlyPort option.
Default: true</p>
</td>
</tr>
<tr><td><code>staticPodPath</code><br/>
<code>string</code>
</td>
<td>
<p>staticPodPath is the path to the directory containing local (static) pods to
run, or the path to a single static pod file.
Default: ""</p>
</td>
</tr>
<tr><td><code>podLogsDir</code><br/>
<code>string</code>
</td>
<td>
<p>podLogsDir is a custom root directory path kubelet will use to place pod's log files.
Default: "/var/log/pods/"
Note: it is not recommended to use the temp folder as a log directory as it may cause
unexpected behavior in many places.</p>
</td>
</tr>
<tr><td><code>syncFrequency</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>syncFrequency is the max period between synchronizing running
containers and config.
Default: "1m"</p>
</td>
</tr>
<tr><td><code>fileCheckFrequency</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>fileCheckFrequency is the duration between checking config files for
new data.
Default: "20s"</p>
</td>
</tr>
<tr><td><code>httpCheckFrequency</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>httpCheckFrequency is the duration between checking http for new data.
Default: "20s"</p>
</td>
</tr>
<tr><td><code>staticPodURL</code><br/>
<code>string</code>
</td>
<td>
<p>staticPodURL is the URL for accessing static pods to run.
Default: ""</p>
</td>
</tr>
<tr><td><code>staticPodURLHeader</code><br/>
<code>map[string][]string</code>
</td>
<td>
<p>staticPodURLHeader is a map of slices with HTTP headers to use when accessing the podURL.
Default: nil</p>
</td>
</tr>
<tr><td><code>address</code><br/>
<code>string</code>
</td>
<td>
<p>address is the IP address for the Kubelet to serve on (set to 0.0.0.0
for all interfaces).
Default: "0.0.0.0"</p>
</td>
</tr>
<tr><td><code>port</code><br/>
<code>int32</code>
</td>
<td>
<p>port is the port for the Kubelet to serve on.
The port number must be between 1 and 65535, inclusive.
Default: 10250</p>
</td>
</tr>
<tr><td><code>readOnlyPort</code><br/>
<code>int32</code>
</td>
<td>
<p>readOnlyPort is the read-only port for the Kubelet to serve on with
no authentication/authorization.
The port number must be between 1 and 65535, inclusive.
Setting this field to 0 disables the read-only service.
Default: 0 (disabled)</p>
</td>
</tr>
<tr><td><code>tlsCertFile</code><br/>
<code>string</code>
</td>
<td>
<p>tlsCertFile is the file containing x509 Certificate for HTTPS. (CA cert,
if any, concatenated after server cert). If tlsCertFile and
tlsPrivateKeyFile are not provided, a self-signed certificate
and key are generated for the public address and saved to the directory
passed to the Kubelet's --cert-dir flag.
Default: ""</p>
</td>
</tr>
<tr><td><code>tlsPrivateKeyFile</code><br/>
<code>string</code>
</td>
<td>
<p>tlsPrivateKeyFile is the file containing x509 private key matching tlsCertFile.
Default: ""</p>
</td>
</tr>
<tr><td><code>tlsCipherSuites</code><br/>
<code>[]string</code>
</td>
<td>
<p>tlsCipherSuites is the list of allowed cipher suites for the server.
Note that TLS 1.3 ciphersuites are not configurable.
Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
Default: nil</p>
</td>
</tr>
<tr><td><code>tlsMinVersion</code><br/>
<code>string</code>
</td>
<td>
<p>tlsMinVersion is the minimum TLS version supported.
Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
Default: ""</p>
</td>
</tr>
<tr><td><code>rotateCertificates</code><br/>
<code>bool</code>
</td>
<td>
<p>rotateCertificates enables client certificate rotation. The Kubelet will request a
new certificate from the certificates.k8s.io API. This requires an approver to approve the
certificate signing requests.
Default: false</p>
</td>
</tr>
<tr><td><code>serverTLSBootstrap</code><br/>
<code>bool</code>
</td>
<td>
<p>serverTLSBootstrap enables server certificate bootstrap. Instead of self
signing a serving certificate, the Kubelet will request a certificate from
the 'certificates.k8s.io' API. This requires an approver to approve the
certificate signing requests (CSR). The RotateKubeletServerCertificate feature
must be enabled when setting this field.
Default: false</p>
</td>
</tr>
<tr><td><code>authentication</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-KubeletAuthentication"><code>KubeletAuthentication</code></a>
</td>
<td>
<p>authentication specifies how requests to the Kubelet's server are authenticated.
Defaults:
anonymous:
enabled: false
webhook:
enabled: true
cacheTTL: "2m"</p>
</td>
</tr>
<tr><td><code>authorization</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-KubeletAuthorization"><code>KubeletAuthorization</code></a>
</td>
<td>
<p>authorization specifies how requests to the Kubelet's server are authorized.
Defaults:
mode: Webhook
webhook:
cacheAuthorizedTTL: "5m"
cacheUnauthorizedTTL: "30s"</p>
</td>
</tr>
<tr><td><code>registryPullQPS</code><br/>
<code>int32</code>
</td>
<td>
<p>registryPullQPS is the limit of registry pulls per second.
The value must not be a negative number.
Setting it to 0 means no limit.
Default: 5</p>
</td>
</tr>
<tr><td><code>registryBurst</code><br/>
<code>int32</code>
</td>
<td>
<p>registryBurst is the maximum size of bursty pulls, temporarily allows
pulls to burst to this number, while still not exceeding registryPullQPS.
The value must not be a negative number.
Only used if registryPullQPS is greater than 0.
Default: 10</p>
</td>
</tr>
<tr><td><code>eventRecordQPS</code><br/>
<code>int32</code>
</td>
<td>
<p>eventRecordQPS is the maximum event creations per second. If 0, there
is no limit enforced. The value cannot be a negative number.
Default: 50</p>
</td>
</tr>
<tr><td><code>eventBurst</code><br/>
<code>int32</code>
</td>
<td>
<p>eventBurst is the maximum size of a burst of event creations, temporarily
allows event creations to burst to this number, while still not exceeding
eventRecordQPS. This field canot be a negative number and it is only used
when eventRecordQPS > 0.
Default: 100</p>
</td>
</tr>
<tr><td><code>enableDebuggingHandlers</code><br/>
<code>bool</code>
</td>
<td>
<p>enableDebuggingHandlers enables server endpoints for log access
and local running of containers and commands, including the exec,
attach, logs, and portforward features.
Default: true</p>
</td>
</tr>
<tr><td><code>enableContentionProfiling</code><br/>
<code>bool</code>
</td>
<td>
<p>enableContentionProfiling enables block profiling, if enableDebuggingHandlers is true.
Default: false</p>
</td>
</tr>
<tr><td><code>healthzPort</code><br/>
<code>int32</code>
</td>
<td>
<p>healthzPort is the port of the localhost healthz endpoint (set to 0 to disable).
A valid number is between 1 and 65535.
Default: 10248</p>
</td>
</tr>
<tr><td><code>healthzBindAddress</code><br/>
<code>string</code>
</td>
<td>
<p>healthzBindAddress is the IP address for the healthz server to serve on.
Default: "127.0.0.1"</p>
</td>
</tr>
<tr><td><code>oomScoreAdj</code><br/>
<code>int32</code>
</td>
<td>
<p>oomScoreAdj is The oom-score-adj value for kubelet process. Values
must be within the range [-1000, 1000].
Default: -999</p>
</td>
</tr>
<tr><td><code>clusterDomain</code><br/>
<code>string</code>
</td>
<td>
<p>clusterDomain is the DNS domain for this cluster. If set, kubelet will
configure all containers to search this domain in addition to the
host's search domains.
Default: ""</p>
</td>
</tr>
<tr><td><code>clusterDNS</code><br/>
<code>[]string</code>
</td>
<td>
<p>clusterDNS is a list of IP addresses for the cluster DNS server. If set,
kubelet will configure all containers to use this for DNS resolution
instead of the host's DNS servers.
Default: nil</p>
</td>
</tr>
<tr><td><code>streamingConnectionIdleTimeout</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>streamingConnectionIdleTimeout is the maximum time a streaming connection
can be idle before the connection is automatically closed.
Default: "4h"</p>
</td>
</tr>
<tr><td><code>nodeStatusUpdateFrequency</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>nodeStatusUpdateFrequency is the frequency that kubelet computes node
status. If node lease feature is not enabled, it is also the frequency that
kubelet posts node status to master.
Note: When node lease feature is not enabled, be cautious when changing the
constant, it must work with nodeMonitorGracePeriod in nodecontroller.
Default: "10s"</p>
</td>
</tr>
<tr><td><code>nodeStatusReportFrequency</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>nodeStatusReportFrequency is the frequency that kubelet posts node
status to master if node status does not change. Kubelet will ignore this
frequency and post node status immediately if any change is detected. It is
only used when node lease feature is enabled. nodeStatusReportFrequency's
default value is 5m. But if nodeStatusUpdateFrequency is set explicitly,
nodeStatusReportFrequency's default value will be set to
nodeStatusUpdateFrequency for backward compatibility.
Default: "5m"</p>
</td>
</tr>
<tr><td><code>nodeLeaseDurationSeconds</code><br/>
<code>int32</code>
</td>
<td>
<p>nodeLeaseDurationSeconds is the duration the Kubelet will set on its corresponding Lease.
NodeLease provides an indicator of node health by having the Kubelet create and
periodically renew a lease, named after the node, in the kube-node-lease namespace.
If the lease expires, the node can be considered unhealthy.
The lease is currently renewed every 10s, per KEP-0009. In the future, the lease renewal
interval may be set based on the lease duration.
The field value must be greater than 0.
Default: 40</p>
</td>
</tr>
<tr><td><code>imageMinimumGCAge</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>imageMinimumGCAge is the minimum age for an unused image before it is
garbage collected.
Default: "2m"</p>
</td>
</tr>
<tr><td><code>imageMaximumGCAge</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>imageMaximumGCAge is the maximum age an image can be unused before it is garbage collected.
The default of this field is "0s", which disables this field--meaning images won't be garbage
collected based on being unused for too long.
Default: "0s" (disabled)</p>
</td>
</tr>
<tr><td><code>imageGCHighThresholdPercent</code><br/>
<code>int32</code>
</td>
<td>
<p>imageGCHighThresholdPercent is the percent of disk usage after which
image garbage collection is always run. The percent is calculated by
dividing this field value by 100, so this field must be between 0 and
100, inclusive. When specified, the value must be greater than
imageGCLowThresholdPercent.
Default: 85</p>
</td>
</tr>
<tr><td><code>imageGCLowThresholdPercent</code><br/>
<code>int32</code>
</td>
<td>
<p>imageGCLowThresholdPercent is the percent of disk usage before which
image garbage collection is never run. Lowest disk usage to garbage
collect to. The percent is calculated by dividing this field value by 100,
so the field value must be between 0 and 100, inclusive. When specified, the
value must be less than imageGCHighThresholdPercent.
Default: 80</p>
</td>
</tr>
<tr><td><code>volumeStatsAggPeriod</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>volumeStatsAggPeriod is the frequency for calculating and caching volume
disk usage for all pods.
Default: "1m"</p>
</td>
</tr>
<tr><td><code>kubeletCgroups</code><br/>
<code>string</code>
</td>
<td>
<p>kubeletCgroups is the absolute name of cgroups to isolate the kubelet in
Default: ""</p>
</td>
</tr>
<tr><td><code>systemCgroups</code><br/>
<code>string</code>
</td>
<td>
<p>systemCgroups is absolute name of cgroups in which to place
all non-kernel processes that are not already in a container. Empty
for no container. Rolling back the flag requires a reboot.
The cgroupRoot must be specified if this field is not empty.
Default: ""</p>
</td>
</tr>
<tr><td><code>cgroupRoot</code><br/>
<code>string</code>
</td>
<td>
<p>cgroupRoot is the root cgroup to use for pods. This is handled by the
container runtime on a best effort basis.</p>
</td>
</tr>
<tr><td><code>cgroupsPerQOS</code><br/>
<code>bool</code>
</td>
<td>
<p>cgroupsPerQOS enable QoS based CGroup hierarchy: top level CGroups for QoS classes
and all Burstable and BestEffort Pods are brought up under their specific top level
QoS CGroup.
Default: true</p>
</td>
</tr>
<tr><td><code>cgroupDriver</code><br/>
<code>string</code>
</td>
<td>
<p>cgroupDriver is the driver kubelet uses to manipulate CGroups on the host (cgroupfs
or systemd).
Default: "cgroupfs"</p>
</td>
</tr>
<tr><td><code>cpuManagerPolicy</code><br/>
<code>string</code>
</td>
<td>
<p>cpuManagerPolicy is the name of the policy to use.
Requires the CPUManager feature gate to be enabled.
Default: "None"</p>
</td>
</tr>
<tr><td><code>cpuManagerPolicyOptions</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>cpuManagerPolicyOptions is a set of key=value which allows to set extra options
to fine tune the behaviour of the cpu manager policies.
Requires both the "CPUManager" and "CPUManagerPolicyOptions" feature gates to be enabled.
Default: nil</p>
</td>
</tr>
<tr><td><code>cpuManagerReconcilePeriod</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>cpuManagerReconcilePeriod is the reconciliation period for the CPU Manager.
Requires the CPUManager feature gate to be enabled.
Default: "10s"</p>
</td>
</tr>
<tr><td><code>memoryManagerPolicy</code><br/>
<code>string</code>
</td>
<td>
<p>memoryManagerPolicy is the name of the policy to use by memory manager.
Requires the MemoryManager feature gate to be enabled.
Default: "none"</p>
</td>
</tr>
<tr><td><code>topologyManagerPolicy</code><br/>
<code>string</code>
</td>
<td>
<p>topologyManagerPolicy is the name of the topology manager policy to use.
Valid values include:</p>
<ul>
<li><code>restricted</code>: kubelet only allows pods with optimal NUMA node alignment for
requested resources;</li>
<li><code>best-effort</code>: kubelet will favor pods with NUMA alignment of CPU and device
resources;</li>
<li><code>none</code>: kubelet has no knowledge of NUMA alignment of a pod's CPU and device resources.</li>
<li><code>single-numa-node</code>: kubelet only allows pods with a single NUMA alignment
of CPU and device resources.</li>
</ul>
<p>Default: "none"</p>
</td>
</tr>
<tr><td><code>topologyManagerScope</code><br/>
<code>string</code>
</td>
<td>
<p>topologyManagerScope represents the scope of topology hint generation
that topology manager requests and hint providers generate. Valid values include:</p>
<ul>
<li><code>container</code>: topology policy is applied on a per-container basis.</li>
<li><code>pod</code>: topology policy is applied on a per-pod basis.</li>
</ul>
<p>Default: "container"</p>
</td>
</tr>
<tr><td><code>topologyManagerPolicyOptions</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>TopologyManagerPolicyOptions is a set of key=value which allows to set extra options
to fine tune the behaviour of the topology manager policies.
Requires both the "TopologyManager" and "TopologyManagerPolicyOptions" feature gates to be enabled.
Default: nil</p>
</td>
</tr>
<tr><td><code>qosReserved</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>qosReserved is a set of resource name to percentage pairs that specify
the minimum percentage of a resource reserved for exclusive use by the
guaranteed QoS tier.
Currently supported resources: "memory"
Requires the QOSReserved feature gate to be enabled.
Default: nil</p>
</td>
</tr>
<tr><td><code>runtimeRequestTimeout</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>runtimeRequestTimeout is the timeout for all runtime requests except long running
requests - pull, logs, exec and attach.
Default: "2m"</p>
</td>
</tr>
<tr><td><code>hairpinMode</code><br/>
<code>string</code>
</td>
<td>
<p>hairpinMode specifies how the Kubelet should configure the container
bridge for hairpin packets.
Setting this flag allows endpoints in a Service to loadbalance back to
themselves if they should try to access their own Service. Values:</p>
<ul>
<li>"promiscuous-bridge": make the container bridge promiscuous.</li>
<li>"hairpin-veth": set the hairpin flag on container veth interfaces.</li>
<li>"none": do nothing.</li>
</ul>
<p>Generally, one must set <code>--hairpin-mode=hairpin-veth to</code> achieve hairpin NAT,
because promiscuous-bridge assumes the existence of a container bridge named cbr0.
Default: "promiscuous-bridge"</p>
</td>
</tr>
<tr><td><code>maxPods</code><br/>
<code>int32</code>
</td>
<td>
<p>maxPods is the maximum number of Pods that can run on this Kubelet.
The value must be a non-negative integer.
Default: 110</p>
</td>
</tr>
<tr><td><code>podCIDR</code><br/>
<code>string</code>
</td>
<td>
<p>podCIDR is the CIDR to use for pod IP addresses, only used in standalone mode.
In cluster mode, this is obtained from the control plane.
Default: ""</p>
</td>
</tr>
<tr><td><code>podPidsLimit</code><br/>
<code>int64</code>
</td>
<td>
<p>podPidsLimit is the maximum number of PIDs in any pod.
Default: -1</p>
</td>
</tr>
<tr><td><code>resolvConf</code><br/>
<code>string</code>
</td>
<td>
<p>resolvConf is the resolver configuration file used as the basis
for the container DNS resolution configuration.
If set to the empty string, will override the default and effectively disable DNS lookups.
Default: "/etc/resolv.conf"</p>
</td>
</tr>
<tr><td><code>runOnce</code><br/>
<code>bool</code>
</td>
<td>
<p>runOnce causes the Kubelet to check the API server once for pods,
run those in addition to the pods specified by static pod files, and exit.
Default: false</p>
</td>
</tr>
<tr><td><code>cpuCFSQuota</code><br/>
<code>bool</code>
</td>
<td>
<p>cpuCFSQuota enables CPU CFS quota enforcement for containers that
specify CPU limits.
Default: true</p>
</td>
</tr>
<tr><td><code>cpuCFSQuotaPeriod</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>cpuCFSQuotaPeriod is the CPU CFS quota period value, <code>cpu.cfs_period_us</code>.
The value must be between 1 ms and 1 second, inclusive.
Requires the CustomCPUCFSQuotaPeriod feature gate to be enabled.
Default: "100ms"</p>
</td>
</tr>
<tr><td><code>nodeStatusMaxImages</code><br/>
<code>int32</code>
</td>
<td>
<p>nodeStatusMaxImages caps the number of images reported in Node.status.images.
The value must be greater than -2.
Note: If -1 is specified, no cap will be applied. If 0 is specified, no image is returned.
Default: 50</p>
</td>
</tr>
<tr><td><code>maxOpenFiles</code><br/>
<code>int64</code>
</td>
<td>
<p>maxOpenFiles is Number of files that can be opened by Kubelet process.
The value must be a non-negative number.
Default: 1000000</p>
</td>
</tr>
<tr><td><code>contentType</code><br/>
<code>string</code>
</td>
<td>
<p>contentType is contentType of requests sent to apiserver.
Default: "application/vnd.kubernetes.protobuf"</p>
</td>
</tr>
<tr><td><code>kubeAPIQPS</code><br/>
<code>int32</code>
</td>
<td>
<p>kubeAPIQPS is the QPS to use while talking with kubernetes apiserver.
Default: 50</p>
</td>
</tr>
<tr><td><code>kubeAPIBurst</code><br/>
<code>int32</code>
</td>
<td>
<p>kubeAPIBurst is the burst to allow while talking with kubernetes API server.
This field cannot be a negative number.
Default: 100</p>
</td>
</tr>
<tr><td><code>serializeImagePulls</code><br/>
<code>bool</code>
</td>
<td>
<p>serializeImagePulls when enabled, tells the Kubelet to pull images one
at a time. We recommend <em>not</em> changing the default value on nodes that
run docker daemon with version < 1.9 or an Aufs storage backend.
Issue #10959 has more details.
Default: true</p>
</td>
</tr>
<tr><td><code>maxParallelImagePulls</code><br/>
<code>int32</code>
</td>
<td>
<p>MaxParallelImagePulls sets the maximum number of image pulls in parallel.
This field cannot be set if SerializeImagePulls is true.
Setting it to nil means no limit.
Default: nil</p>
</td>
</tr>
<tr><td><code>evictionHard</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>evictionHard is a map of signal names to quantities that defines hard eviction
thresholds. For example: <code>{"memory.available": "300Mi"}</code>.
To explicitly disable, pass a 0% or 100% threshold on an arbitrary resource.
Default:
memory.available: "100Mi"
nodefs.available: "10%"
nodefs.inodesFree: "5%"
imagefs.available: "15%"</p>
</td>
</tr>
<tr><td><code>evictionSoft</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>evictionSoft is a map of signal names to quantities that defines soft eviction thresholds.
For example: <code>{"memory.available": "300Mi"}</code>.
Default: nil</p>
</td>
</tr>
<tr><td><code>evictionSoftGracePeriod</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>evictionSoftGracePeriod is a map of signal names to quantities that defines grace
periods for each soft eviction signal. For example: <code>{"memory.available": "30s"}</code>.
Default: nil</p>
</td>
</tr>
<tr><td><code>evictionPressureTransitionPeriod</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>evictionPressureTransitionPeriod is the duration for which the kubelet has to wait
before transitioning out of an eviction pressure condition.
Default: "5m"</p>
</td>
</tr>
<tr><td><code>evictionMaxPodGracePeriod</code><br/>
<code>int32</code>
</td>
<td>
<p>evictionMaxPodGracePeriod is the maximum allowed grace period (in seconds) to use
when terminating pods in response to a soft eviction threshold being met. This value
effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions.
Note: Due to issue #64530, the behavior has a bug where this value currently just
overrides the grace period during soft eviction, which can increase the grace
period from what is set on the Pod. This bug will be fixed in a future release.
Default: 0</p>
</td>
</tr>
<tr><td><code>evictionMinimumReclaim</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>evictionMinimumReclaim is a map of signal names to quantities that defines minimum reclaims,
which describe the minimum amount of a given resource the kubelet will reclaim when
performing a pod eviction while that resource is under pressure.
For example: <code>{"imagefs.available": "2Gi"}</code>.
Default: nil</p>
</td>
</tr>
<tr><td><code>podsPerCore</code><br/>
<code>int32</code>
</td>
<td>
<p>podsPerCore is the maximum number of pods per core. Cannot exceed maxPods.
The value must be a non-negative integer.
If 0, there is no limit on the number of Pods.
Default: 0</p>
</td>
</tr>
<tr><td><code>enableControllerAttachDetach</code><br/>
<code>bool</code>
</td>
<td>
<p>enableControllerAttachDetach enables the Attach/Detach controller to
manage attachment/detachment of volumes scheduled to this node, and
disables kubelet from executing any attach/detach operations.
Note: attaching/detaching CSI volumes is not supported by the kubelet,
so this option needs to be true for that use case.
Default: true</p>
</td>
</tr>
<tr><td><code>protectKernelDefaults</code><br/>
<code>bool</code>
</td>
<td>
<p>protectKernelDefaults, if true, causes the Kubelet to error if kernel
flags are not as it expects. Otherwise the Kubelet will attempt to modify
kernel flags to match its expectation.
Default: false</p>
</td>
</tr>
<tr><td><code>makeIPTablesUtilChains</code><br/>
<code>bool</code>
</td>
<td>
<p>makeIPTablesUtilChains, if true, causes the Kubelet to create the
KUBE-IPTABLES-HINT chain in iptables as a hint to other components about the
configuration of iptables on the system.
Default: true</p>
</td>
</tr>
<tr><td><code>iptablesMasqueradeBit</code><br/>
<code>int32</code>
</td>
<td>
<p>iptablesMasqueradeBit formerly controlled the creation of the KUBE-MARK-MASQ
chain.
Deprecated: no longer has any effect.
Default: 14</p>
</td>
</tr>
<tr><td><code>iptablesDropBit</code><br/>
<code>int32</code>
</td>
<td>
<p>iptablesDropBit formerly controlled the creation of the KUBE-MARK-DROP chain.
Deprecated: no longer has any effect.
Default: 15</p>
</td>
</tr>
<tr><td><code>featureGates</code><br/>
<code>map[string]bool</code>
</td>
<td>
<p>featureGates is a map of feature names to bools that enable or disable experimental
features. This field modifies piecemeal the built-in default values from
"k8s.io/kubernetes/pkg/features/kube_features.go".
Default: nil</p>
</td>
</tr>
<tr><td><code>failSwapOn</code><br/>
<code>bool</code>
</td>
<td>
<p>failSwapOn tells the Kubelet to fail to start if swap is enabled on the node.
Default: true</p>
</td>
</tr>
<tr><td><code>memorySwap</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-MemorySwapConfiguration"><code>MemorySwapConfiguration</code></a>
</td>
<td>
<p>memorySwap configures swap memory available to container workloads.</p>
</td>
</tr>
<tr><td><code>containerLogMaxSize</code><br/>
<code>string</code>
</td>
<td>
<p>containerLogMaxSize is a quantity defining the maximum size of the container log
file before it is rotated. For example: "5Mi" or "256Ki".
Default: "10Mi"</p>
</td>
</tr>
<tr><td><code>containerLogMaxFiles</code><br/>
<code>int32</code>
</td>
<td>
<p>containerLogMaxFiles specifies the maximum number of container log files that can
be present for a container.
Default: 5</p>
</td>
</tr>
<tr><td><code>containerLogMaxWorkers</code><br/>
<code>int32</code>
</td>
<td>
<p>ContainerLogMaxWorkers specifies the maximum number of concurrent workers to spawn
for performing the log rotate operations. Set this count to 1 for disabling the
concurrent log rotation workflows
Default: 1</p>
</td>
</tr>
<tr><td><code>containerLogMonitorInterval</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>ContainerLogMonitorInterval specifies the duration at which the container logs are monitored
for performing the log rotate operation. This defaults to 10 * time.Seconds. But can be
customized to a smaller value based on the log generation rate and the size required to be
rotated against
Default: 10s</p>
</td>
</tr>
<tr><td><code>configMapAndSecretChangeDetectionStrategy</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-ResourceChangeDetectionStrategy"><code>ResourceChangeDetectionStrategy</code></a>
</td>
<td>
<p>configMapAndSecretChangeDetectionStrategy is a mode in which ConfigMap and Secret
managers are running. Valid values include:</p>
<ul>
<li><code>Get</code>: kubelet fetches necessary objects directly from the API server;</li>
<li><code>Cache</code>: kubelet uses TTL cache for object fetched from the API server;</li>
<li><code>Watch</code>: kubelet uses watches to observe changes to objects that are in its interest.</li>
</ul>
<p>Default: "Watch"</p>
</td>
</tr>
<tr><td><code>systemReserved</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>systemReserved is a set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G)
pairs that describe resources reserved for non-kubernetes components.
Currently only cpu and memory are supported.
See http://kubernetes.io/docs/user-guide/compute-resources for more detail.
Default: nil</p>
</td>
</tr>
<tr><td><code>kubeReserved</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>kubeReserved is a set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs
that describe resources reserved for kubernetes system components.
Currently cpu, memory and local storage for root file system are supported.
See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
for more details.
Default: nil</p>
</td>
</tr>
<tr><td><code>reservedSystemCPUs</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>The reservedSystemCPUs option specifies the CPU list reserved for the host
level system threads and kubernetes related threads. This provide a "static"
CPU list rather than the "dynamic" list by systemReserved and kubeReserved.
This option does not support systemReservedCgroup or kubeReservedCgroup.</p>
</td>
</tr>
<tr><td><code>showHiddenMetricsForVersion</code><br/>
<code>string</code>
</td>
<td>
<p>showHiddenMetricsForVersion is 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 <code><major>.<minor></code>, e.g.: <code>1.16</code>.
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.
Default: ""</p>
</td>
</tr>
<tr><td><code>systemReservedCgroup</code><br/>
<code>string</code>
</td>
<td>
<p>systemReservedCgroup helps the kubelet identify absolute name of top level CGroup used
to enforce <code>systemReserved</code> compute resource reservation for OS system daemons.
Refer to <a href="https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable">Node Allocatable</a>
doc for more information.
Default: ""</p>
</td>
</tr>
<tr><td><code>kubeReservedCgroup</code><br/>
<code>string</code>
</td>
<td>
<p>kubeReservedCgroup helps the kubelet identify absolute name of top level CGroup used
to enforce <code>KubeReserved</code> compute resource reservation for Kubernetes node system daemons.
Refer to <a href="https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable">Node Allocatable</a>
doc for more information.
Default: ""</p>
</td>
</tr>
<tr><td><code>enforceNodeAllocatable</code><br/>
<code>[]string</code>
</td>
<td>
<p>This flag specifies the various Node Allocatable enforcements that Kubelet needs to perform.
This flag accepts a list of options. Acceptable options are <code>none</code>, <code>pods</code>,
<code>system-reserved</code> and <code>kube-reserved</code>.
If <code>none</code> is specified, no other options may be specified.
When <code>system-reserved</code> is in the list, systemReservedCgroup must be specified.
When <code>kube-reserved</code> is in the list, kubeReservedCgroup must be specified.
This field is supported only when <code>cgroupsPerQOS</code> is set to true.
Refer to <a href="https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable">Node Allocatable</a>
for more information.
Default: ["pods"]</p>
</td>
</tr>
<tr><td><code>allowedUnsafeSysctls</code><br/>
<code>[]string</code>
</td>
<td>
<p>A comma separated whitelist of unsafe sysctls or sysctl patterns (ending in <code>*</code>).
Unsafe sysctl groups are <code>kernel.shm*</code>, <code>kernel.msg*</code>, <code>kernel.sem</code>, <code>fs.mqueue.*</code>,
and <code>net.*</code>. For example: "<code>kernel.msg*,net.ipv4.route.min_pmtu</code>"
Default: []</p>
</td>
</tr>
<tr><td><code>volumePluginDir</code><br/>
<code>string</code>
</td>
<td>
<p>volumePluginDir is the full path of the directory in which to search
for additional third party volume plugins.
Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/"</p>
</td>
</tr>
<tr><td><code>providerID</code><br/>
<code>string</code>
</td>
<td>
<p>providerID, if set, sets the unique ID of the instance that an external
provider (i.e. cloudprovider) can use to identify a specific node.
Default: ""</p>
</td>
</tr>
<tr><td><code>kernelMemcgNotification</code><br/>
<code>bool</code>
</td>
<td>
<p>kernelMemcgNotification, if set, instructs the kubelet to integrate with the
kernel memcg notification for determining if memory eviction thresholds are
exceeded rather than polling.
Default: false</p>
</td>
</tr>
<tr><td><code>logging</code> <B>[Required]</B><br/>
<a href="#LoggingConfiguration"><code>LoggingConfiguration</code></a>
</td>
<td>
<p>logging specifies the options of logging.
Refer to <a href="https://github.com/kubernetes/component-base/blob/master/logs/options.go">Logs Options</a>
for more information.
Default:
Format: text</p>
</td>
</tr>
<tr><td><code>enableSystemLogHandler</code><br/>
<code>bool</code>
</td>
<td>
<p>enableSystemLogHandler enables system logs via web interface host:port/logs/
Default: true</p>
</td>
</tr>
<tr><td><code>enableSystemLogQuery</code><br/>
<code>bool</code>
</td>
<td>
<p>enableSystemLogQuery enables the node log query feature on the /logs endpoint.
EnableSystemLogHandler has to be enabled in addition for this feature to work.
Default: false</p>
</td>
</tr>
<tr><td><code>shutdownGracePeriod</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>shutdownGracePeriod specifies the total duration that the node should delay the
shutdown and total grace period for pod termination during a node shutdown.
Default: "0s"</p>
</td>
</tr>
<tr><td><code>shutdownGracePeriodCriticalPods</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>shutdownGracePeriodCriticalPods specifies the duration used to terminate critical
pods during a node shutdown. This should be less than shutdownGracePeriod.
For example, if shutdownGracePeriod=30s, and shutdownGracePeriodCriticalPods=10s,
during a node shutdown the first 20 seconds would be reserved for gracefully
terminating normal pods, and the last 10 seconds would be reserved for terminating
critical pods.
Default: "0s"</p>
</td>
</tr>
<tr><td><code>shutdownGracePeriodByPodPriority</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-ShutdownGracePeriodByPodPriority"><code>[]ShutdownGracePeriodByPodPriority</code></a>
</td>
<td>
<p>shutdownGracePeriodByPodPriority specifies the shutdown grace period for Pods based
on their associated priority class value.
When a shutdown request is received, the Kubelet will initiate shutdown on all pods
running on the node with a grace period that depends on the priority of the pod,
and then wait for all pods to exit.
Each entry in the array represents the graceful shutdown time a pod with a priority
class value that lies in the range of that value and the next higher entry in the
list when the node is shutting down.
For example, to allow critical pods 10s to shutdown, priority>=10000 pods 20s to
shutdown, and all remaining pods 30s to shutdown.</p>
<p>shutdownGracePeriodByPodPriority:</p>
<ul>
<li>priority: 2000000000
shutdownGracePeriodSeconds: 10</li>
<li>priority: 10000
shutdownGracePeriodSeconds: 20</li>
<li>priority: 0
shutdownGracePeriodSeconds: 30</li>
</ul>
<p>The time the Kubelet will wait before exiting will at most be the maximum of all
shutdownGracePeriodSeconds for each priority class range represented on the node.
When all pods have exited or reached their grace periods, the Kubelet will release
the shutdown inhibit lock.
Requires the GracefulNodeShutdown feature gate to be enabled.
This configuration must be empty if either ShutdownGracePeriod or ShutdownGracePeriodCriticalPods is set.
Default: nil</p>
</td>
</tr>
<tr><td><code>reservedMemory</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-MemoryReservation"><code>[]MemoryReservation</code></a>
</td>
<td>
<p>reservedMemory specifies a comma-separated list of memory reservations for NUMA nodes.
The parameter makes sense only in the context of the memory manager feature.
The memory manager will not allocate reserved memory for container workloads.
For example, if you have a NUMA0 with 10Gi of memory and the reservedMemory was
specified to reserve 1Gi of memory at NUMA0, the memory manager will assume that
only 9Gi is available for allocation.
You can specify a different amount of NUMA node and memory types.
You can omit this parameter at all, but you should be aware that the amount of
reserved memory from all NUMA nodes should be equal to the amount of memory specified
by the <a href="https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable">node allocatable</a>.
If at least one node allocatable parameter has a non-zero value, you will need
to specify at least one NUMA node.
Also, avoid specifying:</p>
<ol>
<li>Duplicates, the same NUMA node, and memory type, but with a different value.</li>
<li>zero limits for any memory type.</li>
<li>NUMAs nodes IDs that do not exist under the machine.</li>
<li>memory types except for memory and hugepages-<!-- raw HTML omitted --></li>
</ol>
<p>Default: nil</p>
</td>
</tr>
<tr><td><code>enableProfilingHandler</code><br/>
<code>bool</code>
</td>
<td>
<p>enableProfilingHandler enables profiling via web interface host:port/debug/pprof/
Default: true</p>
</td>
</tr>
<tr><td><code>enableDebugFlagsHandler</code><br/>
<code>bool</code>
</td>
<td>
<p>enableDebugFlagsHandler enables flags endpoint via web interface host:port/debug/flags/v
Default: true</p>
</td>
</tr>
<tr><td><code>seccompDefault</code><br/>
<code>bool</code>
</td>
<td>
<p>SeccompDefault enables the use of <code>RuntimeDefault</code> as the default seccomp profile for all workloads.
Default: false</p>
</td>
</tr>
<tr><td><code>memoryThrottlingFactor</code><br/>
<code>float64</code>
</td>
<td>
<p>MemoryThrottlingFactor specifies the factor multiplied by the memory limit or node allocatable memory
when setting the cgroupv2 memory.high value to enforce MemoryQoS.
Decreasing this factor will set lower high limit for container cgroups and put heavier reclaim pressure
while increasing will put less reclaim pressure.
See https://kep.k8s.io/2570 for more details.
Default: 0.9</p>
</td>
</tr>
<tr><td><code>registerWithTaints</code><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>registerWithTaints are an array of taints to add to a node object when
the kubelet registers itself. This only takes effect when registerNode
is true and upon the initial registration of the node.
Default: nil</p>
</td>
</tr>
<tr><td><code>registerNode</code><br/>
<code>bool</code>
</td>
<td>
<p>registerNode enables automatic registration with the apiserver.
Default: true</p>
</td>
</tr>
<tr><td><code>tracing</code><br/>
<a href="#TracingConfiguration"><code>TracingConfiguration</code></a>
</td>
<td>
<p>Tracing specifies the versioned configuration for OpenTelemetry tracing clients.
See https://kep.k8s.io/2832 for more details.
Default: nil</p>
</td>
</tr>
<tr><td><code>localStorageCapacityIsolation</code><br/>
<code>bool</code>
</td>
<td>
<p>LocalStorageCapacityIsolation enables local ephemeral storage isolation feature. The default setting is true.
This feature allows users to set request/limit for container's ephemeral storage and manage it in a similar way
as cpu and memory. It also allows setting sizeLimit for emptyDir volume, which will trigger pod eviction if disk
usage from the volume exceeds the limit.
This feature depends on the capability of detecting correct root file system disk usage. For certain systems,
such as kind rootless, if this capability cannot be supported, the feature LocalStorageCapacityIsolation should be
disabled. Once disabled, user should not set request/limit for container's ephemeral storage, or sizeLimit for emptyDir.
Default: true</p>
</td>
</tr>
<tr><td><code>containerRuntimeEndpoint</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>ContainerRuntimeEndpoint is the endpoint of container runtime.
Unix Domain Sockets are supported on Linux, while npipe and tcp endpoints are supported on Windows.
Examples:'unix:///path/to/runtime.sock', 'npipe:////./pipe/runtime'</p>
</td>
</tr>
<tr><td><code>imageServiceEndpoint</code><br/>
<code>string</code>
</td>
<td>
<p>ImageServiceEndpoint is the endpoint of container image service.
Unix Domain Socket are supported on Linux, while npipe and tcp endpoints are supported on Windows.
Examples:'unix:///path/to/runtime.sock', 'npipe:////./pipe/runtime'.
If not specified, the value in containerRuntimeEndpoint is used.</p>
</td>
</tr>
<tr><td><code>failCgroupV1</code><br/>
<code>bool</code>
</td>
<td>
<p>FailCgroupV1 prevents the kubelet from starting on hosts
that use cgroup v1. By default, this is set to 'false', meaning
the kubelet is allowed to start on cgroup v1 hosts unless this
option is explicitly enabled.
Default: false</p>
</td>
</tr>
</tbody>
</table>
## `SerializedNodeConfigSource` {#kubelet-config-k8s-io-v1beta1-SerializedNodeConfigSource}
<p>SerializedNodeConfigSource allows us to serialize v1.NodeConfigSource.
This type is used internally by the Kubelet for tracking checkpointed dynamic configs.
It exists in the kubeletconfig API group because it is classified as a versioned input to the Kubelet.</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>kubelet.config.k8s.io/v1beta1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>SerializedNodeConfigSource</code></td></tr>
<tr><td><code>source</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#nodeconfigsource-v1-core"><code>core/v1.NodeConfigSource</code></a>
</td>
<td>
<p>source is the source that we are serializing.</p>
</td>
</tr>
</tbody>
</table>
## `CredentialProvider` {#kubelet-config-k8s-io-v1beta1-CredentialProvider}
**Appears in:**
- [CredentialProviderConfig](#kubelet-config-k8s-io-v1beta1-CredentialProviderConfig)
<p>CredentialProvider represents an exec plugin to be invoked by the kubelet. The plugin is only
invoked when an image being pulled matches the images handled by the plugin (see matchImages).</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 required name of the credential provider. It must match the name of the
provider executable as seen by the kubelet. The executable must be in the kubelet's
bin directory (set by the --image-credential-provider-bin-dir flag).</p>
</td>
</tr>
<tr><td><code>matchImages</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>matchImages is a required list of strings used to match against images in order to
determine if this provider should be invoked. If one of the strings matches the
requested image from the kubelet, the plugin will be invoked and given a chance
to provide credentials. Images are expected to contain the registry domain
and URL path.</p>
<p>Each entry in matchImages is a pattern which can optionally contain a port and a path.
Globs can be used in the domain, but not in the port or the path. Globs are supported
as subdomains like '<em>.k8s.io' or 'k8s.</em>.io', and top-level-domains such as 'k8s.<em>'.
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
a single subdomain segment, so *.io does not match *.k8s.io.</p>
<p>A match exists between an image and a matchImage when all of the below are true:</p>
<ul>
<li>Both contain the same number of domain parts and each part matches.</li>
<li>The URL path of an imageMatch must be a prefix of the target image URL path.</li>
<li>If the imageMatch contains a port, then the port must match in the image as well.</li>
</ul>
<p>Example values of matchImages:</p>
<ul>
<li>123456789.dkr.ecr.us-east-1.amazonaws.com</li>
<li>*.azurecr.io</li>
<li>gcr.io</li>
<li><em>.</em>.registry.io</li>
<li>registry.io:8080/path</li>
</ul>
</td>
</tr>
<tr><td><code>defaultCacheDuration</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>defaultCacheDuration is the default duration the plugin will cache credentials in-memory
if a cache duration is not provided in the plugin response. This field is required.</p>
</td>
</tr>
<tr><td><code>apiVersion</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Required input version of the exec CredentialProviderRequest. The returned CredentialProviderResponse
MUST use the same encoding version as the input. Current supported values are:</p>
<ul>
<li>credentialprovider.kubelet.k8s.io/v1beta1</li>
</ul>
</td>
</tr>
<tr><td><code>args</code><br/>
<code>[]string</code>
</td>
<td>
<p>Arguments to pass to the command when executing it.</p>
</td>
</tr>
<tr><td><code>env</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-ExecEnvVar"><code>[]ExecEnvVar</code></a>
</td>
<td>
<p>Env defines additional environment variables to expose to the process. These
are unioned with the host's environment, as well as variables client-go uses
to pass argument to the plugin.</p>
</td>
</tr>
</tbody>
</table>
## `ExecEnvVar` {#kubelet-config-k8s-io-v1beta1-ExecEnvVar}
**Appears in:**
- [CredentialProvider](#kubelet-config-k8s-io-v1beta1-CredentialProvider)
<p>ExecEnvVar is used for setting environment variables when executing an exec-based
credential plugin.</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>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>value</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `KubeletAnonymousAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAnonymousAuthentication}
**Appears in:**
- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>enabled</code><br/>
<code>bool</code>
</td>
<td>
<p>enabled allows 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>.</p>
</td>
</tr>
</tbody>
</table>
## `KubeletAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAuthentication}
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>x509</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-KubeletX509Authentication"><code>KubeletX509Authentication</code></a>
</td>
<td>
<p>x509 contains settings related to x509 client certificate authentication.</p>
</td>
</tr>
<tr><td><code>webhook</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthentication"><code>KubeletWebhookAuthentication</code></a>
</td>
<td>
<p>webhook contains settings related to webhook bearer token authentication.</p>
</td>
</tr>
<tr><td><code>anonymous</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-KubeletAnonymousAuthentication"><code>KubeletAnonymousAuthentication</code></a>
</td>
<td>
<p>anonymous contains settings related to anonymous authentication.</p>
</td>
</tr>
</tbody>
</table>
## `KubeletAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorization}
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>mode</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-KubeletAuthorizationMode"><code>KubeletAuthorizationMode</code></a>
</td>
<td>
<p>mode is the authorization mode to apply to requests to the kubelet server.
Valid values are <code>AlwaysAllow</code> and <code>Webhook</code>.
Webhook mode uses the SubjectAccessReview API to determine authorization.</p>
</td>
</tr>
<tr><td><code>webhook</code><br/>
<a href="#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthorization"><code>KubeletWebhookAuthorization</code></a>
</td>
<td>
<p>webhook contains settings related to Webhook authorization.</p>
</td>
</tr>
</tbody>
</table>
## `KubeletAuthorizationMode` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorizationMode}
(Alias of `string`)
**Appears in:**
- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization)
## `KubeletWebhookAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthentication}
**Appears in:**
- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>enabled</code><br/>
<code>bool</code>
</td>
<td>
<p>enabled allows bearer token authentication backed by the
tokenreviews.authentication.k8s.io API.</p>
</td>
</tr>
<tr><td><code>cacheTTL</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>cacheTTL enables caching of authentication results</p>
</td>
</tr>
</tbody>
</table>
## `KubeletWebhookAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthorization}
**Appears in:**
- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>cacheAuthorizedTTL</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>cacheAuthorizedTTL is the duration to cache 'authorized' responses from the
webhook authorizer.</p>
</td>
</tr>
<tr><td><code>cacheUnauthorizedTTL</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>cacheUnauthorizedTTL is the duration to cache 'unauthorized' responses from
the webhook authorizer.</p>
</td>
</tr>
</tbody>
</table>
## `KubeletX509Authentication` {#kubelet-config-k8s-io-v1beta1-KubeletX509Authentication}
**Appears in:**
- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>clientCAFile</code><br/>
<code>string</code>
</td>
<td>
<p>clientCAFile is the path to a PEM-encoded certificate bundle. If set, any request
presenting a client certificate signed by one of the authorities in the bundle
is authenticated with a username corresponding to the CommonName,
and groups corresponding to the Organization in the client certificate.</p>
</td>
</tr>
</tbody>
</table>
## `MemoryReservation` {#kubelet-config-k8s-io-v1beta1-MemoryReservation}
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
<p>MemoryReservation specifies the memory reservation of different types for each NUMA node</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>numaNode</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>limits</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#resourcelist-v1-core"><code>core/v1.ResourceList</code></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `MemorySwapConfiguration` {#kubelet-config-k8s-io-v1beta1-MemorySwapConfiguration}
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>swapBehavior</code><br/>
<code>string</code>
</td>
<td>
<p>swapBehavior configures swap memory available to container workloads. May be one of
"", "NoSwap": workloads can not use swap, default option.
"LimitedSwap": workload swap usage is limited. The swap limit is proportionate to the container's memory request.</p>
</td>
</tr>
</tbody>
</table>
## `ResourceChangeDetectionStrategy` {#kubelet-config-k8s-io-v1beta1-ResourceChangeDetectionStrategy}
(Alias of `string`)
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
<p>ResourceChangeDetectionStrategy denotes a mode in which internal
managers (secret, configmap) are discovering object changes.</p>
## `ShutdownGracePeriodByPodPriority` {#kubelet-config-k8s-io-v1beta1-ShutdownGracePeriodByPodPriority}
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
<p>ShutdownGracePeriodByPodPriority specifies the shutdown grace period for Pods based on their associated priority class value</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>priority</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>priority is the priority value associated with the shutdown grace period</p>
</td>
</tr>
<tr><td><code>shutdownGracePeriodSeconds</code> <B>[Required]</B><br/>
<code>int64</code>
</td>
<td>
<p>shutdownGracePeriodSeconds is the shutdown grace period in seconds</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title Kubelet Configuration v1beta1 content type tool reference package kubelet config k8s io v1beta1 auto generated true Resource Types CredentialProviderConfig kubelet config k8s io v1beta1 CredentialProviderConfig KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration SerializedNodeConfigSource kubelet config k8s io v1beta1 SerializedNodeConfigSource FormatOptions FormatOptions Appears in LoggingConfiguration LoggingConfiguration p FormatOptions contains options for the different logging formats p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code text code B Required B br a href TextOptions code TextOptions code a td td p Alpha Text contains options for logging format quot text quot Only available when the LoggingAlphaOptions feature gate is enabled p td tr tr td code json code B Required B br a href JSONOptions code JSONOptions code a td td p Alpha JSON contains options for logging format quot json quot Only available when the LoggingAlphaOptions feature gate is enabled p td tr tbody table JSONOptions JSONOptions Appears in FormatOptions FormatOptions p JSONOptions contains options for logging format quot json quot p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code OutputRoutingOptions code B Required B br a href OutputRoutingOptions code OutputRoutingOptions code a td td Members of code OutputRoutingOptions code are embedded into this type span class text muted No description provided span td tr tbody table LogFormatFactory LogFormatFactory p LogFormatFactory provides support for a certain additional non default log format p LoggingConfiguration LoggingConfiguration Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration p LoggingConfiguration contains logging options p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code format code B Required B br code string code td td p Format Flag specifies the structure of log messages default value of format is code text code p td tr tr td code flushFrequency code B Required B br a href TimeOrMetaDuration code TimeOrMetaDuration code a td td p Maximum time between log flushes If a string parsed as a duration i e quot 1s quot If an int the maximum number of nanoseconds i e 1s 1000000000 Ignored if the selected logging backend writes log messages without buffering p td tr tr td code verbosity code B Required B br a href VerbosityLevel code VerbosityLevel code a td td p Verbosity is the threshold that determines which log messages are logged Default is zero which logs only the most important messages Higher values enable additional messages Error messages are always logged p td tr tr td code vmodule code B Required B br a href VModuleConfiguration code VModuleConfiguration code a td td p VModule overrides the verbosity threshold for individual files Only supported for quot text quot log format p td tr tr td code options code B Required B br a href FormatOptions code FormatOptions code a td td p Alpha Options holds additional parameters that are specific to the different logging formats Only the options for the selected format get used but all of them get validated Only available when the LoggingAlphaOptions feature gate is enabled p td tr tbody table LoggingOptions LoggingOptions p LoggingOptions can be used with ValidateAndApplyWithOptions to override certain global defaults p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ErrorStream code B Required B br a href https pkg go dev io Writer code io Writer code a td td p ErrorStream can be used to override the os Stderr default p td tr tr td code InfoStream code B Required B br a href https pkg go dev io Writer code io Writer code a td td p InfoStream can be used to override the os Stdout default p td tr tbody table OutputRoutingOptions OutputRoutingOptions Appears in JSONOptions JSONOptions TextOptions TextOptions p OutputRoutingOptions contains options that are supported by both quot text quot and quot json quot p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code splitStream code B Required B br code bool code td td p Alpha SplitStream redirects error messages to stderr while info messages go to stdout with buffering The default is to write both to stdout without buffering Only available when the LoggingAlphaOptions feature gate is enabled p td tr tr td code infoBufferSize code B Required B br a href https pkg go dev k8s io apimachinery pkg api resource QuantityValue code k8s io apimachinery pkg api resource QuantityValue code a td td p Alpha InfoBufferSize sets the size of the info stream when using split streams The default is zero which disables buffering Only available when the LoggingAlphaOptions feature gate is enabled p td tr tbody table TextOptions TextOptions Appears in FormatOptions FormatOptions p TextOptions contains options for logging format quot text quot p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code OutputRoutingOptions code B Required B br a href OutputRoutingOptions code OutputRoutingOptions code a td td Members of code OutputRoutingOptions code are embedded into this type span class text muted No description provided span td tr tbody table TimeOrMetaDuration TimeOrMetaDuration Appears in LoggingConfiguration LoggingConfiguration p TimeOrMetaDuration is present only for backwards compatibility for the flushFrequency field and new fields should use metav1 Duration p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code Duration 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 Duration holds the duration p td tr tr td code code B Required B br code bool code td td p SerializeAsString controls whether the value is serialized as a string or an integer p td tr tbody table TracingConfiguration TracingConfiguration Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration 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 VModuleConfiguration VModuleConfiguration Alias of k8s io component base logs api v1 VModuleItem Appears in LoggingConfiguration LoggingConfiguration p VModuleConfiguration is a collection of individual file names or patterns and the corresponding verbosity threshold p VerbosityLevel VerbosityLevel Alias of uint32 Appears in LoggingConfiguration LoggingConfiguration p VerbosityLevel represents a klog or logr verbosity threshold p CredentialProviderConfig kubelet config k8s io v1beta1 CredentialProviderConfig p CredentialProviderConfig is the configuration containing information about each exec credential provider Kubelet reads this configuration from disk and enables each provider as specified by the CredentialProvider type 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 kubelet config k8s io v1beta1 code td tr tr td code kind code br string td td code CredentialProviderConfig code td tr tr td code providers code B Required B br a href kubelet config k8s io v1beta1 CredentialProvider code CredentialProvider code a td td p providers is a list of credential provider plugins that will be enabled by the kubelet Multiple providers may match against a single image in which case credentials from all providers will be returned to the kubelet If multiple providers are called for a single image the results are combined If providers return overlapping auth keys the value from the provider earlier in this list is used p td tr tbody table KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration p KubeletConfiguration contains the configuration for the Kubelet 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 kubelet config k8s io v1beta1 code td tr tr td code kind code br string td td code KubeletConfiguration code td tr tr td code enableServer code B Required B br code bool code td td p enableServer enables Kubelet s secured server Note Kubelet s insecure port is controlled by the readOnlyPort option Default true p td tr tr td code staticPodPath code br code string code td td p staticPodPath is the path to the directory containing local static pods to run or the path to a single static pod file Default quot quot p td tr tr td code podLogsDir code br code string code td td p podLogsDir is a custom root directory path kubelet will use to place pod s log files Default quot var log pods quot Note it is not recommended to use the temp folder as a log directory as it may cause unexpected behavior in many places p td tr tr td code syncFrequency 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 syncFrequency is the max period between synchronizing running containers and config Default quot 1m quot p td tr tr td code fileCheckFrequency 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 fileCheckFrequency is the duration between checking config files for new data Default quot 20s quot p td tr tr td code httpCheckFrequency 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 httpCheckFrequency is the duration between checking http for new data Default quot 20s quot p td tr tr td code staticPodURL code br code string code td td p staticPodURL is the URL for accessing static pods to run Default quot quot p td tr tr td code staticPodURLHeader code br code map string string code td td p staticPodURLHeader is a map of slices with HTTP headers to use when accessing the podURL Default nil p td tr tr td code address code br code string code td td p address is the IP address for the Kubelet to serve on set to 0 0 0 0 for all interfaces Default quot 0 0 0 0 quot p td tr tr td code port code br code int32 code td td p port is the port for the Kubelet to serve on The port number must be between 1 and 65535 inclusive Default 10250 p td tr tr td code readOnlyPort code br code int32 code td td p readOnlyPort is the read only port for the Kubelet to serve on with no authentication authorization The port number must be between 1 and 65535 inclusive Setting this field to 0 disables the read only service Default 0 disabled p td tr tr td code tlsCertFile code br code string code td td p tlsCertFile is the file containing x509 Certificate for HTTPS CA cert if any concatenated after server cert If tlsCertFile and tlsPrivateKeyFile are not provided a self signed certificate and key are generated for the public address and saved to the directory passed to the Kubelet s cert dir flag Default quot quot p td tr tr td code tlsPrivateKeyFile code br code string code td td p tlsPrivateKeyFile is the file containing x509 private key matching tlsCertFile Default quot quot p td tr tr td code tlsCipherSuites code br code string code td td p tlsCipherSuites is the list of allowed cipher suites for the server Note that TLS 1 3 ciphersuites are not configurable Values are from tls package constants https golang org pkg crypto tls pkg constants Default nil p td tr tr td code tlsMinVersion code br code string code td td p tlsMinVersion is the minimum TLS version supported Values are from tls package constants https golang org pkg crypto tls pkg constants Default quot quot p td tr tr td code rotateCertificates code br code bool code td td p rotateCertificates enables client certificate rotation The Kubelet will request a new certificate from the certificates k8s io API This requires an approver to approve the certificate signing requests Default false p td tr tr td code serverTLSBootstrap code br code bool code td td p serverTLSBootstrap enables server certificate bootstrap Instead of self signing a serving certificate the Kubelet will request a certificate from the certificates k8s io API This requires an approver to approve the certificate signing requests CSR The RotateKubeletServerCertificate feature must be enabled when setting this field Default false p td tr tr td code authentication code br a href kubelet config k8s io v1beta1 KubeletAuthentication code KubeletAuthentication code a td td p authentication specifies how requests to the Kubelet s server are authenticated Defaults anonymous enabled false webhook enabled true cacheTTL quot 2m quot p td tr tr td code authorization code br a href kubelet config k8s io v1beta1 KubeletAuthorization code KubeletAuthorization code a td td p authorization specifies how requests to the Kubelet s server are authorized Defaults mode Webhook webhook cacheAuthorizedTTL quot 5m quot cacheUnauthorizedTTL quot 30s quot p td tr tr td code registryPullQPS code br code int32 code td td p registryPullQPS is the limit of registry pulls per second The value must not be a negative number Setting it to 0 means no limit Default 5 p td tr tr td code registryBurst code br code int32 code td td p registryBurst is the maximum size of bursty pulls temporarily allows pulls to burst to this number while still not exceeding registryPullQPS The value must not be a negative number Only used if registryPullQPS is greater than 0 Default 10 p td tr tr td code eventRecordQPS code br code int32 code td td p eventRecordQPS is the maximum event creations per second If 0 there is no limit enforced The value cannot be a negative number Default 50 p td tr tr td code eventBurst code br code int32 code td td p eventBurst is the maximum size of a burst of event creations temporarily allows event creations to burst to this number while still not exceeding eventRecordQPS This field canot be a negative number and it is only used when eventRecordQPS gt 0 Default 100 p td tr tr td code enableDebuggingHandlers code br code bool code td td p enableDebuggingHandlers enables server endpoints for log access and local running of containers and commands including the exec attach logs and portforward features Default true p td tr tr td code enableContentionProfiling code br code bool code td td p enableContentionProfiling enables block profiling if enableDebuggingHandlers is true Default false p td tr tr td code healthzPort code br code int32 code td td p healthzPort is the port of the localhost healthz endpoint set to 0 to disable A valid number is between 1 and 65535 Default 10248 p td tr tr td code healthzBindAddress code br code string code td td p healthzBindAddress is the IP address for the healthz server to serve on Default quot 127 0 0 1 quot p td tr tr td code oomScoreAdj code br code int32 code td td p oomScoreAdj is The oom score adj value for kubelet process Values must be within the range 1000 1000 Default 999 p td tr tr td code clusterDomain code br code string code td td p clusterDomain is the DNS domain for this cluster If set kubelet will configure all containers to search this domain in addition to the host s search domains Default quot quot p td tr tr td code clusterDNS code br code string code td td p clusterDNS is a list of IP addresses for the cluster DNS server If set kubelet will configure all containers to use this for DNS resolution instead of the host s DNS servers Default nil p td tr tr td code streamingConnectionIdleTimeout 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 streamingConnectionIdleTimeout is the maximum time a streaming connection can be idle before the connection is automatically closed Default quot 4h quot p td tr tr td code nodeStatusUpdateFrequency 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 nodeStatusUpdateFrequency is the frequency that kubelet computes node status If node lease feature is not enabled it is also the frequency that kubelet posts node status to master Note When node lease feature is not enabled be cautious when changing the constant it must work with nodeMonitorGracePeriod in nodecontroller Default quot 10s quot p td tr tr td code nodeStatusReportFrequency 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 nodeStatusReportFrequency is the frequency that kubelet posts node status to master if node status does not change Kubelet will ignore this frequency and post node status immediately if any change is detected It is only used when node lease feature is enabled nodeStatusReportFrequency s default value is 5m But if nodeStatusUpdateFrequency is set explicitly nodeStatusReportFrequency s default value will be set to nodeStatusUpdateFrequency for backward compatibility Default quot 5m quot p td tr tr td code nodeLeaseDurationSeconds code br code int32 code td td p nodeLeaseDurationSeconds is the duration the Kubelet will set on its corresponding Lease NodeLease provides an indicator of node health by having the Kubelet create and periodically renew a lease named after the node in the kube node lease namespace If the lease expires the node can be considered unhealthy The lease is currently renewed every 10s per KEP 0009 In the future the lease renewal interval may be set based on the lease duration The field value must be greater than 0 Default 40 p td tr tr td code imageMinimumGCAge 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 imageMinimumGCAge is the minimum age for an unused image before it is garbage collected Default quot 2m quot p td tr tr td code imageMaximumGCAge 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 imageMaximumGCAge is the maximum age an image can be unused before it is garbage collected The default of this field is quot 0s quot which disables this field meaning images won t be garbage collected based on being unused for too long Default quot 0s quot disabled p td tr tr td code imageGCHighThresholdPercent code br code int32 code td td p imageGCHighThresholdPercent is the percent of disk usage after which image garbage collection is always run The percent is calculated by dividing this field value by 100 so this field must be between 0 and 100 inclusive When specified the value must be greater than imageGCLowThresholdPercent Default 85 p td tr tr td code imageGCLowThresholdPercent code br code int32 code td td p imageGCLowThresholdPercent is the percent of disk usage before which image garbage collection is never run Lowest disk usage to garbage collect to The percent is calculated by dividing this field value by 100 so the field value must be between 0 and 100 inclusive When specified the value must be less than imageGCHighThresholdPercent Default 80 p td tr tr td code volumeStatsAggPeriod 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 volumeStatsAggPeriod is the frequency for calculating and caching volume disk usage for all pods Default quot 1m quot p td tr tr td code kubeletCgroups code br code string code td td p kubeletCgroups is the absolute name of cgroups to isolate the kubelet in Default quot quot p td tr tr td code systemCgroups code br code string code td td p systemCgroups is absolute name of cgroups in which to place all non kernel processes that are not already in a container Empty for no container Rolling back the flag requires a reboot The cgroupRoot must be specified if this field is not empty Default quot quot p td tr tr td code cgroupRoot code br code string code td td p cgroupRoot is the root cgroup to use for pods This is handled by the container runtime on a best effort basis p td tr tr td code cgroupsPerQOS code br code bool code td td p cgroupsPerQOS enable QoS based CGroup hierarchy top level CGroups for QoS classes and all Burstable and BestEffort Pods are brought up under their specific top level QoS CGroup Default true p td tr tr td code cgroupDriver code br code string code td td p cgroupDriver is the driver kubelet uses to manipulate CGroups on the host cgroupfs or systemd Default quot cgroupfs quot p td tr tr td code cpuManagerPolicy code br code string code td td p cpuManagerPolicy is the name of the policy to use Requires the CPUManager feature gate to be enabled Default quot None quot p td tr tr td code cpuManagerPolicyOptions code br code map string string code td td p cpuManagerPolicyOptions is a set of key value which allows to set extra options to fine tune the behaviour of the cpu manager policies Requires both the quot CPUManager quot and quot CPUManagerPolicyOptions quot feature gates to be enabled Default nil p td tr tr td code cpuManagerReconcilePeriod 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 cpuManagerReconcilePeriod is the reconciliation period for the CPU Manager Requires the CPUManager feature gate to be enabled Default quot 10s quot p td tr tr td code memoryManagerPolicy code br code string code td td p memoryManagerPolicy is the name of the policy to use by memory manager Requires the MemoryManager feature gate to be enabled Default quot none quot p td tr tr td code topologyManagerPolicy code br code string code td td p topologyManagerPolicy is the name of the topology manager policy to use Valid values include p ul li code restricted code kubelet only allows pods with optimal NUMA node alignment for requested resources li li code best effort code kubelet will favor pods with NUMA alignment of CPU and device resources li li code none code kubelet has no knowledge of NUMA alignment of a pod s CPU and device resources li li code single numa node code kubelet only allows pods with a single NUMA alignment of CPU and device resources li ul p Default quot none quot p td tr tr td code topologyManagerScope code br code string code td td p topologyManagerScope represents the scope of topology hint generation that topology manager requests and hint providers generate Valid values include p ul li code container code topology policy is applied on a per container basis li li code pod code topology policy is applied on a per pod basis li ul p Default quot container quot p td tr tr td code topologyManagerPolicyOptions code br code map string string code td td p TopologyManagerPolicyOptions is a set of key value which allows to set extra options to fine tune the behaviour of the topology manager policies Requires both the quot TopologyManager quot and quot TopologyManagerPolicyOptions quot feature gates to be enabled Default nil p td tr tr td code qosReserved code br code map string string code td td p qosReserved is a set of resource name to percentage pairs that specify the minimum percentage of a resource reserved for exclusive use by the guaranteed QoS tier Currently supported resources quot memory quot Requires the QOSReserved feature gate to be enabled Default nil p td tr tr td code runtimeRequestTimeout 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 runtimeRequestTimeout is the timeout for all runtime requests except long running requests pull logs exec and attach Default quot 2m quot p td tr tr td code hairpinMode code br code string code td td p hairpinMode specifies how the Kubelet should configure the container bridge for hairpin packets Setting this flag allows endpoints in a Service to loadbalance back to themselves if they should try to access their own Service Values p ul li quot promiscuous bridge quot make the container bridge promiscuous li li quot hairpin veth quot set the hairpin flag on container veth interfaces li li quot none quot do nothing li ul p Generally one must set code hairpin mode hairpin veth to code achieve hairpin NAT because promiscuous bridge assumes the existence of a container bridge named cbr0 Default quot promiscuous bridge quot p td tr tr td code maxPods code br code int32 code td td p maxPods is the maximum number of Pods that can run on this Kubelet The value must be a non negative integer Default 110 p td tr tr td code podCIDR code br code string code td td p podCIDR is the CIDR to use for pod IP addresses only used in standalone mode In cluster mode this is obtained from the control plane Default quot quot p td tr tr td code podPidsLimit code br code int64 code td td p podPidsLimit is the maximum number of PIDs in any pod Default 1 p td tr tr td code resolvConf code br code string code td td p resolvConf is the resolver configuration file used as the basis for the container DNS resolution configuration If set to the empty string will override the default and effectively disable DNS lookups Default quot etc resolv conf quot p td tr tr td code runOnce code br code bool code td td p runOnce causes the Kubelet to check the API server once for pods run those in addition to the pods specified by static pod files and exit Default false p td tr tr td code cpuCFSQuota code br code bool code td td p cpuCFSQuota enables CPU CFS quota enforcement for containers that specify CPU limits Default true p td tr tr td code cpuCFSQuotaPeriod 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 cpuCFSQuotaPeriod is the CPU CFS quota period value code cpu cfs period us code The value must be between 1 ms and 1 second inclusive Requires the CustomCPUCFSQuotaPeriod feature gate to be enabled Default quot 100ms quot p td tr tr td code nodeStatusMaxImages code br code int32 code td td p nodeStatusMaxImages caps the number of images reported in Node status images The value must be greater than 2 Note If 1 is specified no cap will be applied If 0 is specified no image is returned Default 50 p td tr tr td code maxOpenFiles code br code int64 code td td p maxOpenFiles is Number of files that can be opened by Kubelet process The value must be a non negative number Default 1000000 p td tr tr td code contentType code br code string code td td p contentType is contentType of requests sent to apiserver Default quot application vnd kubernetes protobuf quot p td tr tr td code kubeAPIQPS code br code int32 code td td p kubeAPIQPS is the QPS to use while talking with kubernetes apiserver Default 50 p td tr tr td code kubeAPIBurst code br code int32 code td td p kubeAPIBurst is the burst to allow while talking with kubernetes API server This field cannot be a negative number Default 100 p td tr tr td code serializeImagePulls code br code bool code td td p serializeImagePulls when enabled tells the Kubelet to pull images one at a time We recommend em not em changing the default value on nodes that run docker daemon with version lt 1 9 or an Aufs storage backend Issue 10959 has more details Default true p td tr tr td code maxParallelImagePulls code br code int32 code td td p MaxParallelImagePulls sets the maximum number of image pulls in parallel This field cannot be set if SerializeImagePulls is true Setting it to nil means no limit Default nil p td tr tr td code evictionHard code br code map string string code td td p evictionHard is a map of signal names to quantities that defines hard eviction thresholds For example code quot memory available quot quot 300Mi quot code To explicitly disable pass a 0 or 100 threshold on an arbitrary resource Default memory available quot 100Mi quot nodefs available quot 10 quot nodefs inodesFree quot 5 quot imagefs available quot 15 quot p td tr tr td code evictionSoft code br code map string string code td td p evictionSoft is a map of signal names to quantities that defines soft eviction thresholds For example code quot memory available quot quot 300Mi quot code Default nil p td tr tr td code evictionSoftGracePeriod code br code map string string code td td p evictionSoftGracePeriod is a map of signal names to quantities that defines grace periods for each soft eviction signal For example code quot memory available quot quot 30s quot code Default nil p td tr tr td code evictionPressureTransitionPeriod 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 evictionPressureTransitionPeriod is the duration for which the kubelet has to wait before transitioning out of an eviction pressure condition Default quot 5m quot p td tr tr td code evictionMaxPodGracePeriod code br code int32 code td td p evictionMaxPodGracePeriod is the maximum allowed grace period in seconds to use when terminating pods in response to a soft eviction threshold being met This value effectively caps the Pod s terminationGracePeriodSeconds value during soft evictions Note Due to issue 64530 the behavior has a bug where this value currently just overrides the grace period during soft eviction which can increase the grace period from what is set on the Pod This bug will be fixed in a future release Default 0 p td tr tr td code evictionMinimumReclaim code br code map string string code td td p evictionMinimumReclaim is a map of signal names to quantities that defines minimum reclaims which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure For example code quot imagefs available quot quot 2Gi quot code Default nil p td tr tr td code podsPerCore code br code int32 code td td p podsPerCore is the maximum number of pods per core Cannot exceed maxPods The value must be a non negative integer If 0 there is no limit on the number of Pods Default 0 p td tr tr td code enableControllerAttachDetach code br code bool code td td p enableControllerAttachDetach enables the Attach Detach controller to manage attachment detachment of volumes scheduled to this node and disables kubelet from executing any attach detach operations Note attaching detaching CSI volumes is not supported by the kubelet so this option needs to be true for that use case Default true p td tr tr td code protectKernelDefaults code br code bool code td td p protectKernelDefaults if true causes the Kubelet to error if kernel flags are not as it expects Otherwise the Kubelet will attempt to modify kernel flags to match its expectation Default false p td tr tr td code makeIPTablesUtilChains code br code bool code td td p makeIPTablesUtilChains if true causes the Kubelet to create the KUBE IPTABLES HINT chain in iptables as a hint to other components about the configuration of iptables on the system Default true p td tr tr td code iptablesMasqueradeBit code br code int32 code td td p iptablesMasqueradeBit formerly controlled the creation of the KUBE MARK MASQ chain Deprecated no longer has any effect Default 14 p td tr tr td code iptablesDropBit code br code int32 code td td p iptablesDropBit formerly controlled the creation of the KUBE MARK DROP chain Deprecated no longer has any effect Default 15 p td tr tr td code featureGates code br code map string bool code td td p featureGates is a map of feature names to bools that enable or disable experimental features This field modifies piecemeal the built in default values from quot k8s io kubernetes pkg features kube features go quot Default nil p td tr tr td code failSwapOn code br code bool code td td p failSwapOn tells the Kubelet to fail to start if swap is enabled on the node Default true p td tr tr td code memorySwap code br a href kubelet config k8s io v1beta1 MemorySwapConfiguration code MemorySwapConfiguration code a td td p memorySwap configures swap memory available to container workloads p td tr tr td code containerLogMaxSize code br code string code td td p containerLogMaxSize is a quantity defining the maximum size of the container log file before it is rotated For example quot 5Mi quot or quot 256Ki quot Default quot 10Mi quot p td tr tr td code containerLogMaxFiles code br code int32 code td td p containerLogMaxFiles specifies the maximum number of container log files that can be present for a container Default 5 p td tr tr td code containerLogMaxWorkers code br code int32 code td td p ContainerLogMaxWorkers specifies the maximum number of concurrent workers to spawn for performing the log rotate operations Set this count to 1 for disabling the concurrent log rotation workflows Default 1 p td tr tr td code containerLogMonitorInterval 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 ContainerLogMonitorInterval specifies the duration at which the container logs are monitored for performing the log rotate operation This defaults to 10 time Seconds But can be customized to a smaller value based on the log generation rate and the size required to be rotated against Default 10s p td tr tr td code configMapAndSecretChangeDetectionStrategy code br a href kubelet config k8s io v1beta1 ResourceChangeDetectionStrategy code ResourceChangeDetectionStrategy code a td td p configMapAndSecretChangeDetectionStrategy is a mode in which ConfigMap and Secret managers are running Valid values include p ul li code Get code kubelet fetches necessary objects directly from the API server li li code Cache code kubelet uses TTL cache for object fetched from the API server li li code Watch code kubelet uses watches to observe changes to objects that are in its interest li ul p Default quot Watch quot p td tr tr td code systemReserved code br code map string string code td td p systemReserved is a set of ResourceName ResourceQuantity e g cpu 200m memory 150G pairs that describe resources reserved for non kubernetes components Currently only cpu and memory are supported See http kubernetes io docs user guide compute resources for more detail Default nil p td tr tr td code kubeReserved code br code map string string code td td p kubeReserved is a set of ResourceName ResourceQuantity e g cpu 200m memory 150G pairs that describe resources reserved for kubernetes system components Currently cpu memory and local storage for root file system are supported See https kubernetes io docs concepts configuration manage resources containers for more details Default nil p td tr tr td code reservedSystemCPUs code B Required B br code string code td td p The reservedSystemCPUs option specifies the CPU list reserved for the host level system threads and kubernetes related threads This provide a quot static quot CPU list rather than the quot dynamic quot list by systemReserved and kubeReserved This option does not support systemReservedCgroup or kubeReservedCgroup p td tr tr td code showHiddenMetricsForVersion code br code string code td td p showHiddenMetricsForVersion is 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 code lt major gt lt minor gt code e g code 1 16 code 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 Default quot quot p td tr tr td code systemReservedCgroup code br code string code td td p systemReservedCgroup helps the kubelet identify absolute name of top level CGroup used to enforce code systemReserved code compute resource reservation for OS system daemons Refer to a href https kubernetes io docs tasks administer cluster reserve compute resources node allocatable Node Allocatable a doc for more information Default quot quot p td tr tr td code kubeReservedCgroup code br code string code td td p kubeReservedCgroup helps the kubelet identify absolute name of top level CGroup used to enforce code KubeReserved code compute resource reservation for Kubernetes node system daemons Refer to a href https kubernetes io docs tasks administer cluster reserve compute resources node allocatable Node Allocatable a doc for more information Default quot quot p td tr tr td code enforceNodeAllocatable code br code string code td td p This flag specifies the various Node Allocatable enforcements that Kubelet needs to perform This flag accepts a list of options Acceptable options are code none code code pods code code system reserved code and code kube reserved code If code none code is specified no other options may be specified When code system reserved code is in the list systemReservedCgroup must be specified When code kube reserved code is in the list kubeReservedCgroup must be specified This field is supported only when code cgroupsPerQOS code is set to true Refer to a href https kubernetes io docs tasks administer cluster reserve compute resources node allocatable Node Allocatable a for more information Default quot pods quot p td tr tr td code allowedUnsafeSysctls code br code string code td td p A comma separated whitelist of unsafe sysctls or sysctl patterns ending in code code Unsafe sysctl groups are code kernel shm code code kernel msg code code kernel sem code code fs mqueue code and code net code For example quot code kernel msg net ipv4 route min pmtu code quot Default p td tr tr td code volumePluginDir code br code string code td td p volumePluginDir is the full path of the directory in which to search for additional third party volume plugins Default quot usr libexec kubernetes kubelet plugins volume exec quot p td tr tr td code providerID code br code string code td td p providerID if set sets the unique ID of the instance that an external provider i e cloudprovider can use to identify a specific node Default quot quot p td tr tr td code kernelMemcgNotification code br code bool code td td p kernelMemcgNotification if set instructs the kubelet to integrate with the kernel memcg notification for determining if memory eviction thresholds are exceeded rather than polling Default false p td tr tr td code logging code B Required B br a href LoggingConfiguration code LoggingConfiguration code a td td p logging specifies the options of logging Refer to a href https github com kubernetes component base blob master logs options go Logs Options a for more information Default Format text p td tr tr td code enableSystemLogHandler code br code bool code td td p enableSystemLogHandler enables system logs via web interface host port logs Default true p td tr tr td code enableSystemLogQuery code br code bool code td td p enableSystemLogQuery enables the node log query feature on the logs endpoint EnableSystemLogHandler has to be enabled in addition for this feature to work Default false p td tr tr td code shutdownGracePeriod 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 shutdownGracePeriod specifies the total duration that the node should delay the shutdown and total grace period for pod termination during a node shutdown Default quot 0s quot p td tr tr td code shutdownGracePeriodCriticalPods 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 shutdownGracePeriodCriticalPods specifies the duration used to terminate critical pods during a node shutdown This should be less than shutdownGracePeriod For example if shutdownGracePeriod 30s and shutdownGracePeriodCriticalPods 10s during a node shutdown the first 20 seconds would be reserved for gracefully terminating normal pods and the last 10 seconds would be reserved for terminating critical pods Default quot 0s quot p td tr tr td code shutdownGracePeriodByPodPriority code br a href kubelet config k8s io v1beta1 ShutdownGracePeriodByPodPriority code ShutdownGracePeriodByPodPriority code a td td p shutdownGracePeriodByPodPriority specifies the shutdown grace period for Pods based on their associated priority class value When a shutdown request is received the Kubelet will initiate shutdown on all pods running on the node with a grace period that depends on the priority of the pod and then wait for all pods to exit Each entry in the array represents the graceful shutdown time a pod with a priority class value that lies in the range of that value and the next higher entry in the list when the node is shutting down For example to allow critical pods 10s to shutdown priority gt 10000 pods 20s to shutdown and all remaining pods 30s to shutdown p p shutdownGracePeriodByPodPriority p ul li priority 2000000000 shutdownGracePeriodSeconds 10 li li priority 10000 shutdownGracePeriodSeconds 20 li li priority 0 shutdownGracePeriodSeconds 30 li ul p The time the Kubelet will wait before exiting will at most be the maximum of all shutdownGracePeriodSeconds for each priority class range represented on the node When all pods have exited or reached their grace periods the Kubelet will release the shutdown inhibit lock Requires the GracefulNodeShutdown feature gate to be enabled This configuration must be empty if either ShutdownGracePeriod or ShutdownGracePeriodCriticalPods is set Default nil p td tr tr td code reservedMemory code br a href kubelet config k8s io v1beta1 MemoryReservation code MemoryReservation code a td td p reservedMemory specifies a comma separated list of memory reservations for NUMA nodes The parameter makes sense only in the context of the memory manager feature The memory manager will not allocate reserved memory for container workloads For example if you have a NUMA0 with 10Gi of memory and the reservedMemory was specified to reserve 1Gi of memory at NUMA0 the memory manager will assume that only 9Gi is available for allocation You can specify a different amount of NUMA node and memory types You can omit this parameter at all but you should be aware that the amount of reserved memory from all NUMA nodes should be equal to the amount of memory specified by the a href https kubernetes io docs tasks administer cluster reserve compute resources node allocatable node allocatable a If at least one node allocatable parameter has a non zero value you will need to specify at least one NUMA node Also avoid specifying p ol li Duplicates the same NUMA node and memory type but with a different value li li zero limits for any memory type li li NUMAs nodes IDs that do not exist under the machine li li memory types except for memory and hugepages raw HTML omitted li ol p Default nil p td tr tr td code enableProfilingHandler code br code bool code td td p enableProfilingHandler enables profiling via web interface host port debug pprof Default true p td tr tr td code enableDebugFlagsHandler code br code bool code td td p enableDebugFlagsHandler enables flags endpoint via web interface host port debug flags v Default true p td tr tr td code seccompDefault code br code bool code td td p SeccompDefault enables the use of code RuntimeDefault code as the default seccomp profile for all workloads Default false p td tr tr td code memoryThrottlingFactor code br code float64 code td td p MemoryThrottlingFactor specifies the factor multiplied by the memory limit or node allocatable memory when setting the cgroupv2 memory high value to enforce MemoryQoS Decreasing this factor will set lower high limit for container cgroups and put heavier reclaim pressure while increasing will put less reclaim pressure See https kep k8s io 2570 for more details Default 0 9 p td tr tr td code registerWithTaints code 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 registerWithTaints are an array of taints to add to a node object when the kubelet registers itself This only takes effect when registerNode is true and upon the initial registration of the node Default nil p td tr tr td code registerNode code br code bool code td td p registerNode enables automatic registration with the apiserver Default true p td tr tr td code tracing code br a href TracingConfiguration code TracingConfiguration code a td td p Tracing specifies the versioned configuration for OpenTelemetry tracing clients See https kep k8s io 2832 for more details Default nil p td tr tr td code localStorageCapacityIsolation code br code bool code td td p LocalStorageCapacityIsolation enables local ephemeral storage isolation feature The default setting is true This feature allows users to set request limit for container s ephemeral storage and manage it in a similar way as cpu and memory It also allows setting sizeLimit for emptyDir volume which will trigger pod eviction if disk usage from the volume exceeds the limit This feature depends on the capability of detecting correct root file system disk usage For certain systems such as kind rootless if this capability cannot be supported the feature LocalStorageCapacityIsolation should be disabled Once disabled user should not set request limit for container s ephemeral storage or sizeLimit for emptyDir Default true p td tr tr td code containerRuntimeEndpoint code B Required B br code string code td td p ContainerRuntimeEndpoint is the endpoint of container runtime Unix Domain Sockets are supported on Linux while npipe and tcp endpoints are supported on Windows Examples unix path to runtime sock npipe pipe runtime p td tr tr td code imageServiceEndpoint code br code string code td td p ImageServiceEndpoint is the endpoint of container image service Unix Domain Socket are supported on Linux while npipe and tcp endpoints are supported on Windows Examples unix path to runtime sock npipe pipe runtime If not specified the value in containerRuntimeEndpoint is used p td tr tr td code failCgroupV1 code br code bool code td td p FailCgroupV1 prevents the kubelet from starting on hosts that use cgroup v1 By default this is set to false meaning the kubelet is allowed to start on cgroup v1 hosts unless this option is explicitly enabled Default false p td tr tbody table SerializedNodeConfigSource kubelet config k8s io v1beta1 SerializedNodeConfigSource p SerializedNodeConfigSource allows us to serialize v1 NodeConfigSource This type is used internally by the Kubelet for tracking checkpointed dynamic configs It exists in the kubeletconfig API group because it is classified as a versioned input to the Kubelet 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 kubelet config k8s io v1beta1 code td tr tr td code kind code br string td td code SerializedNodeConfigSource code td tr tr td code source code br a href https kubernetes io docs reference generated kubernetes api v1 31 nodeconfigsource v1 core code core v1 NodeConfigSource code a td td p source is the source that we are serializing p td tr tbody table CredentialProvider kubelet config k8s io v1beta1 CredentialProvider Appears in CredentialProviderConfig kubelet config k8s io v1beta1 CredentialProviderConfig p CredentialProvider represents an exec plugin to be invoked by the kubelet The plugin is only invoked when an image being pulled matches the images handled by the plugin see matchImages 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 required name of the credential provider It must match the name of the provider executable as seen by the kubelet The executable must be in the kubelet s bin directory set by the image credential provider bin dir flag p td tr tr td code matchImages code B Required B br code string code td td p matchImages is a required list of strings used to match against images in order to determine if this provider should be invoked If one of the strings matches the requested image from the kubelet the plugin will be invoked and given a chance to provide credentials Images are expected to contain the registry domain and URL path p p Each entry in matchImages is a pattern which can optionally contain a port and a path Globs can be used in the domain but not in the port or the path Globs are supported as subdomains like em k8s io or k8s em io and top level domains such as k8s em Matching partial subdomains like app em k8s io is also supported Each glob can only match a single subdomain segment so io does not match k8s io p p A match exists between an image and a matchImage when all of the below are true p ul li Both contain the same number of domain parts and each part matches li li The URL path of an imageMatch must be a prefix of the target image URL path li li If the imageMatch contains a port then the port must match in the image as well li ul p Example values of matchImages p ul li 123456789 dkr ecr us east 1 amazonaws com li li azurecr io li li gcr io li li em em registry io li li registry io 8080 path li ul td tr tr td code defaultCacheDuration 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 defaultCacheDuration is the default duration the plugin will cache credentials in memory if a cache duration is not provided in the plugin response This field is required p td tr tr td code apiVersion code B Required B br code string code td td p Required input version of the exec CredentialProviderRequest The returned CredentialProviderResponse MUST use the same encoding version as the input Current supported values are p ul li credentialprovider kubelet k8s io v1beta1 li ul td tr tr td code args code br code string code td td p Arguments to pass to the command when executing it p td tr tr td code env code br a href kubelet config k8s io v1beta1 ExecEnvVar code ExecEnvVar code a td td p Env defines additional environment variables to expose to the process These are unioned with the host s environment as well as variables client go uses to pass argument to the plugin p td tr tbody table ExecEnvVar kubelet config k8s io v1beta1 ExecEnvVar Appears in CredentialProvider kubelet config k8s io v1beta1 CredentialProvider p ExecEnvVar is used for setting environment variables when executing an exec based credential plugin 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 span class text muted No description provided span td tr tr td code value code B Required B br code string code td td span class text muted No description provided span td tr tbody table KubeletAnonymousAuthentication kubelet config k8s io v1beta1 KubeletAnonymousAuthentication Appears in KubeletAuthentication kubelet config k8s io v1beta1 KubeletAuthentication table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code enabled code br code bool code td td p enabled allows 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 p td tr tbody table KubeletAuthentication kubelet config k8s io v1beta1 KubeletAuthentication Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code x509 code br a href kubelet config k8s io v1beta1 KubeletX509Authentication code KubeletX509Authentication code a td td p x509 contains settings related to x509 client certificate authentication p td tr tr td code webhook code br a href kubelet config k8s io v1beta1 KubeletWebhookAuthentication code KubeletWebhookAuthentication code a td td p webhook contains settings related to webhook bearer token authentication p td tr tr td code anonymous code br a href kubelet config k8s io v1beta1 KubeletAnonymousAuthentication code KubeletAnonymousAuthentication code a td td p anonymous contains settings related to anonymous authentication p td tr tbody table KubeletAuthorization kubelet config k8s io v1beta1 KubeletAuthorization Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code mode code br a href kubelet config k8s io v1beta1 KubeletAuthorizationMode code KubeletAuthorizationMode code a td td p mode is the authorization mode to apply to requests to the kubelet server Valid values are code AlwaysAllow code and code Webhook code Webhook mode uses the SubjectAccessReview API to determine authorization p td tr tr td code webhook code br a href kubelet config k8s io v1beta1 KubeletWebhookAuthorization code KubeletWebhookAuthorization code a td td p webhook contains settings related to Webhook authorization p td tr tbody table KubeletAuthorizationMode kubelet config k8s io v1beta1 KubeletAuthorizationMode Alias of string Appears in KubeletAuthorization kubelet config k8s io v1beta1 KubeletAuthorization KubeletWebhookAuthentication kubelet config k8s io v1beta1 KubeletWebhookAuthentication Appears in KubeletAuthentication kubelet config k8s io v1beta1 KubeletAuthentication table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code enabled code br code bool code td td p enabled allows bearer token authentication backed by the tokenreviews authentication k8s io API p td tr tr td code cacheTTL 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 cacheTTL enables caching of authentication results p td tr tbody table KubeletWebhookAuthorization kubelet config k8s io v1beta1 KubeletWebhookAuthorization Appears in KubeletAuthorization kubelet config k8s io v1beta1 KubeletAuthorization table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code cacheAuthorizedTTL 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 cacheAuthorizedTTL is the duration to cache authorized responses from the webhook authorizer p td tr tr td code cacheUnauthorizedTTL 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 cacheUnauthorizedTTL is the duration to cache unauthorized responses from the webhook authorizer p td tr tbody table KubeletX509Authentication kubelet config k8s io v1beta1 KubeletX509Authentication Appears in KubeletAuthentication kubelet config k8s io v1beta1 KubeletAuthentication table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code clientCAFile code br code string code td td p clientCAFile is the path to a PEM encoded certificate bundle If set any request presenting a client certificate signed by one of the authorities in the bundle is authenticated with a username corresponding to the CommonName and groups corresponding to the Organization in the client certificate p td tr tbody table MemoryReservation kubelet config k8s io v1beta1 MemoryReservation Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration p MemoryReservation specifies the memory reservation of different types for each NUMA node p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code numaNode code B Required B br code int32 code td td span class text muted No description provided span td tr tr td code limits code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 31 resourcelist v1 core code core v1 ResourceList code a td td span class text muted No description provided span td tr tbody table MemorySwapConfiguration kubelet config k8s io v1beta1 MemorySwapConfiguration Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code swapBehavior code br code string code td td p swapBehavior configures swap memory available to container workloads May be one of quot quot quot NoSwap quot workloads can not use swap default option quot LimitedSwap quot workload swap usage is limited The swap limit is proportionate to the container s memory request p td tr tbody table ResourceChangeDetectionStrategy kubelet config k8s io v1beta1 ResourceChangeDetectionStrategy Alias of string Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration p ResourceChangeDetectionStrategy denotes a mode in which internal managers secret configmap are discovering object changes p ShutdownGracePeriodByPodPriority kubelet config k8s io v1beta1 ShutdownGracePeriodByPodPriority Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration p ShutdownGracePeriodByPodPriority specifies the shutdown grace period for Pods based on their associated priority class value p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code priority code B Required B br code int32 code td td p priority is the priority value associated with the shutdown grace period p td tr tr td code shutdownGracePeriodSeconds code B Required B br code int64 code td td p shutdownGracePeriodSeconds is the shutdown grace period in seconds p td tr tbody table |
kubernetes reference package v1 title kubeconfig v1 contenttype tool reference Resource Types autogenerated true | ---
title: kubeconfig (v1)
content_type: tool-reference
package: v1
auto_generated: true
---
## Resource Types
- [Config](#Config)
## `Config` {#Config}
<p>Config holds the information needed to build connect to remote kubernetes clusters as a given user</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>/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>Config</code></td></tr>
<tr><td><code>kind</code><br/>
<code>string</code>
</td>
<td>
<p>Legacy field from pkg/api/types.go TypeMeta.
TODO(jlowdermilk): remove this after eliminating downstream dependencies.</p>
</td>
</tr>
<tr><td><code>apiVersion</code><br/>
<code>string</code>
</td>
<td>
<p>Legacy field from pkg/api/types.go TypeMeta.
TODO(jlowdermilk): remove this after eliminating downstream dependencies.</p>
</td>
</tr>
<tr><td><code>preferences</code> <B>[Required]</B><br/>
<a href="#Preferences"><code>Preferences</code></a>
</td>
<td>
<p>Preferences holds general information to be use for cli interactions</p>
</td>
</tr>
<tr><td><code>clusters</code> <B>[Required]</B><br/>
<a href="#NamedCluster"><code>[]NamedCluster</code></a>
</td>
<td>
<p>Clusters is a map of referencable names to cluster configs</p>
</td>
</tr>
<tr><td><code>users</code> <B>[Required]</B><br/>
<a href="#NamedAuthInfo"><code>[]NamedAuthInfo</code></a>
</td>
<td>
<p>AuthInfos is a map of referencable names to user configs</p>
</td>
</tr>
<tr><td><code>contexts</code> <B>[Required]</B><br/>
<a href="#NamedContext"><code>[]NamedContext</code></a>
</td>
<td>
<p>Contexts is a map of referencable names to context configs</p>
</td>
</tr>
<tr><td><code>current-context</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>CurrentContext is the name of the context that you would like to use by default</p>
</td>
</tr>
<tr><td><code>extensions</code><br/>
<a href="#NamedExtension"><code>[]NamedExtension</code></a>
</td>
<td>
<p>Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields</p>
</td>
</tr>
</tbody>
</table>
## `AuthInfo` {#AuthInfo}
**Appears in:**
- [NamedAuthInfo](#NamedAuthInfo)
<p>AuthInfo contains information that describes identity information. This is use to tell the kubernetes cluster who you are.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>client-certificate</code><br/>
<code>string</code>
</td>
<td>
<p>ClientCertificate is the path to a client cert file for TLS.</p>
</td>
</tr>
<tr><td><code>client-certificate-data</code><br/>
<code>[]byte</code>
</td>
<td>
<p>ClientCertificateData contains PEM-encoded data from a client cert file for TLS. Overrides ClientCertificate</p>
</td>
</tr>
<tr><td><code>client-key</code><br/>
<code>string</code>
</td>
<td>
<p>ClientKey is the path to a client key file for TLS.</p>
</td>
</tr>
<tr><td><code>client-key-data</code><br/>
<code>[]byte</code>
</td>
<td>
<p>ClientKeyData contains PEM-encoded data from a client key file for TLS. Overrides ClientKey</p>
</td>
</tr>
<tr><td><code>token</code><br/>
<code>string</code>
</td>
<td>
<p>Token is the bearer token for authentication to the kubernetes cluster.</p>
</td>
</tr>
<tr><td><code>tokenFile</code><br/>
<code>string</code>
</td>
<td>
<p>TokenFile is a pointer to a file that contains a bearer token (as described above). If both Token and TokenFile are present, Token takes precedence.</p>
</td>
</tr>
<tr><td><code>as</code><br/>
<code>string</code>
</td>
<td>
<p>Impersonate is the username to impersonate. The name matches the flag.</p>
</td>
</tr>
<tr><td><code>as-uid</code><br/>
<code>string</code>
</td>
<td>
<p>ImpersonateUID is the uid to impersonate.</p>
</td>
</tr>
<tr><td><code>as-groups</code><br/>
<code>[]string</code>
</td>
<td>
<p>ImpersonateGroups is the groups to impersonate.</p>
</td>
</tr>
<tr><td><code>as-user-extra</code><br/>
<code>map[string][]string</code>
</td>
<td>
<p>ImpersonateUserExtra contains additional information for impersonated user.</p>
</td>
</tr>
<tr><td><code>username</code><br/>
<code>string</code>
</td>
<td>
<p>Username is the username for basic authentication to the kubernetes cluster.</p>
</td>
</tr>
<tr><td><code>password</code><br/>
<code>string</code>
</td>
<td>
<p>Password is the password for basic authentication to the kubernetes cluster.</p>
</td>
</tr>
<tr><td><code>auth-provider</code><br/>
<a href="#AuthProviderConfig"><code>AuthProviderConfig</code></a>
</td>
<td>
<p>AuthProvider specifies a custom authentication plugin for the kubernetes cluster.</p>
</td>
</tr>
<tr><td><code>exec</code><br/>
<a href="#ExecConfig"><code>ExecConfig</code></a>
</td>
<td>
<p>Exec specifies a custom exec-based authentication plugin for the kubernetes cluster.</p>
</td>
</tr>
<tr><td><code>extensions</code><br/>
<a href="#NamedExtension"><code>[]NamedExtension</code></a>
</td>
<td>
<p>Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields</p>
</td>
</tr>
</tbody>
</table>
## `AuthProviderConfig` {#AuthProviderConfig}
**Appears in:**
- [AuthInfo](#AuthInfo)
<p>AuthProviderConfig holds the configuration for a specified auth provider.</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>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>config</code> <B>[Required]</B><br/>
<code>map[string]string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `Cluster` {#Cluster}
**Appears in:**
- [NamedCluster](#NamedCluster)
<p>Cluster contains information about how to communicate with a kubernetes cluster</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>server</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Server is the address of the kubernetes cluster (https://hostname:port).</p>
</td>
</tr>
<tr><td><code>tls-server-name</code><br/>
<code>string</code>
</td>
<td>
<p>TLSServerName is used to check server certificate. If TLSServerName is empty, the hostname used to contact the server is used.</p>
</td>
</tr>
<tr><td><code>insecure-skip-tls-verify</code><br/>
<code>bool</code>
</td>
<td>
<p>InsecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure.</p>
</td>
</tr>
<tr><td><code>certificate-authority</code><br/>
<code>string</code>
</td>
<td>
<p>CertificateAuthority is the path to a cert file for the certificate authority.</p>
</td>
</tr>
<tr><td><code>certificate-authority-data</code><br/>
<code>[]byte</code>
</td>
<td>
<p>CertificateAuthorityData contains PEM-encoded certificate authority certificates. Overrides CertificateAuthority</p>
</td>
</tr>
<tr><td><code>proxy-url</code><br/>
<code>string</code>
</td>
<td>
<p>ProxyURL is the URL to the proxy to be used for all requests made by this
client. URLs with "http", "https", and "socks5" schemes are supported. If
this configuration is not provided or the empty string, the client
attempts to construct a proxy configuration from http_proxy and
https_proxy environment variables. If these environment variables are not
set, the client does not attempt to proxy requests.</p>
<p>socks5 proxying does not currently support spdy streaming endpoints (exec,
attach, port forward).</p>
</td>
</tr>
<tr><td><code>disable-compression</code><br/>
<code>bool</code>
</td>
<td>
<p>DisableCompression allows client to opt-out of response compression for all requests to the server. This is useful
to speed up requests (specifically lists) when client-server network bandwidth is ample, by saving time on
compression (server-side) and decompression (client-side): https://github.com/kubernetes/kubernetes/issues/112296.</p>
</td>
</tr>
<tr><td><code>extensions</code><br/>
<a href="#NamedExtension"><code>[]NamedExtension</code></a>
</td>
<td>
<p>Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields</p>
</td>
</tr>
</tbody>
</table>
## `Context` {#Context}
**Appears in:**
- [NamedContext](#NamedContext)
<p>Context is a tuple of references to a cluster (how do I communicate with a kubernetes cluster), a user (how do I identify myself), and a namespace (what subset of resources do I want to work with)</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>cluster</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Cluster is the name of the cluster for this context</p>
</td>
</tr>
<tr><td><code>user</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>AuthInfo is the name of the authInfo for this context</p>
</td>
</tr>
<tr><td><code>namespace</code><br/>
<code>string</code>
</td>
<td>
<p>Namespace is the default namespace to use on unspecified requests</p>
</td>
</tr>
<tr><td><code>extensions</code><br/>
<a href="#NamedExtension"><code>[]NamedExtension</code></a>
</td>
<td>
<p>Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields</p>
</td>
</tr>
</tbody>
</table>
## `ExecConfig` {#ExecConfig}
**Appears in:**
- [AuthInfo](#AuthInfo)
<p>ExecConfig specifies a command to provide client credentials. The command is exec'd
and outputs structured stdout holding credentials.</p>
<p>See the client.authentication.k8s.io API group for specifications of the exact input
and output format</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>command</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Command to execute.</p>
</td>
</tr>
<tr><td><code>args</code><br/>
<code>[]string</code>
</td>
<td>
<p>Arguments to pass to the command when executing it.</p>
</td>
</tr>
<tr><td><code>env</code><br/>
<a href="#ExecEnvVar"><code>[]ExecEnvVar</code></a>
</td>
<td>
<p>Env defines additional environment variables to expose to the process. These
are unioned with the host's environment, as well as variables client-go uses
to pass argument to the plugin.</p>
</td>
</tr>
<tr><td><code>apiVersion</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Preferred input version of the ExecInfo. The returned ExecCredentials MUST use
the same encoding version as the input.</p>
</td>
</tr>
<tr><td><code>installHint</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>This text is shown to the user when the executable doesn't seem to be
present. For example, <code>brew install foo-cli</code> might be a good InstallHint for
foo-cli on Mac OS systems.</p>
</td>
</tr>
<tr><td><code>provideClusterInfo</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>ProvideClusterInfo determines whether or not to provide cluster information,
which could potentially contain very large CA data, to this exec plugin as a
part of the KUBERNETES_EXEC_INFO environment variable. By default, it is set
to false. Package k8s.io/client-go/tools/auth/exec provides helper methods for
reading this environment variable.</p>
</td>
</tr>
<tr><td><code>interactiveMode</code><br/>
<a href="#ExecInteractiveMode"><code>ExecInteractiveMode</code></a>
</td>
<td>
<p>InteractiveMode determines this plugin's relationship with standard input. Valid
values are "Never" (this exec plugin never uses standard input), "IfAvailable" (this
exec plugin wants to use standard input if it is available), or "Always" (this exec
plugin requires standard input to function). See ExecInteractiveMode values for more
details.</p>
<p>If APIVersion is client.authentication.k8s.io/v1alpha1 or
client.authentication.k8s.io/v1beta1, then this field is optional and defaults
to "IfAvailable" when unset. Otherwise, this field is required.</p>
</td>
</tr>
</tbody>
</table>
## `ExecEnvVar` {#ExecEnvVar}
**Appears in:**
- [ExecConfig](#ExecConfig)
<p>ExecEnvVar is used for setting environment variables when executing an exec-based
credential plugin.</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>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>value</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
## `ExecInteractiveMode` {#ExecInteractiveMode}
(Alias of `string`)
**Appears in:**
- [ExecConfig](#ExecConfig)
<p>ExecInteractiveMode is a string that describes an exec plugin's relationship with standard input.</p>
## `NamedAuthInfo` {#NamedAuthInfo}
**Appears in:**
- [Config](#Config)
<p>NamedAuthInfo relates nicknames to auth information</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 nickname for this AuthInfo</p>
</td>
</tr>
<tr><td><code>user</code> <B>[Required]</B><br/>
<a href="#AuthInfo"><code>AuthInfo</code></a>
</td>
<td>
<p>AuthInfo holds the auth information</p>
</td>
</tr>
</tbody>
</table>
## `NamedCluster` {#NamedCluster}
**Appears in:**
- [Config](#Config)
<p>NamedCluster relates nicknames to cluster information</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 nickname for this Cluster</p>
</td>
</tr>
<tr><td><code>cluster</code> <B>[Required]</B><br/>
<a href="#Cluster"><code>Cluster</code></a>
</td>
<td>
<p>Cluster holds the cluster information</p>
</td>
</tr>
</tbody>
</table>
## `NamedContext` {#NamedContext}
**Appears in:**
- [Config](#Config)
<p>NamedContext relates nicknames to context information</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 nickname for this Context</p>
</td>
</tr>
<tr><td><code>context</code> <B>[Required]</B><br/>
<a href="#Context"><code>Context</code></a>
</td>
<td>
<p>Context holds the context information</p>
</td>
</tr>
</tbody>
</table>
## `NamedExtension` {#NamedExtension}
**Appears in:**
- [Config](#Config)
- [AuthInfo](#AuthInfo)
- [Cluster](#Cluster)
- [Context](#Context)
- [Preferences](#Preferences)
<p>NamedExtension relates nicknames to extension information</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 nickname for this Extension</p>
</td>
</tr>
<tr><td><code>extension</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
</td>
<td>
<p>Extension holds the extension information</p>
</td>
</tr>
</tbody>
</table>
## `Preferences` {#Preferences}
**Appears in:**
- [Config](#Config)
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>colors</code><br/>
<code>bool</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>extensions</code><br/>
<a href="#NamedExtension"><code>[]NamedExtension</code></a>
</td>
<td>
<p>Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields</p>
</td>
</tr>
</tbody>
</table | kubernetes reference | title kubeconfig v1 content type tool reference package v1 auto generated true Resource Types Config Config Config Config p Config holds the information needed to build connect to remote kubernetes clusters as a given user 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 v1 code td tr tr td code kind code br string td td code Config code td tr tr td code kind code br code string code td td p Legacy field from pkg api types go TypeMeta TODO jlowdermilk remove this after eliminating downstream dependencies p td tr tr td code apiVersion code br code string code td td p Legacy field from pkg api types go TypeMeta TODO jlowdermilk remove this after eliminating downstream dependencies p td tr tr td code preferences code B Required B br a href Preferences code Preferences code a td td p Preferences holds general information to be use for cli interactions p td tr tr td code clusters code B Required B br a href NamedCluster code NamedCluster code a td td p Clusters is a map of referencable names to cluster configs p td tr tr td code users code B Required B br a href NamedAuthInfo code NamedAuthInfo code a td td p AuthInfos is a map of referencable names to user configs p td tr tr td code contexts code B Required B br a href NamedContext code NamedContext code a td td p Contexts is a map of referencable names to context configs p td tr tr td code current context code B Required B br code string code td td p CurrentContext is the name of the context that you would like to use by default p td tr tr td code extensions code br a href NamedExtension code NamedExtension code a td td p Extensions holds additional information This is useful for extenders so that reads and writes don t clobber unknown fields p td tr tbody table AuthInfo AuthInfo Appears in NamedAuthInfo NamedAuthInfo p AuthInfo contains information that describes identity information This is use to tell the kubernetes cluster who you are p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code client certificate code br code string code td td p ClientCertificate is the path to a client cert file for TLS p td tr tr td code client certificate data code br code byte code td td p ClientCertificateData contains PEM encoded data from a client cert file for TLS Overrides ClientCertificate p td tr tr td code client key code br code string code td td p ClientKey is the path to a client key file for TLS p td tr tr td code client key data code br code byte code td td p ClientKeyData contains PEM encoded data from a client key file for TLS Overrides ClientKey p td tr tr td code token code br code string code td td p Token is the bearer token for authentication to the kubernetes cluster p td tr tr td code tokenFile code br code string code td td p TokenFile is a pointer to a file that contains a bearer token as described above If both Token and TokenFile are present Token takes precedence p td tr tr td code as code br code string code td td p Impersonate is the username to impersonate The name matches the flag p td tr tr td code as uid code br code string code td td p ImpersonateUID is the uid to impersonate p td tr tr td code as groups code br code string code td td p ImpersonateGroups is the groups to impersonate p td tr tr td code as user extra code br code map string string code td td p ImpersonateUserExtra contains additional information for impersonated user p td tr tr td code username code br code string code td td p Username is the username for basic authentication to the kubernetes cluster p td tr tr td code password code br code string code td td p Password is the password for basic authentication to the kubernetes cluster p td tr tr td code auth provider code br a href AuthProviderConfig code AuthProviderConfig code a td td p AuthProvider specifies a custom authentication plugin for the kubernetes cluster p td tr tr td code exec code br a href ExecConfig code ExecConfig code a td td p Exec specifies a custom exec based authentication plugin for the kubernetes cluster p td tr tr td code extensions code br a href NamedExtension code NamedExtension code a td td p Extensions holds additional information This is useful for extenders so that reads and writes don t clobber unknown fields p td tr tbody table AuthProviderConfig AuthProviderConfig Appears in AuthInfo AuthInfo p AuthProviderConfig holds the configuration for a specified auth provider 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 span class text muted No description provided span td tr tr td code config code B Required B br code map string string code td td span class text muted No description provided span td tr tbody table Cluster Cluster Appears in NamedCluster NamedCluster p Cluster contains information about how to communicate with a kubernetes cluster p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code server code B Required B br code string code td td p Server is the address of the kubernetes cluster https hostname port p td tr tr td code tls server name code br code string code td td p TLSServerName is used to check server certificate If TLSServerName is empty the hostname used to contact the server is used p td tr tr td code insecure skip tls verify code br code bool code td td p InsecureSkipTLSVerify skips the validity check for the server s certificate This will make your HTTPS connections insecure p td tr tr td code certificate authority code br code string code td td p CertificateAuthority is the path to a cert file for the certificate authority p td tr tr td code certificate authority data code br code byte code td td p CertificateAuthorityData contains PEM encoded certificate authority certificates Overrides CertificateAuthority p td tr tr td code proxy url code br code string code td td p ProxyURL is the URL to the proxy to be used for all requests made by this client URLs with quot http quot quot https quot and quot socks5 quot schemes are supported If this configuration is not provided or the empty string the client attempts to construct a proxy configuration from http proxy and https proxy environment variables If these environment variables are not set the client does not attempt to proxy requests p p socks5 proxying does not currently support spdy streaming endpoints exec attach port forward p td tr tr td code disable compression code br code bool code td td p DisableCompression allows client to opt out of response compression for all requests to the server This is useful to speed up requests specifically lists when client server network bandwidth is ample by saving time on compression server side and decompression client side https github com kubernetes kubernetes issues 112296 p td tr tr td code extensions code br a href NamedExtension code NamedExtension code a td td p Extensions holds additional information This is useful for extenders so that reads and writes don t clobber unknown fields p td tr tbody table Context Context Appears in NamedContext NamedContext p Context is a tuple of references to a cluster how do I communicate with a kubernetes cluster a user how do I identify myself and a namespace what subset of resources do I want to work with p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code cluster code B Required B br code string code td td p Cluster is the name of the cluster for this context p td tr tr td code user code B Required B br code string code td td p AuthInfo is the name of the authInfo for this context p td tr tr td code namespace code br code string code td td p Namespace is the default namespace to use on unspecified requests p td tr tr td code extensions code br a href NamedExtension code NamedExtension code a td td p Extensions holds additional information This is useful for extenders so that reads and writes don t clobber unknown fields p td tr tbody table ExecConfig ExecConfig Appears in AuthInfo AuthInfo p ExecConfig specifies a command to provide client credentials The command is exec d and outputs structured stdout holding credentials p p See the client authentication k8s io API group for specifications of the exact input and output format p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code command code B Required B br code string code td td p Command to execute p td tr tr td code args code br code string code td td p Arguments to pass to the command when executing it p td tr tr td code env code br a href ExecEnvVar code ExecEnvVar code a td td p Env defines additional environment variables to expose to the process These are unioned with the host s environment as well as variables client go uses to pass argument to the plugin p td tr tr td code apiVersion code B Required B br code string code td td p Preferred input version of the ExecInfo The returned ExecCredentials MUST use the same encoding version as the input p td tr tr td code installHint code B Required B br code string code td td p This text is shown to the user when the executable doesn t seem to be present For example code brew install foo cli code might be a good InstallHint for foo cli on Mac OS systems p td tr tr td code provideClusterInfo code B Required B br code bool code td td p ProvideClusterInfo determines whether or not to provide cluster information which could potentially contain very large CA data to this exec plugin as a part of the KUBERNETES EXEC INFO environment variable By default it is set to false Package k8s io client go tools auth exec provides helper methods for reading this environment variable p td tr tr td code interactiveMode code br a href ExecInteractiveMode code ExecInteractiveMode code a td td p InteractiveMode determines this plugin s relationship with standard input Valid values are quot Never quot this exec plugin never uses standard input quot IfAvailable quot this exec plugin wants to use standard input if it is available or quot Always quot this exec plugin requires standard input to function See ExecInteractiveMode values for more details p p If APIVersion is client authentication k8s io v1alpha1 or client authentication k8s io v1beta1 then this field is optional and defaults to quot IfAvailable quot when unset Otherwise this field is required p td tr tbody table ExecEnvVar ExecEnvVar Appears in ExecConfig ExecConfig p ExecEnvVar is used for setting environment variables when executing an exec based credential plugin 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 span class text muted No description provided span td tr tr td code value code B Required B br code string code td td span class text muted No description provided span td tr tbody table ExecInteractiveMode ExecInteractiveMode Alias of string Appears in ExecConfig ExecConfig p ExecInteractiveMode is a string that describes an exec plugin s relationship with standard input p NamedAuthInfo NamedAuthInfo Appears in Config Config p NamedAuthInfo relates nicknames to auth information 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 nickname for this AuthInfo p td tr tr td code user code B Required B br a href AuthInfo code AuthInfo code a td td p AuthInfo holds the auth information p td tr tbody table NamedCluster NamedCluster Appears in Config Config p NamedCluster relates nicknames to cluster information 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 nickname for this Cluster p td tr tr td code cluster code B Required B br a href Cluster code Cluster code a td td p Cluster holds the cluster information p td tr tbody table NamedContext NamedContext Appears in Config Config p NamedContext relates nicknames to context information 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 nickname for this Context p td tr tr td code context code B Required B br a href Context code Context code a td td p Context holds the context information p td tr tbody table NamedExtension NamedExtension Appears in Config Config AuthInfo AuthInfo Cluster Cluster Context Context Preferences Preferences p NamedExtension relates nicknames to extension information 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 nickname for this Extension p td tr tr td code extension code B Required B br a href https pkg go dev k8s io apimachinery pkg runtime RawExtension code k8s io apimachinery pkg runtime RawExtension code a td td p Extension holds the extension information p td tr tbody table Preferences Preferences Appears in Config Config table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code colors code br code bool code td td span class text muted No description provided span td tr tr td code extensions code br a href NamedExtension code NamedExtension code a td td p Extensions holds additional information This is useful for extenders so that reads and writes don t clobber unknown fields p td tr tbody table |
kubernetes reference contenttype tool reference Resource Types package client authentication k8s io v1 autogenerated true title Client Authentication v1 | ---
title: Client Authentication (v1)
content_type: tool-reference
package: client.authentication.k8s.io/v1
auto_generated: true
---
## Resource Types
- [ExecCredential](#client-authentication-k8s-io-v1-ExecCredential)
## `ExecCredential` {#client-authentication-k8s-io-v1-ExecCredential}
<p>ExecCredential is used by exec-based plugins to communicate credentials to
HTTP transports.</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>client.authentication.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>ExecCredential</code></td></tr>
<tr><td><code>spec</code> <B>[Required]</B><br/>
<a href="#client-authentication-k8s-io-v1-ExecCredentialSpec"><code>ExecCredentialSpec</code></a>
</td>
<td>
<p>Spec holds information passed to the plugin by the transport.</p>
</td>
</tr>
<tr><td><code>status</code><br/>
<a href="#client-authentication-k8s-io-v1-ExecCredentialStatus"><code>ExecCredentialStatus</code></a>
</td>
<td>
<p>Status is filled in by the plugin and holds the credentials that the transport
should use to contact the API.</p>
</td>
</tr>
</tbody>
</table>
## `Cluster` {#client-authentication-k8s-io-v1-Cluster}
**Appears in:**
- [ExecCredentialSpec](#client-authentication-k8s-io-v1-ExecCredentialSpec)
<p>Cluster contains information to allow an exec plugin to communicate
with the kubernetes cluster being authenticated to.</p>
<p>To ensure that this struct contains everything someone would need to communicate
with a kubernetes cluster (just like they would via a kubeconfig), the fields
should shadow "k8s.io/client-go/tools/clientcmd/api/v1".Cluster, with the exception
of CertificateAuthority, since CA data will always be passed to the plugin as bytes.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>server</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Server is the address of the kubernetes cluster (https://hostname:port).</p>
</td>
</tr>
<tr><td><code>tls-server-name</code><br/>
<code>string</code>
</td>
<td>
<p>TLSServerName is passed to the server for SNI and is used in the client to
check server certificates against. If ServerName is empty, the hostname
used to contact the server is used.</p>
</td>
</tr>
<tr><td><code>insecure-skip-tls-verify</code><br/>
<code>bool</code>
</td>
<td>
<p>InsecureSkipTLSVerify skips the validity check for the server's certificate.
This will make your HTTPS connections insecure.</p>
</td>
</tr>
<tr><td><code>certificate-authority-data</code><br/>
<code>[]byte</code>
</td>
<td>
<p>CAData contains PEM-encoded certificate authority certificates.
If empty, system roots should be used.</p>
</td>
</tr>
<tr><td><code>proxy-url</code><br/>
<code>string</code>
</td>
<td>
<p>ProxyURL is the URL to the proxy to be used for all requests to this
cluster.</p>
</td>
</tr>
<tr><td><code>disable-compression</code><br/>
<code>bool</code>
</td>
<td>
<p>DisableCompression allows client to opt-out of response compression for all requests to the server. This is useful
to speed up requests (specifically lists) when client-server network bandwidth is ample, by saving time on
compression (server-side) and decompression (client-side): https://github.com/kubernetes/kubernetes/issues/112296.</p>
</td>
</tr>
<tr><td><code>config</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
</td>
<td>
<p>Config holds additional config data that is specific to the exec
plugin with regards to the cluster being authenticated to.</p>
<p>This data is sourced from the clientcmd Cluster object's
extensions[client.authentication.k8s.io/exec] field:</p>
<p>clusters:</p>
<ul>
<li>name: my-cluster
cluster:
...
extensions:
<ul>
<li>name: client.authentication.k8s.io/exec # reserved extension name for per cluster exec config
extension:
audience: 06e3fbd18de8 # arbitrary config</li>
</ul>
</li>
</ul>
<p>In some environments, the user config may be exactly the same across many clusters
(i.e. call this exec plugin) minus some details that are specific to each cluster
such as the audience. This field allows the per cluster config to be directly
specified with the cluster info. Using this field to store secret data is not
recommended as one of the prime benefits of exec plugins is that no secrets need
to be stored directly in the kubeconfig.</p>
</td>
</tr>
</tbody>
</table>
## `ExecCredentialSpec` {#client-authentication-k8s-io-v1-ExecCredentialSpec}
**Appears in:**
- [ExecCredential](#client-authentication-k8s-io-v1-ExecCredential)
<p>ExecCredentialSpec holds request and runtime specific information provided by
the transport.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>cluster</code><br/>
<a href="#client-authentication-k8s-io-v1-Cluster"><code>Cluster</code></a>
</td>
<td>
<p>Cluster contains information to allow an exec plugin to communicate with the
kubernetes cluster being authenticated to. Note that Cluster is non-nil only
when provideClusterInfo is set to true in the exec provider config (i.e.,
ExecConfig.ProvideClusterInfo).</p>
</td>
</tr>
<tr><td><code>interactive</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>Interactive declares whether stdin has been passed to this exec plugin.</p>
</td>
</tr>
</tbody>
</table>
## `ExecCredentialStatus` {#client-authentication-k8s-io-v1-ExecCredentialStatus}
**Appears in:**
- [ExecCredential](#client-authentication-k8s-io-v1-ExecCredential)
<p>ExecCredentialStatus holds credentials for the transport to use.</p>
<p>Token and ClientKeyData are sensitive fields. This data should only be
transmitted in-memory between client and exec plugin process. Exec plugin
itself should at least be protected via file permissions.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>expirationTimestamp</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>ExpirationTimestamp indicates a time when the provided credentials expire.</p>
</td>
</tr>
<tr><td><code>token</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Token is a bearer token used by the client for request authentication.</p>
</td>
</tr>
<tr><td><code>clientCertificateData</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>PEM-encoded client TLS certificates (including intermediates, if any).</p>
</td>
</tr>
<tr><td><code>clientKeyData</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>PEM-encoded private key for the above certificate.</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title Client Authentication v1 content type tool reference package client authentication k8s io v1 auto generated true Resource Types ExecCredential client authentication k8s io v1 ExecCredential ExecCredential client authentication k8s io v1 ExecCredential p ExecCredential is used by exec based plugins to communicate credentials to HTTP transports 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 client authentication k8s io v1 code td tr tr td code kind code br string td td code ExecCredential code td tr tr td code spec code B Required B br a href client authentication k8s io v1 ExecCredentialSpec code ExecCredentialSpec code a td td p Spec holds information passed to the plugin by the transport p td tr tr td code status code br a href client authentication k8s io v1 ExecCredentialStatus code ExecCredentialStatus code a td td p Status is filled in by the plugin and holds the credentials that the transport should use to contact the API p td tr tbody table Cluster client authentication k8s io v1 Cluster Appears in ExecCredentialSpec client authentication k8s io v1 ExecCredentialSpec p Cluster contains information to allow an exec plugin to communicate with the kubernetes cluster being authenticated to p p To ensure that this struct contains everything someone would need to communicate with a kubernetes cluster just like they would via a kubeconfig the fields should shadow quot k8s io client go tools clientcmd api v1 quot Cluster with the exception of CertificateAuthority since CA data will always be passed to the plugin as bytes p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code server code B Required B br code string code td td p Server is the address of the kubernetes cluster https hostname port p td tr tr td code tls server name code br code string code td td p TLSServerName is passed to the server for SNI and is used in the client to check server certificates against If ServerName is empty the hostname used to contact the server is used p td tr tr td code insecure skip tls verify code br code bool code td td p InsecureSkipTLSVerify skips the validity check for the server s certificate This will make your HTTPS connections insecure p td tr tr td code certificate authority data code br code byte code td td p CAData contains PEM encoded certificate authority certificates If empty system roots should be used p td tr tr td code proxy url code br code string code td td p ProxyURL is the URL to the proxy to be used for all requests to this cluster p td tr tr td code disable compression code br code bool code td td p DisableCompression allows client to opt out of response compression for all requests to the server This is useful to speed up requests specifically lists when client server network bandwidth is ample by saving time on compression server side and decompression client side https github com kubernetes kubernetes issues 112296 p td tr tr td code config code br a href https pkg go dev k8s io apimachinery pkg runtime RawExtension code k8s io apimachinery pkg runtime RawExtension code a td td p Config holds additional config data that is specific to the exec plugin with regards to the cluster being authenticated to p p This data is sourced from the clientcmd Cluster object s extensions client authentication k8s io exec field p p clusters p ul li name my cluster cluster extensions ul li name client authentication k8s io exec reserved extension name for per cluster exec config extension audience 06e3fbd18de8 arbitrary config li ul li ul p In some environments the user config may be exactly the same across many clusters i e call this exec plugin minus some details that are specific to each cluster such as the audience This field allows the per cluster config to be directly specified with the cluster info Using this field to store secret data is not recommended as one of the prime benefits of exec plugins is that no secrets need to be stored directly in the kubeconfig p td tr tbody table ExecCredentialSpec client authentication k8s io v1 ExecCredentialSpec Appears in ExecCredential client authentication k8s io v1 ExecCredential p ExecCredentialSpec holds request and runtime specific information provided by the transport p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code cluster code br a href client authentication k8s io v1 Cluster code Cluster code a td td p Cluster contains information to allow an exec plugin to communicate with the kubernetes cluster being authenticated to Note that Cluster is non nil only when provideClusterInfo is set to true in the exec provider config i e ExecConfig ProvideClusterInfo p td tr tr td code interactive code B Required B br code bool code td td p Interactive declares whether stdin has been passed to this exec plugin p td tr tbody table ExecCredentialStatus client authentication k8s io v1 ExecCredentialStatus Appears in ExecCredential client authentication k8s io v1 ExecCredential p ExecCredentialStatus holds credentials for the transport to use p p Token and ClientKeyData are sensitive fields This data should only be transmitted in memory between client and exec plugin process Exec plugin itself should at least be protected via file permissions p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code expirationTimestamp 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 ExpirationTimestamp indicates a time when the provided credentials expire p td tr tr td code token code B Required B br code string code td td p Token is a bearer token used by the client for request authentication p td tr tr td code clientCertificateData code B Required B br code string code td td p PEM encoded client TLS certificates including intermediates if any p td tr tr td code clientKeyData code B Required B br code string code td td p PEM encoded private key for the above certificate p td tr tbody table |
kubernetes reference contenttype tool reference Resource Types package kubescheduler config k8s io v1 title kube scheduler Configuration v1 autogenerated true | ---
title: kube-scheduler Configuration (v1)
content_type: tool-reference
package: kubescheduler.config.k8s.io/v1
auto_generated: true
---
## Resource Types
- [DefaultPreemptionArgs](#kubescheduler-config-k8s-io-v1-DefaultPreemptionArgs)
- [InterPodAffinityArgs](#kubescheduler-config-k8s-io-v1-InterPodAffinityArgs)
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration)
- [NodeAffinityArgs](#kubescheduler-config-k8s-io-v1-NodeAffinityArgs)
- [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1-NodeResourcesBalancedAllocationArgs)
- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1-NodeResourcesFitArgs)
- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1-PodTopologySpreadArgs)
- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1-VolumeBindingArgs)
## `ClientConnectionConfiguration` {#ClientConnectionConfiguration}
**Appears in:**
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration)
<p>ClientConnectionConfiguration contains details for constructing a client.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>kubeconfig</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>kubeconfig is the path to a KubeConfig file.</p>
</td>
</tr>
<tr><td><code>acceptContentTypes</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the
default value of 'application/json'. This field will control all connections to the server used by a particular
client.</p>
</td>
</tr>
<tr><td><code>contentType</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>contentType is the content type used when sending data to the server from this client.</p>
</td>
</tr>
<tr><td><code>qps</code> <B>[Required]</B><br/>
<code>float32</code>
</td>
<td>
<p>qps controls the number of queries per second allowed for this connection.</p>
</td>
</tr>
<tr><td><code>burst</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>burst allows extra queries to accumulate when a client is exceeding its rate.</p>
</td>
</tr>
</tbody>
</table>
## `DebuggingConfiguration` {#DebuggingConfiguration}
**Appears in:**
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration)
<p>DebuggingConfiguration holds configuration for Debugging related features.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>enableProfiling</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enableProfiling enables profiling via web interface host:port/debug/pprof/</p>
</td>
</tr>
<tr><td><code>enableContentionProfiling</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enableContentionProfiling enables block profiling, if
enableProfiling is true.</p>
</td>
</tr>
</tbody>
</table>
## `LeaderElectionConfiguration` {#LeaderElectionConfiguration}
**Appears in:**
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration)
<p>LeaderElectionConfiguration defines the configuration of leader election
clients for components that can run with leader election enabled.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>leaderElect</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>leaderElect enables a leader election client to gain leadership
before executing the main loop. Enable this when running replicated
components for high availability.</p>
</td>
</tr>
<tr><td><code>leaseDuration</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>leaseDuration is 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><code>renewDeadline</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>renewDeadline is the interval between attempts by the acting master to
renew a leadership slot before it stops leading. This must be less
than or equal to the lease duration. This is only applicable if leader
election is enabled.</p>
</td>
</tr>
<tr><td><code>retryPeriod</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>retryPeriod is 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><code>resourceLock</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>resourceLock indicates the resource object type that will be used to lock
during leader election cycles.</p>
</td>
</tr>
<tr><td><code>resourceName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>resourceName indicates the name of resource object that will be used to lock
during leader election cycles.</p>
</td>
</tr>
<tr><td><code>resourceNamespace</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>resourceName indicates the namespace of resource object that will be used to lock
during leader election cycles.</p>
</td>
</tr>
</tbody>
</table>
## `DefaultPreemptionArgs` {#kubescheduler-config-k8s-io-v1-DefaultPreemptionArgs}
<p>DefaultPreemptionArgs holds arguments used to configure the
DefaultPreemption plugin.</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>kubescheduler.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>DefaultPreemptionArgs</code></td></tr>
<tr><td><code>minCandidateNodesPercentage</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>MinCandidateNodesPercentage is the minimum number of candidates to
shortlist when dry running preemption as a percentage of number of nodes.
Must be in the range [0, 100]. Defaults to 10% of the cluster size if
unspecified.</p>
</td>
</tr>
<tr><td><code>minCandidateNodesAbsolute</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>MinCandidateNodesAbsolute is the absolute minimum number of candidates to
shortlist. The likely number of candidates enumerated for dry running
preemption is given by the formula:
numCandidates = max(numNodes * minCandidateNodesPercentage, minCandidateNodesAbsolute)
We say "likely" because there are other factors such as PDB violations
that play a role in the number of candidates shortlisted. Must be at least
0 nodes. Defaults to 100 nodes if unspecified.</p>
</td>
</tr>
</tbody>
</table>
## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1-InterPodAffinityArgs}
<p>InterPodAffinityArgs holds arguments used to configure the InterPodAffinity plugin.</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>kubescheduler.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>InterPodAffinityArgs</code></td></tr>
<tr><td><code>hardPodAffinityWeight</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>HardPodAffinityWeight is the scoring weight for existing pods with a
matching hard affinity to the incoming pod.</p>
</td>
</tr>
<tr><td><code>ignorePreferredTermsOfExistingPods</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>IgnorePreferredTermsOfExistingPods configures the scheduler to ignore existing pods' preferred affinity
rules when scoring candidate nodes, unless the incoming pod has inter-pod affinities.</p>
</td>
</tr>
</tbody>
</table>
## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration}
<p>KubeSchedulerConfiguration configures a scheduler</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>kubescheduler.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>KubeSchedulerConfiguration</code></td></tr>
<tr><td><code>parallelism</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>Parallelism defines the amount of parallelism in algorithms for scheduling a Pods. Must be greater than 0. Defaults to 16</p>
</td>
</tr>
<tr><td><code>leaderElection</code> <B>[Required]</B><br/>
<a href="#LeaderElectionConfiguration"><code>LeaderElectionConfiguration</code></a>
</td>
<td>
<p>LeaderElection defines the configuration of leader election client.</p>
</td>
</tr>
<tr><td><code>clientConnection</code> <B>[Required]</B><br/>
<a href="#ClientConnectionConfiguration"><code>ClientConnectionConfiguration</code></a>
</td>
<td>
<p>ClientConnection specifies the kubeconfig file and client connection
settings for the proxy server to use when communicating with the apiserver.</p>
</td>
</tr>
<tr><td><code>DebuggingConfiguration</code> <B>[Required]</B><br/>
<a href="#DebuggingConfiguration"><code>DebuggingConfiguration</code></a>
</td>
<td>(Members of <code>DebuggingConfiguration</code> are embedded into this type.)
<p>DebuggingConfiguration holds configuration for Debugging related features
TODO: We might wanna make this a substruct like Debugging componentbaseconfigv1alpha1.DebuggingConfiguration</p>
</td>
</tr>
<tr><td><code>percentageOfNodesToScore</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>PercentageOfNodesToScore is the percentage of all nodes that once found feasible
for running a pod, the scheduler stops its search for more feasible nodes in
the cluster. This helps improve scheduler's performance. Scheduler always tries to find
at least "minFeasibleNodesToFind" feasible nodes no matter what the value of this flag is.
Example: if the cluster size is 500 nodes and the value of this flag is 30,
then scheduler stops finding further feasible nodes once it finds 150 feasible ones.
When the value is 0, default percentage (5%--50% based on the size of the cluster) of the
nodes will be scored. It is overridden by profile level PercentageOfNodesToScore.</p>
</td>
</tr>
<tr><td><code>podInitialBackoffSeconds</code> <B>[Required]</B><br/>
<code>int64</code>
</td>
<td>
<p>PodInitialBackoffSeconds is the initial backoff for unschedulable pods.
If specified, it must be greater than 0. If this value is null, the default value (1s)
will be used.</p>
</td>
</tr>
<tr><td><code>podMaxBackoffSeconds</code> <B>[Required]</B><br/>
<code>int64</code>
</td>
<td>
<p>PodMaxBackoffSeconds is the max backoff for unschedulable pods.
If specified, it must be greater than podInitialBackoffSeconds. If this value is null,
the default value (10s) will be used.</p>
</td>
</tr>
<tr><td><code>profiles</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-KubeSchedulerProfile"><code>[]KubeSchedulerProfile</code></a>
</td>
<td>
<p>Profiles are scheduling profiles that kube-scheduler supports. Pods can
choose to be scheduled under a particular profile by setting its associated
scheduler name. Pods that don't specify any scheduler name are scheduled
with the "default-scheduler" profile, if present here.</p>
</td>
</tr>
<tr><td><code>extenders</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-Extender"><code>[]Extender</code></a>
</td>
<td>
<p>Extenders are the list of scheduler extenders, each holding the values of how to communicate
with the extender. These extenders are shared by all scheduler profiles.</p>
</td>
</tr>
<tr><td><code>delayCacheUntilActive</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>DelayCacheUntilActive specifies when to start caching. If this is true and leader election is enabled,
the scheduler will wait to fill informer caches until it is the leader. Doing so will have slower
failover with the benefit of lower memory overhead while waiting to become leader.
Defaults to false.</p>
</td>
</tr>
</tbody>
</table>
## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1-NodeAffinityArgs}
<p>NodeAffinityArgs holds arguments to configure the NodeAffinity plugin.</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>kubescheduler.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>NodeAffinityArgs</code></td></tr>
<tr><td><code>addedAffinity</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#nodeaffinity-v1-core"><code>core/v1.NodeAffinity</code></a>
</td>
<td>
<p>AddedAffinity is applied to all Pods additionally to the NodeAffinity
specified in the PodSpec. That is, Nodes need to satisfy AddedAffinity
AND .spec.NodeAffinity. AddedAffinity is empty by default (all Nodes
match).
When AddedAffinity is used, some Pods with affinity requirements that match
a specific Node (such as Daemonset Pods) might remain unschedulable.</p>
</td>
</tr>
</tbody>
</table>
## `NodeResourcesBalancedAllocationArgs` {#kubescheduler-config-k8s-io-v1-NodeResourcesBalancedAllocationArgs}
<p>NodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResourcesBalancedAllocation plugin.</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>kubescheduler.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>NodeResourcesBalancedAllocationArgs</code></td></tr>
<tr><td><code>resources</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-ResourceSpec"><code>[]ResourceSpec</code></a>
</td>
<td>
<p>Resources to be managed, the default is "cpu" and "memory" if not specified.</p>
</td>
</tr>
</tbody>
</table>
## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1-NodeResourcesFitArgs}
<p>NodeResourcesFitArgs holds arguments used to configure the NodeResourcesFit plugin.</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>kubescheduler.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>NodeResourcesFitArgs</code></td></tr>
<tr><td><code>ignoredResources</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>IgnoredResources is the list of resources that NodeResources fit filter
should ignore. This doesn't apply to scoring.</p>
</td>
</tr>
<tr><td><code>ignoredResourceGroups</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>IgnoredResourceGroups defines the list of resource groups that NodeResources fit filter should ignore.
e.g. if group is ["example.com"], it will ignore all resource names that begin
with "example.com", such as "example.com/aaa" and "example.com/bbb".
A resource group name can't contain '/'. This doesn't apply to scoring.</p>
</td>
</tr>
<tr><td><code>scoringStrategy</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-ScoringStrategy"><code>ScoringStrategy</code></a>
</td>
<td>
<p>ScoringStrategy selects the node resource scoring strategy.
The default strategy is LeastAllocated with an equal "cpu" and "memory" weight.</p>
</td>
</tr>
</tbody>
</table>
## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1-PodTopologySpreadArgs}
<p>PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread plugin.</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>kubescheduler.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>PodTopologySpreadArgs</code></td></tr>
<tr><td><code>defaultConstraints</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#topologyspreadconstraint-v1-core"><code>[]core/v1.TopologySpreadConstraint</code></a>
</td>
<td>
<p>DefaultConstraints defines topology spread constraints to be applied to
Pods that don't define any in <code>pod.spec.topologySpreadConstraints</code>.
<code>.defaultConstraints[*].labelSelectors</code> must be empty, as they are
deduced from the Pod's membership to Services, ReplicationControllers,
ReplicaSets or StatefulSets.
When not empty, .defaultingType must be "List".</p>
</td>
</tr>
<tr><td><code>defaultingType</code><br/>
<a href="#kubescheduler-config-k8s-io-v1-PodTopologySpreadConstraintsDefaulting"><code>PodTopologySpreadConstraintsDefaulting</code></a>
</td>
<td>
<p>DefaultingType determines how .defaultConstraints are deduced. Can be one
of "System" or "List".</p>
<ul>
<li>"System": Use kubernetes defined constraints that spread Pods among
Nodes and Zones.</li>
<li>"List": Use constraints defined in .defaultConstraints.</li>
</ul>
<p>Defaults to "System".</p>
</td>
</tr>
</tbody>
</table>
## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1-VolumeBindingArgs}
<p>VolumeBindingArgs holds arguments used to configure the VolumeBinding plugin.</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>kubescheduler.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>VolumeBindingArgs</code></td></tr>
<tr><td><code>bindTimeoutSeconds</code> <B>[Required]</B><br/>
<code>int64</code>
</td>
<td>
<p>BindTimeoutSeconds is the timeout in seconds in volume binding operation.
Value must be non-negative integer. The value zero indicates no waiting.
If this value is nil, the default value (600) will be used.</p>
</td>
</tr>
<tr><td><code>shape</code><br/>
<a href="#kubescheduler-config-k8s-io-v1-UtilizationShapePoint"><code>[]UtilizationShapePoint</code></a>
</td>
<td>
<p>Shape specifies the points defining the score function shape, which is
used to score nodes based on the utilization of statically provisioned
PVs. The utilization is calculated by dividing the total requested
storage of the pod by the total capacity of feasible PVs on each node.
Each point contains utilization (ranges from 0 to 100) and its
associated score (ranges from 0 to 10). You can turn the priority by
specifying different scores for different utilization numbers.
The default shape points are:</p>
<ol>
<li>0 for 0 utilization</li>
<li>10 for 100 utilization
All points must be sorted in increasing order by utilization.</li>
</ol>
</td>
</tr>
</tbody>
</table>
## `Extender` {#kubescheduler-config-k8s-io-v1-Extender}
**Appears in:**
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration)
<p>Extender holds the parameters used to communicate with the extender. If a verb is unspecified/empty,
it is assumed that the extender chose not to provide that extension.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>urlPrefix</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>URLPrefix at which the extender is available</p>
</td>
</tr>
<tr><td><code>filterVerb</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.</p>
</td>
</tr>
<tr><td><code>preemptVerb</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.</p>
</td>
</tr>
<tr><td><code>prioritizeVerb</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.</p>
</td>
</tr>
<tr><td><code>weight</code> <B>[Required]</B><br/>
<code>int64</code>
</td>
<td>
<p>The numeric multiplier for the node scores that the prioritize call generates.
The weight should be a positive integer</p>
</td>
</tr>
<tr><td><code>bindVerb</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Verb for the bind call, empty if not supported. This verb is appended to the URLPrefix when issuing the bind call to extender.
If this method is implemented by the extender, it is the extender's responsibility to bind the pod to apiserver. Only one extender
can implement this function.</p>
</td>
</tr>
<tr><td><code>enableHTTPS</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>EnableHTTPS specifies whether https should be used to communicate with the extender</p>
</td>
</tr>
<tr><td><code>tlsConfig</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-ExtenderTLSConfig"><code>ExtenderTLSConfig</code></a>
</td>
<td>
<p>TLSConfig specifies the transport layer security config</p>
</td>
</tr>
<tr><td><code>httpTimeout</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>HTTPTimeout specifies the timeout duration for a call to the extender. Filter timeout fails the scheduling of the pod. Prioritize
timeout is ignored, k8s/other extenders priorities are used to select the node.</p>
</td>
</tr>
<tr><td><code>nodeCacheCapable</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>NodeCacheCapable specifies that the extender is capable of caching node information,
so the scheduler should only send minimal information about the eligible nodes
assuming that the extender already cached full details of all nodes in the cluster</p>
</td>
</tr>
<tr><td><code>managedResources</code><br/>
<a href="#kubescheduler-config-k8s-io-v1-ExtenderManagedResource"><code>[]ExtenderManagedResource</code></a>
</td>
<td>
<p>ManagedResources is a list of extended resources that are managed by
this extender.</p>
<ul>
<li>A pod will be sent to the extender on the Filter, Prioritize and Bind
(if the extender is the binder) phases iff the pod requests at least
one of the extended resources in this list. If empty or unspecified,
all pods will be sent to this extender.</li>
<li>If IgnoredByScheduler is set to true for a resource, kube-scheduler
will skip checking the resource in predicates.</li>
</ul>
</td>
</tr>
<tr><td><code>ignorable</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>Ignorable specifies if the extender is ignorable, i.e. scheduling should not
fail when the extender returns an error or is not reachable.</p>
</td>
</tr>
</tbody>
</table>
## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1-ExtenderManagedResource}
**Appears in:**
- [Extender](#kubescheduler-config-k8s-io-v1-Extender)
<p>ExtenderManagedResource describes the arguments of extended resources
managed by an extender.</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 extended resource name.</p>
</td>
</tr>
<tr><td><code>ignoredByScheduler</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>IgnoredByScheduler indicates whether kube-scheduler should ignore this
resource when applying predicates.</p>
</td>
</tr>
</tbody>
</table>
## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1-ExtenderTLSConfig}
**Appears in:**
- [Extender](#kubescheduler-config-k8s-io-v1-Extender)
<p>ExtenderTLSConfig contains settings to enable TLS with extender</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>insecure</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>Server should be accessed without verifying the TLS certificate. For testing only.</p>
</td>
</tr>
<tr><td><code>serverName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>ServerName is passed to the server for SNI and is used in the client to check server
certificates against. If ServerName is empty, the hostname used to contact the
server is used.</p>
</td>
</tr>
<tr><td><code>certFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Server requires TLS client certificate authentication</p>
</td>
</tr>
<tr><td><code>keyFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Server requires TLS client certificate authentication</p>
</td>
</tr>
<tr><td><code>caFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Trusted root certificates for server</p>
</td>
</tr>
<tr><td><code>certData</code> <B>[Required]</B><br/>
<code>[]byte</code>
</td>
<td>
<p>CertData holds PEM-encoded bytes (typically read from a client certificate file).
CertData takes precedence over CertFile</p>
</td>
</tr>
<tr><td><code>keyData</code> <B>[Required]</B><br/>
<code>[]byte</code>
</td>
<td>
<p>KeyData holds PEM-encoded bytes (typically read from a client certificate key file).
KeyData takes precedence over KeyFile</p>
</td>
</tr>
<tr><td><code>caData</code> <B>[Required]</B><br/>
<code>[]byte</code>
</td>
<td>
<p>CAData holds PEM-encoded bytes (typically read from a root certificates bundle).
CAData takes precedence over CAFile</p>
</td>
</tr>
</tbody>
</table>
## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1-KubeSchedulerProfile}
**Appears in:**
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration)
<p>KubeSchedulerProfile is a scheduling profile.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>schedulerName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>SchedulerName is the name of the scheduler associated to this profile.
If SchedulerName matches with the pod's "spec.schedulerName", then the pod
is scheduled with this profile.</p>
</td>
</tr>
<tr><td><code>percentageOfNodesToScore</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>PercentageOfNodesToScore is the percentage of all nodes that once found feasible
for running a pod, the scheduler stops its search for more feasible nodes in
the cluster. This helps improve scheduler's performance. Scheduler always tries to find
at least "minFeasibleNodesToFind" feasible nodes no matter what the value of this flag is.
Example: if the cluster size is 500 nodes and the value of this flag is 30,
then scheduler stops finding further feasible nodes once it finds 150 feasible ones.
When the value is 0, default percentage (5%--50% based on the size of the cluster) of the
nodes will be scored. It will override global PercentageOfNodesToScore. If it is empty,
global PercentageOfNodesToScore will be used.</p>
</td>
</tr>
<tr><td><code>plugins</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-Plugins"><code>Plugins</code></a>
</td>
<td>
<p>Plugins specify the set of plugins that should be enabled or disabled.
Enabled plugins are the ones that should be enabled in addition to the
default plugins. Disabled plugins are any of the default plugins that
should be disabled.
When no enabled or disabled plugin is specified for an extension point,
default plugins for that extension point will be used if there is any.
If a QueueSort plugin is specified, the same QueueSort Plugin and
PluginConfig must be specified for all profiles.</p>
</td>
</tr>
<tr><td><code>pluginConfig</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginConfig"><code>[]PluginConfig</code></a>
</td>
<td>
<p>PluginConfig is an optional set of custom plugin arguments for each plugin.
Omitting config args for a plugin is equivalent to using the default config
for that plugin.</p>
</td>
</tr>
</tbody>
</table>
## `Plugin` {#kubescheduler-config-k8s-io-v1-Plugin}
**Appears in:**
- [PluginSet](#kubescheduler-config-k8s-io-v1-PluginSet)
<p>Plugin specifies a plugin name and its weight when applicable. Weight is used only for Score plugins.</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 defines the name of plugin</p>
</td>
</tr>
<tr><td><code>weight</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>Weight defines the weight of plugin, only used for Score plugins.</p>
</td>
</tr>
</tbody>
</table>
## `PluginConfig` {#kubescheduler-config-k8s-io-v1-PluginConfig}
**Appears in:**
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1-KubeSchedulerProfile)
<p>PluginConfig specifies arguments that should be passed to a plugin at the time of initialization.
A plugin that is invoked at multiple extension points is initialized once. Args can have arbitrary structure.
It is up to the plugin to process these Args.</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 defines the name of plugin being configured</p>
</td>
</tr>
<tr><td><code>args</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
</td>
<td>
<p>Args defines the arguments passed to the plugins at the time of initialization. Args can have arbitrary structure.</p>
</td>
</tr>
</tbody>
</table>
## `PluginSet` {#kubescheduler-config-k8s-io-v1-PluginSet}
**Appears in:**
- [Plugins](#kubescheduler-config-k8s-io-v1-Plugins)
<p>PluginSet specifies enabled and disabled plugins for an extension point.
If an array is empty, missing, or nil, default plugins at that extension point will be used.</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/>
<a href="#kubescheduler-config-k8s-io-v1-Plugin"><code>[]Plugin</code></a>
</td>
<td>
<p>Enabled specifies plugins that should be enabled in addition to default plugins.
If the default plugin is also configured in the scheduler config file, the weight of plugin will
be overridden accordingly.
These are called after default plugins and in the same order specified here.</p>
</td>
</tr>
<tr><td><code>disabled</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-Plugin"><code>[]Plugin</code></a>
</td>
<td>
<p>Disabled specifies default plugins that should be disabled.
When all default plugins need to be disabled, an array containing only one "*" should be provided.</p>
</td>
</tr>
</tbody>
</table>
## `Plugins` {#kubescheduler-config-k8s-io-v1-Plugins}
**Appears in:**
- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1-KubeSchedulerProfile)
<p>Plugins include multiple extension points. When specified, the list of plugins for
a particular extension point are the only ones enabled. If an extension point is
omitted from the config, then the default set of plugins is used for that extension point.
Enabled plugins are called in the order specified here, after default plugins. If they need to
be invoked before default plugins, default plugins must be disabled and re-enabled here in desired order.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>preEnqueue</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>PreEnqueue is a list of plugins that should be invoked before adding pods to the scheduling queue.</p>
</td>
</tr>
<tr><td><code>queueSort</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>QueueSort is a list of plugins that should be invoked when sorting pods in the scheduling queue.</p>
</td>
</tr>
<tr><td><code>preFilter</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>PreFilter is a list of plugins that should be invoked at "PreFilter" extension point of the scheduling framework.</p>
</td>
</tr>
<tr><td><code>filter</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>Filter is a list of plugins that should be invoked when filtering out nodes that cannot run the Pod.</p>
</td>
</tr>
<tr><td><code>postFilter</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>PostFilter is a list of plugins that are invoked after filtering phase, but only when no feasible nodes were found for the pod.</p>
</td>
</tr>
<tr><td><code>preScore</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>PreScore is a list of plugins that are invoked before scoring.</p>
</td>
</tr>
<tr><td><code>score</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>Score is a list of plugins that should be invoked when ranking nodes that have passed the filtering phase.</p>
</td>
</tr>
<tr><td><code>reserve</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>Reserve is a list of plugins invoked when reserving/unreserving resources
after a node is assigned to run the pod.</p>
</td>
</tr>
<tr><td><code>permit</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>Permit is a list of plugins that control binding of a Pod. These plugins can prevent or delay binding of a Pod.</p>
</td>
</tr>
<tr><td><code>preBind</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>PreBind is a list of plugins that should be invoked before a pod is bound.</p>
</td>
</tr>
<tr><td><code>bind</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>Bind is a list of plugins that should be invoked at "Bind" extension point of the scheduling framework.
The scheduler call these plugins in order. Scheduler skips the rest of these plugins as soon as one returns success.</p>
</td>
</tr>
<tr><td><code>postBind</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>PostBind is a list of plugins that should be invoked after a pod is successfully bound.</p>
</td>
</tr>
<tr><td><code>multiPoint</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-PluginSet"><code>PluginSet</code></a>
</td>
<td>
<p>MultiPoint is a simplified config section to enable plugins for all valid extension points.
Plugins enabled through MultiPoint will automatically register for every individual extension
point the plugin has implemented. Disabling a plugin through MultiPoint disables that behavior.
The same is true for disabling "*" through MultiPoint (no default plugins will be automatically registered).
Plugins can still be disabled through their individual extension points.</p>
<p>In terms of precedence, plugin config follows this basic hierarchy</p>
<ol>
<li>Specific extension points</li>
<li>Explicitly configured MultiPoint plugins</li>
<li>The set of default plugins, as MultiPoint plugins
This implies that a higher precedence plugin will run first and overwrite any settings within MultiPoint.
Explicitly user-configured plugins also take a higher precedence over default plugins.
Within this hierarchy, an Enabled setting takes precedence over Disabled. For example, if a plugin is
set in both <code>multiPoint.Enabled</code> and <code>multiPoint.Disabled</code>, the plugin will be enabled. Similarly,
including <code>multiPoint.Disabled = '*'</code> and <code>multiPoint.Enabled = pluginA</code> will still register that specific
plugin through MultiPoint. This follows the same behavior as all other extension point configurations.</li>
</ol>
</td>
</tr>
</tbody>
</table>
## `PodTopologySpreadConstraintsDefaulting` {#kubescheduler-config-k8s-io-v1-PodTopologySpreadConstraintsDefaulting}
(Alias of `string`)
**Appears in:**
- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1-PodTopologySpreadArgs)
<p>PodTopologySpreadConstraintsDefaulting defines how to set default constraints
for the PodTopologySpread plugin.</p>
## `RequestedToCapacityRatioParam` {#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioParam}
**Appears in:**
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1-ScoringStrategy)
<p>RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>shape</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-UtilizationShapePoint"><code>[]UtilizationShapePoint</code></a>
</td>
<td>
<p>Shape is a list of points defining the scoring function shape.</p>
</td>
</tr>
</tbody>
</table>
## `ResourceSpec` {#kubescheduler-config-k8s-io-v1-ResourceSpec}
**Appears in:**
- [NodeResourcesBalancedAllocationArgs](#kubescheduler-config-k8s-io-v1-NodeResourcesBalancedAllocationArgs)
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1-ScoringStrategy)
<p>ResourceSpec represents a single resource.</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 of the resource.</p>
</td>
</tr>
<tr><td><code>weight</code> <B>[Required]</B><br/>
<code>int64</code>
</td>
<td>
<p>Weight of the resource.</p>
</td>
</tr>
</tbody>
</table>
## `ScoringStrategy` {#kubescheduler-config-k8s-io-v1-ScoringStrategy}
**Appears in:**
- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1-NodeResourcesFitArgs)
<p>ScoringStrategy define ScoringStrategyType for node resource plugin</p>
<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/>
<a href="#kubescheduler-config-k8s-io-v1-ScoringStrategyType"><code>ScoringStrategyType</code></a>
</td>
<td>
<p>Type selects which strategy to run.</p>
</td>
</tr>
<tr><td><code>resources</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-ResourceSpec"><code>[]ResourceSpec</code></a>
</td>
<td>
<p>Resources to consider when scoring.
The default resource set includes "cpu" and "memory" with an equal weight.
Allowed weights go from 1 to 100.
Weight defaults to 1 if not specified or explicitly set to 0.</p>
</td>
</tr>
<tr><td><code>requestedToCapacityRatio</code> <B>[Required]</B><br/>
<a href="#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioParam"><code>RequestedToCapacityRatioParam</code></a>
</td>
<td>
<p>Arguments specific to RequestedToCapacityRatio strategy.</p>
</td>
</tr>
</tbody>
</table>
## `ScoringStrategyType` {#kubescheduler-config-k8s-io-v1-ScoringStrategyType}
(Alias of `string`)
**Appears in:**
- [ScoringStrategy](#kubescheduler-config-k8s-io-v1-ScoringStrategy)
<p>ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin.</p>
## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1-UtilizationShapePoint}
**Appears in:**
- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1-VolumeBindingArgs)
- [RequestedToCapacityRatioParam](#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioParam)
<p>UtilizationShapePoint represents single point of priority function shape.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>utilization</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.</p>
</td>
</tr>
<tr><td><code>score</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>Score assigned to given utilization (y axis). Valid values are 0 to 10.</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title kube scheduler Configuration v1 content type tool reference package kubescheduler config k8s io v1 auto generated true Resource Types DefaultPreemptionArgs kubescheduler config k8s io v1 DefaultPreemptionArgs InterPodAffinityArgs kubescheduler config k8s io v1 InterPodAffinityArgs KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration NodeAffinityArgs kubescheduler config k8s io v1 NodeAffinityArgs NodeResourcesBalancedAllocationArgs kubescheduler config k8s io v1 NodeResourcesBalancedAllocationArgs NodeResourcesFitArgs kubescheduler config k8s io v1 NodeResourcesFitArgs PodTopologySpreadArgs kubescheduler config k8s io v1 PodTopologySpreadArgs VolumeBindingArgs kubescheduler config k8s io v1 VolumeBindingArgs ClientConnectionConfiguration ClientConnectionConfiguration Appears in KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration p ClientConnectionConfiguration contains details for constructing a client p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code kubeconfig code B Required B br code string code td td p kubeconfig is the path to a KubeConfig file p td tr tr td code acceptContentTypes code B Required B br code string code td td p acceptContentTypes defines the Accept header sent by clients when connecting to a server overriding the default value of application json This field will control all connections to the server used by a particular client p td tr tr td code contentType code B Required B br code string code td td p contentType is the content type used when sending data to the server from this client p td tr tr td code qps code B Required B br code float32 code td td p qps controls the number of queries per second allowed for this connection p td tr tr td code burst code B Required B br code int32 code td td p burst allows extra queries to accumulate when a client is exceeding its rate p td tr tbody table DebuggingConfiguration DebuggingConfiguration Appears in KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration p DebuggingConfiguration holds configuration for Debugging related features p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code enableProfiling code B Required B br code bool code td td p enableProfiling enables profiling via web interface host port debug pprof p td tr tr td code enableContentionProfiling code B Required B br code bool code td td p enableContentionProfiling enables block profiling if enableProfiling is true p td tr tbody table LeaderElectionConfiguration LeaderElectionConfiguration Appears in KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration p LeaderElectionConfiguration defines the configuration of leader election clients for components that can run with leader election enabled p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code leaderElect code B Required B br code bool code td td p leaderElect enables a leader election client to gain leadership before executing the main loop Enable this when running replicated components for high availability p td tr tr td code leaseDuration 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 leaseDuration is 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 code renewDeadline 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 renewDeadline is the interval between attempts by the acting master to renew a leadership slot before it stops leading This must be less than or equal to the lease duration This is only applicable if leader election is enabled p td tr tr td code retryPeriod 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 retryPeriod is 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 code resourceLock code B Required B br code string code td td p resourceLock indicates the resource object type that will be used to lock during leader election cycles p td tr tr td code resourceName code B Required B br code string code td td p resourceName indicates the name of resource object that will be used to lock during leader election cycles p td tr tr td code resourceNamespace code B Required B br code string code td td p resourceName indicates the namespace of resource object that will be used to lock during leader election cycles p td tr tbody table DefaultPreemptionArgs kubescheduler config k8s io v1 DefaultPreemptionArgs p DefaultPreemptionArgs holds arguments used to configure the DefaultPreemption plugin 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 kubescheduler config k8s io v1 code td tr tr td code kind code br string td td code DefaultPreemptionArgs code td tr tr td code minCandidateNodesPercentage code B Required B br code int32 code td td p MinCandidateNodesPercentage is the minimum number of candidates to shortlist when dry running preemption as a percentage of number of nodes Must be in the range 0 100 Defaults to 10 of the cluster size if unspecified p td tr tr td code minCandidateNodesAbsolute code B Required B br code int32 code td td p MinCandidateNodesAbsolute is the absolute minimum number of candidates to shortlist The likely number of candidates enumerated for dry running preemption is given by the formula numCandidates max numNodes minCandidateNodesPercentage minCandidateNodesAbsolute We say quot likely quot because there are other factors such as PDB violations that play a role in the number of candidates shortlisted Must be at least 0 nodes Defaults to 100 nodes if unspecified p td tr tbody table InterPodAffinityArgs kubescheduler config k8s io v1 InterPodAffinityArgs p InterPodAffinityArgs holds arguments used to configure the InterPodAffinity plugin 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 kubescheduler config k8s io v1 code td tr tr td code kind code br string td td code InterPodAffinityArgs code td tr tr td code hardPodAffinityWeight code B Required B br code int32 code td td p HardPodAffinityWeight is the scoring weight for existing pods with a matching hard affinity to the incoming pod p td tr tr td code ignorePreferredTermsOfExistingPods code B Required B br code bool code td td p IgnorePreferredTermsOfExistingPods configures the scheduler to ignore existing pods preferred affinity rules when scoring candidate nodes unless the incoming pod has inter pod affinities p td tr tbody table KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration p KubeSchedulerConfiguration configures a scheduler 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 kubescheduler config k8s io v1 code td tr tr td code kind code br string td td code KubeSchedulerConfiguration code td tr tr td code parallelism code B Required B br code int32 code td td p Parallelism defines the amount of parallelism in algorithms for scheduling a Pods Must be greater than 0 Defaults to 16 p td tr tr td code leaderElection code B Required B br a href LeaderElectionConfiguration code LeaderElectionConfiguration code a td td p LeaderElection defines the configuration of leader election client p td tr tr td code clientConnection code B Required B br a href ClientConnectionConfiguration code ClientConnectionConfiguration code a td td p ClientConnection specifies the kubeconfig file and client connection settings for the proxy server to use when communicating with the apiserver p td tr tr td code DebuggingConfiguration code B Required B br a href DebuggingConfiguration code DebuggingConfiguration code a td td Members of code DebuggingConfiguration code are embedded into this type p DebuggingConfiguration holds configuration for Debugging related features TODO We might wanna make this a substruct like Debugging componentbaseconfigv1alpha1 DebuggingConfiguration p td tr tr td code percentageOfNodesToScore code B Required B br code int32 code td td p PercentageOfNodesToScore is the percentage of all nodes that once found feasible for running a pod the scheduler stops its search for more feasible nodes in the cluster This helps improve scheduler s performance Scheduler always tries to find at least quot minFeasibleNodesToFind quot feasible nodes no matter what the value of this flag is Example if the cluster size is 500 nodes and the value of this flag is 30 then scheduler stops finding further feasible nodes once it finds 150 feasible ones When the value is 0 default percentage 5 50 based on the size of the cluster of the nodes will be scored It is overridden by profile level PercentageOfNodesToScore p td tr tr td code podInitialBackoffSeconds code B Required B br code int64 code td td p PodInitialBackoffSeconds is the initial backoff for unschedulable pods If specified it must be greater than 0 If this value is null the default value 1s will be used p td tr tr td code podMaxBackoffSeconds code B Required B br code int64 code td td p PodMaxBackoffSeconds is the max backoff for unschedulable pods If specified it must be greater than podInitialBackoffSeconds If this value is null the default value 10s will be used p td tr tr td code profiles code B Required B br a href kubescheduler config k8s io v1 KubeSchedulerProfile code KubeSchedulerProfile code a td td p Profiles are scheduling profiles that kube scheduler supports Pods can choose to be scheduled under a particular profile by setting its associated scheduler name Pods that don t specify any scheduler name are scheduled with the quot default scheduler quot profile if present here p td tr tr td code extenders code B Required B br a href kubescheduler config k8s io v1 Extender code Extender code a td td p Extenders are the list of scheduler extenders each holding the values of how to communicate with the extender These extenders are shared by all scheduler profiles p td tr tr td code delayCacheUntilActive code B Required B br code bool code td td p DelayCacheUntilActive specifies when to start caching If this is true and leader election is enabled the scheduler will wait to fill informer caches until it is the leader Doing so will have slower failover with the benefit of lower memory overhead while waiting to become leader Defaults to false p td tr tbody table NodeAffinityArgs kubescheduler config k8s io v1 NodeAffinityArgs p NodeAffinityArgs holds arguments to configure the NodeAffinity plugin 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 kubescheduler config k8s io v1 code td tr tr td code kind code br string td td code NodeAffinityArgs code td tr tr td code addedAffinity code br a href https kubernetes io docs reference generated kubernetes api v1 31 nodeaffinity v1 core code core v1 NodeAffinity code a td td p AddedAffinity is applied to all Pods additionally to the NodeAffinity specified in the PodSpec That is Nodes need to satisfy AddedAffinity AND spec NodeAffinity AddedAffinity is empty by default all Nodes match When AddedAffinity is used some Pods with affinity requirements that match a specific Node such as Daemonset Pods might remain unschedulable p td tr tbody table NodeResourcesBalancedAllocationArgs kubescheduler config k8s io v1 NodeResourcesBalancedAllocationArgs p NodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResourcesBalancedAllocation plugin 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 kubescheduler config k8s io v1 code td tr tr td code kind code br string td td code NodeResourcesBalancedAllocationArgs code td tr tr td code resources code B Required B br a href kubescheduler config k8s io v1 ResourceSpec code ResourceSpec code a td td p Resources to be managed the default is quot cpu quot and quot memory quot if not specified p td tr tbody table NodeResourcesFitArgs kubescheduler config k8s io v1 NodeResourcesFitArgs p NodeResourcesFitArgs holds arguments used to configure the NodeResourcesFit plugin 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 kubescheduler config k8s io v1 code td tr tr td code kind code br string td td code NodeResourcesFitArgs code td tr tr td code ignoredResources code B Required B br code string code td td p IgnoredResources is the list of resources that NodeResources fit filter should ignore This doesn t apply to scoring p td tr tr td code ignoredResourceGroups code B Required B br code string code td td p IgnoredResourceGroups defines the list of resource groups that NodeResources fit filter should ignore e g if group is quot example com quot it will ignore all resource names that begin with quot example com quot such as quot example com aaa quot and quot example com bbb quot A resource group name can t contain This doesn t apply to scoring p td tr tr td code scoringStrategy code B Required B br a href kubescheduler config k8s io v1 ScoringStrategy code ScoringStrategy code a td td p ScoringStrategy selects the node resource scoring strategy The default strategy is LeastAllocated with an equal quot cpu quot and quot memory quot weight p td tr tbody table PodTopologySpreadArgs kubescheduler config k8s io v1 PodTopologySpreadArgs p PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread plugin 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 kubescheduler config k8s io v1 code td tr tr td code kind code br string td td code PodTopologySpreadArgs code td tr tr td code defaultConstraints code br a href https kubernetes io docs reference generated kubernetes api v1 31 topologyspreadconstraint v1 core code core v1 TopologySpreadConstraint code a td td p DefaultConstraints defines topology spread constraints to be applied to Pods that don t define any in code pod spec topologySpreadConstraints code code defaultConstraints labelSelectors code must be empty as they are deduced from the Pod s membership to Services ReplicationControllers ReplicaSets or StatefulSets When not empty defaultingType must be quot List quot p td tr tr td code defaultingType code br a href kubescheduler config k8s io v1 PodTopologySpreadConstraintsDefaulting code PodTopologySpreadConstraintsDefaulting code a td td p DefaultingType determines how defaultConstraints are deduced Can be one of quot System quot or quot List quot p ul li quot System quot Use kubernetes defined constraints that spread Pods among Nodes and Zones li li quot List quot Use constraints defined in defaultConstraints li ul p Defaults to quot System quot p td tr tbody table VolumeBindingArgs kubescheduler config k8s io v1 VolumeBindingArgs p VolumeBindingArgs holds arguments used to configure the VolumeBinding plugin 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 kubescheduler config k8s io v1 code td tr tr td code kind code br string td td code VolumeBindingArgs code td tr tr td code bindTimeoutSeconds code B Required B br code int64 code td td p BindTimeoutSeconds is the timeout in seconds in volume binding operation Value must be non negative integer The value zero indicates no waiting If this value is nil the default value 600 will be used p td tr tr td code shape code br a href kubescheduler config k8s io v1 UtilizationShapePoint code UtilizationShapePoint code a td td p Shape specifies the points defining the score function shape which is used to score nodes based on the utilization of statically provisioned PVs The utilization is calculated by dividing the total requested storage of the pod by the total capacity of feasible PVs on each node Each point contains utilization ranges from 0 to 100 and its associated score ranges from 0 to 10 You can turn the priority by specifying different scores for different utilization numbers The default shape points are p ol li 0 for 0 utilization li li 10 for 100 utilization All points must be sorted in increasing order by utilization li ol td tr tbody table Extender kubescheduler config k8s io v1 Extender Appears in KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration p Extender holds the parameters used to communicate with the extender If a verb is unspecified empty it is assumed that the extender chose not to provide that extension p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code urlPrefix code B Required B br code string code td td p URLPrefix at which the extender is available p td tr tr td code filterVerb code B Required B br code string code td td p Verb for the filter call empty if not supported This verb is appended to the URLPrefix when issuing the filter call to extender p td tr tr td code preemptVerb code B Required B br code string code td td p Verb for the preempt call empty if not supported This verb is appended to the URLPrefix when issuing the preempt call to extender p td tr tr td code prioritizeVerb code B Required B br code string code td td p Verb for the prioritize call empty if not supported This verb is appended to the URLPrefix when issuing the prioritize call to extender p td tr tr td code weight code B Required B br code int64 code td td p The numeric multiplier for the node scores that the prioritize call generates The weight should be a positive integer p td tr tr td code bindVerb code B Required B br code string code td td p Verb for the bind call empty if not supported This verb is appended to the URLPrefix when issuing the bind call to extender If this method is implemented by the extender it is the extender s responsibility to bind the pod to apiserver Only one extender can implement this function p td tr tr td code enableHTTPS code B Required B br code bool code td td p EnableHTTPS specifies whether https should be used to communicate with the extender p td tr tr td code tlsConfig code B Required B br a href kubescheduler config k8s io v1 ExtenderTLSConfig code ExtenderTLSConfig code a td td p TLSConfig specifies the transport layer security config p td tr tr td code httpTimeout 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 HTTPTimeout specifies the timeout duration for a call to the extender Filter timeout fails the scheduling of the pod Prioritize timeout is ignored k8s other extenders priorities are used to select the node p td tr tr td code nodeCacheCapable code B Required B br code bool code td td p NodeCacheCapable specifies that the extender is capable of caching node information so the scheduler should only send minimal information about the eligible nodes assuming that the extender already cached full details of all nodes in the cluster p td tr tr td code managedResources code br a href kubescheduler config k8s io v1 ExtenderManagedResource code ExtenderManagedResource code a td td p ManagedResources is a list of extended resources that are managed by this extender p ul li A pod will be sent to the extender on the Filter Prioritize and Bind if the extender is the binder phases iff the pod requests at least one of the extended resources in this list If empty or unspecified all pods will be sent to this extender li li If IgnoredByScheduler is set to true for a resource kube scheduler will skip checking the resource in predicates li ul td tr tr td code ignorable code B Required B br code bool code td td p Ignorable specifies if the extender is ignorable i e scheduling should not fail when the extender returns an error or is not reachable p td tr tbody table ExtenderManagedResource kubescheduler config k8s io v1 ExtenderManagedResource Appears in Extender kubescheduler config k8s io v1 Extender p ExtenderManagedResource describes the arguments of extended resources managed by an extender 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 extended resource name p td tr tr td code ignoredByScheduler code B Required B br code bool code td td p IgnoredByScheduler indicates whether kube scheduler should ignore this resource when applying predicates p td tr tbody table ExtenderTLSConfig kubescheduler config k8s io v1 ExtenderTLSConfig Appears in Extender kubescheduler config k8s io v1 Extender p ExtenderTLSConfig contains settings to enable TLS with extender p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code insecure code B Required B br code bool code td td p Server should be accessed without verifying the TLS certificate For testing only p td tr tr td code serverName code B Required B br code string code td td p ServerName is passed to the server for SNI and is used in the client to check server certificates against If ServerName is empty the hostname used to contact the server is used p td tr tr td code certFile code B Required B br code string code td td p Server requires TLS client certificate authentication p td tr tr td code keyFile code B Required B br code string code td td p Server requires TLS client certificate authentication p td tr tr td code caFile code B Required B br code string code td td p Trusted root certificates for server p td tr tr td code certData code B Required B br code byte code td td p CertData holds PEM encoded bytes typically read from a client certificate file CertData takes precedence over CertFile p td tr tr td code keyData code B Required B br code byte code td td p KeyData holds PEM encoded bytes typically read from a client certificate key file KeyData takes precedence over KeyFile p td tr tr td code caData code B Required B br code byte code td td p CAData holds PEM encoded bytes typically read from a root certificates bundle CAData takes precedence over CAFile p td tr tbody table KubeSchedulerProfile kubescheduler config k8s io v1 KubeSchedulerProfile Appears in KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration p KubeSchedulerProfile is a scheduling profile p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code schedulerName code B Required B br code string code td td p SchedulerName is the name of the scheduler associated to this profile If SchedulerName matches with the pod s quot spec schedulerName quot then the pod is scheduled with this profile p td tr tr td code percentageOfNodesToScore code B Required B br code int32 code td td p PercentageOfNodesToScore is the percentage of all nodes that once found feasible for running a pod the scheduler stops its search for more feasible nodes in the cluster This helps improve scheduler s performance Scheduler always tries to find at least quot minFeasibleNodesToFind quot feasible nodes no matter what the value of this flag is Example if the cluster size is 500 nodes and the value of this flag is 30 then scheduler stops finding further feasible nodes once it finds 150 feasible ones When the value is 0 default percentage 5 50 based on the size of the cluster of the nodes will be scored It will override global PercentageOfNodesToScore If it is empty global PercentageOfNodesToScore will be used p td tr tr td code plugins code B Required B br a href kubescheduler config k8s io v1 Plugins code Plugins code a td td p Plugins specify the set of plugins that should be enabled or disabled Enabled plugins are the ones that should be enabled in addition to the default plugins Disabled plugins are any of the default plugins that should be disabled When no enabled or disabled plugin is specified for an extension point default plugins for that extension point will be used if there is any If a QueueSort plugin is specified the same QueueSort Plugin and PluginConfig must be specified for all profiles p td tr tr td code pluginConfig code B Required B br a href kubescheduler config k8s io v1 PluginConfig code PluginConfig code a td td p PluginConfig is an optional set of custom plugin arguments for each plugin Omitting config args for a plugin is equivalent to using the default config for that plugin p td tr tbody table Plugin kubescheduler config k8s io v1 Plugin Appears in PluginSet kubescheduler config k8s io v1 PluginSet p Plugin specifies a plugin name and its weight when applicable Weight is used only for Score plugins 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 defines the name of plugin p td tr tr td code weight code B Required B br code int32 code td td p Weight defines the weight of plugin only used for Score plugins p td tr tbody table PluginConfig kubescheduler config k8s io v1 PluginConfig Appears in KubeSchedulerProfile kubescheduler config k8s io v1 KubeSchedulerProfile p PluginConfig specifies arguments that should be passed to a plugin at the time of initialization A plugin that is invoked at multiple extension points is initialized once Args can have arbitrary structure It is up to the plugin to process these Args 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 defines the name of plugin being configured p td tr tr td code args code B Required B br a href https pkg go dev k8s io apimachinery pkg runtime RawExtension code k8s io apimachinery pkg runtime RawExtension code a td td p Args defines the arguments passed to the plugins at the time of initialization Args can have arbitrary structure p td tr tbody table PluginSet kubescheduler config k8s io v1 PluginSet Appears in Plugins kubescheduler config k8s io v1 Plugins p PluginSet specifies enabled and disabled plugins for an extension point If an array is empty missing or nil default plugins at that extension point will be used 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 a href kubescheduler config k8s io v1 Plugin code Plugin code a td td p Enabled specifies plugins that should be enabled in addition to default plugins If the default plugin is also configured in the scheduler config file the weight of plugin will be overridden accordingly These are called after default plugins and in the same order specified here p td tr tr td code disabled code B Required B br a href kubescheduler config k8s io v1 Plugin code Plugin code a td td p Disabled specifies default plugins that should be disabled When all default plugins need to be disabled an array containing only one quot quot should be provided p td tr tbody table Plugins kubescheduler config k8s io v1 Plugins Appears in KubeSchedulerProfile kubescheduler config k8s io v1 KubeSchedulerProfile p Plugins include multiple extension points When specified the list of plugins for a particular extension point are the only ones enabled If an extension point is omitted from the config then the default set of plugins is used for that extension point Enabled plugins are called in the order specified here after default plugins If they need to be invoked before default plugins default plugins must be disabled and re enabled here in desired order p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code preEnqueue code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p PreEnqueue is a list of plugins that should be invoked before adding pods to the scheduling queue p td tr tr td code queueSort code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p QueueSort is a list of plugins that should be invoked when sorting pods in the scheduling queue p td tr tr td code preFilter code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p PreFilter is a list of plugins that should be invoked at quot PreFilter quot extension point of the scheduling framework p td tr tr td code filter code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p Filter is a list of plugins that should be invoked when filtering out nodes that cannot run the Pod p td tr tr td code postFilter code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p PostFilter is a list of plugins that are invoked after filtering phase but only when no feasible nodes were found for the pod p td tr tr td code preScore code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p PreScore is a list of plugins that are invoked before scoring p td tr tr td code score code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p Score is a list of plugins that should be invoked when ranking nodes that have passed the filtering phase p td tr tr td code reserve code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p Reserve is a list of plugins invoked when reserving unreserving resources after a node is assigned to run the pod p td tr tr td code permit code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p Permit is a list of plugins that control binding of a Pod These plugins can prevent or delay binding of a Pod p td tr tr td code preBind code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p PreBind is a list of plugins that should be invoked before a pod is bound p td tr tr td code bind code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p Bind is a list of plugins that should be invoked at quot Bind quot extension point of the scheduling framework The scheduler call these plugins in order Scheduler skips the rest of these plugins as soon as one returns success p td tr tr td code postBind code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p PostBind is a list of plugins that should be invoked after a pod is successfully bound p td tr tr td code multiPoint code B Required B br a href kubescheduler config k8s io v1 PluginSet code PluginSet code a td td p MultiPoint is a simplified config section to enable plugins for all valid extension points Plugins enabled through MultiPoint will automatically register for every individual extension point the plugin has implemented Disabling a plugin through MultiPoint disables that behavior The same is true for disabling quot quot through MultiPoint no default plugins will be automatically registered Plugins can still be disabled through their individual extension points p p In terms of precedence plugin config follows this basic hierarchy p ol li Specific extension points li li Explicitly configured MultiPoint plugins li li The set of default plugins as MultiPoint plugins This implies that a higher precedence plugin will run first and overwrite any settings within MultiPoint Explicitly user configured plugins also take a higher precedence over default plugins Within this hierarchy an Enabled setting takes precedence over Disabled For example if a plugin is set in both code multiPoint Enabled code and code multiPoint Disabled code the plugin will be enabled Similarly including code multiPoint Disabled code and code multiPoint Enabled pluginA code will still register that specific plugin through MultiPoint This follows the same behavior as all other extension point configurations li ol td tr tbody table PodTopologySpreadConstraintsDefaulting kubescheduler config k8s io v1 PodTopologySpreadConstraintsDefaulting Alias of string Appears in PodTopologySpreadArgs kubescheduler config k8s io v1 PodTopologySpreadArgs p PodTopologySpreadConstraintsDefaulting defines how to set default constraints for the PodTopologySpread plugin p RequestedToCapacityRatioParam kubescheduler config k8s io v1 RequestedToCapacityRatioParam Appears in ScoringStrategy kubescheduler config k8s io v1 ScoringStrategy p RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code shape code B Required B br a href kubescheduler config k8s io v1 UtilizationShapePoint code UtilizationShapePoint code a td td p Shape is a list of points defining the scoring function shape p td tr tbody table ResourceSpec kubescheduler config k8s io v1 ResourceSpec Appears in NodeResourcesBalancedAllocationArgs kubescheduler config k8s io v1 NodeResourcesBalancedAllocationArgs ScoringStrategy kubescheduler config k8s io v1 ScoringStrategy p ResourceSpec represents a single resource 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 of the resource p td tr tr td code weight code B Required B br code int64 code td td p Weight of the resource p td tr tbody table ScoringStrategy kubescheduler config k8s io v1 ScoringStrategy Appears in NodeResourcesFitArgs kubescheduler config k8s io v1 NodeResourcesFitArgs p ScoringStrategy define ScoringStrategyType for node resource plugin p 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 a href kubescheduler config k8s io v1 ScoringStrategyType code ScoringStrategyType code a td td p Type selects which strategy to run p td tr tr td code resources code B Required B br a href kubescheduler config k8s io v1 ResourceSpec code ResourceSpec code a td td p Resources to consider when scoring The default resource set includes quot cpu quot and quot memory quot with an equal weight Allowed weights go from 1 to 100 Weight defaults to 1 if not specified or explicitly set to 0 p td tr tr td code requestedToCapacityRatio code B Required B br a href kubescheduler config k8s io v1 RequestedToCapacityRatioParam code RequestedToCapacityRatioParam code a td td p Arguments specific to RequestedToCapacityRatio strategy p td tr tbody table ScoringStrategyType kubescheduler config k8s io v1 ScoringStrategyType Alias of string Appears in ScoringStrategy kubescheduler config k8s io v1 ScoringStrategy p ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin p UtilizationShapePoint kubescheduler config k8s io v1 UtilizationShapePoint Appears in VolumeBindingArgs kubescheduler config k8s io v1 VolumeBindingArgs RequestedToCapacityRatioParam kubescheduler config k8s io v1 RequestedToCapacityRatioParam p UtilizationShapePoint represents single point of priority function shape p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code utilization code B Required B br code int32 code td td p Utilization x axis Valid values are 0 to 100 Fully utilized node maps to 100 p td tr tr td code score code B Required B br code int32 code td td p Score assigned to given utilization y axis Valid values are 0 to 10 p td tr tbody table |
kubernetes reference package credentialprovider kubelet k8s io v1 contenttype tool reference title Kubelet CredentialProvider v1 Resource Types autogenerated true | ---
title: Kubelet CredentialProvider (v1)
content_type: tool-reference
package: credentialprovider.kubelet.k8s.io/v1
auto_generated: true
---
## Resource Types
- [CredentialProviderRequest](#credentialprovider-kubelet-k8s-io-v1-CredentialProviderRequest)
- [CredentialProviderResponse](#credentialprovider-kubelet-k8s-io-v1-CredentialProviderResponse)
## `CredentialProviderRequest` {#credentialprovider-kubelet-k8s-io-v1-CredentialProviderRequest}
<p>CredentialProviderRequest includes the image that the kubelet requires authentication for.
Kubelet will pass this request object to the plugin via stdin. In general, plugins should
prefer responding with the same apiVersion they were sent.</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>credentialprovider.kubelet.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>CredentialProviderRequest</code></td></tr>
<tr><td><code>image</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>image is the container image that is being pulled as part of the
credential provider plugin request. Plugins may optionally parse the image
to extract any information required to fetch credentials.</p>
</td>
</tr>
</tbody>
</table>
## `CredentialProviderResponse` {#credentialprovider-kubelet-k8s-io-v1-CredentialProviderResponse}
<p>CredentialProviderResponse holds credentials that the kubelet should use for the specified
image provided in the original request. Kubelet will read the response from the plugin via stdout.
This response should be set to the same apiVersion as CredentialProviderRequest.</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>credentialprovider.kubelet.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>CredentialProviderResponse</code></td></tr>
<tr><td><code>cacheKeyType</code> <B>[Required]</B><br/>
<a href="#credentialprovider-kubelet-k8s-io-v1-PluginCacheKeyType"><code>PluginCacheKeyType</code></a>
</td>
<td>
<p>cacheKeyType indiciates the type of caching key to use based on the image provided
in the request. There are three valid values for the cache key type: Image, Registry, and
Global. If an invalid value is specified, the response will NOT be used by the kubelet.</p>
</td>
</tr>
<tr><td><code>cacheDuration</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>cacheDuration indicates the duration the provided credentials should be cached for.
The kubelet will use this field to set the in-memory cache duration for credentials
in the AuthConfig. If null, the kubelet will use defaultCacheDuration provided in
CredentialProviderConfig. If set to 0, the kubelet will not cache the provided AuthConfig.</p>
</td>
</tr>
<tr><td><code>auth</code><br/>
<a href="#credentialprovider-kubelet-k8s-io-v1-AuthConfig"><code>map[string]AuthConfig</code></a>
</td>
<td>
<p>auth is a map containing authentication information passed into the kubelet.
Each key is a match image string (more on this below). The corresponding authConfig value
should be valid for all images that match against this key. A plugin should set
this field to null if no valid credentials can be returned for the requested image.</p>
<p>Each key in the map is a pattern which can optionally contain a port and a path.
Globs can be used in the domain, but not in the port or the path. Globs are supported
as subdomains like '<em>.k8s.io' or 'k8s.</em>.io', and top-level-domains such as 'k8s.<em>'.
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
a single subdomain segment, so *.io does not match *.k8s.io.</p>
<p>The kubelet will match images against the key when all of the below are true:</p>
<ul>
<li>Both contain the same number of domain parts and each part matches.</li>
<li>The URL path of an imageMatch must be a prefix of the target image URL path.</li>
<li>If the imageMatch contains a port, then the port must match in the image as well.</li>
</ul>
<p>When multiple keys are returned, the kubelet will traverse all keys in reverse order so that:</p>
<ul>
<li>longer keys come before shorter keys with the same prefix</li>
<li>non-wildcard keys come before wildcard keys with the same prefix.</li>
</ul>
<p>For any given match, the kubelet will attempt an image pull with the provided credentials,
stopping after the first successfully authenticated pull.</p>
<p>Example keys:</p>
<ul>
<li>123456789.dkr.ecr.us-east-1.amazonaws.com</li>
<li>*.azurecr.io</li>
<li>gcr.io</li>
<li><em>.</em>.registry.io</li>
<li>registry.io:8080/path</li>
</ul>
</td>
</tr>
</tbody>
</table>
## `AuthConfig` {#credentialprovider-kubelet-k8s-io-v1-AuthConfig}
**Appears in:**
- [CredentialProviderResponse](#credentialprovider-kubelet-k8s-io-v1-CredentialProviderResponse)
<p>AuthConfig contains authentication information for a container registry.
Only username/password based authentication is supported today, but more authentication
mechanisms may be added in the future.</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/>
<code>string</code>
</td>
<td>
<p>username is the username used for authenticating to the container registry
An empty username is valid.</p>
</td>
</tr>
<tr><td><code>password</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>password is the password used for authenticating to the container registry
An empty password is valid.</p>
</td>
</tr>
</tbody>
</table>
## `PluginCacheKeyType` {#credentialprovider-kubelet-k8s-io-v1-PluginCacheKeyType}
(Alias of `string`)
**Appears in:**
- [CredentialProviderResponse](#credentialprovider-kubelet-k8s-io-v1-CredentialProviderResponse)
| kubernetes reference | title Kubelet CredentialProvider v1 content type tool reference package credentialprovider kubelet k8s io v1 auto generated true Resource Types CredentialProviderRequest credentialprovider kubelet k8s io v1 CredentialProviderRequest CredentialProviderResponse credentialprovider kubelet k8s io v1 CredentialProviderResponse CredentialProviderRequest credentialprovider kubelet k8s io v1 CredentialProviderRequest p CredentialProviderRequest includes the image that the kubelet requires authentication for Kubelet will pass this request object to the plugin via stdin In general plugins should prefer responding with the same apiVersion they were sent 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 credentialprovider kubelet k8s io v1 code td tr tr td code kind code br string td td code CredentialProviderRequest code td tr tr td code image code B Required B br code string code td td p image is the container image that is being pulled as part of the credential provider plugin request Plugins may optionally parse the image to extract any information required to fetch credentials p td tr tbody table CredentialProviderResponse credentialprovider kubelet k8s io v1 CredentialProviderResponse p CredentialProviderResponse holds credentials that the kubelet should use for the specified image provided in the original request Kubelet will read the response from the plugin via stdout This response should be set to the same apiVersion as CredentialProviderRequest 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 credentialprovider kubelet k8s io v1 code td tr tr td code kind code br string td td code CredentialProviderResponse code td tr tr td code cacheKeyType code B Required B br a href credentialprovider kubelet k8s io v1 PluginCacheKeyType code PluginCacheKeyType code a td td p cacheKeyType indiciates the type of caching key to use based on the image provided in the request There are three valid values for the cache key type Image Registry and Global If an invalid value is specified the response will NOT be used by the kubelet p td tr tr td code cacheDuration 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 cacheDuration indicates the duration the provided credentials should be cached for The kubelet will use this field to set the in memory cache duration for credentials in the AuthConfig If null the kubelet will use defaultCacheDuration provided in CredentialProviderConfig If set to 0 the kubelet will not cache the provided AuthConfig p td tr tr td code auth code br a href credentialprovider kubelet k8s io v1 AuthConfig code map string AuthConfig code a td td p auth is a map containing authentication information passed into the kubelet Each key is a match image string more on this below The corresponding authConfig value should be valid for all images that match against this key A plugin should set this field to null if no valid credentials can be returned for the requested image p p Each key in the map is a pattern which can optionally contain a port and a path Globs can be used in the domain but not in the port or the path Globs are supported as subdomains like em k8s io or k8s em io and top level domains such as k8s em Matching partial subdomains like app em k8s io is also supported Each glob can only match a single subdomain segment so io does not match k8s io p p The kubelet will match images against the key when all of the below are true p ul li Both contain the same number of domain parts and each part matches li li The URL path of an imageMatch must be a prefix of the target image URL path li li If the imageMatch contains a port then the port must match in the image as well li ul p When multiple keys are returned the kubelet will traverse all keys in reverse order so that p ul li longer keys come before shorter keys with the same prefix li li non wildcard keys come before wildcard keys with the same prefix li ul p For any given match the kubelet will attempt an image pull with the provided credentials stopping after the first successfully authenticated pull p p Example keys p ul li 123456789 dkr ecr us east 1 amazonaws com li li azurecr io li li gcr io li li em em registry io li li registry io 8080 path li ul td tr tbody table AuthConfig credentialprovider kubelet k8s io v1 AuthConfig Appears in CredentialProviderResponse credentialprovider kubelet k8s io v1 CredentialProviderResponse p AuthConfig contains authentication information for a container registry Only username password based authentication is supported today but more authentication mechanisms may be added in the future 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 code string code td td p username is the username used for authenticating to the container registry An empty username is valid p td tr tr td code password code B Required B br code string code td td p password is the password used for authenticating to the container registry An empty password is valid p td tr tbody table PluginCacheKeyType credentialprovider kubelet k8s io v1 PluginCacheKeyType Alias of string Appears in CredentialProviderResponse credentialprovider kubelet k8s io v1 CredentialProviderResponse |
kubernetes reference contenttype tool reference package apiserver k8s io v1beta1 Resource Types p Package v1beta1 is the v1beta1 version of the API p title kube apiserver Configuration v1beta1 autogenerated true | ---
title: kube-apiserver Configuration (v1beta1)
content_type: tool-reference
package: apiserver.k8s.io/v1beta1
auto_generated: true
---
<p>Package v1beta1 is the v1beta1 version of the API.</p>
## Resource Types
- [AuthenticationConfiguration](#apiserver-k8s-io-v1beta1-AuthenticationConfiguration)
- [AuthorizationConfiguration](#apiserver-k8s-io-v1beta1-AuthorizationConfiguration)
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-EgressSelectorConfiguration)
- [TracingConfiguration](#apiserver-k8s-io-v1beta1-TracingConfiguration)
## `TracingConfiguration` {#TracingConfiguration}
**Appears in:**
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
- [TracingConfiguration](#apiserver-k8s-io-v1alpha1-TracingConfiguration)
- [TracingConfiguration](#apiserver-k8s-io-v1beta1-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>
## `AuthenticationConfiguration` {#apiserver-k8s-io-v1beta1-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/v1beta1</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-v1beta1-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-v1beta1-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-v1beta1-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/v1beta1</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-v1beta1-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-v1beta1-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/v1beta1</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-v1beta1-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-v1beta1-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/v1beta1</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>
## `AnonymousAuthCondition` {#apiserver-k8s-io-v1beta1-AnonymousAuthCondition}
**Appears in:**
- [AnonymousAuthConfig](#apiserver-k8s-io-v1beta1-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-v1beta1-AnonymousAuthConfig}
**Appears in:**
- [AuthenticationConfiguration](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-AudienceMatchPolicyType}
(Alias of `string`)
**Appears in:**
- [Issuer](#apiserver-k8s-io-v1beta1-Issuer)
<p>AudienceMatchPolicyType is a set of valid values for issuer.audienceMatchPolicy</p>
## `AuthorizerConfiguration` {#apiserver-k8s-io-v1beta1-AuthorizerConfiguration}
**Appears in:**
- [AuthorizationConfiguration](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-ClaimMappings}
**Appears in:**
- [JWTAuthenticator](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-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-v1beta1-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-v1beta1-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-v1beta1-ClaimOrExpression}
**Appears in:**
- [ClaimMappings](#apiserver-k8s-io-v1beta1-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-v1beta1-ClaimValidationRule}
**Appears in:**
- [JWTAuthenticator](#apiserver-k8s-io-v1beta1-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-v1beta1-Connection}
**Appears in:**
- [EgressSelection](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-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-v1beta1-EgressSelection}
**Appears in:**
- [EgressSelectorConfiguration](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-ExtraMapping}
**Appears in:**
- [ClaimMappings](#apiserver-k8s-io-v1beta1-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-v1beta1-Issuer}
**Appears in:**
- [JWTAuthenticator](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-JWTAuthenticator}
**Appears in:**
- [AuthenticationConfiguration](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-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-v1beta1-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-v1beta1-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-v1beta1-PrefixedClaimOrExpression}
**Appears in:**
- [ClaimMappings](#apiserver-k8s-io-v1beta1-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-v1beta1-ProtocolType}
(Alias of `string`)
**Appears in:**
- [Connection](#apiserver-k8s-io-v1beta1-Connection)
<p>ProtocolType is a set of valid values for Connection.ProtocolType</p>
## `TCPTransport` {#apiserver-k8s-io-v1beta1-TCPTransport}
**Appears in:**
- [Transport](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-TLSConfig}
**Appears in:**
- [TCPTransport](#apiserver-k8s-io-v1beta1-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-v1beta1-Transport}
**Appears in:**
- [Connection](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-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-v1beta1-UDSTransport}
**Appears in:**
- [Transport](#apiserver-k8s-io-v1beta1-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-v1beta1-UserValidationRule}
**Appears in:**
- [JWTAuthenticator](#apiserver-k8s-io-v1beta1-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-v1beta1-WebhookConfiguration}
**Appears in:**
- [AuthorizerConfiguration](#apiserver-k8s-io-v1beta1-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-v1beta1-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-v1beta1-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-v1beta1-WebhookConnectionInfo}
**Appears in:**
- [WebhookConfiguration](#apiserver-k8s-io-v1beta1-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-v1beta1-WebhookMatchCondition}
**Appears in:**
- [WebhookConfiguration](#apiserver-k8s-io-v1beta1-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 v1beta1 content type tool reference package apiserver k8s io v1beta1 auto generated true p Package v1beta1 is the v1beta1 version of the API p Resource Types AuthenticationConfiguration apiserver k8s io v1beta1 AuthenticationConfiguration AuthorizationConfiguration apiserver k8s io v1beta1 AuthorizationConfiguration EgressSelectorConfiguration apiserver k8s io v1beta1 EgressSelectorConfiguration TracingConfiguration apiserver k8s io v1beta1 TracingConfiguration TracingConfiguration TracingConfiguration Appears in KubeletConfiguration kubelet config k8s io v1beta1 KubeletConfiguration TracingConfiguration apiserver k8s io v1alpha1 TracingConfiguration TracingConfiguration apiserver k8s io v1beta1 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 AuthenticationConfiguration apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 AnonymousAuthCondition apiserver k8s io v1beta1 AnonymousAuthCondition Appears in AnonymousAuthConfig apiserver k8s io v1beta1 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 v1beta1 AnonymousAuthConfig Appears in AuthenticationConfiguration apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 AudienceMatchPolicyType Alias of string Appears in Issuer apiserver k8s io v1beta1 Issuer p AudienceMatchPolicyType is a set of valid values for issuer audienceMatchPolicy p AuthorizerConfiguration apiserver k8s io v1beta1 AuthorizerConfiguration Appears in AuthorizationConfiguration apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 ClaimMappings Appears in JWTAuthenticator apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 ClaimOrExpression Appears in ClaimMappings apiserver k8s io v1beta1 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 v1beta1 ClaimValidationRule Appears in JWTAuthenticator apiserver k8s io v1beta1 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 v1beta1 Connection Appears in EgressSelection apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 EgressSelection Appears in EgressSelectorConfiguration apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 ExtraMapping Appears in ClaimMappings apiserver k8s io v1beta1 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 v1beta1 Issuer Appears in JWTAuthenticator apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 JWTAuthenticator Appears in AuthenticationConfiguration apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 PrefixedClaimOrExpression Appears in ClaimMappings apiserver k8s io v1beta1 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 v1beta1 ProtocolType Alias of string Appears in Connection apiserver k8s io v1beta1 Connection p ProtocolType is a set of valid values for Connection ProtocolType p TCPTransport apiserver k8s io v1beta1 TCPTransport Appears in Transport apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 TLSConfig Appears in TCPTransport apiserver k8s io v1beta1 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 v1beta1 Transport Appears in Connection apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 UDSTransport Appears in Transport apiserver k8s io v1beta1 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 v1beta1 UserValidationRule Appears in JWTAuthenticator apiserver k8s io v1beta1 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 v1beta1 WebhookConfiguration Appears in AuthorizerConfiguration apiserver k8s io v1beta1 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 v1beta1 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 v1beta1 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 v1beta1 WebhookConnectionInfo Appears in WebhookConfiguration apiserver k8s io v1beta1 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 v1beta1 WebhookMatchCondition Appears in WebhookConfiguration apiserver k8s io v1beta1 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 kubelet config k8s io v1 contenttype tool reference Resource Types title Kubelet Configuration v1 autogenerated true | ---
title: Kubelet Configuration (v1)
content_type: tool-reference
package: kubelet.config.k8s.io/v1
auto_generated: true
---
## Resource Types
- [CredentialProviderConfig](#kubelet-config-k8s-io-v1-CredentialProviderConfig)
## `CredentialProviderConfig` {#kubelet-config-k8s-io-v1-CredentialProviderConfig}
<p>CredentialProviderConfig is the configuration containing information about
each exec credential provider. Kubelet reads this configuration from disk and enables
each provider as specified by the CredentialProvider type.</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>kubelet.config.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>CredentialProviderConfig</code></td></tr>
<tr><td><code>providers</code> <B>[Required]</B><br/>
<a href="#kubelet-config-k8s-io-v1-CredentialProvider"><code>[]CredentialProvider</code></a>
</td>
<td>
<p>providers is a list of credential provider plugins that will be enabled by the kubelet.
Multiple providers may match against a single image, in which case credentials
from all providers will be returned to the kubelet. If multiple providers are called
for a single image, the results are combined. If providers return overlapping
auth keys, the value from the provider earlier in this list is used.</p>
</td>
</tr>
</tbody>
</table>
## `CredentialProvider` {#kubelet-config-k8s-io-v1-CredentialProvider}
**Appears in:**
- [CredentialProviderConfig](#kubelet-config-k8s-io-v1-CredentialProviderConfig)
<p>CredentialProvider represents an exec plugin to be invoked by the kubelet. The plugin is only
invoked when an image being pulled matches the images handled by the plugin (see matchImages).</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 required name of the credential provider. It must match the name of the
provider executable as seen by the kubelet. The executable must be in the kubelet's
bin directory (set by the --image-credential-provider-bin-dir flag).</p>
</td>
</tr>
<tr><td><code>matchImages</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>matchImages is a required list of strings used to match against images in order to
determine if this provider should be invoked. If one of the strings matches the
requested image from the kubelet, the plugin will be invoked and given a chance
to provide credentials. Images are expected to contain the registry domain
and URL path.</p>
<p>Each entry in matchImages is a pattern which can optionally contain a port and a path.
Globs can be used in the domain, but not in the port or the path. Globs are supported
as subdomains like '<em>.k8s.io' or 'k8s.</em>.io', and top-level-domains such as 'k8s.<em>'.
Matching partial subdomains like 'app</em>.k8s.io' is also supported. Each glob can only match
a single subdomain segment, so *.io does not match *.k8s.io.</p>
<p>A match exists between an image and a matchImage when all of the below are true:</p>
<ul>
<li>Both contain the same number of domain parts and each part matches.</li>
<li>The URL path of an imageMatch must be a prefix of the target image URL path.</li>
<li>If the imageMatch contains a port, then the port must match in the image as well.</li>
</ul>
<p>Example values of matchImages:</p>
<ul>
<li>123456789.dkr.ecr.us-east-1.amazonaws.com</li>
<li>*.azurecr.io</li>
<li>gcr.io</li>
<li><em>.</em>.registry.io</li>
<li>registry.io:8080/path</li>
</ul>
</td>
</tr>
<tr><td><code>defaultCacheDuration</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>defaultCacheDuration is the default duration the plugin will cache credentials in-memory
if a cache duration is not provided in the plugin response. This field is required.</p>
</td>
</tr>
<tr><td><code>apiVersion</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Required input version of the exec CredentialProviderRequest. The returned CredentialProviderResponse
MUST use the same encoding version as the input. Current supported values are:</p>
<ul>
<li>credentialprovider.kubelet.k8s.io/v1</li>
</ul>
</td>
</tr>
<tr><td><code>args</code><br/>
<code>[]string</code>
</td>
<td>
<p>Arguments to pass to the command when executing it.</p>
</td>
</tr>
<tr><td><code>env</code><br/>
<a href="#kubelet-config-k8s-io-v1-ExecEnvVar"><code>[]ExecEnvVar</code></a>
</td>
<td>
<p>Env defines additional environment variables to expose to the process. These
are unioned with the host's environment, as well as variables client-go uses
to pass argument to the plugin.</p>
</td>
</tr>
</tbody>
</table>
## `ExecEnvVar` {#kubelet-config-k8s-io-v1-ExecEnvVar}
**Appears in:**
- [CredentialProvider](#kubelet-config-k8s-io-v1-CredentialProvider)
<p>ExecEnvVar is used for setting environment variables when executing an exec-based
credential plugin.</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>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>value</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
| kubernetes reference | title Kubelet Configuration v1 content type tool reference package kubelet config k8s io v1 auto generated true Resource Types CredentialProviderConfig kubelet config k8s io v1 CredentialProviderConfig CredentialProviderConfig kubelet config k8s io v1 CredentialProviderConfig p CredentialProviderConfig is the configuration containing information about each exec credential provider Kubelet reads this configuration from disk and enables each provider as specified by the CredentialProvider type 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 kubelet config k8s io v1 code td tr tr td code kind code br string td td code CredentialProviderConfig code td tr tr td code providers code B Required B br a href kubelet config k8s io v1 CredentialProvider code CredentialProvider code a td td p providers is a list of credential provider plugins that will be enabled by the kubelet Multiple providers may match against a single image in which case credentials from all providers will be returned to the kubelet If multiple providers are called for a single image the results are combined If providers return overlapping auth keys the value from the provider earlier in this list is used p td tr tbody table CredentialProvider kubelet config k8s io v1 CredentialProvider Appears in CredentialProviderConfig kubelet config k8s io v1 CredentialProviderConfig p CredentialProvider represents an exec plugin to be invoked by the kubelet The plugin is only invoked when an image being pulled matches the images handled by the plugin see matchImages 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 required name of the credential provider It must match the name of the provider executable as seen by the kubelet The executable must be in the kubelet s bin directory set by the image credential provider bin dir flag p td tr tr td code matchImages code B Required B br code string code td td p matchImages is a required list of strings used to match against images in order to determine if this provider should be invoked If one of the strings matches the requested image from the kubelet the plugin will be invoked and given a chance to provide credentials Images are expected to contain the registry domain and URL path p p Each entry in matchImages is a pattern which can optionally contain a port and a path Globs can be used in the domain but not in the port or the path Globs are supported as subdomains like em k8s io or k8s em io and top level domains such as k8s em Matching partial subdomains like app em k8s io is also supported Each glob can only match a single subdomain segment so io does not match k8s io p p A match exists between an image and a matchImage when all of the below are true p ul li Both contain the same number of domain parts and each part matches li li The URL path of an imageMatch must be a prefix of the target image URL path li li If the imageMatch contains a port then the port must match in the image as well li ul p Example values of matchImages p ul li 123456789 dkr ecr us east 1 amazonaws com li li azurecr io li li gcr io li li em em registry io li li registry io 8080 path li ul td tr tr td code defaultCacheDuration 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 defaultCacheDuration is the default duration the plugin will cache credentials in memory if a cache duration is not provided in the plugin response This field is required p td tr tr td code apiVersion code B Required B br code string code td td p Required input version of the exec CredentialProviderRequest The returned CredentialProviderResponse MUST use the same encoding version as the input Current supported values are p ul li credentialprovider kubelet k8s io v1 li ul td tr tr td code args code br code string code td td p Arguments to pass to the command when executing it p td tr tr td code env code br a href kubelet config k8s io v1 ExecEnvVar code ExecEnvVar code a td td p Env defines additional environment variables to expose to the process These are unioned with the host s environment as well as variables client go uses to pass argument to the plugin p td tr tbody table ExecEnvVar kubelet config k8s io v1 ExecEnvVar Appears in CredentialProvider kubelet config k8s io v1 CredentialProvider p ExecEnvVar is used for setting environment variables when executing an exec based credential plugin 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 span class text muted No description provided span td tr tr td code value code B Required B br code string code td td span class text muted No description provided span td tr tbody table |
kubernetes reference title Kubelet Configuration v1alpha1 contenttype tool reference Resource Types package kubelet config k8s io v1alpha1 autogenerated true | ---
title: Kubelet Configuration (v1alpha1)
content_type: tool-reference
package: kubelet.config.k8s.io/v1alpha1
auto_generated: true
---
## Resource Types
- [CredentialProviderConfig](#kubelet-config-k8s-io-v1alpha1-CredentialProviderConfig)
## `CredentialProviderConfig` {#kubelet-config-k8s-io-v1alpha1-CredentialProviderConfig}
<p>CredentialProviderConfig is the configuration containing information about
each exec credential provider. Kubelet reads this configuration from disk and enables
each provider as specified by the CredentialProvider type.</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>kubelet.config.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>CredentialProviderConfig</code></td></tr>
<tr><td><code>providers</code> <B>[Required]</B><br/>
<a href="#kubelet-config-k8s-io-v1alpha1-CredentialProvider"><code>[]CredentialProvider</code></a>
</td>
<td>
<p>providers is a list of credential provider plugins that will be enabled by the kubelet.
Multiple providers may match against a single image, in which case credentials
from all providers will be returned to the kubelet. If multiple providers are called
for a single image, the results are combined. If providers return overlapping
auth keys, the value from the provider earlier in this list is used.</p>
</td>
</tr>
</tbody>
</table>
## `CredentialProvider` {#kubelet-config-k8s-io-v1alpha1-CredentialProvider}
**Appears in:**
- [CredentialProviderConfig](#kubelet-config-k8s-io-v1alpha1-CredentialProviderConfig)
<p>CredentialProvider represents an exec plugin to be invoked by the kubelet. The plugin is only
invoked when an image being pulled matches the images handled by the plugin (see matchImages).</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 required name of the credential provider. It must match the name of the
provider executable as seen by the kubelet. The executable must be in the kubelet's
bin directory (set by the --image-credential-provider-bin-dir flag).</p>
</td>
</tr>
<tr><td><code>matchImages</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>matchImages is a required list of strings used to match against images in order to
determine if this provider should be invoked. If one of the strings matches the
requested image from the kubelet, the plugin will be invoked and given a chance
to provide credentials. Images are expected to contain the registry domain
and URL path.</p>
<p>Each entry in matchImages is a pattern which can optionally contain a port and a path.
Globs can be used in the domain, but not in the port or the path. Globs are supported
as subdomains like <code>*.k8s.io</code> or <code>k8s.*.io</code>, and top-level-domains such as <code>k8s.*</code>.
Matching partial subdomains like <code>app*.k8s.io</code> is also supported. Each glob can only match
a single subdomain segment, so <code>*.io</code> does not match <code>*.k8s.io</code>.</p>
<p>A match exists between an image and a matchImage when all of the below are true:</p>
<ul>
<li>Both contain the same number of domain parts and each part matches.</li>
<li>The URL path of an imageMatch must be a prefix of the target image URL path.</li>
<li>If the imageMatch contains a port, then the port must match in the image as well.</li>
</ul>
<p>Example values of matchImages:</p>
<ul>
<li><code>123456789.dkr.ecr.us-east-1.amazonaws.com</code></li>
<li><code>*.azurecr.io</code></li>
<li><code>gcr.io</code></li>
<li><code>*.*.registry.io</code></li>
<li><code>registry.io:8080/path</code></li>
</ul>
</td>
</tr>
<tr><td><code>defaultCacheDuration</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>defaultCacheDuration is the default duration the plugin will cache credentials in-memory
if a cache duration is not provided in the plugin response. This field is required.</p>
</td>
</tr>
<tr><td><code>apiVersion</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Required input version of the exec CredentialProviderRequest. The returned CredentialProviderResponse
MUST use the same encoding version as the input. Current supported values are:</p>
<ul>
<li>credentialprovider.kubelet.k8s.io/v1alpha1</li>
</ul>
</td>
</tr>
<tr><td><code>args</code><br/>
<code>[]string</code>
</td>
<td>
<p>Arguments to pass to the command when executing it.</p>
</td>
</tr>
<tr><td><code>env</code><br/>
<a href="#kubelet-config-k8s-io-v1alpha1-ExecEnvVar"><code>[]ExecEnvVar</code></a>
</td>
<td>
<p>Env defines additional environment variables to expose to the process. These
are unioned with the host's environment, as well as variables client-go uses
to pass argument to the plugin.</p>
</td>
</tr>
</tbody>
</table>
## `ExecEnvVar` {#kubelet-config-k8s-io-v1alpha1-ExecEnvVar}
**Appears in:**
- [CredentialProvider](#kubelet-config-k8s-io-v1alpha1-CredentialProvider)
<p>ExecEnvVar is used for setting environment variables when executing an exec-based
credential plugin.</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>
<span class="text-muted">No description provided.</span></td>
</tr>
<tr><td><code>value</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
</tr>
</tbody>
</table>
| kubernetes reference | title Kubelet Configuration v1alpha1 content type tool reference package kubelet config k8s io v1alpha1 auto generated true Resource Types CredentialProviderConfig kubelet config k8s io v1alpha1 CredentialProviderConfig CredentialProviderConfig kubelet config k8s io v1alpha1 CredentialProviderConfig p CredentialProviderConfig is the configuration containing information about each exec credential provider Kubelet reads this configuration from disk and enables each provider as specified by the CredentialProvider type 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 kubelet config k8s io v1alpha1 code td tr tr td code kind code br string td td code CredentialProviderConfig code td tr tr td code providers code B Required B br a href kubelet config k8s io v1alpha1 CredentialProvider code CredentialProvider code a td td p providers is a list of credential provider plugins that will be enabled by the kubelet Multiple providers may match against a single image in which case credentials from all providers will be returned to the kubelet If multiple providers are called for a single image the results are combined If providers return overlapping auth keys the value from the provider earlier in this list is used p td tr tbody table CredentialProvider kubelet config k8s io v1alpha1 CredentialProvider Appears in CredentialProviderConfig kubelet config k8s io v1alpha1 CredentialProviderConfig p CredentialProvider represents an exec plugin to be invoked by the kubelet The plugin is only invoked when an image being pulled matches the images handled by the plugin see matchImages 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 required name of the credential provider It must match the name of the provider executable as seen by the kubelet The executable must be in the kubelet s bin directory set by the image credential provider bin dir flag p td tr tr td code matchImages code B Required B br code string code td td p matchImages is a required list of strings used to match against images in order to determine if this provider should be invoked If one of the strings matches the requested image from the kubelet the plugin will be invoked and given a chance to provide credentials Images are expected to contain the registry domain and URL path p p Each entry in matchImages is a pattern which can optionally contain a port and a path Globs can be used in the domain but not in the port or the path Globs are supported as subdomains like code k8s io code or code k8s io code and top level domains such as code k8s code Matching partial subdomains like code app k8s io code is also supported Each glob can only match a single subdomain segment so code io code does not match code k8s io code p p A match exists between an image and a matchImage when all of the below are true p ul li Both contain the same number of domain parts and each part matches li li The URL path of an imageMatch must be a prefix of the target image URL path li li If the imageMatch contains a port then the port must match in the image as well li ul p Example values of matchImages p ul li code 123456789 dkr ecr us east 1 amazonaws com code li li code azurecr io code li li code gcr io code li li code registry io code li li code registry io 8080 path code li ul td tr tr td code defaultCacheDuration 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 defaultCacheDuration is the default duration the plugin will cache credentials in memory if a cache duration is not provided in the plugin response This field is required p td tr tr td code apiVersion code B Required B br code string code td td p Required input version of the exec CredentialProviderRequest The returned CredentialProviderResponse MUST use the same encoding version as the input Current supported values are p ul li credentialprovider kubelet k8s io v1alpha1 li ul td tr tr td code args code br code string code td td p Arguments to pass to the command when executing it p td tr tr td code env code br a href kubelet config k8s io v1alpha1 ExecEnvVar code ExecEnvVar code a td td p Env defines additional environment variables to expose to the process These are unioned with the host s environment as well as variables client go uses to pass argument to the plugin p td tr tbody table ExecEnvVar kubelet config k8s io v1alpha1 ExecEnvVar Appears in CredentialProvider kubelet config k8s io v1alpha1 CredentialProvider p ExecEnvVar is used for setting environment variables when executing an exec based credential plugin 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 span class text muted No description provided span td tr tr td code value code B Required B br code string code td td span class text muted No description provided span td tr tbody table |
kubernetes reference contenttype tool reference title Event Rate Limit Configuration v1alpha1 package eventratelimit admission k8s io v1alpha1 Resource Types autogenerated true | ---
title: Event Rate Limit Configuration (v1alpha1)
content_type: tool-reference
package: eventratelimit.admission.k8s.io/v1alpha1
auto_generated: true
---
## Resource Types
- [Configuration](#eventratelimit-admission-k8s-io-v1alpha1-Configuration)
## `Configuration` {#eventratelimit-admission-k8s-io-v1alpha1-Configuration}
<p>Configuration provides configuration for the EventRateLimit admission
controller.</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>eventratelimit.admission.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>Configuration</code></td></tr>
<tr><td><code>limits</code> <B>[Required]</B><br/>
<a href="#eventratelimit-admission-k8s-io-v1alpha1-Limit"><code>[]Limit</code></a>
</td>
<td>
<p>limits are the limits to place on event queries received.
Limits can be placed on events received server-wide, per namespace,
per user, and per source+object.
At least one limit is required.</p>
</td>
</tr>
</tbody>
</table>
## `Limit` {#eventratelimit-admission-k8s-io-v1alpha1-Limit}
**Appears in:**
- [Configuration](#eventratelimit-admission-k8s-io-v1alpha1-Configuration)
<p>Limit is the configuration for a particular limit type</p>
<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/>
<a href="#eventratelimit-admission-k8s-io-v1alpha1-LimitType"><code>LimitType</code></a>
</td>
<td>
<p>type is the type of limit to which this configuration applies</p>
</td>
</tr>
<tr><td><code>qps</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>qps is the number of event queries per second that are allowed for this
type of limit. The qps and burst fields are used together to determine if
a particular event query is accepted. The qps determines how many queries
are accepted once the burst amount of queries has been exhausted.</p>
</td>
</tr>
<tr><td><code>burst</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>burst is the burst number of event queries that are allowed for this type
of limit. The qps and burst fields are used together to determine if a
particular event query is accepted. The burst determines the maximum size
of the allowance granted for a particular bucket. For example, if the burst
is 10 and the qps is 3, then the admission control will accept 10 queries
before blocking any queries. Every second, 3 more queries will be allowed.
If some of that allowance is not used, then it will roll over to the next
second, until the maximum allowance of 10 is reached.</p>
</td>
</tr>
<tr><td><code>cacheSize</code><br/>
<code>int32</code>
</td>
<td>
<p>cacheSize is the size of the LRU cache for this type of limit. If a bucket
is evicted from the cache, then the allowance for that bucket is reset. If
more queries are later received for an evicted bucket, then that bucket
will re-enter the cache with a clean slate, giving that bucket a full
allowance of burst queries.</p>
<p>The default cache size is 4096.</p>
<p>If limitType is 'server', then cacheSize is ignored.</p>
</td>
</tr>
</tbody>
</table>
## `LimitType` {#eventratelimit-admission-k8s-io-v1alpha1-LimitType}
(Alias of `string`)
**Appears in:**
- [Limit](#eventratelimit-admission-k8s-io-v1alpha1-Limit)
<p>LimitType is the type of the limit (e.g., per-namespace)</p>
| kubernetes reference | title Event Rate Limit Configuration v1alpha1 content type tool reference package eventratelimit admission k8s io v1alpha1 auto generated true Resource Types Configuration eventratelimit admission k8s io v1alpha1 Configuration Configuration eventratelimit admission k8s io v1alpha1 Configuration p Configuration provides configuration for the EventRateLimit admission controller 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 eventratelimit admission k8s io v1alpha1 code td tr tr td code kind code br string td td code Configuration code td tr tr td code limits code B Required B br a href eventratelimit admission k8s io v1alpha1 Limit code Limit code a td td p limits are the limits to place on event queries received Limits can be placed on events received server wide per namespace per user and per source object At least one limit is required p td tr tbody table Limit eventratelimit admission k8s io v1alpha1 Limit Appears in Configuration eventratelimit admission k8s io v1alpha1 Configuration p Limit is the configuration for a particular limit type p 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 a href eventratelimit admission k8s io v1alpha1 LimitType code LimitType code a td td p type is the type of limit to which this configuration applies p td tr tr td code qps code B Required B br code int32 code td td p qps is the number of event queries per second that are allowed for this type of limit The qps and burst fields are used together to determine if a particular event query is accepted The qps determines how many queries are accepted once the burst amount of queries has been exhausted p td tr tr td code burst code B Required B br code int32 code td td p burst is the burst number of event queries that are allowed for this type of limit The qps and burst fields are used together to determine if a particular event query is accepted The burst determines the maximum size of the allowance granted for a particular bucket For example if the burst is 10 and the qps is 3 then the admission control will accept 10 queries before blocking any queries Every second 3 more queries will be allowed If some of that allowance is not used then it will roll over to the next second until the maximum allowance of 10 is reached p td tr tr td code cacheSize code br code int32 code td td p cacheSize is the size of the LRU cache for this type of limit If a bucket is evicted from the cache then the allowance for that bucket is reset If more queries are later received for an evicted bucket then that bucket will re enter the cache with a clean slate giving that bucket a full allowance of burst queries p p The default cache size is 4096 p p If limitType is server then cacheSize is ignored p td tr tbody table LimitType eventratelimit admission k8s io v1alpha1 LimitType Alias of string Appears in Limit eventratelimit admission k8s io v1alpha1 Limit p LimitType is the type of the limit e g per namespace p |
kubernetes reference contenttype tool reference Resource Types title kube controller manager Configuration v1alpha1 package kubecontrollermanager config k8s io v1alpha1 autogenerated true | ---
title: kube-controller-manager Configuration (v1alpha1)
content_type: tool-reference
package: kubecontrollermanager.config.k8s.io/v1alpha1
auto_generated: true
---
## Resource Types
- [CloudControllerManagerConfiguration](#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudControllerManagerConfiguration)
- [LeaderMigrationConfiguration](#controllermanager-config-k8s-io-v1alpha1-LeaderMigrationConfiguration)
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
## `NodeControllerConfiguration` {#NodeControllerConfiguration}
**Appears in:**
- [CloudControllerManagerConfiguration](#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudControllerManagerConfiguration)
<p>NodeControllerConfiguration contains elements describing NodeController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentNodeSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>ConcurrentNodeSyncs is the number of workers
concurrently synchronizing nodes</p>
</td>
</tr>
</tbody>
</table>
## `ServiceControllerConfiguration` {#ServiceControllerConfiguration}
**Appears in:**
- [CloudControllerManagerConfiguration](#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudControllerManagerConfiguration)
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>ServiceControllerConfiguration contains elements describing ServiceController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentServiceSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentServiceSyncs is 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>
</tbody>
</table>
## `CloudControllerManagerConfiguration` {#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudControllerManagerConfiguration}
<p>CloudControllerManagerConfiguration contains elements describing cloud-controller manager.</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>cloudcontrollermanager.config.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>CloudControllerManagerConfiguration</code></td></tr>
<tr><td><code>Generic</code> <B>[Required]</B><br/>
<a href="#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration"><code>GenericControllerManagerConfiguration</code></a>
</td>
<td>
<p>Generic holds configuration for a generic controller-manager</p>
</td>
</tr>
<tr><td><code>KubeCloudShared</code> <B>[Required]</B><br/>
<a href="#cloudcontrollermanager-config-k8s-io-v1alpha1-KubeCloudSharedConfiguration"><code>KubeCloudSharedConfiguration</code></a>
</td>
<td>
<p>KubeCloudSharedConfiguration holds configuration for shared related features
both in cloud controller manager and kube-controller manager.</p>
</td>
</tr>
<tr><td><code>NodeController</code> <B>[Required]</B><br/>
<a href="#NodeControllerConfiguration"><code>NodeControllerConfiguration</code></a>
</td>
<td>
<p>NodeController holds configuration for node controller
related features.</p>
</td>
</tr>
<tr><td><code>ServiceController</code> <B>[Required]</B><br/>
<a href="#ServiceControllerConfiguration"><code>ServiceControllerConfiguration</code></a>
</td>
<td>
<p>ServiceControllerConfiguration holds configuration for ServiceController
related features.</p>
</td>
</tr>
<tr><td><code>NodeStatusUpdateFrequency</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>NodeStatusUpdateFrequency is the frequency at which the controller updates nodes' status</p>
</td>
</tr>
<tr><td><code>Webhook</code> <B>[Required]</B><br/>
<a href="#cloudcontrollermanager-config-k8s-io-v1alpha1-WebhookConfiguration"><code>WebhookConfiguration</code></a>
</td>
<td>
<p>Webhook is the configuration for cloud-controller-manager hosted webhooks</p>
</td>
</tr>
</tbody>
</table>
## `CloudProviderConfiguration` {#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudProviderConfiguration}
**Appears in:**
- [KubeCloudSharedConfiguration](#cloudcontrollermanager-config-k8s-io-v1alpha1-KubeCloudSharedConfiguration)
<p>CloudProviderConfiguration contains basically elements about cloud provider.</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 provider for cloud services.</p>
</td>
</tr>
<tr><td><code>CloudConfigFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>cloudConfigFile is the path to the cloud provider configuration file.</p>
</td>
</tr>
</tbody>
</table>
## `KubeCloudSharedConfiguration` {#cloudcontrollermanager-config-k8s-io-v1alpha1-KubeCloudSharedConfiguration}
**Appears in:**
- [CloudControllerManagerConfiguration](#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudControllerManagerConfiguration)
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>KubeCloudSharedConfiguration contains elements shared by both kube-controller manager
and cloud-controller manager, but not genericconfig.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>CloudProvider</code> <B>[Required]</B><br/>
<a href="#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudProviderConfiguration"><code>CloudProviderConfiguration</code></a>
</td>
<td>
<p>CloudProviderConfiguration holds configuration for CloudProvider related features.</p>
</td>
</tr>
<tr><td><code>ExternalCloudVolumePlugin</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>externalCloudVolumePlugin specifies the plugin to use when cloudProvider is "external".
It is currently used by the in repo cloud providers to handle node and volume control in the KCM.</p>
</td>
</tr>
<tr><td><code>UseServiceAccountCredentials</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>useServiceAccountCredentials indicates whether controllers should be run with
individual service account credentials.</p>
</td>
</tr>
<tr><td><code>AllowUntaggedCloud</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>run with untagged cloud instances</p>
</td>
</tr>
<tr><td><code>RouteReconciliationPeriod</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>routeReconciliationPeriod is the period for reconciling routes created for Nodes by cloud provider..</p>
</td>
</tr>
<tr><td><code>NodeMonitorPeriod</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>nodeMonitorPeriod is the period for syncing NodeStatus in NodeController.</p>
</td>
</tr>
<tr><td><code>ClusterName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>clusterName is the instance prefix for the cluster.</p>
</td>
</tr>
<tr><td><code>ClusterCIDR</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>clusterCIDR is CIDR Range for Pods in cluster.</p>
</td>
</tr>
<tr><td><code>AllocateNodeCIDRs</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>AllocateNodeCIDRs enables CIDRs for Pods to be allocated and, if
ConfigureCloudRoutes is true, to be set on the cloud provider.</p>
</td>
</tr>
<tr><td><code>CIDRAllocatorType</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>CIDRAllocatorType determines what kind of pod CIDR allocator will be used.</p>
</td>
</tr>
<tr><td><code>ConfigureCloudRoutes</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>configureCloudRoutes enables CIDRs allocated with allocateNodeCIDRs
to be configured on the cloud provider.</p>
</td>
</tr>
<tr><td><code>NodeSyncPeriod</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>nodeSyncPeriod is the period for syncing nodes from cloudprovider. Longer
periods will result in fewer calls to cloud provider, but may delay addition
of new nodes to cluster.</p>
</td>
</tr>
</tbody>
</table>
## `WebhookConfiguration` {#cloudcontrollermanager-config-k8s-io-v1alpha1-WebhookConfiguration}
**Appears in:**
- [CloudControllerManagerConfiguration](#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudControllerManagerConfiguration)
<p>WebhookConfiguration contains configuration related to
cloud-controller-manager hosted webhooks</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>Webhooks</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>Webhooks is the list of webhooks to enable or disable
'*' means "all enabled by default webhooks"
'foo' means "enable 'foo'"
'-foo' means "disable 'foo'"
first item for a particular name wins</p>
</td>
</tr>
</tbody>
</table>
## `LeaderMigrationConfiguration` {#controllermanager-config-k8s-io-v1alpha1-LeaderMigrationConfiguration}
**Appears in:**
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
<p>LeaderMigrationConfiguration provides versioned configuration for all migrating leader locks.</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>controllermanager.config.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>LeaderMigrationConfiguration</code></td></tr>
<tr><td><code>leaderName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>LeaderName is the name of the leader election resource that protects the migration
E.g. 1-20-KCM-to-1-21-CCM</p>
</td>
</tr>
<tr><td><code>resourceLock</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>ResourceLock indicates the resource object type that will be used to lock
Should be "leases" or "endpoints"</p>
</td>
</tr>
<tr><td><code>controllerLeaders</code> <B>[Required]</B><br/>
<a href="#controllermanager-config-k8s-io-v1alpha1-ControllerLeaderConfiguration"><code>[]ControllerLeaderConfiguration</code></a>
</td>
<td>
<p>ControllerLeaders contains a list of migrating leader lock configurations</p>
</td>
</tr>
</tbody>
</table>
## `ControllerLeaderConfiguration` {#controllermanager-config-k8s-io-v1alpha1-ControllerLeaderConfiguration}
**Appears in:**
- [LeaderMigrationConfiguration](#controllermanager-config-k8s-io-v1alpha1-LeaderMigrationConfiguration)
<p>ControllerLeaderConfiguration provides the configuration for a migrating leader lock.</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 controller being migrated
E.g. service-controller, route-controller, cloud-node-controller, etc</p>
</td>
</tr>
<tr><td><code>component</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>Component is the name of the component in which the controller should be running.
E.g. kube-controller-manager, cloud-controller-manager, etc
Or '*' meaning the controller can be run under any component that participates in the migration</p>
</td>
</tr>
</tbody>
</table>
## `GenericControllerManagerConfiguration` {#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration}
**Appears in:**
- [CloudControllerManagerConfiguration](#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudControllerManagerConfiguration)
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>GenericControllerManagerConfiguration holds configuration for a generic controller-manager.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>Port</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>port is the port that the controller-manager's http service runs on.</p>
</td>
</tr>
<tr><td><code>Address</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>address is the IP address to serve on (set to 0.0.0.0 for all interfaces).</p>
</td>
</tr>
<tr><td><code>MinResyncPeriod</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>minResyncPeriod is the resync period in reflectors; will be random between
minResyncPeriod and 2*minResyncPeriod.</p>
</td>
</tr>
<tr><td><code>ClientConnection</code> <B>[Required]</B><br/>
<a href="#ClientConnectionConfiguration"><code>ClientConnectionConfiguration</code></a>
</td>
<td>
<p>ClientConnection specifies the kubeconfig file and client connection
settings for the proxy server to use when communicating with the apiserver.</p>
</td>
</tr>
<tr><td><code>ControllerStartInterval</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>How long to wait between starting controller managers</p>
</td>
</tr>
<tr><td><code>LeaderElection</code> <B>[Required]</B><br/>
<a href="#LeaderElectionConfiguration"><code>LeaderElectionConfiguration</code></a>
</td>
<td>
<p>leaderElection defines the configuration of leader election client.</p>
</td>
</tr>
<tr><td><code>Controllers</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>Controllers is the list of controllers to enable or disable
'*' means "all enabled by default controllers"
'foo' means "enable 'foo'"
'-foo' means "disable 'foo'"
first item for a particular name wins</p>
</td>
</tr>
<tr><td><code>Debugging</code> <B>[Required]</B><br/>
<a href="#DebuggingConfiguration"><code>DebuggingConfiguration</code></a>
</td>
<td>
<p>DebuggingConfiguration holds configuration for Debugging related features.</p>
</td>
</tr>
<tr><td><code>LeaderMigrationEnabled</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>LeaderMigrationEnabled indicates whether Leader Migration should be enabled for the controller manager.</p>
</td>
</tr>
<tr><td><code>LeaderMigration</code> <B>[Required]</B><br/>
<a href="#controllermanager-config-k8s-io-v1alpha1-LeaderMigrationConfiguration"><code>LeaderMigrationConfiguration</code></a>
</td>
<td>
<p>LeaderMigration holds the configuration for Leader Migration.</p>
</td>
</tr>
</tbody>
</table>
## `KubeControllerManagerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration}
<p>KubeControllerManagerConfiguration contains elements describing kube-controller manager.</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>kubecontrollermanager.config.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>KubeControllerManagerConfiguration</code></td></tr>
<tr><td><code>Generic</code> <B>[Required]</B><br/>
<a href="#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration"><code>GenericControllerManagerConfiguration</code></a>
</td>
<td>
<p>Generic holds configuration for a generic controller-manager</p>
</td>
</tr>
<tr><td><code>KubeCloudShared</code> <B>[Required]</B><br/>
<a href="#cloudcontrollermanager-config-k8s-io-v1alpha1-KubeCloudSharedConfiguration"><code>KubeCloudSharedConfiguration</code></a>
</td>
<td>
<p>KubeCloudSharedConfiguration holds configuration for shared related features
both in cloud controller manager and kube-controller manager.</p>
</td>
</tr>
<tr><td><code>AttachDetachController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-AttachDetachControllerConfiguration"><code>AttachDetachControllerConfiguration</code></a>
</td>
<td>
<p>AttachDetachControllerConfiguration holds configuration for
AttachDetachController related features.</p>
</td>
</tr>
<tr><td><code>CSRSigningController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-CSRSigningControllerConfiguration"><code>CSRSigningControllerConfiguration</code></a>
</td>
<td>
<p>CSRSigningControllerConfiguration holds configuration for
CSRSigningController related features.</p>
</td>
</tr>
<tr><td><code>DaemonSetController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-DaemonSetControllerConfiguration"><code>DaemonSetControllerConfiguration</code></a>
</td>
<td>
<p>DaemonSetControllerConfiguration holds configuration for DaemonSetController
related features.</p>
</td>
</tr>
<tr><td><code>DeploymentController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-DeploymentControllerConfiguration"><code>DeploymentControllerConfiguration</code></a>
</td>
<td>
<p>DeploymentControllerConfiguration holds configuration for
DeploymentController related features.</p>
</td>
</tr>
<tr><td><code>StatefulSetController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-StatefulSetControllerConfiguration"><code>StatefulSetControllerConfiguration</code></a>
</td>
<td>
<p>StatefulSetControllerConfiguration holds configuration for
StatefulSetController related features.</p>
</td>
</tr>
<tr><td><code>DeprecatedController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-DeprecatedControllerConfiguration"><code>DeprecatedControllerConfiguration</code></a>
</td>
<td>
<p>DeprecatedControllerConfiguration holds configuration for some deprecated
features.</p>
</td>
</tr>
<tr><td><code>EndpointController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-EndpointControllerConfiguration"><code>EndpointControllerConfiguration</code></a>
</td>
<td>
<p>EndpointControllerConfiguration holds configuration for EndpointController
related features.</p>
</td>
</tr>
<tr><td><code>EndpointSliceController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-EndpointSliceControllerConfiguration"><code>EndpointSliceControllerConfiguration</code></a>
</td>
<td>
<p>EndpointSliceControllerConfiguration holds configuration for
EndpointSliceController related features.</p>
</td>
</tr>
<tr><td><code>EndpointSliceMirroringController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-EndpointSliceMirroringControllerConfiguration"><code>EndpointSliceMirroringControllerConfiguration</code></a>
</td>
<td>
<p>EndpointSliceMirroringControllerConfiguration holds configuration for
EndpointSliceMirroringController related features.</p>
</td>
</tr>
<tr><td><code>EphemeralVolumeController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-EphemeralVolumeControllerConfiguration"><code>EphemeralVolumeControllerConfiguration</code></a>
</td>
<td>
<p>EphemeralVolumeControllerConfiguration holds configuration for EphemeralVolumeController
related features.</p>
</td>
</tr>
<tr><td><code>GarbageCollectorController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-GarbageCollectorControllerConfiguration"><code>GarbageCollectorControllerConfiguration</code></a>
</td>
<td>
<p>GarbageCollectorControllerConfiguration holds configuration for
GarbageCollectorController related features.</p>
</td>
</tr>
<tr><td><code>HPAController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-HPAControllerConfiguration"><code>HPAControllerConfiguration</code></a>
</td>
<td>
<p>HPAControllerConfiguration holds configuration for HPAController related features.</p>
</td>
</tr>
<tr><td><code>JobController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-JobControllerConfiguration"><code>JobControllerConfiguration</code></a>
</td>
<td>
<p>JobControllerConfiguration holds configuration for JobController related features.</p>
</td>
</tr>
<tr><td><code>CronJobController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-CronJobControllerConfiguration"><code>CronJobControllerConfiguration</code></a>
</td>
<td>
<p>CronJobControllerConfiguration holds configuration for CronJobController related features.</p>
</td>
</tr>
<tr><td><code>LegacySATokenCleaner</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-LegacySATokenCleanerConfiguration"><code>LegacySATokenCleanerConfiguration</code></a>
</td>
<td>
<p>LegacySATokenCleanerConfiguration holds configuration for LegacySATokenCleaner related features.</p>
</td>
</tr>
<tr><td><code>NamespaceController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-NamespaceControllerConfiguration"><code>NamespaceControllerConfiguration</code></a>
</td>
<td>
<p>NamespaceControllerConfiguration holds configuration for NamespaceController
related features.</p>
</td>
</tr>
<tr><td><code>NodeIPAMController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-NodeIPAMControllerConfiguration"><code>NodeIPAMControllerConfiguration</code></a>
</td>
<td>
<p>NodeIPAMControllerConfiguration holds configuration for NodeIPAMController
related features.</p>
</td>
</tr>
<tr><td><code>NodeLifecycleController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-NodeLifecycleControllerConfiguration"><code>NodeLifecycleControllerConfiguration</code></a>
</td>
<td>
<p>NodeLifecycleControllerConfiguration holds configuration for
NodeLifecycleController related features.</p>
</td>
</tr>
<tr><td><code>PersistentVolumeBinderController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-PersistentVolumeBinderControllerConfiguration"><code>PersistentVolumeBinderControllerConfiguration</code></a>
</td>
<td>
<p>PersistentVolumeBinderControllerConfiguration holds configuration for
PersistentVolumeBinderController related features.</p>
</td>
</tr>
<tr><td><code>PodGCController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-PodGCControllerConfiguration"><code>PodGCControllerConfiguration</code></a>
</td>
<td>
<p>PodGCControllerConfiguration holds configuration for PodGCController
related features.</p>
</td>
</tr>
<tr><td><code>ReplicaSetController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-ReplicaSetControllerConfiguration"><code>ReplicaSetControllerConfiguration</code></a>
</td>
<td>
<p>ReplicaSetControllerConfiguration holds configuration for ReplicaSet related features.</p>
</td>
</tr>
<tr><td><code>ReplicationController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-ReplicationControllerConfiguration"><code>ReplicationControllerConfiguration</code></a>
</td>
<td>
<p>ReplicationControllerConfiguration holds configuration for
ReplicationController related features.</p>
</td>
</tr>
<tr><td><code>ResourceQuotaController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-ResourceQuotaControllerConfiguration"><code>ResourceQuotaControllerConfiguration</code></a>
</td>
<td>
<p>ResourceQuotaControllerConfiguration holds configuration for
ResourceQuotaController related features.</p>
</td>
</tr>
<tr><td><code>SAController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-SAControllerConfiguration"><code>SAControllerConfiguration</code></a>
</td>
<td>
<p>SAControllerConfiguration holds configuration for ServiceAccountController
related features.</p>
</td>
</tr>
<tr><td><code>ServiceController</code> <B>[Required]</B><br/>
<a href="#ServiceControllerConfiguration"><code>ServiceControllerConfiguration</code></a>
</td>
<td>
<p>ServiceControllerConfiguration holds configuration for ServiceController
related features.</p>
</td>
</tr>
<tr><td><code>TTLAfterFinishedController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-TTLAfterFinishedControllerConfiguration"><code>TTLAfterFinishedControllerConfiguration</code></a>
</td>
<td>
<p>TTLAfterFinishedControllerConfiguration holds configuration for
TTLAfterFinishedController related features.</p>
</td>
</tr>
<tr><td><code>ValidatingAdmissionPolicyStatusController</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-ValidatingAdmissionPolicyStatusControllerConfiguration"><code>ValidatingAdmissionPolicyStatusControllerConfiguration</code></a>
</td>
<td>
<p>ValidatingAdmissionPolicyStatusControllerConfiguration holds configuration for
ValidatingAdmissionPolicyStatusController related features.</p>
</td>
</tr>
</tbody>
</table>
## `AttachDetachControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-AttachDetachControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>AttachDetachControllerConfiguration contains elements describing AttachDetachController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>DisableAttachDetachReconcilerSync</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>Reconciler runs a periodic loop to reconcile the desired state of the with
the actual state of the world by triggering attach detach operations.
This flag enables or disables reconcile. Is false by default, and thus enabled.</p>
</td>
</tr>
<tr><td><code>ReconcilerSyncLoopPeriod</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>ReconcilerSyncLoopPeriod is the amount of time the reconciler sync states loop
wait between successive executions. Is set to 60 sec by default.</p>
</td>
</tr>
<tr><td><code>disableForceDetachOnTimeout</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>DisableForceDetachOnTimeout disables force detach when the maximum unmount
time is exceeded. Is false by default, and thus force detach on unmount is
enabled.</p>
</td>
</tr>
</tbody>
</table>
## `CSRSigningConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-CSRSigningConfiguration}
**Appears in:**
- [CSRSigningControllerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-CSRSigningControllerConfiguration)
<p>CSRSigningConfiguration holds information about a particular CSR signer</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>CertFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>certFile is the filename containing a PEM-encoded
X509 CA certificate used to issue certificates</p>
</td>
</tr>
<tr><td><code>KeyFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>keyFile is the filename containing a PEM-encoded
RSA or ECDSA private key used to issue certificates</p>
</td>
</tr>
</tbody>
</table>
## `CSRSigningControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-CSRSigningControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>CSRSigningControllerConfiguration contains elements describing CSRSigningController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ClusterSigningCertFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>clusterSigningCertFile is the filename containing a PEM-encoded
X509 CA certificate used to issue cluster-scoped certificates</p>
</td>
</tr>
<tr><td><code>ClusterSigningKeyFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>clusterSigningCertFile is the filename containing a PEM-encoded
RSA or ECDSA private key used to issue cluster-scoped certificates</p>
</td>
</tr>
<tr><td><code>KubeletServingSignerConfiguration</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-CSRSigningConfiguration"><code>CSRSigningConfiguration</code></a>
</td>
<td>
<p>kubeletServingSignerConfiguration holds the certificate and key used to issue certificates for the kubernetes.io/kubelet-serving signer</p>
</td>
</tr>
<tr><td><code>KubeletClientSignerConfiguration</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-CSRSigningConfiguration"><code>CSRSigningConfiguration</code></a>
</td>
<td>
<p>kubeletClientSignerConfiguration holds the certificate and key used to issue certificates for the kubernetes.io/kube-apiserver-client-kubelet</p>
</td>
</tr>
<tr><td><code>KubeAPIServerClientSignerConfiguration</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-CSRSigningConfiguration"><code>CSRSigningConfiguration</code></a>
</td>
<td>
<p>kubeAPIServerClientSignerConfiguration holds the certificate and key used to issue certificates for the kubernetes.io/kube-apiserver-client</p>
</td>
</tr>
<tr><td><code>LegacyUnknownSignerConfiguration</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-CSRSigningConfiguration"><code>CSRSigningConfiguration</code></a>
</td>
<td>
<p>legacyUnknownSignerConfiguration holds the certificate and key used to issue certificates for the kubernetes.io/legacy-unknown</p>
</td>
</tr>
<tr><td><code>ClusterSigningDuration</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>clusterSigningDuration is the max length of duration signed certificates will be given.
Individual CSRs may request shorter certs by setting spec.expirationSeconds.</p>
</td>
</tr>
</tbody>
</table>
## `CronJobControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-CronJobControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>CronJobControllerConfiguration contains elements describing CrongJob2Controller.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentCronJobSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentCronJobSyncs is 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>
</tbody>
</table>
## `DaemonSetControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-DaemonSetControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>DaemonSetControllerConfiguration contains elements describing DaemonSetController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentDaemonSetSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentDaemonSetSyncs is the number of daemonset objects that are
allowed to sync concurrently. Larger number = more responsive daemonset,
but more CPU (and network) load.</p>
</td>
</tr>
</tbody>
</table>
## `DeploymentControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-DeploymentControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>DeploymentControllerConfiguration contains elements describing DeploymentController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentDeploymentSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentDeploymentSyncs is 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>
</tbody>
</table>
## `DeprecatedControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-DeprecatedControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>DeprecatedControllerConfiguration contains elements be deprecated.</p>
## `EndpointControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-EndpointControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>EndpointControllerConfiguration contains elements describing EndpointController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentEndpointSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentEndpointSyncs is 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><code>EndpointUpdatesBatchPeriod</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>EndpointUpdatesBatchPeriod describes 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.</p>
</td>
</tr>
</tbody>
</table>
## `EndpointSliceControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-EndpointSliceControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>EndpointSliceControllerConfiguration contains elements describing
EndpointSliceController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentServiceEndpointSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentServiceEndpointSyncs is the number of service endpoint syncing
operations that will be done concurrently. Larger number = faster
endpoint slice updating, but more CPU (and network) load.</p>
</td>
</tr>
<tr><td><code>MaxEndpointsPerSlice</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>maxEndpointsPerSlice is the maximum number of endpoints that will be
added to an EndpointSlice. More endpoints per slice will result in fewer
and larger endpoint slices, but larger resources.</p>
</td>
</tr>
<tr><td><code>EndpointUpdatesBatchPeriod</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>EndpointUpdatesBatchPeriod describes 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.</p>
</td>
</tr>
</tbody>
</table>
## `EndpointSliceMirroringControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-EndpointSliceMirroringControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>EndpointSliceMirroringControllerConfiguration contains elements describing
EndpointSliceMirroringController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>MirroringConcurrentServiceEndpointSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>mirroringConcurrentServiceEndpointSyncs is the number of service endpoint
syncing operations that will be done concurrently. Larger number = faster
endpoint slice updating, but more CPU (and network) load.</p>
</td>
</tr>
<tr><td><code>MirroringMaxEndpointsPerSubset</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>mirroringMaxEndpointsPerSubset is the maximum number of endpoints that
will be mirrored to an EndpointSlice for an EndpointSubset.</p>
</td>
</tr>
<tr><td><code>MirroringEndpointUpdatesBatchPeriod</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>mirroringEndpointUpdatesBatchPeriod can be used to batch EndpointSlice
updates. All updates triggered by EndpointSlice changes will be delayed
by up to 'mirroringEndpointUpdatesBatchPeriod'. If other addresses in the
same Endpoints resource change in that period, they will be batched to a
single EndpointSlice update. Default 0 value means that each Endpoints
update triggers an EndpointSlice update.</p>
</td>
</tr>
</tbody>
</table>
## `EphemeralVolumeControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-EphemeralVolumeControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>EphemeralVolumeControllerConfiguration contains elements describing EphemeralVolumeController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentEphemeralVolumeSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>ConcurrentEphemeralVolumeSyncseSyncs is 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>
</tbody>
</table>
## `GarbageCollectorControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-GarbageCollectorControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>GarbageCollectorControllerConfiguration contains elements describing GarbageCollectorController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>EnableGarbageCollector</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enables the generic garbage collector. MUST be synced with the
corresponding flag of the kube-apiserver. WARNING: the generic garbage
collector is an alpha feature.</p>
</td>
</tr>
<tr><td><code>ConcurrentGCSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentGCSyncs is the number of garbage collector workers that are
allowed to sync concurrently.</p>
</td>
</tr>
<tr><td><code>GCIgnoredResources</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-GroupResource"><code>[]GroupResource</code></a>
</td>
<td>
<p>gcIgnoredResources is the list of GroupResources that garbage collection should ignore.</p>
</td>
</tr>
</tbody>
</table>
## `GroupResource` {#kubecontrollermanager-config-k8s-io-v1alpha1-GroupResource}
**Appears in:**
- [GarbageCollectorControllerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-GarbageCollectorControllerConfiguration)
<p>GroupResource describes an group resource.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>Group</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>group is the group portion of the GroupResource.</p>
</td>
</tr>
<tr><td><code>Resource</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>resource is the resource portion of the GroupResource.</p>
</td>
</tr>
</tbody>
</table>
## `HPAControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-HPAControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>HPAControllerConfiguration contains elements describing HPAController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentHorizontalPodAutoscalerSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>ConcurrentHorizontalPodAutoscalerSyncs is the number of HPA objects that are allowed to sync concurrently.
Larger number = more responsive HPA processing, but more CPU (and network) load.</p>
</td>
</tr>
<tr><td><code>HorizontalPodAutoscalerSyncPeriod</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>HorizontalPodAutoscalerSyncPeriod is the period for syncing the number of
pods in horizontal pod autoscaler.</p>
</td>
</tr>
<tr><td><code>HorizontalPodAutoscalerDownscaleStabilizationWindow</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>HorizontalPodAutoscalerDowncaleStabilizationWindow is a period for which autoscaler will look
backwards and not scale down below any recommendation it made during that period.</p>
</td>
</tr>
<tr><td><code>HorizontalPodAutoscalerTolerance</code> <B>[Required]</B><br/>
<code>float64</code>
</td>
<td>
<p>HorizontalPodAutoscalerTolerance is the tolerance for when
resource usage suggests upscaling/downscaling</p>
</td>
</tr>
<tr><td><code>HorizontalPodAutoscalerCPUInitializationPeriod</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>HorizontalPodAutoscalerCPUInitializationPeriod is the period after pod start when CPU samples
might be skipped.</p>
</td>
</tr>
<tr><td><code>HorizontalPodAutoscalerInitialReadinessDelay</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>HorizontalPodAutoscalerInitialReadinessDelay is period after pod start during which readiness
changes are treated as readiness being set for the first time. The only effect of this is that
HPA will disregard CPU samples from unready pods that had last readiness change during that
period.</p>
</td>
</tr>
</tbody>
</table>
## `JobControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-JobControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>JobControllerConfiguration contains elements describing JobController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentJobSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentJobSyncs is 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>
</tbody>
</table>
## `LegacySATokenCleanerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-LegacySATokenCleanerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>LegacySATokenCleanerConfiguration contains elements describing LegacySATokenCleaner</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>CleanUpPeriod</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>CleanUpPeriod is the period of time since the last usage of an
auto-generated service account token before it can be deleted.</p>
</td>
</tr>
</tbody>
</table>
## `NamespaceControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-NamespaceControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>NamespaceControllerConfiguration contains elements describing NamespaceController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>NamespaceSyncPeriod</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>namespaceSyncPeriod is the period for syncing namespace life-cycle
updates.</p>
</td>
</tr>
<tr><td><code>ConcurrentNamespaceSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentNamespaceSyncs is the number of namespace objects that are
allowed to sync concurrently.</p>
</td>
</tr>
</tbody>
</table>
## `NodeIPAMControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-NodeIPAMControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>NodeIPAMControllerConfiguration contains elements describing NodeIpamController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ServiceCIDR</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>serviceCIDR is CIDR Range for Services in cluster.</p>
</td>
</tr>
<tr><td><code>SecondaryServiceCIDR</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>secondaryServiceCIDR is CIDR Range for Services in cluster. This is used in dual stack clusters. SecondaryServiceCIDR must be of different IP family than ServiceCIDR</p>
</td>
</tr>
<tr><td><code>NodeCIDRMaskSize</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>NodeCIDRMaskSize is the mask size for node cidr in cluster.</p>
</td>
</tr>
<tr><td><code>NodeCIDRMaskSizeIPv4</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>NodeCIDRMaskSizeIPv4 is the mask size for node cidr in dual-stack cluster.</p>
</td>
</tr>
<tr><td><code>NodeCIDRMaskSizeIPv6</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>NodeCIDRMaskSizeIPv6 is the mask size for node cidr in dual-stack cluster.</p>
</td>
</tr>
</tbody>
</table>
## `NodeLifecycleControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-NodeLifecycleControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>NodeLifecycleControllerConfiguration contains elements describing NodeLifecycleController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>NodeEvictionRate</code> <B>[Required]</B><br/>
<code>float32</code>
</td>
<td>
<p>nodeEvictionRate is the number of nodes per second on which pods are deleted in case of node failure when a zone is healthy</p>
</td>
</tr>
<tr><td><code>SecondaryNodeEvictionRate</code> <B>[Required]</B><br/>
<code>float32</code>
</td>
<td>
<p>secondaryNodeEvictionRate is the number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy</p>
</td>
</tr>
<tr><td><code>NodeStartupGracePeriod</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>nodeStartupGracePeriod is the amount of time which we allow starting a node to
be unresponsive before marking it unhealthy.</p>
</td>
</tr>
<tr><td><code>NodeMonitorGracePeriod</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>nodeMontiorGracePeriod is the amount of time which we allow a 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><code>PodEvictionTimeout</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>podEvictionTimeout is the grace period for deleting pods on failed nodes.</p>
</td>
</tr>
<tr><td><code>LargeClusterSizeThreshold</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>secondaryNodeEvictionRate is implicitly overridden to 0 for clusters smaller than or equal to largeClusterSizeThreshold</p>
</td>
</tr>
<tr><td><code>UnhealthyZoneThreshold</code> <B>[Required]</B><br/>
<code>float32</code>
</td>
<td>
<p>Zone is treated as unhealthy in nodeEvictionRate and secondaryNodeEvictionRate when at least
unhealthyZoneThreshold (no less than 3) of Nodes in the zone are NotReady</p>
</td>
</tr>
</tbody>
</table>
## `PersistentVolumeBinderControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-PersistentVolumeBinderControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>PersistentVolumeBinderControllerConfiguration contains elements describing
PersistentVolumeBinderController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>PVClaimBinderSyncPeriod</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>pvClaimBinderSyncPeriod is the period for syncing persistent volumes
and persistent volume claims.</p>
</td>
</tr>
<tr><td><code>VolumeConfiguration</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-VolumeConfiguration"><code>VolumeConfiguration</code></a>
</td>
<td>
<p>volumeConfiguration holds configuration for volume related features.</p>
</td>
</tr>
</tbody>
</table>
## `PersistentVolumeRecyclerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-PersistentVolumeRecyclerConfiguration}
**Appears in:**
- [VolumeConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-VolumeConfiguration)
<p>PersistentVolumeRecyclerConfiguration contains elements describing persistent volume plugins.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>MaximumRetry</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>maximumRetry is number of retries the PV recycler will execute on failure to recycle
PV.</p>
</td>
</tr>
<tr><td><code>MinimumTimeoutNFS</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>minimumTimeoutNFS is the minimum ActiveDeadlineSeconds to use for an NFS Recycler
pod.</p>
</td>
</tr>
<tr><td><code>PodTemplateFilePathNFS</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>podTemplateFilePathNFS is the file path to a pod definition used as a template for
NFS persistent volume recycling</p>
</td>
</tr>
<tr><td><code>IncrementTimeoutNFS</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>incrementTimeoutNFS is the increment of time added per Gi to ActiveDeadlineSeconds
for an NFS scrubber pod.</p>
</td>
</tr>
<tr><td><code>PodTemplateFilePathHostPath</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>podTemplateFilePathHostPath is 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><code>MinimumTimeoutHostPath</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>minimumTimeoutHostPath is 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><code>IncrementTimeoutHostPath</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>incrementTimeoutHostPath is 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>
</tbody>
</table>
## `PodGCControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-PodGCControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>PodGCControllerConfiguration contains elements describing PodGCController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>TerminatedPodGCThreshold</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>terminatedPodGCThreshold is the 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>
</tbody>
</table>
## `ReplicaSetControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-ReplicaSetControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>ReplicaSetControllerConfiguration contains elements describing ReplicaSetController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentRSSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentRSSyncs is 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>
</tbody>
</table>
## `ReplicationControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-ReplicationControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>ReplicationControllerConfiguration contains elements describing ReplicationController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentRCSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentRCSyncs is 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>
</tbody>
</table>
## `ResourceQuotaControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-ResourceQuotaControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>ResourceQuotaControllerConfiguration contains elements describing ResourceQuotaController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ResourceQuotaSyncPeriod</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>resourceQuotaSyncPeriod is the period for syncing quota usage status
in the system.</p>
</td>
</tr>
<tr><td><code>ConcurrentResourceQuotaSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentResourceQuotaSyncs is 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>
</tbody>
</table>
## `SAControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-SAControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>SAControllerConfiguration contains elements describing ServiceAccountController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ServiceAccountKeyFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>serviceAccountKeyFile is the filename containing a PEM-encoded private RSA key
used to sign service account tokens.</p>
</td>
</tr>
<tr><td><code>ConcurrentSATokenSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentSATokenSyncs is the number of service account token syncing operations
that will be done concurrently.</p>
</td>
</tr>
<tr><td><code>RootCAFile</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>rootCAFile is the root certificate authority will be included in service
account's token secret. This must be a valid PEM-encoded CA bundle.</p>
</td>
</tr>
</tbody>
</table>
## `StatefulSetControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-StatefulSetControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>StatefulSetControllerConfiguration contains elements describing StatefulSetController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentStatefulSetSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentStatefulSetSyncs is 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>
</tbody>
</table>
## `TTLAfterFinishedControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-TTLAfterFinishedControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>TTLAfterFinishedControllerConfiguration contains elements describing TTLAfterFinishedController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentTTLSyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>concurrentTTLSyncs is the number of TTL-after-finished collector workers that are
allowed to sync concurrently.</p>
</td>
</tr>
</tbody>
</table>
## `ValidatingAdmissionPolicyStatusControllerConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-ValidatingAdmissionPolicyStatusControllerConfiguration}
**Appears in:**
- [KubeControllerManagerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-KubeControllerManagerConfiguration)
<p>ValidatingAdmissionPolicyStatusControllerConfiguration contains elements describing ValidatingAdmissionPolicyStatusController.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>ConcurrentPolicySyncs</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>ConcurrentPolicySyncs is the number of policy objects that are
allowed to sync concurrently. Larger number = quicker type checking,
but more CPU (and network) load.
The default value is 5.</p>
</td>
</tr>
</tbody>
</table>
## `VolumeConfiguration` {#kubecontrollermanager-config-k8s-io-v1alpha1-VolumeConfiguration}
**Appears in:**
- [PersistentVolumeBinderControllerConfiguration](#kubecontrollermanager-config-k8s-io-v1alpha1-PersistentVolumeBinderControllerConfiguration)
<p>VolumeConfiguration contains <em>all</em> enumerated flags meant to configure all volume
plugins. From this config, the controller-manager binary will create many instances of
volume.VolumeConfig, each containing only the configuration needed for that plugin which
are then passed to the appropriate plugin. The ControllerManager binary is the only part
of the code which knows what plugins are supported and which flags correspond to each plugin.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>EnableHostPathProvisioning</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enableHostPathProvisioning enables 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><code>EnableDynamicProvisioning</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enableDynamicProvisioning enables the provisioning of volumes when running within an environment
that supports dynamic provisioning. Defaults to true.</p>
</td>
</tr>
<tr><td><code>PersistentVolumeRecyclerConfiguration</code> <B>[Required]</B><br/>
<a href="#kubecontrollermanager-config-k8s-io-v1alpha1-PersistentVolumeRecyclerConfiguration"><code>PersistentVolumeRecyclerConfiguration</code></a>
</td>
<td>
<p>persistentVolumeRecyclerConfiguration holds configuration for persistent volume plugins.</p>
</td>
</tr>
<tr><td><code>FlexVolumePluginDir</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>volumePluginDir is the full path of the directory in which the flex
volume plugin should search for additional third party volume plugins</p>
</td>
</tr>
</tbody>
</table>
| kubernetes reference | title kube controller manager Configuration v1alpha1 content type tool reference package kubecontrollermanager config k8s io v1alpha1 auto generated true Resource Types CloudControllerManagerConfiguration cloudcontrollermanager config k8s io v1alpha1 CloudControllerManagerConfiguration LeaderMigrationConfiguration controllermanager config k8s io v1alpha1 LeaderMigrationConfiguration KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration NodeControllerConfiguration NodeControllerConfiguration Appears in CloudControllerManagerConfiguration cloudcontrollermanager config k8s io v1alpha1 CloudControllerManagerConfiguration p NodeControllerConfiguration contains elements describing NodeController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentNodeSyncs code B Required B br code int32 code td td p ConcurrentNodeSyncs is the number of workers concurrently synchronizing nodes p td tr tbody table ServiceControllerConfiguration ServiceControllerConfiguration Appears in CloudControllerManagerConfiguration cloudcontrollermanager config k8s io v1alpha1 CloudControllerManagerConfiguration KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p ServiceControllerConfiguration contains elements describing ServiceController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentServiceSyncs code B Required B br code int32 code td td p concurrentServiceSyncs is 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 tbody table CloudControllerManagerConfiguration cloudcontrollermanager config k8s io v1alpha1 CloudControllerManagerConfiguration p CloudControllerManagerConfiguration contains elements describing cloud controller manager 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 cloudcontrollermanager config k8s io v1alpha1 code td tr tr td code kind code br string td td code CloudControllerManagerConfiguration code td tr tr td code Generic code B Required B br a href controllermanager config k8s io v1alpha1 GenericControllerManagerConfiguration code GenericControllerManagerConfiguration code a td td p Generic holds configuration for a generic controller manager p td tr tr td code KubeCloudShared code B Required B br a href cloudcontrollermanager config k8s io v1alpha1 KubeCloudSharedConfiguration code KubeCloudSharedConfiguration code a td td p KubeCloudSharedConfiguration holds configuration for shared related features both in cloud controller manager and kube controller manager p td tr tr td code NodeController code B Required B br a href NodeControllerConfiguration code NodeControllerConfiguration code a td td p NodeController holds configuration for node controller related features p td tr tr td code ServiceController code B Required B br a href ServiceControllerConfiguration code ServiceControllerConfiguration code a td td p ServiceControllerConfiguration holds configuration for ServiceController related features p td tr tr td code NodeStatusUpdateFrequency 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 NodeStatusUpdateFrequency is the frequency at which the controller updates nodes status p td tr tr td code Webhook code B Required B br a href cloudcontrollermanager config k8s io v1alpha1 WebhookConfiguration code WebhookConfiguration code a td td p Webhook is the configuration for cloud controller manager hosted webhooks p td tr tbody table CloudProviderConfiguration cloudcontrollermanager config k8s io v1alpha1 CloudProviderConfiguration Appears in KubeCloudSharedConfiguration cloudcontrollermanager config k8s io v1alpha1 KubeCloudSharedConfiguration p CloudProviderConfiguration contains basically elements about cloud provider 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 provider for cloud services p td tr tr td code CloudConfigFile code B Required B br code string code td td p cloudConfigFile is the path to the cloud provider configuration file p td tr tbody table KubeCloudSharedConfiguration cloudcontrollermanager config k8s io v1alpha1 KubeCloudSharedConfiguration Appears in CloudControllerManagerConfiguration cloudcontrollermanager config k8s io v1alpha1 CloudControllerManagerConfiguration KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p KubeCloudSharedConfiguration contains elements shared by both kube controller manager and cloud controller manager but not genericconfig p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code CloudProvider code B Required B br a href cloudcontrollermanager config k8s io v1alpha1 CloudProviderConfiguration code CloudProviderConfiguration code a td td p CloudProviderConfiguration holds configuration for CloudProvider related features p td tr tr td code ExternalCloudVolumePlugin code B Required B br code string code td td p externalCloudVolumePlugin specifies the plugin to use when cloudProvider is quot external quot It is currently used by the in repo cloud providers to handle node and volume control in the KCM p td tr tr td code UseServiceAccountCredentials code B Required B br code bool code td td p useServiceAccountCredentials indicates whether controllers should be run with individual service account credentials p td tr tr td code AllowUntaggedCloud code B Required B br code bool code td td p run with untagged cloud instances p td tr tr td code RouteReconciliationPeriod 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 routeReconciliationPeriod is the period for reconciling routes created for Nodes by cloud provider p td tr tr td code NodeMonitorPeriod 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 nodeMonitorPeriod is the period for syncing NodeStatus in NodeController p td tr tr td code ClusterName code B Required B br code string code td td p clusterName is the instance prefix for the cluster p td tr tr td code ClusterCIDR code B Required B br code string code td td p clusterCIDR is CIDR Range for Pods in cluster p td tr tr td code AllocateNodeCIDRs code B Required B br code bool code td td p AllocateNodeCIDRs enables CIDRs for Pods to be allocated and if ConfigureCloudRoutes is true to be set on the cloud provider p td tr tr td code CIDRAllocatorType code B Required B br code string code td td p CIDRAllocatorType determines what kind of pod CIDR allocator will be used p td tr tr td code ConfigureCloudRoutes code B Required B br code bool code td td p configureCloudRoutes enables CIDRs allocated with allocateNodeCIDRs to be configured on the cloud provider p td tr tr td code NodeSyncPeriod 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 nodeSyncPeriod is the period for syncing nodes from cloudprovider Longer periods will result in fewer calls to cloud provider but may delay addition of new nodes to cluster p td tr tbody table WebhookConfiguration cloudcontrollermanager config k8s io v1alpha1 WebhookConfiguration Appears in CloudControllerManagerConfiguration cloudcontrollermanager config k8s io v1alpha1 CloudControllerManagerConfiguration p WebhookConfiguration contains configuration related to cloud controller manager hosted webhooks p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code Webhooks code B Required B br code string code td td p Webhooks is the list of webhooks to enable or disable means quot all enabled by default webhooks quot foo means quot enable foo quot foo means quot disable foo quot first item for a particular name wins p td tr tbody table LeaderMigrationConfiguration controllermanager config k8s io v1alpha1 LeaderMigrationConfiguration Appears in GenericControllerManagerConfiguration controllermanager config k8s io v1alpha1 GenericControllerManagerConfiguration p LeaderMigrationConfiguration provides versioned configuration for all migrating leader locks 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 controllermanager config k8s io v1alpha1 code td tr tr td code kind code br string td td code LeaderMigrationConfiguration code td tr tr td code leaderName code B Required B br code string code td td p LeaderName is the name of the leader election resource that protects the migration E g 1 20 KCM to 1 21 CCM p td tr tr td code resourceLock code B Required B br code string code td td p ResourceLock indicates the resource object type that will be used to lock Should be quot leases quot or quot endpoints quot p td tr tr td code controllerLeaders code B Required B br a href controllermanager config k8s io v1alpha1 ControllerLeaderConfiguration code ControllerLeaderConfiguration code a td td p ControllerLeaders contains a list of migrating leader lock configurations p td tr tbody table ControllerLeaderConfiguration controllermanager config k8s io v1alpha1 ControllerLeaderConfiguration Appears in LeaderMigrationConfiguration controllermanager config k8s io v1alpha1 LeaderMigrationConfiguration p ControllerLeaderConfiguration provides the configuration for a migrating leader lock 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 controller being migrated E g service controller route controller cloud node controller etc p td tr tr td code component code B Required B br code string code td td p Component is the name of the component in which the controller should be running E g kube controller manager cloud controller manager etc Or meaning the controller can be run under any component that participates in the migration p td tr tbody table GenericControllerManagerConfiguration controllermanager config k8s io v1alpha1 GenericControllerManagerConfiguration Appears in CloudControllerManagerConfiguration cloudcontrollermanager config k8s io v1alpha1 CloudControllerManagerConfiguration KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p GenericControllerManagerConfiguration holds configuration for a generic controller manager p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code Port code B Required B br code int32 code td td p port is the port that the controller manager s http service runs on p td tr tr td code Address code B Required B br code string code td td p address is the IP address to serve on set to 0 0 0 0 for all interfaces p td tr tr td code MinResyncPeriod 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 minResyncPeriod is the resync period in reflectors will be random between minResyncPeriod and 2 minResyncPeriod p td tr tr td code ClientConnection code B Required B br a href ClientConnectionConfiguration code ClientConnectionConfiguration code a td td p ClientConnection specifies the kubeconfig file and client connection settings for the proxy server to use when communicating with the apiserver p td tr tr td code ControllerStartInterval 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 How long to wait between starting controller managers p td tr tr td code LeaderElection code B Required B br a href LeaderElectionConfiguration code LeaderElectionConfiguration code a td td p leaderElection defines the configuration of leader election client p td tr tr td code Controllers code B Required B br code string code td td p Controllers is the list of controllers to enable or disable means quot all enabled by default controllers quot foo means quot enable foo quot foo means quot disable foo quot first item for a particular name wins p td tr tr td code Debugging code B Required B br a href DebuggingConfiguration code DebuggingConfiguration code a td td p DebuggingConfiguration holds configuration for Debugging related features p td tr tr td code LeaderMigrationEnabled code B Required B br code bool code td td p LeaderMigrationEnabled indicates whether Leader Migration should be enabled for the controller manager p td tr tr td code LeaderMigration code B Required B br a href controllermanager config k8s io v1alpha1 LeaderMigrationConfiguration code LeaderMigrationConfiguration code a td td p LeaderMigration holds the configuration for Leader Migration p td tr tbody table KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p KubeControllerManagerConfiguration contains elements describing kube controller manager 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 kubecontrollermanager config k8s io v1alpha1 code td tr tr td code kind code br string td td code KubeControllerManagerConfiguration code td tr tr td code Generic code B Required B br a href controllermanager config k8s io v1alpha1 GenericControllerManagerConfiguration code GenericControllerManagerConfiguration code a td td p Generic holds configuration for a generic controller manager p td tr tr td code KubeCloudShared code B Required B br a href cloudcontrollermanager config k8s io v1alpha1 KubeCloudSharedConfiguration code KubeCloudSharedConfiguration code a td td p KubeCloudSharedConfiguration holds configuration for shared related features both in cloud controller manager and kube controller manager p td tr tr td code AttachDetachController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 AttachDetachControllerConfiguration code AttachDetachControllerConfiguration code a td td p AttachDetachControllerConfiguration holds configuration for AttachDetachController related features p td tr tr td code CSRSigningController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 CSRSigningControllerConfiguration code CSRSigningControllerConfiguration code a td td p CSRSigningControllerConfiguration holds configuration for CSRSigningController related features p td tr tr td code DaemonSetController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 DaemonSetControllerConfiguration code DaemonSetControllerConfiguration code a td td p DaemonSetControllerConfiguration holds configuration for DaemonSetController related features p td tr tr td code DeploymentController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 DeploymentControllerConfiguration code DeploymentControllerConfiguration code a td td p DeploymentControllerConfiguration holds configuration for DeploymentController related features p td tr tr td code StatefulSetController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 StatefulSetControllerConfiguration code StatefulSetControllerConfiguration code a td td p StatefulSetControllerConfiguration holds configuration for StatefulSetController related features p td tr tr td code DeprecatedController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 DeprecatedControllerConfiguration code DeprecatedControllerConfiguration code a td td p DeprecatedControllerConfiguration holds configuration for some deprecated features p td tr tr td code EndpointController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 EndpointControllerConfiguration code EndpointControllerConfiguration code a td td p EndpointControllerConfiguration holds configuration for EndpointController related features p td tr tr td code EndpointSliceController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 EndpointSliceControllerConfiguration code EndpointSliceControllerConfiguration code a td td p EndpointSliceControllerConfiguration holds configuration for EndpointSliceController related features p td tr tr td code EndpointSliceMirroringController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 EndpointSliceMirroringControllerConfiguration code EndpointSliceMirroringControllerConfiguration code a td td p EndpointSliceMirroringControllerConfiguration holds configuration for EndpointSliceMirroringController related features p td tr tr td code EphemeralVolumeController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 EphemeralVolumeControllerConfiguration code EphemeralVolumeControllerConfiguration code a td td p EphemeralVolumeControllerConfiguration holds configuration for EphemeralVolumeController related features p td tr tr td code GarbageCollectorController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 GarbageCollectorControllerConfiguration code GarbageCollectorControllerConfiguration code a td td p GarbageCollectorControllerConfiguration holds configuration for GarbageCollectorController related features p td tr tr td code HPAController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 HPAControllerConfiguration code HPAControllerConfiguration code a td td p HPAControllerConfiguration holds configuration for HPAController related features p td tr tr td code JobController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 JobControllerConfiguration code JobControllerConfiguration code a td td p JobControllerConfiguration holds configuration for JobController related features p td tr tr td code CronJobController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 CronJobControllerConfiguration code CronJobControllerConfiguration code a td td p CronJobControllerConfiguration holds configuration for CronJobController related features p td tr tr td code LegacySATokenCleaner code B Required B br a href kubecontrollermanager config k8s io v1alpha1 LegacySATokenCleanerConfiguration code LegacySATokenCleanerConfiguration code a td td p LegacySATokenCleanerConfiguration holds configuration for LegacySATokenCleaner related features p td tr tr td code NamespaceController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 NamespaceControllerConfiguration code NamespaceControllerConfiguration code a td td p NamespaceControllerConfiguration holds configuration for NamespaceController related features p td tr tr td code NodeIPAMController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 NodeIPAMControllerConfiguration code NodeIPAMControllerConfiguration code a td td p NodeIPAMControllerConfiguration holds configuration for NodeIPAMController related features p td tr tr td code NodeLifecycleController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 NodeLifecycleControllerConfiguration code NodeLifecycleControllerConfiguration code a td td p NodeLifecycleControllerConfiguration holds configuration for NodeLifecycleController related features p td tr tr td code PersistentVolumeBinderController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 PersistentVolumeBinderControllerConfiguration code PersistentVolumeBinderControllerConfiguration code a td td p PersistentVolumeBinderControllerConfiguration holds configuration for PersistentVolumeBinderController related features p td tr tr td code PodGCController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 PodGCControllerConfiguration code PodGCControllerConfiguration code a td td p PodGCControllerConfiguration holds configuration for PodGCController related features p td tr tr td code ReplicaSetController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 ReplicaSetControllerConfiguration code ReplicaSetControllerConfiguration code a td td p ReplicaSetControllerConfiguration holds configuration for ReplicaSet related features p td tr tr td code ReplicationController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 ReplicationControllerConfiguration code ReplicationControllerConfiguration code a td td p ReplicationControllerConfiguration holds configuration for ReplicationController related features p td tr tr td code ResourceQuotaController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 ResourceQuotaControllerConfiguration code ResourceQuotaControllerConfiguration code a td td p ResourceQuotaControllerConfiguration holds configuration for ResourceQuotaController related features p td tr tr td code SAController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 SAControllerConfiguration code SAControllerConfiguration code a td td p SAControllerConfiguration holds configuration for ServiceAccountController related features p td tr tr td code ServiceController code B Required B br a href ServiceControllerConfiguration code ServiceControllerConfiguration code a td td p ServiceControllerConfiguration holds configuration for ServiceController related features p td tr tr td code TTLAfterFinishedController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 TTLAfterFinishedControllerConfiguration code TTLAfterFinishedControllerConfiguration code a td td p TTLAfterFinishedControllerConfiguration holds configuration for TTLAfterFinishedController related features p td tr tr td code ValidatingAdmissionPolicyStatusController code B Required B br a href kubecontrollermanager config k8s io v1alpha1 ValidatingAdmissionPolicyStatusControllerConfiguration code ValidatingAdmissionPolicyStatusControllerConfiguration code a td td p ValidatingAdmissionPolicyStatusControllerConfiguration holds configuration for ValidatingAdmissionPolicyStatusController related features p td tr tbody table AttachDetachControllerConfiguration kubecontrollermanager config k8s io v1alpha1 AttachDetachControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p AttachDetachControllerConfiguration contains elements describing AttachDetachController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code DisableAttachDetachReconcilerSync code B Required B br code bool code td td p Reconciler runs a periodic loop to reconcile the desired state of the with the actual state of the world by triggering attach detach operations This flag enables or disables reconcile Is false by default and thus enabled p td tr tr td code ReconcilerSyncLoopPeriod 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 ReconcilerSyncLoopPeriod is the amount of time the reconciler sync states loop wait between successive executions Is set to 60 sec by default p td tr tr td code disableForceDetachOnTimeout code B Required B br code bool code td td p DisableForceDetachOnTimeout disables force detach when the maximum unmount time is exceeded Is false by default and thus force detach on unmount is enabled p td tr tbody table CSRSigningConfiguration kubecontrollermanager config k8s io v1alpha1 CSRSigningConfiguration Appears in CSRSigningControllerConfiguration kubecontrollermanager config k8s io v1alpha1 CSRSigningControllerConfiguration p CSRSigningConfiguration holds information about a particular CSR signer p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code CertFile code B Required B br code string code td td p certFile is the filename containing a PEM encoded X509 CA certificate used to issue certificates p td tr tr td code KeyFile code B Required B br code string code td td p keyFile is the filename containing a PEM encoded RSA or ECDSA private key used to issue certificates p td tr tbody table CSRSigningControllerConfiguration kubecontrollermanager config k8s io v1alpha1 CSRSigningControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p CSRSigningControllerConfiguration contains elements describing CSRSigningController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ClusterSigningCertFile code B Required B br code string code td td p clusterSigningCertFile is the filename containing a PEM encoded X509 CA certificate used to issue cluster scoped certificates p td tr tr td code ClusterSigningKeyFile code B Required B br code string code td td p clusterSigningCertFile is the filename containing a PEM encoded RSA or ECDSA private key used to issue cluster scoped certificates p td tr tr td code KubeletServingSignerConfiguration code B Required B br a href kubecontrollermanager config k8s io v1alpha1 CSRSigningConfiguration code CSRSigningConfiguration code a td td p kubeletServingSignerConfiguration holds the certificate and key used to issue certificates for the kubernetes io kubelet serving signer p td tr tr td code KubeletClientSignerConfiguration code B Required B br a href kubecontrollermanager config k8s io v1alpha1 CSRSigningConfiguration code CSRSigningConfiguration code a td td p kubeletClientSignerConfiguration holds the certificate and key used to issue certificates for the kubernetes io kube apiserver client kubelet p td tr tr td code KubeAPIServerClientSignerConfiguration code B Required B br a href kubecontrollermanager config k8s io v1alpha1 CSRSigningConfiguration code CSRSigningConfiguration code a td td p kubeAPIServerClientSignerConfiguration holds the certificate and key used to issue certificates for the kubernetes io kube apiserver client p td tr tr td code LegacyUnknownSignerConfiguration code B Required B br a href kubecontrollermanager config k8s io v1alpha1 CSRSigningConfiguration code CSRSigningConfiguration code a td td p legacyUnknownSignerConfiguration holds the certificate and key used to issue certificates for the kubernetes io legacy unknown p td tr tr td code ClusterSigningDuration 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 clusterSigningDuration is the max length of duration signed certificates will be given Individual CSRs may request shorter certs by setting spec expirationSeconds p td tr tbody table CronJobControllerConfiguration kubecontrollermanager config k8s io v1alpha1 CronJobControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p CronJobControllerConfiguration contains elements describing CrongJob2Controller p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentCronJobSyncs code B Required B br code int32 code td td p concurrentCronJobSyncs is 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 tbody table DaemonSetControllerConfiguration kubecontrollermanager config k8s io v1alpha1 DaemonSetControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p DaemonSetControllerConfiguration contains elements describing DaemonSetController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentDaemonSetSyncs code B Required B br code int32 code td td p concurrentDaemonSetSyncs is the number of daemonset objects that are allowed to sync concurrently Larger number more responsive daemonset but more CPU and network load p td tr tbody table DeploymentControllerConfiguration kubecontrollermanager config k8s io v1alpha1 DeploymentControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p DeploymentControllerConfiguration contains elements describing DeploymentController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentDeploymentSyncs code B Required B br code int32 code td td p concurrentDeploymentSyncs is 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 tbody table DeprecatedControllerConfiguration kubecontrollermanager config k8s io v1alpha1 DeprecatedControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p DeprecatedControllerConfiguration contains elements be deprecated p EndpointControllerConfiguration kubecontrollermanager config k8s io v1alpha1 EndpointControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p EndpointControllerConfiguration contains elements describing EndpointController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentEndpointSyncs code B Required B br code int32 code td td p concurrentEndpointSyncs is 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 code EndpointUpdatesBatchPeriod 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 EndpointUpdatesBatchPeriod describes 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 p td tr tbody table EndpointSliceControllerConfiguration kubecontrollermanager config k8s io v1alpha1 EndpointSliceControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p EndpointSliceControllerConfiguration contains elements describing EndpointSliceController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentServiceEndpointSyncs code B Required B br code int32 code td td p concurrentServiceEndpointSyncs is the number of service endpoint syncing operations that will be done concurrently Larger number faster endpoint slice updating but more CPU and network load p td tr tr td code MaxEndpointsPerSlice code B Required B br code int32 code td td p maxEndpointsPerSlice is the maximum number of endpoints that will be added to an EndpointSlice More endpoints per slice will result in fewer and larger endpoint slices but larger resources p td tr tr td code EndpointUpdatesBatchPeriod 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 EndpointUpdatesBatchPeriod describes 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 p td tr tbody table EndpointSliceMirroringControllerConfiguration kubecontrollermanager config k8s io v1alpha1 EndpointSliceMirroringControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p EndpointSliceMirroringControllerConfiguration contains elements describing EndpointSliceMirroringController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code MirroringConcurrentServiceEndpointSyncs code B Required B br code int32 code td td p mirroringConcurrentServiceEndpointSyncs is the number of service endpoint syncing operations that will be done concurrently Larger number faster endpoint slice updating but more CPU and network load p td tr tr td code MirroringMaxEndpointsPerSubset code B Required B br code int32 code td td p mirroringMaxEndpointsPerSubset is the maximum number of endpoints that will be mirrored to an EndpointSlice for an EndpointSubset p td tr tr td code MirroringEndpointUpdatesBatchPeriod 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 mirroringEndpointUpdatesBatchPeriod can be used to batch EndpointSlice updates All updates triggered by EndpointSlice changes will be delayed by up to mirroringEndpointUpdatesBatchPeriod If other addresses in the same Endpoints resource change in that period they will be batched to a single EndpointSlice update Default 0 value means that each Endpoints update triggers an EndpointSlice update p td tr tbody table EphemeralVolumeControllerConfiguration kubecontrollermanager config k8s io v1alpha1 EphemeralVolumeControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p EphemeralVolumeControllerConfiguration contains elements describing EphemeralVolumeController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentEphemeralVolumeSyncs code B Required B br code int32 code td td p ConcurrentEphemeralVolumeSyncseSyncs is 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 tbody table GarbageCollectorControllerConfiguration kubecontrollermanager config k8s io v1alpha1 GarbageCollectorControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p GarbageCollectorControllerConfiguration contains elements describing GarbageCollectorController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code EnableGarbageCollector code B Required B br code bool code td td p enables the generic garbage collector MUST be synced with the corresponding flag of the kube apiserver WARNING the generic garbage collector is an alpha feature p td tr tr td code ConcurrentGCSyncs code B Required B br code int32 code td td p concurrentGCSyncs is the number of garbage collector workers that are allowed to sync concurrently p td tr tr td code GCIgnoredResources code B Required B br a href kubecontrollermanager config k8s io v1alpha1 GroupResource code GroupResource code a td td p gcIgnoredResources is the list of GroupResources that garbage collection should ignore p td tr tbody table GroupResource kubecontrollermanager config k8s io v1alpha1 GroupResource Appears in GarbageCollectorControllerConfiguration kubecontrollermanager config k8s io v1alpha1 GarbageCollectorControllerConfiguration p GroupResource describes an group resource p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code Group code B Required B br code string code td td p group is the group portion of the GroupResource p td tr tr td code Resource code B Required B br code string code td td p resource is the resource portion of the GroupResource p td tr tbody table HPAControllerConfiguration kubecontrollermanager config k8s io v1alpha1 HPAControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p HPAControllerConfiguration contains elements describing HPAController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentHorizontalPodAutoscalerSyncs code B Required B br code int32 code td td p ConcurrentHorizontalPodAutoscalerSyncs is the number of HPA objects that are allowed to sync concurrently Larger number more responsive HPA processing but more CPU and network load p td tr tr td code HorizontalPodAutoscalerSyncPeriod 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 HorizontalPodAutoscalerSyncPeriod is the period for syncing the number of pods in horizontal pod autoscaler p td tr tr td code HorizontalPodAutoscalerDownscaleStabilizationWindow 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 HorizontalPodAutoscalerDowncaleStabilizationWindow is a period for which autoscaler will look backwards and not scale down below any recommendation it made during that period p td tr tr td code HorizontalPodAutoscalerTolerance code B Required B br code float64 code td td p HorizontalPodAutoscalerTolerance is the tolerance for when resource usage suggests upscaling downscaling p td tr tr td code HorizontalPodAutoscalerCPUInitializationPeriod 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 HorizontalPodAutoscalerCPUInitializationPeriod is the period after pod start when CPU samples might be skipped p td tr tr td code HorizontalPodAutoscalerInitialReadinessDelay 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 HorizontalPodAutoscalerInitialReadinessDelay is period after pod start during which readiness changes are treated as readiness being set for the first time The only effect of this is that HPA will disregard CPU samples from unready pods that had last readiness change during that period p td tr tbody table JobControllerConfiguration kubecontrollermanager config k8s io v1alpha1 JobControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p JobControllerConfiguration contains elements describing JobController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentJobSyncs code B Required B br code int32 code td td p concurrentJobSyncs is 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 tbody table LegacySATokenCleanerConfiguration kubecontrollermanager config k8s io v1alpha1 LegacySATokenCleanerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p LegacySATokenCleanerConfiguration contains elements describing LegacySATokenCleaner p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code CleanUpPeriod 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 CleanUpPeriod is the period of time since the last usage of an auto generated service account token before it can be deleted p td tr tbody table NamespaceControllerConfiguration kubecontrollermanager config k8s io v1alpha1 NamespaceControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p NamespaceControllerConfiguration contains elements describing NamespaceController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code NamespaceSyncPeriod 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 namespaceSyncPeriod is the period for syncing namespace life cycle updates p td tr tr td code ConcurrentNamespaceSyncs code B Required B br code int32 code td td p concurrentNamespaceSyncs is the number of namespace objects that are allowed to sync concurrently p td tr tbody table NodeIPAMControllerConfiguration kubecontrollermanager config k8s io v1alpha1 NodeIPAMControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p NodeIPAMControllerConfiguration contains elements describing NodeIpamController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ServiceCIDR code B Required B br code string code td td p serviceCIDR is CIDR Range for Services in cluster p td tr tr td code SecondaryServiceCIDR code B Required B br code string code td td p secondaryServiceCIDR is CIDR Range for Services in cluster This is used in dual stack clusters SecondaryServiceCIDR must be of different IP family than ServiceCIDR p td tr tr td code NodeCIDRMaskSize code B Required B br code int32 code td td p NodeCIDRMaskSize is the mask size for node cidr in cluster p td tr tr td code NodeCIDRMaskSizeIPv4 code B Required B br code int32 code td td p NodeCIDRMaskSizeIPv4 is the mask size for node cidr in dual stack cluster p td tr tr td code NodeCIDRMaskSizeIPv6 code B Required B br code int32 code td td p NodeCIDRMaskSizeIPv6 is the mask size for node cidr in dual stack cluster p td tr tbody table NodeLifecycleControllerConfiguration kubecontrollermanager config k8s io v1alpha1 NodeLifecycleControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p NodeLifecycleControllerConfiguration contains elements describing NodeLifecycleController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code NodeEvictionRate code B Required B br code float32 code td td p nodeEvictionRate is the number of nodes per second on which pods are deleted in case of node failure when a zone is healthy p td tr tr td code SecondaryNodeEvictionRate code B Required B br code float32 code td td p secondaryNodeEvictionRate is the number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy p td tr tr td code NodeStartupGracePeriod 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 nodeStartupGracePeriod is the amount of time which we allow starting a node to be unresponsive before marking it unhealthy p td tr tr td code NodeMonitorGracePeriod 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 nodeMontiorGracePeriod is the amount of time which we allow a 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 code PodEvictionTimeout 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 podEvictionTimeout is the grace period for deleting pods on failed nodes p td tr tr td code LargeClusterSizeThreshold code B Required B br code int32 code td td p secondaryNodeEvictionRate is implicitly overridden to 0 for clusters smaller than or equal to largeClusterSizeThreshold p td tr tr td code UnhealthyZoneThreshold code B Required B br code float32 code td td p Zone is treated as unhealthy in nodeEvictionRate and secondaryNodeEvictionRate when at least unhealthyZoneThreshold no less than 3 of Nodes in the zone are NotReady p td tr tbody table PersistentVolumeBinderControllerConfiguration kubecontrollermanager config k8s io v1alpha1 PersistentVolumeBinderControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p PersistentVolumeBinderControllerConfiguration contains elements describing PersistentVolumeBinderController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code PVClaimBinderSyncPeriod 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 pvClaimBinderSyncPeriod is the period for syncing persistent volumes and persistent volume claims p td tr tr td code VolumeConfiguration code B Required B br a href kubecontrollermanager config k8s io v1alpha1 VolumeConfiguration code VolumeConfiguration code a td td p volumeConfiguration holds configuration for volume related features p td tr tbody table PersistentVolumeRecyclerConfiguration kubecontrollermanager config k8s io v1alpha1 PersistentVolumeRecyclerConfiguration Appears in VolumeConfiguration kubecontrollermanager config k8s io v1alpha1 VolumeConfiguration p PersistentVolumeRecyclerConfiguration contains elements describing persistent volume plugins p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code MaximumRetry code B Required B br code int32 code td td p maximumRetry is number of retries the PV recycler will execute on failure to recycle PV p td tr tr td code MinimumTimeoutNFS code B Required B br code int32 code td td p minimumTimeoutNFS is the minimum ActiveDeadlineSeconds to use for an NFS Recycler pod p td tr tr td code PodTemplateFilePathNFS code B Required B br code string code td td p podTemplateFilePathNFS is the file path to a pod definition used as a template for NFS persistent volume recycling p td tr tr td code IncrementTimeoutNFS code B Required B br code int32 code td td p incrementTimeoutNFS is the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod p td tr tr td code PodTemplateFilePathHostPath code B Required B br code string code td td p podTemplateFilePathHostPath is 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 code MinimumTimeoutHostPath code B Required B br code int32 code td td p minimumTimeoutHostPath is 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 code IncrementTimeoutHostPath code B Required B br code int32 code td td p incrementTimeoutHostPath is 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 tbody table PodGCControllerConfiguration kubecontrollermanager config k8s io v1alpha1 PodGCControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p PodGCControllerConfiguration contains elements describing PodGCController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code TerminatedPodGCThreshold code B Required B br code int32 code td td p terminatedPodGCThreshold is the 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 tbody table ReplicaSetControllerConfiguration kubecontrollermanager config k8s io v1alpha1 ReplicaSetControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p ReplicaSetControllerConfiguration contains elements describing ReplicaSetController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentRSSyncs code B Required B br code int32 code td td p concurrentRSSyncs is 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 tbody table ReplicationControllerConfiguration kubecontrollermanager config k8s io v1alpha1 ReplicationControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p ReplicationControllerConfiguration contains elements describing ReplicationController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentRCSyncs code B Required B br code int32 code td td p concurrentRCSyncs is 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 tbody table ResourceQuotaControllerConfiguration kubecontrollermanager config k8s io v1alpha1 ResourceQuotaControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p ResourceQuotaControllerConfiguration contains elements describing ResourceQuotaController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ResourceQuotaSyncPeriod 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 resourceQuotaSyncPeriod is the period for syncing quota usage status in the system p td tr tr td code ConcurrentResourceQuotaSyncs code B Required B br code int32 code td td p concurrentResourceQuotaSyncs is 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 tbody table SAControllerConfiguration kubecontrollermanager config k8s io v1alpha1 SAControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p SAControllerConfiguration contains elements describing ServiceAccountController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ServiceAccountKeyFile code B Required B br code string code td td p serviceAccountKeyFile is the filename containing a PEM encoded private RSA key used to sign service account tokens p td tr tr td code ConcurrentSATokenSyncs code B Required B br code int32 code td td p concurrentSATokenSyncs is the number of service account token syncing operations that will be done concurrently p td tr tr td code RootCAFile code B Required B br code string code td td p rootCAFile is the root certificate authority will be included in service account s token secret This must be a valid PEM encoded CA bundle p td tr tbody table StatefulSetControllerConfiguration kubecontrollermanager config k8s io v1alpha1 StatefulSetControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p StatefulSetControllerConfiguration contains elements describing StatefulSetController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentStatefulSetSyncs code B Required B br code int32 code td td p concurrentStatefulSetSyncs is 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 tbody table TTLAfterFinishedControllerConfiguration kubecontrollermanager config k8s io v1alpha1 TTLAfterFinishedControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p TTLAfterFinishedControllerConfiguration contains elements describing TTLAfterFinishedController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentTTLSyncs code B Required B br code int32 code td td p concurrentTTLSyncs is the number of TTL after finished collector workers that are allowed to sync concurrently p td tr tbody table ValidatingAdmissionPolicyStatusControllerConfiguration kubecontrollermanager config k8s io v1alpha1 ValidatingAdmissionPolicyStatusControllerConfiguration Appears in KubeControllerManagerConfiguration kubecontrollermanager config k8s io v1alpha1 KubeControllerManagerConfiguration p ValidatingAdmissionPolicyStatusControllerConfiguration contains elements describing ValidatingAdmissionPolicyStatusController p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code ConcurrentPolicySyncs code B Required B br code int32 code td td p ConcurrentPolicySyncs is the number of policy objects that are allowed to sync concurrently Larger number quicker type checking but more CPU and network load The default value is 5 p td tr tbody table VolumeConfiguration kubecontrollermanager config k8s io v1alpha1 VolumeConfiguration Appears in PersistentVolumeBinderControllerConfiguration kubecontrollermanager config k8s io v1alpha1 PersistentVolumeBinderControllerConfiguration p VolumeConfiguration contains em all em enumerated flags meant to configure all volume plugins From this config the controller manager binary will create many instances of volume VolumeConfig each containing only the configuration needed for that plugin which are then passed to the appropriate plugin The ControllerManager binary is the only part of the code which knows what plugins are supported and which flags correspond to each plugin p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code EnableHostPathProvisioning code B Required B br code bool code td td p enableHostPathProvisioning enables 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 code EnableDynamicProvisioning code B Required B br code bool code td td p enableDynamicProvisioning enables the provisioning of volumes when running within an environment that supports dynamic provisioning Defaults to true p td tr tr td code PersistentVolumeRecyclerConfiguration code B Required B br a href kubecontrollermanager config k8s io v1alpha1 PersistentVolumeRecyclerConfiguration code PersistentVolumeRecyclerConfiguration code a td td p persistentVolumeRecyclerConfiguration holds configuration for persistent volume plugins p td tr tr td code FlexVolumePluginDir code B Required B br code string code td td p volumePluginDir is the full path of the directory in which the flex volume plugin should search for additional third party volume plugins p td tr tbody table |
kubernetes reference contenttype tool reference Resource Types package kubeproxy config k8s io v1alpha1 autogenerated true title kube proxy Configuration v1alpha1 | ---
title: kube-proxy Configuration (v1alpha1)
content_type: tool-reference
package: kubeproxy.config.k8s.io/v1alpha1
auto_generated: true
---
## Resource Types
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
## `ClientConnectionConfiguration` {#ClientConnectionConfiguration}
**Appears in:**
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration)
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
<p>ClientConnectionConfiguration contains details for constructing a client.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>kubeconfig</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>kubeconfig is the path to a KubeConfig file.</p>
</td>
</tr>
<tr><td><code>acceptContentTypes</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the
default value of 'application/json'. This field will control all connections to the server used by a particular
client.</p>
</td>
</tr>
<tr><td><code>contentType</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>contentType is the content type used when sending data to the server from this client.</p>
</td>
</tr>
<tr><td><code>qps</code> <B>[Required]</B><br/>
<code>float32</code>
</td>
<td>
<p>qps controls the number of queries per second allowed for this connection.</p>
</td>
</tr>
<tr><td><code>burst</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>burst allows extra queries to accumulate when a client is exceeding its rate.</p>
</td>
</tr>
</tbody>
</table>
## `DebuggingConfiguration` {#DebuggingConfiguration}
**Appears in:**
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration)
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
<p>DebuggingConfiguration holds configuration for Debugging related features.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>enableProfiling</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enableProfiling enables profiling via web interface host:port/debug/pprof/</p>
</td>
</tr>
<tr><td><code>enableContentionProfiling</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enableContentionProfiling enables block profiling, if
enableProfiling is true.</p>
</td>
</tr>
</tbody>
</table>
## `LeaderElectionConfiguration` {#LeaderElectionConfiguration}
**Appears in:**
- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1-KubeSchedulerConfiguration)
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
<p>LeaderElectionConfiguration defines the configuration of leader election
clients for components that can run with leader election enabled.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>leaderElect</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>leaderElect enables a leader election client to gain leadership
before executing the main loop. Enable this when running replicated
components for high availability.</p>
</td>
</tr>
<tr><td><code>leaseDuration</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>leaseDuration is 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><code>renewDeadline</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>renewDeadline is the interval between attempts by the acting master to
renew a leadership slot before it stops leading. This must be less
than or equal to the lease duration. This is only applicable if leader
election is enabled.</p>
</td>
</tr>
<tr><td><code>retryPeriod</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>retryPeriod is 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><code>resourceLock</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>resourceLock indicates the resource object type that will be used to lock
during leader election cycles.</p>
</td>
</tr>
<tr><td><code>resourceName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>resourceName indicates the name of resource object that will be used to lock
during leader election cycles.</p>
</td>
</tr>
<tr><td><code>resourceNamespace</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>resourceName indicates the namespace of resource object that will be used to lock
during leader election cycles.</p>
</td>
</tr>
</tbody>
</table>
## `KubeProxyConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration}
<p>KubeProxyConfiguration contains everything necessary to configure the
Kubernetes proxy server.</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>kubeproxy.config.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>KubeProxyConfiguration</code></td></tr>
<tr><td><code>featureGates</code> <B>[Required]</B><br/>
<code>map[string]bool</code>
</td>
<td>
<p>featureGates is a map of feature names to bools that enable or disable alpha/experimental features.</p>
</td>
</tr>
<tr><td><code>clientConnection</code> <B>[Required]</B><br/>
<a href="#ClientConnectionConfiguration"><code>ClientConnectionConfiguration</code></a>
</td>
<td>
<p>clientConnection specifies the kubeconfig file and client connection settings for the proxy
server to use when communicating with the apiserver.</p>
</td>
</tr>
<tr><td><code>logging</code> <B>[Required]</B><br/>
<a href="#LoggingConfiguration"><code>LoggingConfiguration</code></a>
</td>
<td>
<p>logging specifies the options of logging.
Refer to <a href="https://github.com/kubernetes/component-base/blob/master/logs/options.go">Logs Options</a>
for more information.</p>
</td>
</tr>
<tr><td><code>hostnameOverride</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>hostnameOverride, 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><code>bindAddress</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>bindAddress can be used to override 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.</p>
</td>
</tr>
<tr><td><code>healthzBindAddress</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>healthzBindAddress is the IP address and port for the health check server to
serve on, defaulting to "0.0.0.0:10256" (if bindAddress is unset or IPv4), or
"[::]:10256" (if bindAddress is IPv6).</p>
</td>
</tr>
<tr><td><code>metricsBindAddress</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>metricsBindAddress is the IP address and port for the metrics server to serve
on, defaulting to "127.0.0.1:10249" (if bindAddress is unset or IPv4), or
"[::1]:10249" (if bindAddress is IPv6). (Set to "0.0.0.0:10249" / "[::]:10249"
to bind on all interfaces.)</p>
</td>
</tr>
<tr><td><code>bindAddressHardFail</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>bindAddressHardFail, if true, tells kube-proxy to treat failure to bind to a
port as fatal and exit</p>
</td>
</tr>
<tr><td><code>enableProfiling</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enableProfiling enables profiling via web interface on /debug/pprof handler.
Profiling handlers will be handled by metrics server.</p>
</td>
</tr>
<tr><td><code>showHiddenMetricsForVersion</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>showHiddenMetricsForVersion is the version for which you want to show hidden metrics.</p>
</td>
</tr>
<tr><td><code>mode</code> <B>[Required]</B><br/>
<a href="#kubeproxy-config-k8s-io-v1alpha1-ProxyMode"><code>ProxyMode</code></a>
</td>
<td>
<p>mode specifies which proxy mode to use.</p>
</td>
</tr>
<tr><td><code>iptables</code> <B>[Required]</B><br/>
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPTablesConfiguration"><code>KubeProxyIPTablesConfiguration</code></a>
</td>
<td>
<p>iptables contains iptables-related configuration options.</p>
</td>
</tr>
<tr><td><code>ipvs</code> <B>[Required]</B><br/>
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPVSConfiguration"><code>KubeProxyIPVSConfiguration</code></a>
</td>
<td>
<p>ipvs contains ipvs-related configuration options.</p>
</td>
</tr>
<tr><td><code>nftables</code> <B>[Required]</B><br/>
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyNFTablesConfiguration"><code>KubeProxyNFTablesConfiguration</code></a>
</td>
<td>
<p>nftables contains nftables-related configuration options.</p>
</td>
</tr>
<tr><td><code>winkernel</code> <B>[Required]</B><br/>
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyWinkernelConfiguration"><code>KubeProxyWinkernelConfiguration</code></a>
</td>
<td>
<p>winkernel contains winkernel-related configuration options.</p>
</td>
</tr>
<tr><td><code>detectLocalMode</code> <B>[Required]</B><br/>
<a href="#kubeproxy-config-k8s-io-v1alpha1-LocalMode"><code>LocalMode</code></a>
</td>
<td>
<p>detectLocalMode determines mode to use for detecting local traffic, defaults to ClusterCIDR</p>
</td>
</tr>
<tr><td><code>detectLocal</code> <B>[Required]</B><br/>
<a href="#kubeproxy-config-k8s-io-v1alpha1-DetectLocalConfiguration"><code>DetectLocalConfiguration</code></a>
</td>
<td>
<p>detectLocal contains optional configuration settings related to DetectLocalMode.</p>
</td>
</tr>
<tr><td><code>clusterCIDR</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>clusterCIDR is 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
DetectLocalMode 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.)</p>
</td>
</tr>
<tr><td><code>nodePortAddresses</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>nodePortAddresses is 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 IPv4 and/or IPv6 address according to the Node
object. If unset, NodePort connections will be accepted on all local IPs.</p>
</td>
</tr>
<tr><td><code>oomScoreAdj</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>oomScoreAdj is the oom-score-adj value for kube-proxy process. Values must be within
the range [-1000, 1000]</p>
</td>
</tr>
<tr><td><code>conntrack</code> <B>[Required]</B><br/>
<a href="#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConntrackConfiguration"><code>KubeProxyConntrackConfiguration</code></a>
</td>
<td>
<p>conntrack contains conntrack-related configuration options.</p>
</td>
</tr>
<tr><td><code>configSyncPeriod</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>configSyncPeriod is how often configuration from the apiserver is refreshed. Must be greater
than 0.</p>
</td>
</tr>
<tr><td><code>portRange</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>portRange was previously used to configure the userspace proxy, but is now unused.</p>
</td>
</tr>
<tr><td><code>windowsRunAsService</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>windowsRunAsService, if true, enables Windows service control manager API integration.</p>
</td>
</tr>
</tbody>
</table>
## `DetectLocalConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-DetectLocalConfiguration}
**Appears in:**
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
<p>DetectLocalConfiguration contains optional settings related to DetectLocalMode option</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>bridgeInterface</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>bridgeInterface is a bridge interface name. When DetectLocalMode is set to
LocalModeBridgeInterface, kube-proxy will consider traffic to be local if
it originates from this bridge.</p>
</td>
</tr>
<tr><td><code>interfaceNamePrefix</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>interfaceNamePrefix is an interface name prefix. When DetectLocalMode is set to
LocalModeInterfaceNamePrefix, kube-proxy will consider traffic to be local if
it originates from any interface whose name begins with this prefix.</p>
</td>
</tr>
</tbody>
</table>
## `KubeProxyConntrackConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConntrackConfiguration}
**Appears in:**
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
<p>KubeProxyConntrackConfiguration contains conntrack settings for
the Kubernetes proxy server.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>maxPerCore</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>maxPerCore is the maximum number of NAT connections to track
per CPU core (0 to leave the limit as-is and ignore min).</p>
</td>
</tr>
<tr><td><code>min</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>min is the minimum value of connect-tracking records to allocate,
regardless of maxPerCore (set maxPerCore=0 to leave the limit as-is).</p>
</td>
</tr>
<tr><td><code>tcpEstablishedTimeout</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>tcpEstablishedTimeout is how long an idle TCP connection will be kept open
(e.g. '2s'). Must be greater than 0 to set.</p>
</td>
</tr>
<tr><td><code>tcpCloseWaitTimeout</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>tcpCloseWaitTimeout is how long an idle conntrack entry
in CLOSE_WAIT state will remain in the conntrack
table. (e.g. '60s'). Must be greater than 0 to set.</p>
</td>
</tr>
<tr><td><code>tcpBeLiberal</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>tcpBeLiberal, if true, kube-proxy will configure conntrack
to run in liberal mode for TCP connections and packets with
out-of-window sequence numbers won't be marked INVALID.</p>
</td>
</tr>
<tr><td><code>udpTimeout</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>udpTimeout is how long an idle UDP conntrack entry in
UNREPLIED state will remain in the conntrack table
(e.g. '30s'). Must be greater than 0 to set.</p>
</td>
</tr>
<tr><td><code>udpStreamTimeout</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>udpStreamTimeout is how long an idle UDP conntrack entry in
ASSURED state will remain in the conntrack table
(e.g. '300s'). Must be greater than 0 to set.</p>
</td>
</tr>
</tbody>
</table>
## `KubeProxyIPTablesConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPTablesConfiguration}
**Appears in:**
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
<p>KubeProxyIPTablesConfiguration contains iptables-related configuration
details for the Kubernetes proxy server.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>masqueradeBit</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>masqueradeBit is the bit of the iptables fwmark space to use for SNAT if using
the iptables or ipvs proxy mode. Values must be within the range [0, 31].</p>
</td>
</tr>
<tr><td><code>masqueradeAll</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>masqueradeAll tells kube-proxy to SNAT all traffic sent to Service cluster IPs,
when using the iptables or ipvs proxy mode. This may be required with some CNI
plugins.</p>
</td>
</tr>
<tr><td><code>localhostNodePorts</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>localhostNodePorts, if false, tells kube-proxy to 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><code>syncPeriod</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>syncPeriod is 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><code>minSyncPeriod</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>minSyncPeriod is 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>
</tbody>
</table>
## `KubeProxyIPVSConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPVSConfiguration}
**Appears in:**
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
<p>KubeProxyIPVSConfiguration contains ipvs-related configuration
details for the Kubernetes proxy server.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>syncPeriod</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>syncPeriod is 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><code>minSyncPeriod</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>minSyncPeriod is 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><code>scheduler</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>scheduler is the IPVS scheduler to use</p>
</td>
</tr>
<tr><td><code>excludeCIDRs</code> <B>[Required]</B><br/>
<code>[]string</code>
</td>
<td>
<p>excludeCIDRs is a list of CIDRs which the ipvs proxier should not touch
when cleaning up ipvs services.</p>
</td>
</tr>
<tr><td><code>strictARP</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>strictARP configures arp_ignore and arp_announce to avoid answering ARP queries
from kube-ipvs0 interface</p>
</td>
</tr>
<tr><td><code>tcpTimeout</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>tcpTimeout is the timeout value used for idle IPVS TCP sessions.
The default value is 0, which preserves the current timeout value on the system.</p>
</td>
</tr>
<tr><td><code>tcpFinTimeout</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>tcpFinTimeout is the timeout value used for IPVS TCP sessions after receiving a FIN.
The default value is 0, which preserves the current timeout value on the system.</p>
</td>
</tr>
<tr><td><code>udpTimeout</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>udpTimeout is the timeout value used for IPVS UDP packets.
The default value is 0, which preserves the current timeout value on the system.</p>
</td>
</tr>
</tbody>
</table>
## `KubeProxyNFTablesConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyNFTablesConfiguration}
**Appears in:**
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
<p>KubeProxyNFTablesConfiguration contains nftables-related configuration
details for the Kubernetes proxy server.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>masqueradeBit</code> <B>[Required]</B><br/>
<code>int32</code>
</td>
<td>
<p>masqueradeBit is the bit of the iptables fwmark space to use for SNAT if using
the nftables proxy mode. Values must be within the range [0, 31].</p>
</td>
</tr>
<tr><td><code>masqueradeAll</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>masqueradeAll tells kube-proxy to SNAT all traffic sent to Service cluster IPs,
when using the nftables mode. This may be required with some CNI plugins.</p>
</td>
</tr>
<tr><td><code>syncPeriod</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>syncPeriod is 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><code>minSyncPeriod</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>minSyncPeriod is 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>
</tbody>
</table>
## `KubeProxyWinkernelConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyWinkernelConfiguration}
**Appears in:**
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
<p>KubeProxyWinkernelConfiguration contains Windows/HNS settings for
the Kubernetes proxy server.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>networkName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>networkName is the name of the network kube-proxy will use
to create endpoints and policies</p>
</td>
</tr>
<tr><td><code>sourceVip</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>sourceVip is the IP address of the source VIP endpoint used for
NAT when loadbalancing</p>
</td>
</tr>
<tr><td><code>enableDSR</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>enableDSR tells kube-proxy whether HNS policies should be created
with DSR</p>
</td>
</tr>
<tr><td><code>rootHnsEndpointName</code> <B>[Required]</B><br/>
<code>string</code>
</td>
<td>
<p>rootHnsEndpointName is the name of hnsendpoint that is attached to
l2bridge for root network namespace</p>
</td>
</tr>
<tr><td><code>forwardHealthCheckVip</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>forwardHealthCheckVip forwards service VIP for health check port on
Windows</p>
</td>
</tr>
</tbody>
</table>
## `LocalMode` {#kubeproxy-config-k8s-io-v1alpha1-LocalMode}
(Alias of `string`)
**Appears in:**
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
<p>LocalMode represents modes to detect local traffic from the node</p>
## `ProxyMode` {#kubeproxy-config-k8s-io-v1alpha1-ProxyMode}
(Alias of `string`)
**Appears in:**
- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration)
<p>ProxyMode represents modes used by the Kubernetes proxy server.</p>
<p>Currently, two modes of proxy are available on Linux platforms: 'iptables' and 'ipvs'.
One mode of proxy is available on Windows platforms: 'kernelspace'.</p>
<p>If the proxy mode is unspecified, the best-available proxy mode will be used (currently this
is <code>iptables</code> on Linux and <code>kernelspace</code> on Windows). If the selected proxy mode cannot be
used (due to lack of kernel support, missing userspace components, etc) then kube-proxy
will exit with an error.</p>
| kubernetes reference | title kube proxy Configuration v1alpha1 content type tool reference package kubeproxy config k8s io v1alpha1 auto generated true Resource Types KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration ClientConnectionConfiguration ClientConnectionConfiguration Appears in KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration GenericControllerManagerConfiguration controllermanager config k8s io v1alpha1 GenericControllerManagerConfiguration p ClientConnectionConfiguration contains details for constructing a client p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code kubeconfig code B Required B br code string code td td p kubeconfig is the path to a KubeConfig file p td tr tr td code acceptContentTypes code B Required B br code string code td td p acceptContentTypes defines the Accept header sent by clients when connecting to a server overriding the default value of application json This field will control all connections to the server used by a particular client p td tr tr td code contentType code B Required B br code string code td td p contentType is the content type used when sending data to the server from this client p td tr tr td code qps code B Required B br code float32 code td td p qps controls the number of queries per second allowed for this connection p td tr tr td code burst code B Required B br code int32 code td td p burst allows extra queries to accumulate when a client is exceeding its rate p td tr tbody table DebuggingConfiguration DebuggingConfiguration Appears in KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration GenericControllerManagerConfiguration controllermanager config k8s io v1alpha1 GenericControllerManagerConfiguration p DebuggingConfiguration holds configuration for Debugging related features p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code enableProfiling code B Required B br code bool code td td p enableProfiling enables profiling via web interface host port debug pprof p td tr tr td code enableContentionProfiling code B Required B br code bool code td td p enableContentionProfiling enables block profiling if enableProfiling is true p td tr tbody table LeaderElectionConfiguration LeaderElectionConfiguration Appears in KubeSchedulerConfiguration kubescheduler config k8s io v1 KubeSchedulerConfiguration GenericControllerManagerConfiguration controllermanager config k8s io v1alpha1 GenericControllerManagerConfiguration p LeaderElectionConfiguration defines the configuration of leader election clients for components that can run with leader election enabled p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code leaderElect code B Required B br code bool code td td p leaderElect enables a leader election client to gain leadership before executing the main loop Enable this when running replicated components for high availability p td tr tr td code leaseDuration 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 leaseDuration is 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 code renewDeadline 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 renewDeadline is the interval between attempts by the acting master to renew a leadership slot before it stops leading This must be less than or equal to the lease duration This is only applicable if leader election is enabled p td tr tr td code retryPeriod 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 retryPeriod is 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 code resourceLock code B Required B br code string code td td p resourceLock indicates the resource object type that will be used to lock during leader election cycles p td tr tr td code resourceName code B Required B br code string code td td p resourceName indicates the name of resource object that will be used to lock during leader election cycles p td tr tr td code resourceNamespace code B Required B br code string code td td p resourceName indicates the namespace of resource object that will be used to lock during leader election cycles p td tr tbody table KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration p KubeProxyConfiguration contains everything necessary to configure the Kubernetes proxy server 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 kubeproxy config k8s io v1alpha1 code td tr tr td code kind code br string td td code KubeProxyConfiguration code td tr tr td code featureGates code B Required B br code map string bool code td td p featureGates is a map of feature names to bools that enable or disable alpha experimental features p td tr tr td code clientConnection code B Required B br a href ClientConnectionConfiguration code ClientConnectionConfiguration code a td td p clientConnection specifies the kubeconfig file and client connection settings for the proxy server to use when communicating with the apiserver p td tr tr td code logging code B Required B br a href LoggingConfiguration code LoggingConfiguration code a td td p logging specifies the options of logging Refer to a href https github com kubernetes component base blob master logs options go Logs Options a for more information p td tr tr td code hostnameOverride code B Required B br code string code td td p hostnameOverride 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 code bindAddress code B Required B br code string code td td p bindAddress can be used to override 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 p td tr tr td code healthzBindAddress code B Required B br code string code td td p healthzBindAddress is the IP address and port for the health check server to serve on defaulting to quot 0 0 0 0 10256 quot if bindAddress is unset or IPv4 or quot 10256 quot if bindAddress is IPv6 p td tr tr td code metricsBindAddress code B Required B br code string code td td p metricsBindAddress is the IP address and port for the metrics server to serve on defaulting to quot 127 0 0 1 10249 quot if bindAddress is unset or IPv4 or quot 1 10249 quot if bindAddress is IPv6 Set to quot 0 0 0 0 10249 quot quot 10249 quot to bind on all interfaces p td tr tr td code bindAddressHardFail code B Required B br code bool code td td p bindAddressHardFail if true tells kube proxy to treat failure to bind to a port as fatal and exit p td tr tr td code enableProfiling code B Required B br code bool code td td p enableProfiling enables profiling via web interface on debug pprof handler Profiling handlers will be handled by metrics server p td tr tr td code showHiddenMetricsForVersion code B Required B br code string code td td p showHiddenMetricsForVersion is the version for which you want to show hidden metrics p td tr tr td code mode code B Required B br a href kubeproxy config k8s io v1alpha1 ProxyMode code ProxyMode code a td td p mode specifies which proxy mode to use p td tr tr td code iptables code B Required B br a href kubeproxy config k8s io v1alpha1 KubeProxyIPTablesConfiguration code KubeProxyIPTablesConfiguration code a td td p iptables contains iptables related configuration options p td tr tr td code ipvs code B Required B br a href kubeproxy config k8s io v1alpha1 KubeProxyIPVSConfiguration code KubeProxyIPVSConfiguration code a td td p ipvs contains ipvs related configuration options p td tr tr td code nftables code B Required B br a href kubeproxy config k8s io v1alpha1 KubeProxyNFTablesConfiguration code KubeProxyNFTablesConfiguration code a td td p nftables contains nftables related configuration options p td tr tr td code winkernel code B Required B br a href kubeproxy config k8s io v1alpha1 KubeProxyWinkernelConfiguration code KubeProxyWinkernelConfiguration code a td td p winkernel contains winkernel related configuration options p td tr tr td code detectLocalMode code B Required B br a href kubeproxy config k8s io v1alpha1 LocalMode code LocalMode code a td td p detectLocalMode determines mode to use for detecting local traffic defaults to ClusterCIDR p td tr tr td code detectLocal code B Required B br a href kubeproxy config k8s io v1alpha1 DetectLocalConfiguration code DetectLocalConfiguration code a td td p detectLocal contains optional configuration settings related to DetectLocalMode p td tr tr td code clusterCIDR code B Required B br code string code td td p clusterCIDR is 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 DetectLocalMode 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 p td tr tr td code nodePortAddresses code B Required B br code string code td td p nodePortAddresses is 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 IPv4 and or IPv6 address according to the Node object If unset NodePort connections will be accepted on all local IPs p td tr tr td code oomScoreAdj code B Required B br code int32 code td td p oomScoreAdj is the oom score adj value for kube proxy process Values must be within the range 1000 1000 p td tr tr td code conntrack code B Required B br a href kubeproxy config k8s io v1alpha1 KubeProxyConntrackConfiguration code KubeProxyConntrackConfiguration code a td td p conntrack contains conntrack related configuration options p td tr tr td code configSyncPeriod 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 configSyncPeriod is how often configuration from the apiserver is refreshed Must be greater than 0 p td tr tr td code portRange code B Required B br code string code td td p portRange was previously used to configure the userspace proxy but is now unused p td tr tr td code windowsRunAsService code B Required B br code bool code td td p windowsRunAsService if true enables Windows service control manager API integration p td tr tbody table DetectLocalConfiguration kubeproxy config k8s io v1alpha1 DetectLocalConfiguration Appears in KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration p DetectLocalConfiguration contains optional settings related to DetectLocalMode option p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code bridgeInterface code B Required B br code string code td td p bridgeInterface is a bridge interface name When DetectLocalMode is set to LocalModeBridgeInterface kube proxy will consider traffic to be local if it originates from this bridge p td tr tr td code interfaceNamePrefix code B Required B br code string code td td p interfaceNamePrefix is an interface name prefix When DetectLocalMode is set to LocalModeInterfaceNamePrefix kube proxy will consider traffic to be local if it originates from any interface whose name begins with this prefix p td tr tbody table KubeProxyConntrackConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConntrackConfiguration Appears in KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration p KubeProxyConntrackConfiguration contains conntrack settings for the Kubernetes proxy server p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code maxPerCore code B Required B br code int32 code td td p maxPerCore is the maximum number of NAT connections to track per CPU core 0 to leave the limit as is and ignore min p td tr tr td code min code B Required B br code int32 code td td p min is the minimum value of connect tracking records to allocate regardless of maxPerCore set maxPerCore 0 to leave the limit as is p td tr tr td code tcpEstablishedTimeout 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 tcpEstablishedTimeout is how long an idle TCP connection will be kept open e g 2s Must be greater than 0 to set p td tr tr td code tcpCloseWaitTimeout 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 tcpCloseWaitTimeout is how long an idle conntrack entry in CLOSE WAIT state will remain in the conntrack table e g 60s Must be greater than 0 to set p td tr tr td code tcpBeLiberal code B Required B br code bool code td td p tcpBeLiberal if true kube proxy will configure conntrack to run in liberal mode for TCP connections and packets with out of window sequence numbers won t be marked INVALID p td tr tr td code udpTimeout 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 udpTimeout is how long an idle UDP conntrack entry in UNREPLIED state will remain in the conntrack table e g 30s Must be greater than 0 to set p td tr tr td code udpStreamTimeout 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 udpStreamTimeout is how long an idle UDP conntrack entry in ASSURED state will remain in the conntrack table e g 300s Must be greater than 0 to set p td tr tbody table KubeProxyIPTablesConfiguration kubeproxy config k8s io v1alpha1 KubeProxyIPTablesConfiguration Appears in KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration p KubeProxyIPTablesConfiguration contains iptables related configuration details for the Kubernetes proxy server p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code masqueradeBit code B Required B br code int32 code td td p masqueradeBit is the bit of the iptables fwmark space to use for SNAT if using the iptables or ipvs proxy mode Values must be within the range 0 31 p td tr tr td code masqueradeAll code B Required B br code bool code td td p masqueradeAll tells kube proxy to SNAT all traffic sent to Service cluster IPs when using the iptables or ipvs proxy mode This may be required with some CNI plugins p td tr tr td code localhostNodePorts code B Required B br code bool code td td p localhostNodePorts if false tells kube proxy to 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 code syncPeriod 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 syncPeriod is 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 code minSyncPeriod 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 minSyncPeriod is 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 tbody table KubeProxyIPVSConfiguration kubeproxy config k8s io v1alpha1 KubeProxyIPVSConfiguration Appears in KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration p KubeProxyIPVSConfiguration contains ipvs related configuration details for the Kubernetes proxy server p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code syncPeriod 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 syncPeriod is 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 code minSyncPeriod 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 minSyncPeriod is 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 code scheduler code B Required B br code string code td td p scheduler is the IPVS scheduler to use p td tr tr td code excludeCIDRs code B Required B br code string code td td p excludeCIDRs is a list of CIDRs which the ipvs proxier should not touch when cleaning up ipvs services p td tr tr td code strictARP code B Required B br code bool code td td p strictARP configures arp ignore and arp announce to avoid answering ARP queries from kube ipvs0 interface p td tr tr td code tcpTimeout 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 tcpTimeout is the timeout value used for idle IPVS TCP sessions The default value is 0 which preserves the current timeout value on the system p td tr tr td code tcpFinTimeout 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 tcpFinTimeout is the timeout value used for IPVS TCP sessions after receiving a FIN The default value is 0 which preserves the current timeout value on the system p td tr tr td code udpTimeout 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 udpTimeout is the timeout value used for IPVS UDP packets The default value is 0 which preserves the current timeout value on the system p td tr tbody table KubeProxyNFTablesConfiguration kubeproxy config k8s io v1alpha1 KubeProxyNFTablesConfiguration Appears in KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration p KubeProxyNFTablesConfiguration contains nftables related configuration details for the Kubernetes proxy server p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code masqueradeBit code B Required B br code int32 code td td p masqueradeBit is the bit of the iptables fwmark space to use for SNAT if using the nftables proxy mode Values must be within the range 0 31 p td tr tr td code masqueradeAll code B Required B br code bool code td td p masqueradeAll tells kube proxy to SNAT all traffic sent to Service cluster IPs when using the nftables mode This may be required with some CNI plugins p td tr tr td code syncPeriod 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 syncPeriod is 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 code minSyncPeriod 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 minSyncPeriod is 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 tbody table KubeProxyWinkernelConfiguration kubeproxy config k8s io v1alpha1 KubeProxyWinkernelConfiguration Appears in KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration p KubeProxyWinkernelConfiguration contains Windows HNS settings for the Kubernetes proxy server p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code networkName code B Required B br code string code td td p networkName is the name of the network kube proxy will use to create endpoints and policies p td tr tr td code sourceVip code B Required B br code string code td td p sourceVip is the IP address of the source VIP endpoint used for NAT when loadbalancing p td tr tr td code enableDSR code B Required B br code bool code td td p enableDSR tells kube proxy whether HNS policies should be created with DSR p td tr tr td code rootHnsEndpointName code B Required B br code string code td td p rootHnsEndpointName is the name of hnsendpoint that is attached to l2bridge for root network namespace p td tr tr td code forwardHealthCheckVip code B Required B br code bool code td td p forwardHealthCheckVip forwards service VIP for health check port on Windows p td tr tbody table LocalMode kubeproxy config k8s io v1alpha1 LocalMode Alias of string Appears in KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration p LocalMode represents modes to detect local traffic from the node p ProxyMode kubeproxy config k8s io v1alpha1 ProxyMode Alias of string Appears in KubeProxyConfiguration kubeproxy config k8s io v1alpha1 KubeProxyConfiguration p ProxyMode represents modes used by the Kubernetes proxy server p p Currently two modes of proxy are available on Linux platforms iptables and ipvs One mode of proxy is available on Windows platforms kernelspace p p If the proxy mode is unspecified the best available proxy mode will be used currently this is code iptables code on Linux and code kernelspace code on Windows If the selected proxy mode cannot be used due to lack of kernel support missing userspace components etc then kube proxy will exit with an error p |
kubernetes reference package admission k8s io v1 contenttype tool reference title kube apiserver Admission v1 Resource Types autogenerated true | ---
title: kube-apiserver Admission (v1)
content_type: tool-reference
package: admission.k8s.io/v1
auto_generated: true
---
## Resource Types
- [AdmissionReview](#admission-k8s-io-v1-AdmissionReview)
## `AdmissionReview` {#admission-k8s-io-v1-AdmissionReview}
<p>AdmissionReview describes an admission review request/response.</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>admission.k8s.io/v1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>AdmissionReview</code></td></tr>
<tr><td><code>request</code><br/>
<a href="#admission-k8s-io-v1-AdmissionRequest"><code>AdmissionRequest</code></a>
</td>
<td>
<p>Request describes the attributes for the admission request.</p>
</td>
</tr>
<tr><td><code>response</code><br/>
<a href="#admission-k8s-io-v1-AdmissionResponse"><code>AdmissionResponse</code></a>
</td>
<td>
<p>Response describes the attributes for the admission response.</p>
</td>
</tr>
</tbody>
</table>
## `AdmissionRequest` {#admission-k8s-io-v1-AdmissionRequest}
**Appears in:**
- [AdmissionReview](#admission-k8s-io-v1-AdmissionReview)
<p>AdmissionRequest describes the admission.Attributes for the admission request.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>uid</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID"><code>k8s.io/apimachinery/pkg/types.UID</code></a>
</td>
<td>
<p>UID is an identifier for the individual request/response. It allows us to distinguish instances of requests which are
otherwise identical (parallel requests, requests when earlier requests did not modify etc)
The UID is meant to track the round trip (request/response) between the KAS and the WebHook, not the user request.
It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.</p>
</td>
</tr>
<tr><td><code>kind</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionKind"><code>meta/v1.GroupVersionKind</code></a>
</td>
<td>
<p>Kind is the fully-qualified type of object being submitted (for example, v1.Pod or autoscaling.v1.Scale)</p>
</td>
</tr>
<tr><td><code>resource</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionResource"><code>meta/v1.GroupVersionResource</code></a>
</td>
<td>
<p>Resource is the fully-qualified resource being requested (for example, v1.pods)</p>
</td>
</tr>
<tr><td><code>subResource</code><br/>
<code>string</code>
</td>
<td>
<p>SubResource is the subresource being requested, if any (for example, "status" or "scale")</p>
</td>
</tr>
<tr><td><code>requestKind</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionKind"><code>meta/v1.GroupVersionKind</code></a>
</td>
<td>
<p>RequestKind is the fully-qualified type of the original API request (for example, v1.Pod or autoscaling.v1.Scale).
If this is specified and differs from the value in "kind", an equivalent match and conversion was performed.</p>
<p>For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
<code>apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]</code> and <code>matchPolicy: Equivalent</code>,
an API request to apps/v1beta1 deployments would be converted and sent to the webhook
with <code>kind: {group:"apps", version:"v1", kind:"Deployment"}</code> (matching the rule the webhook registered for),
and <code>requestKind: {group:"apps", version:"v1beta1", kind:"Deployment"}</code> (indicating the kind of the original API request).</p>
<p>See documentation for the "matchPolicy" field in the webhook configuration type for more details.</p>
</td>
</tr>
<tr><td><code>requestResource</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionResource"><code>meta/v1.GroupVersionResource</code></a>
</td>
<td>
<p>RequestResource is the fully-qualified resource of the original API request (for example, v1.pods).
If this is specified and differs from the value in "resource", an equivalent match and conversion was performed.</p>
<p>For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
<code>apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]</code> and <code>matchPolicy: Equivalent</code>,
an API request to apps/v1beta1 deployments would be converted and sent to the webhook
with <code>resource: {group:"apps", version:"v1", resource:"deployments"}</code> (matching the resource the webhook registered for),
and <code>requestResource: {group:"apps", version:"v1beta1", resource:"deployments"}</code> (indicating the resource of the original API request).</p>
<p>See documentation for the "matchPolicy" field in the webhook configuration type.</p>
</td>
</tr>
<tr><td><code>requestSubResource</code><br/>
<code>string</code>
</td>
<td>
<p>RequestSubResource is the name of the subresource of the original API request, if any (for example, "status" or "scale")
If this is specified and differs from the value in "subResource", an equivalent match and conversion was performed.
See documentation for the "matchPolicy" field in the webhook configuration type.</p>
</td>
</tr>
<tr><td><code>name</code><br/>
<code>string</code>
</td>
<td>
<p>Name is the name of the object as presented in the request. On a CREATE operation, the client may omit name and
rely on the server to generate the name. If that is the case, this field will contain an empty string.</p>
</td>
</tr>
<tr><td><code>namespace</code><br/>
<code>string</code>
</td>
<td>
<p>Namespace is the namespace associated with the request (if any).</p>
</td>
</tr>
<tr><td><code>operation</code> <B>[Required]</B><br/>
<a href="#admission-k8s-io-v1-Operation"><code>Operation</code></a>
</td>
<td>
<p>Operation is the operation being performed. This may be different than the operation
requested. e.g. a patch can result in either a CREATE or UPDATE Operation.</p>
</td>
</tr>
<tr><td><code>userInfo</code> <B>[Required]</B><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a>
</td>
<td>
<p>UserInfo is information about the requesting user</p>
</td>
</tr>
<tr><td><code>object</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
</td>
<td>
<p>Object is the object from the incoming request.</p>
</td>
</tr>
<tr><td><code>oldObject</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
</td>
<td>
<p>OldObject is the existing object. Only populated for DELETE and UPDATE requests.</p>
</td>
</tr>
<tr><td><code>dryRun</code><br/>
<code>bool</code>
</td>
<td>
<p>DryRun indicates that modifications will definitely not be persisted for this request.
Defaults to false.</p>
</td>
</tr>
<tr><td><code>options</code><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a>
</td>
<td>
<p>Options is the operation option structure of the operation being performed.
e.g. <code>meta.k8s.io/v1.DeleteOptions</code> or <code>meta.k8s.io/v1.CreateOptions</code>. This may be
different than the options the caller provided. e.g. for a patch request the performed
Operation might be a CREATE, in which case the Options will a
<code>meta.k8s.io/v1.CreateOptions</code> even though the caller provided <code>meta.k8s.io/v1.PatchOptions</code>.</p>
</td>
</tr>
</tbody>
</table>
## `AdmissionResponse` {#admission-k8s-io-v1-AdmissionResponse}
**Appears in:**
- [AdmissionReview](#admission-k8s-io-v1-AdmissionReview)
<p>AdmissionResponse describes an admission response.</p>
<table class="table">
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
<tbody>
<tr><td><code>uid</code> <B>[Required]</B><br/>
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID"><code>k8s.io/apimachinery/pkg/types.UID</code></a>
</td>
<td>
<p>UID is an identifier for the individual request/response.
This must be copied over from the corresponding AdmissionRequest.</p>
</td>
</tr>
<tr><td><code>allowed</code> <B>[Required]</B><br/>
<code>bool</code>
</td>
<td>
<p>Allowed indicates whether or not the admission request was permitted.</p>
</td>
</tr>
<tr><td><code>status</code><br/>
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#status-v1-meta"><code>meta/v1.Status</code></a>
</td>
<td>
<p>Result contains extra details into why an admission request was denied.
This field IS NOT consulted in any way if "Allowed" is "true".</p>
</td>
</tr>
<tr><td><code>patch</code><br/>
<code>[]byte</code>
</td>
<td>
<p>The patch body. Currently we only support "JSONPatch" which implements RFC 6902.</p>
</td>
</tr>
<tr><td><code>patchType</code><br/>
<a href="#admission-k8s-io-v1-PatchType"><code>PatchType</code></a>
</td>
<td>
<p>The type of Patch. Currently we only allow "JSONPatch".</p>
</td>
</tr>
<tr><td><code>auditAnnotations</code><br/>
<code>map[string]string</code>
</td>
<td>
<p>AuditAnnotations is an unstructured key value map set by remote admission controller (e.g. error=image-blacklisted).
MutatingAdmissionWebhook and ValidatingAdmissionWebhook admission controller will prefix the keys with
admission webhook name (e.g. imagepolicy.example.com/error=image-blacklisted). AuditAnnotations will be provided by
the admission webhook to add additional context to the audit log for this request.</p>
</td>
</tr>
<tr><td><code>warnings</code><br/>
<code>[]string</code>
</td>
<td>
<p>warnings is a list of warning messages to return to the requesting API client.
Warning messages describe a problem the client making the API request should correct or be aware of.
Limit warnings to 120 characters if possible.
Warnings over 256 characters and large numbers of warnings may be truncated.</p>
</td>
</tr>
</tbody>
</table>
## `Operation` {#admission-k8s-io-v1-Operation}
(Alias of `string`)
**Appears in:**
- [AdmissionRequest](#admission-k8s-io-v1-AdmissionRequest)
<p>Operation is the type of resource operation being checked for admission control</p>
## `PatchType` {#admission-k8s-io-v1-PatchType}
(Alias of `string`)
**Appears in:**
- [AdmissionResponse](#admission-k8s-io-v1-AdmissionResponse)
<p>PatchType is the type of patch being used to represent the mutated object</p>
| kubernetes reference | title kube apiserver Admission v1 content type tool reference package admission k8s io v1 auto generated true Resource Types AdmissionReview admission k8s io v1 AdmissionReview AdmissionReview admission k8s io v1 AdmissionReview p AdmissionReview describes an admission review request response 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 admission k8s io v1 code td tr tr td code kind code br string td td code AdmissionReview code td tr tr td code request code br a href admission k8s io v1 AdmissionRequest code AdmissionRequest code a td td p Request describes the attributes for the admission request p td tr tr td code response code br a href admission k8s io v1 AdmissionResponse code AdmissionResponse code a td td p Response describes the attributes for the admission response p td tr tbody table AdmissionRequest admission k8s io v1 AdmissionRequest Appears in AdmissionReview admission k8s io v1 AdmissionReview p AdmissionRequest describes the admission Attributes for the admission request p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code uid code B Required B br a href https pkg go dev k8s io apimachinery pkg types UID code k8s io apimachinery pkg types UID code a td td p UID is an identifier for the individual request response It allows us to distinguish instances of requests which are otherwise identical parallel requests requests when earlier requests did not modify etc The UID is meant to track the round trip request response between the KAS and the WebHook not the user request It is suitable for correlating log entries between the webhook and apiserver for either auditing or debugging p td tr tr td code kind code B Required B br a href https pkg go dev k8s io apimachinery pkg apis meta v1 GroupVersionKind code meta v1 GroupVersionKind code a td td p Kind is the fully qualified type of object being submitted for example v1 Pod or autoscaling v1 Scale p td tr tr td code resource code B Required B br a href https pkg go dev k8s io apimachinery pkg apis meta v1 GroupVersionResource code meta v1 GroupVersionResource code a td td p Resource is the fully qualified resource being requested for example v1 pods p td tr tr td code subResource code br code string code td td p SubResource is the subresource being requested if any for example quot status quot or quot scale quot p td tr tr td code requestKind code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 GroupVersionKind code meta v1 GroupVersionKind code a td td p RequestKind is the fully qualified type of the original API request for example v1 Pod or autoscaling v1 Scale If this is specified and differs from the value in quot kind quot an equivalent match and conversion was performed p p For example if deployments can be modified via apps v1 and apps v1beta1 and a webhook registered a rule of code apiGroups quot apps quot apiVersions quot v1 quot resources quot deployments quot code and code matchPolicy Equivalent code an API request to apps v1beta1 deployments would be converted and sent to the webhook with code kind group quot apps quot version quot v1 quot kind quot Deployment quot code matching the rule the webhook registered for and code requestKind group quot apps quot version quot v1beta1 quot kind quot Deployment quot code indicating the kind of the original API request p p See documentation for the quot matchPolicy quot field in the webhook configuration type for more details p td tr tr td code requestResource code br a href https pkg go dev k8s io apimachinery pkg apis meta v1 GroupVersionResource code meta v1 GroupVersionResource code a td td p RequestResource is the fully qualified resource of the original API request for example v1 pods If this is specified and differs from the value in quot resource quot an equivalent match and conversion was performed p p For example if deployments can be modified via apps v1 and apps v1beta1 and a webhook registered a rule of code apiGroups quot apps quot apiVersions quot v1 quot resources quot deployments quot code and code matchPolicy Equivalent code an API request to apps v1beta1 deployments would be converted and sent to the webhook with code resource group quot apps quot version quot v1 quot resource quot deployments quot code matching the resource the webhook registered for and code requestResource group quot apps quot version quot v1beta1 quot resource quot deployments quot code indicating the resource of the original API request p p See documentation for the quot matchPolicy quot field in the webhook configuration type p td tr tr td code requestSubResource code br code string code td td p RequestSubResource is the name of the subresource of the original API request if any for example quot status quot or quot scale quot If this is specified and differs from the value in quot subResource quot an equivalent match and conversion was performed See documentation for the quot matchPolicy quot field in the webhook configuration type p td tr tr td code name code br code string code td td p Name is the name of the object as presented in the request On a CREATE operation the client may omit name and rely on the server to generate the name If that is the case this field will contain an empty string p td tr tr td code namespace code br code string code td td p Namespace is the namespace associated with the request if any p td tr tr td code operation code B Required B br a href admission k8s io v1 Operation code Operation code a td td p Operation is the operation being performed This may be different than the operation requested e g a patch can result in either a CREATE or UPDATE Operation p td tr tr td code userInfo code B Required B br a href https kubernetes io docs reference generated kubernetes api v1 31 userinfo v1 authentication k8s io code authentication v1 UserInfo code a td td p UserInfo is information about the requesting user p td tr tr td code object code br a href https pkg go dev k8s io apimachinery pkg runtime RawExtension code k8s io apimachinery pkg runtime RawExtension code a td td p Object is the object from the incoming request p td tr tr td code oldObject code br a href https pkg go dev k8s io apimachinery pkg runtime RawExtension code k8s io apimachinery pkg runtime RawExtension code a td td p OldObject is the existing object Only populated for DELETE and UPDATE requests p td tr tr td code dryRun code br code bool code td td p DryRun indicates that modifications will definitely not be persisted for this request Defaults to false p td tr tr td code options code br a href https pkg go dev k8s io apimachinery pkg runtime RawExtension code k8s io apimachinery pkg runtime RawExtension code a td td p Options is the operation option structure of the operation being performed e g code meta k8s io v1 DeleteOptions code or code meta k8s io v1 CreateOptions code This may be different than the options the caller provided e g for a patch request the performed Operation might be a CREATE in which case the Options will a code meta k8s io v1 CreateOptions code even though the caller provided code meta k8s io v1 PatchOptions code p td tr tbody table AdmissionResponse admission k8s io v1 AdmissionResponse Appears in AdmissionReview admission k8s io v1 AdmissionReview p AdmissionResponse describes an admission response p table class table thead tr th width 30 Field th th Description th tr thead tbody tr td code uid code B Required B br a href https pkg go dev k8s io apimachinery pkg types UID code k8s io apimachinery pkg types UID code a td td p UID is an identifier for the individual request response This must be copied over from the corresponding AdmissionRequest p td tr tr td code allowed code B Required B br code bool code td td p Allowed indicates whether or not the admission request was permitted p td tr tr td code status code br a href https kubernetes io docs reference generated kubernetes api v1 31 status v1 meta code meta v1 Status code a td td p Result contains extra details into why an admission request was denied This field IS NOT consulted in any way if quot Allowed quot is quot true quot p td tr tr td code patch code br code byte code td td p The patch body Currently we only support quot JSONPatch quot which implements RFC 6902 p td tr tr td code patchType code br a href admission k8s io v1 PatchType code PatchType code a td td p The type of Patch Currently we only allow quot JSONPatch quot p td tr tr td code auditAnnotations code br code map string string code td td p AuditAnnotations is an unstructured key value map set by remote admission controller e g error image blacklisted MutatingAdmissionWebhook and ValidatingAdmissionWebhook admission controller will prefix the keys with admission webhook name e g imagepolicy example com error image blacklisted AuditAnnotations will be provided by the admission webhook to add additional context to the audit log for this request p td tr tr td code warnings code br code string code td td p warnings is a list of warning messages to return to the requesting API client Warning messages describe a problem the client making the API request should correct or be aware of Limit warnings to 120 characters if possible Warnings over 256 characters and large numbers of warnings may be truncated p td tr tbody table Operation admission k8s io v1 Operation Alias of string Appears in AdmissionRequest admission k8s io v1 AdmissionRequest p Operation is the type of resource operation being checked for admission control p PatchType admission k8s io v1 PatchType Alias of string Appears in AdmissionResponse admission k8s io v1 AdmissionResponse p PatchType is the type of patch being used to represent the mutated object p |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.