Kubernetes API

401: Unauthorized

`list` list or watch objects of kind HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/horizontalpodautoscalers

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

401: Unauthorized

`create` create a HorizontalPodAutoscaler

HTTP Request

POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

Parameters

namespace (in path): string, required

namespace
body: HorizontalPodAutoscaler, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

202 (HorizontalPodAutoscaler): 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

namespace
body: HorizontalPodAutoscaler, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): 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

namespace
body: HorizontalPodAutoscaler, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of HorizontalPodAutoscaler

HTTP Request

DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

1.12 - HorizontalPodAutoscaler v2beta2

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.

apiVersion: autoscaling/v2beta2

import "k8s.io/api/autoscaling/v2beta2"

HorizontalPodAutoscaler

apiVersion: autoscaling/v2beta2
kind: HorizontalPodAutoscaler
metadata (ObjectMeta)

metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (HorizontalPodAutoscalerSpec)

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 (HorizontalPodAutoscalerStatus)

status is the current information about the autoscaler.

HorizontalPodAutoscalerSpec

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

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.

CrossVersionObjectReference contains enough information to let you identify the referred resource.
- scaleTargetRef.kind (string), required
  
  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 of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
- scaleTargetRef.apiVersion (string)
  
  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.

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).
  
  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)
    
    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
    
    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 MaxPolicySelect 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.
  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)
    
    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
    
    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 MaxPolicySelect 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)

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.

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)
  
  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 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.
  
  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
    
    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 (Quantity)
      
      averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
    - metrics.containerResource.target.value (Quantity)
      
      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).
  
  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
    
    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 (LabelSelector)
      
      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
    
    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 (Quantity)
      
      averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
    - metrics.external.target.value (Quantity)
      
      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).
  
  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
    
    CrossVersionObjectReference contains enough information to let you identify the referred resource.
    - metrics.object.describedObject.kind (string), required
      
      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 of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
    - metrics.object.describedObject.apiVersion (string)
      
      API version of the referent
  - metrics.object.metric (MetricIdentifier), required
    
    metric identifies the target metric by name and selector
    
    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 (LabelSelector)
      
      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
    
    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 (Quantity)
      
      averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
    - metrics.object.target.value (Quantity)
      
      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.
  
  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
    
    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 (LabelSelector)
      
      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
    
    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 (Quantity)
      
      averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
    - metrics.pods.target.value (Quantity)
      
      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.
  
  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
    
    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 (Quantity)
      
      averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
    - metrics.resource.target.value (Quantity)
      
      value is the target value of the metric (as a quantity).

HorizontalPodAutoscalerStatus

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

conditions ([]HorizontalPodAutoscalerCondition), required

conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.

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
  
  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.
currentReplicas (int32), required

currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
desiredReplicas (int32), required

desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
currentMetrics ([]MetricStatus)

currentMetrics is the last read state of the metrics used by this autoscaler.

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.
  
  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
    
    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 (Quantity)
      
      averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
    - currentMetrics.containerResource.current.value (Quantity)
      
      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).
  
  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
    
    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 (Quantity)
      
      averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
    - currentMetrics.external.current.value (Quantity)
      
      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
    
    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 (LabelSelector)
      
      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).
  
  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
    
    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 (Quantity)
      
      averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
    - currentMetrics.object.current.value (Quantity)
      
      value is the current value of the metric (as a quantity).
  - currentMetrics.object.describedObject (CrossVersionObjectReference), required
    
    CrossVersionObjectReference contains enough information to let you identify the referred resource.
    - currentMetrics.object.describedObject.kind (string), required
      
      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 of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
    - currentMetrics.object.describedObject.apiVersion (string)
      
      API version of the referent
  - currentMetrics.object.metric (MetricIdentifier), required
    
    metric identifies the target metric by name and selector
    
    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 (LabelSelector)
      
      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.
  
  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
    
    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 (Quantity)
      
      averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
    - currentMetrics.pods.current.value (Quantity)
      
      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
    
    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 (LabelSelector)
      
      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.
  
  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
    
    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 (Quantity)
      
      averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
    - currentMetrics.resource.current.value (Quantity)
      
      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.
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.

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 is a list of horizontal pod autoscaler objects.

apiVersion: autoscaling/v2beta2
kind: HorizontalPodAutoscalerList
metadata (ListMeta)

metadata is the standard list metadata.
items ([]HorizontalPodAutoscaler), required

items is the list of horizontal pod autoscaler objects.

Operations

`get` read the specified HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}

Parameters

name (in path): string, required

name of the HorizontalPodAutoscaler
namespace (in path): string, required

namespace
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

401: Unauthorized

`get` read status of the specified HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Parameters

name (in path): string, required

name of the HorizontalPodAutoscaler
namespace (in path): string, required

namespace
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

401: Unauthorized

`list` list or watch objects of kind HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers

Parameters

namespace (in path): string, required

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

401: Unauthorized

`list` list or watch objects of kind HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v2beta2/horizontalpodautoscalers

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

401: Unauthorized

`create` create a HorizontalPodAutoscaler

HTTP Request

POST /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers

Parameters

namespace (in path): string, required

namespace
body: HorizontalPodAutoscaler, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

202 (HorizontalPodAutoscaler): Accepted

401: Unauthorized

`update` replace the specified HorizontalPodAutoscaler

HTTP Request

PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}

Parameters

name (in path): string, required

name of the HorizontalPodAutoscaler
namespace (in path): string, required

namespace
body: HorizontalPodAutoscaler, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

401: Unauthorized

`update` replace status of the specified HorizontalPodAutoscaler

HTTP Request

PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Parameters

name (in path): string, required

name of the HorizontalPodAutoscaler
namespace (in path): string, required

namespace
body: HorizontalPodAutoscaler, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

401: Unauthorized

`patch` partially update the specified HorizontalPodAutoscaler

HTTP Request

PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}

Parameters

name (in path): string, required

name of the HorizontalPodAutoscaler
namespace (in path): string, required

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

401: Unauthorized

`patch` partially update status of the specified HorizontalPodAutoscaler

HTTP Request

PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Parameters

name (in path): string, required

name of the HorizontalPodAutoscaler
namespace (in path): string, required

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

401: Unauthorized

`delete` delete a HorizontalPodAutoscaler

HTTP Request

DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}

Parameters

name (in path): string, required

name of the HorizontalPodAutoscaler
namespace (in path): string, required

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of HorizontalPodAutoscaler

HTTP Request

DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

1.13 - PriorityClass

PriorityClass defines mapping from a priority class name to the priority integer value.

apiVersion: scheduling.k8s.io/v1

import "k8s.io/api/scheduling/v1"

PriorityClass

PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

apiVersion: scheduling.k8s.io/v1
kind: PriorityClass
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
value (int32), required

The 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. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

PriorityClassList

PriorityClassList is a collection of priority classes.

apiVersion: scheduling.k8s.io/v1
kind: PriorityClassList
metadata (ListMeta)

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]PriorityClass), required

items is the list of PriorityClasses

Operations

`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

pretty

Response

200 (PriorityClass): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (PriorityClassList): OK

401: Unauthorized

`create` create a PriorityClass

HTTP Request

POST /apis/scheduling.k8s.io/v1/priorityclasses

Parameters

body: PriorityClass, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PriorityClass): OK

201 (PriorityClass): Created

202 (PriorityClass): 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: PriorityClass, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PriorityClass): OK

201 (PriorityClass): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (PriorityClass): OK

201 (PriorityClass): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of PriorityClass

HTTP Request

DELETE /apis/scheduling.k8s.io/v1/priorityclasses

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

2 - Service Resources

2.1 - 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.

apiVersion: v1

import "k8s.io/api/core/v1"

Service

apiVersion: v1
kind: Service
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (ServiceSpec)

Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status (ServiceStatus)

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 describes the attributes that a user creates on a service.

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

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
  
  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 field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use 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, and is gated by the "IPv6DualStack" feature gate. 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, and is gated by the "IPv6DualStack" feature gate. 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.

Unless the "IPv6DualStack" feature gate is enabled, this field is limited to one value, which must be the same as the clusterIP field. If the feature gate is enabled, 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)

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 LoadBalancer will get created with the IP specified in this field. 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.
loadBalancerSourceRanges ([]string)

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 denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
internalTrafficPolicy (string)

InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
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).
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.

SessionAffinityConfig represents the configurations of session affinity.
- sessionAffinityConfig.clientIP (ClientIPConfig)
  
  clientIP contains the configurations of Client IP based session affinity.
  
  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. This field is beta-level and is only honored by servers that enable the ServiceLBNodePortControl feature.

ServiceStatus

ServiceStatus represents the current status of a service.

conditions ([]Condition)

Patch strategy: merge on key type

Map: unique values on key type will be kept during a merge

Current service state

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.
  
  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.

LoadBalancerStatus represents the status of a load-balancer.
- loadBalancer.ingress ([]LoadBalancerIngress)
  
  Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.
  
  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.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
    
    **
    - 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 holds a list of services.

apiVersion: v1
kind: ServiceList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]Service), required

List of services

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (Service): 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

namespace
pretty (in query): string

pretty

Response

200 (Service): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ServiceList): OK

401: Unauthorized

`list` list or watch objects of kind Service

HTTP Request

GET /api/v1/services

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ServiceList): OK

401: Unauthorized

`create` create a Service

HTTP Request

POST /api/v1/namespaces/{namespace}/services

Parameters

namespace (in path): string, required

namespace
body: Service, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Service): OK

201 (Service): Created

202 (Service): 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

namespace
body: Service, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Service): OK

201 (Service): 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

namespace
body: Service, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Service): OK

201 (Service): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Service): OK

201 (Service): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Service): OK

201 (Service): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

2.2 - Endpoints

Endpoints is a collection of endpoints that implement the actual service.

apiVersion: v1

import "k8s.io/api/core/v1"

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}] }, ]

apiVersion: v1
kind: Endpoints
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
subsets ([]EndpointSubset)

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.

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)
  
  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.
  
  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), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
  - 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 (ObjectReference)
    
    Reference to object providing the endpoint.
- subsets.notReadyAddresses ([]EndpointAddress)
  
  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.
  
  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), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
  - 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 (ObjectReference)
    
    Reference to object providing the endpoint.
- subsets.ports ([]EndpointPort)
  
  Port numbers available on the related IP addresses.
  
  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 field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.

EndpointsList

EndpointsList is a list of endpoints.

apiVersion: v1
kind: EndpointsList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]Endpoints), required

List of endpoints.

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (Endpoints): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (EndpointsList): OK

401: Unauthorized

`list` list or watch objects of kind Endpoints

HTTP Request

GET /api/v1/endpoints

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (EndpointsList): OK

401: Unauthorized

`create` create Endpoints

HTTP Request

POST /api/v1/namespaces/{namespace}/endpoints

Parameters

namespace (in path): string, required

namespace
body: Endpoints, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Endpoints): OK

201 (Endpoints): Created

202 (Endpoints): 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

namespace
body: Endpoints, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Endpoints): OK

201 (Endpoints): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Endpoints): OK

201 (Endpoints): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of Endpoints

HTTP Request

DELETE /api/v1/namespaces/{namespace}/endpoints

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

2.3 - EndpointSlice

EndpointSlice represents a subset of the endpoints that implement a service.

apiVersion: discovery.k8s.io/v1

import "k8s.io/api/discovery/v1"

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.

apiVersion: discovery.k8s.io/v1
kind: EndpointSlice
metadata (ObjectMeta)

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.

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.
- endpoints.conditions (EndpointConditions)
  
  conditions contains information about the current status of the endpoint.
  
  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.
  - 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. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
  - 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. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
- 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.
  
  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.
    
    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. This field can be enabled with the EndpointSliceNodeName feature gate.
- endpoints.targetRef (ObjectReference)
  
  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.

EndpointPort represents a Port used by an EndpointSlice
- ports.port (int32)
  
  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)
  
  The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
- ports.name (string)
  
  The name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied 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 field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.

EndpointSliceList

EndpointSliceList represents a list of endpoint slices

apiVersion: discovery.k8s.io/v1
kind: EndpointSliceList
metadata (ListMeta)

Standard list metadata.
items ([]EndpointSlice), required

List of endpoint slices

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (EndpointSlice): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (EndpointSliceList): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (EndpointSliceList): OK

401: Unauthorized

`create` create an EndpointSlice

HTTP Request

POST /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices

Parameters

namespace (in path): string, required

namespace
body: EndpointSlice, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (EndpointSlice): OK

201 (EndpointSlice): Created

202 (EndpointSlice): 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

namespace
body: EndpointSlice, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (EndpointSlice): OK

201 (EndpointSlice): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (EndpointSlice): OK

201 (EndpointSlice): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): 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

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

2.4 - Ingress

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend.

apiVersion: networking.k8s.io/v1

import "k8s.io/api/networking/v1"

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.

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (IngressSpec)

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 (IngressStatus)

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 describes the Ingress the user wishes to exist.

defaultBackend (IngressBackend)

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 the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated kubernetes.io/ingress.class annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.
rules ([]IngressRule)

Atomic: will be replaced during a merge

A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.

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)
  
  HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> 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
    
    A collection of paths that map requests to backends.
    
    HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.
    - rules.http.paths.backend (IngressBackend), 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 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.

IngressTLS describes the transport layer security associated with an Ingress.
- tls.hosts ([]string)
  
  Atomic: will be replaced during a merge
  
  Hosts are 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 describes all endpoints for a given service and port.

resource (TypedLocalObjectReference)

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".

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.
  
  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 describe the current state of the Ingress.

loadBalancer (LoadBalancerStatus)

LoadBalancer contains the current status of the load-balancer.

LoadBalancerStatus represents the status of a load-balancer.
- loadBalancer.ingress ([]LoadBalancerIngress)
  
  Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.
  
  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.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
    
    **
    - 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.

IngressList

IngressList is a collection of Ingress.

items ([]Ingress), 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 (ListMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (Ingress): 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

namespace
pretty (in query): string

pretty

Response

200 (Ingress): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (IngressList): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (IngressList): OK

401: Unauthorized

`create` create an Ingress

HTTP Request

POST /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses

Parameters

namespace (in path): string, required

namespace
body: Ingress, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Ingress): OK

201 (Ingress): Created

202 (Ingress): 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

namespace
body: Ingress, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Ingress): OK

201 (Ingress): 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

namespace
body: Ingress, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Ingress): OK

201 (Ingress): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Ingress): OK

201 (Ingress): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Ingress): OK

201 (Ingress): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): 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

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

2.5 - IngressClass

IngressClass represents the class of the Ingress, referenced by the Ingress Spec.

apiVersion: networking.k8s.io/v1

import "k8s.io/api/networking/v1"

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.

apiVersion: networking.k8s.io/v1
kind: IngressClass
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (IngressClassSpec)

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 provides information about the class of an Ingress.

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.

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". Field can be enabled with IngressClassNamespacedParams feature gate.

IngressClassList

IngressClassList is a collection of IngressClasses.

apiVersion: networking.k8s.io/v1
kind: IngressClassList
metadata (ListMeta)

Standard list metadata.
items ([]IngressClass), required

Items is the list of IngressClasses.

Operations

`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

pretty

Response

200 (IngressClass): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (IngressClassList): OK

401: Unauthorized

`create` create an IngressClass

HTTP Request

POST /apis/networking.k8s.io/v1/ingressclasses

Parameters

body: IngressClass, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (IngressClass): OK

201 (IngressClass): Created

202 (IngressClass): 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: IngressClass, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (IngressClass): OK

201 (IngressClass): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (IngressClass): OK

201 (IngressClass): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of IngressClass

HTTP Request

DELETE /apis/networking.k8s.io/v1/ingressclasses

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

3 - Config and Storage Resources

3.1 - ConfigMap

ConfigMap holds configuration data for pods to consume.

apiVersion: v1

import "k8s.io/api/core/v1"

ConfigMap

ConfigMap holds configuration data for pods to consume.

apiVersion: v1
kind: ConfigMap
metadata (ObjectMeta)

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 is a resource containing a list of ConfigMap objects.

apiVersion: v1
kind: ConfigMapList
metadata (ListMeta)

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]ConfigMap), required

Items is the list of ConfigMaps.

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (ConfigMap): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ConfigMapList): OK

401: Unauthorized

`list` list or watch objects of kind ConfigMap

HTTP Request

GET /api/v1/configmaps

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ConfigMapList): OK

401: Unauthorized

`create` create a ConfigMap

HTTP Request

POST /api/v1/namespaces/{namespace}/configmaps

Parameters

namespace (in path): string, required

namespace
body: ConfigMap, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ConfigMap): OK

201 (ConfigMap): Created

202 (ConfigMap): 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

namespace
body: ConfigMap, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ConfigMap): OK

201 (ConfigMap): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (ConfigMap): OK

201 (ConfigMap): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of ConfigMap

HTTP Request

DELETE /api/v1/namespaces/{namespace}/configmaps

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

3.2 - Secret

Secret holds secret data of a certain type.

apiVersion: v1

import "k8s.io/api/core/v1"

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.

apiVersion: v1
kind: Secret
metadata (ObjectMeta)

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.

SecretList

SecretList is a list of Secret.

apiVersion: v1
kind: SecretList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]Secret), required

Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (Secret): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (SecretList): OK

401: Unauthorized

`list` list or watch objects of kind Secret

HTTP Request

GET /api/v1/secrets

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (SecretList): OK

401: Unauthorized

`create` create a Secret

HTTP Request

POST /api/v1/namespaces/{namespace}/secrets

Parameters

namespace (in path): string, required

namespace
body: Secret, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Secret): OK

201 (Secret): Created

202 (Secret): 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

namespace
body: Secret, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Secret): OK

201 (Secret): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Secret): OK

201 (Secret): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of Secret

HTTP Request

DELETE /api/v1/namespaces/{namespace}/secrets

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

3.3 - Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

import "k8s.io/api/core/v1"

Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

name (string), required

Volume's name. 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

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)
  
  Will force the ReadOnly setting in VolumeMounts. Default false.

Projections

configMap (ConfigMapVolumeSource)

ConfigMap represents a configMap that should populate this volume

*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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- configMap.optional (boolean)
  
  Specify whether the ConfigMap or its keys must be defined
- configMap.defaultMode (int32)
  
  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 ([]KeyToPath)
  
  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

*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)
  
  Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- secret.optional (boolean)
  
  Specify whether the Secret or its keys must be defined
- secret.defaultMode (int32)
  
  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 ([]KeyToPath)
  
  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

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 ([]DownwardAPIVolumeFile)
  
  Items is a list of downward API volume file
projected (ProjectedVolumeSource)

Items for all in one resources secrets, configmaps, and downward API

Represents a projected volume source
- projected.defaultMode (int32)
  
  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)
  
  list of volume projections
  
  Projection that may be projected along with other supported volume types
  - projected.sources.configMap (ConfigMapProjection)
    
    information about the configMap data to project
    
    *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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    - projected.sources.configMap.optional (boolean)
      
      Specify whether the ConfigMap or its keys must be defined
    - projected.sources.configMap.items ([]KeyToPath)
      
      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)
    
    information about the downwardAPI data to project
    
    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 ([]DownwardAPIVolumeFile)
      
      Items is a list of DownwardAPIVolume file
  - projected.sources.secret (SecretProjection)
    
    information about the secret data to project
    
    *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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    - projected.sources.secret.optional (boolean)
      
      Specify whether the Secret or its key must be defined
    - projected.sources.secret.items ([]KeyToPath)
      
      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)
    
    information about the serviceAccountToken data to project
    
    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

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
- emptyDir.medium (string)
  
  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 (Quantity)
  
  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: http://kubernetes.io/docs/user-guide/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

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

*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
  
  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)
  
  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)
  
  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)
  
  Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". 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.

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- azureDisk.diskName (string), required
  
  The Name of the data disk in the blob storage
- azureDisk.diskURI (string), required
  
  The URI the data disk in the blob storage
- azureDisk.cachingMode (string)
  
  Host Caching mode: None, Read Only, Read Write.
- azureDisk.fsType (string)
  
  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)
  
  Expected values 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)
  
  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.

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
- azureFile.secretName (string), required
  
  the name of secret that contains Azure Storage Account Name and Key
- azureFile.shareName (string), required
  
  Share Name
- azureFile.readOnly (boolean)
  
  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

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
  
  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)
  
  Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- cephfs.readOnly (boolean)
  
  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)
  
  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 (LocalObjectReference)
  
  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)
  
  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

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
  
  volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- cinder.fsType (string)
  
  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)
  
  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 (LocalObjectReference)
  
  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).

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)
  
  Filesystem type 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 (LocalObjectReference)
  
  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)
  
  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.
fc (FCVolumeSource)

FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

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)
  
  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)
  
  Optional: FC target lun number
- fc.readOnly (boolean)
  
  Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- fc.targetWWNs ([]string)
  
  Optional: FC target worldwide names (WWNs)
- fc.wwids ([]string)
  
  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.

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)
  
  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)
  
  Optional: Extra command options if any.
- flexVolume.readOnly (boolean)
  
  Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- flexVolume.secretRef (LocalObjectReference)
  
  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

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)
  
  Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
- flocker.datasetUUID (string)
  
  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

*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
  
  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)
  
  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)
  
  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

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
  
  EndpointsName 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

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
  
  Target iSCSI Qualified Name.
- iscsi.lun (int32), required
  
  iSCSI Target Lun number.
- iscsi.targetPortal (string), required
  
  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)
  
  whether support iSCSI Discovery CHAP authentication
- iscsi.chapAuthSession (boolean)
  
  whether support iSCSI Session CHAP authentication
- iscsi.fsType (string)
  
  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)
  
  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)
  
  iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
- iscsi.portals ([]string)
  
  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 (LocalObjectReference)
  
  CHAP Secret for iSCSI target and initiator authentication
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

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

Represents a Photon Controller persistent disk resource.
- photonPersistentDisk.pdID (string), required
  
  ID that identifies Photon Controller persistent disk
- photonPersistentDisk.fsType (string)
  
  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

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)
  
  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

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

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
  
  The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- rbd.monitors ([]string), required
  
  A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- rbd.fsType (string)
  
  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)
  
  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 (LocalObjectReference)
  
  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)
  
  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.

ScaleIOVolumeSource represents a persistent ScaleIO volume
- scaleIO.gateway (string), required
  
  The host address of the ScaleIO API Gateway.
- scaleIO.secretRef (LocalObjectReference), 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
  
  The name of the storage system as configured in ScaleIO.
- scaleIO.fsType (string)
  
  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)
  
  The name of the ScaleIO Protection Domain for the configured storage.
- scaleIO.readOnly (boolean)
  
  Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- scaleIO.sslEnabled (boolean)
  
  Flag to enable/disable SSL communication with Gateway, default false
- scaleIO.storageMode (string)
  
  Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
- scaleIO.storagePool (string)
  
  The ScaleIO Storage Pool associated with the protection domain.
- scaleIO.volumeName (string)
  
  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.

Represents a StorageOS persistent volume resource.
- storageos.fsType (string)
  
  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)
  
  Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- storageos.secretRef (LocalObjectReference)
  
  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

Represents a vSphere volume resource.
- vsphereVolume.volumePath (string), required
  
  Path that identifies vSphere volume vmdk
- vsphereVolume.fsType (string)
  
  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)
  
  Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- vsphereVolume.storagePolicyName (string)
  
  Storage Policy Based Management (SPBM) profile name.

Alpha level

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.

This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.

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.
  
  PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
  - ephemeral.volumeClaimTemplate.spec (PersistentVolumeClaimSpec), 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 (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.

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.

*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 URL
- gitRepo.directory (string)
  
  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)
  
  Commit hash for the specified revision.

DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

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 (ObjectFieldSelector)

Required: Selects a field of the pod: only annotations, labels, name and namespace 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 (ResourceFieldSelector)

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

KeyToPath

Maps a string key to a path within a volume.

key (string), required

The key to project.
path (string), required

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)

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.

3.4 - PersistentVolumeClaim

PersistentVolumeClaim is a user's request for and claim to a persistent volume.

apiVersion: v1

import "k8s.io/api/core/v1"

PersistentVolumeClaim

PersistentVolumeClaim is a user's request for and claim to a persistent volume

apiVersion: v1
kind: PersistentVolumeClaim
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (PersistentVolumeClaimSpec)

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 (PersistentVolumeClaimStatus)

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 describes the common attributes of storage devices and allows a Source for provider-specific attributes

accessModes ([]string)

AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
selector (LabelSelector)

A label query over volumes to consider for binding.
resources (ResourceRequirements)

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

ResourceRequirements describes the compute resource requirements.
- resources.limits (map[string]Quantity)
  
  Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- resources.requests (map[string]Quantity)
  
  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. 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)

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.

Alpha level

dataSource (TypedLocalObjectReference)

This 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. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
dataSourceRef (TypedLocalObjectReference)

Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local 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, 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. There are two 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. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

PersistentVolumeClaimStatus

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

accessModes ([]string)

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
capacity (map[string]Quantity)

Represents the actual resources of the underlying volume.
conditions ([]PersistentVolumeClaimCondition)

Patch strategy: merge on key type

Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.

PersistentVolumeClaimCondition contails details about state of pvc
- conditions.status (string), required
- conditions.type (string), required
- conditions.lastProbeTime (Time)
  
  Last time we probed the condition.
  
  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.
  
  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, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
phase (string)

Phase represents the current phase of PersistentVolumeClaim.

PersistentVolumeClaimList

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

apiVersion: v1
kind: PersistentVolumeClaimList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]PersistentVolumeClaim), required

A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (PersistentVolumeClaim): 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

namespace
pretty (in query): string

pretty

Response

200 (PersistentVolumeClaim): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (PersistentVolumeClaimList): OK

401: Unauthorized

`list` list or watch objects of kind PersistentVolumeClaim

HTTP Request

GET /api/v1/persistentvolumeclaims

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (PersistentVolumeClaimList): OK

401: Unauthorized

`create` create a PersistentVolumeClaim

HTTP Request

POST /api/v1/namespaces/{namespace}/persistentvolumeclaims

Parameters

namespace (in path): string, required

namespace
body: PersistentVolumeClaim, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PersistentVolumeClaim): OK

201 (PersistentVolumeClaim): Created

202 (PersistentVolumeClaim): 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

namespace
body: PersistentVolumeClaim, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PersistentVolumeClaim): OK

201 (PersistentVolumeClaim): 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

namespace
body: PersistentVolumeClaim, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PersistentVolumeClaim): OK

201 (PersistentVolumeClaim): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (PersistentVolumeClaim): OK

201 (PersistentVolumeClaim): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (PersistentVolumeClaim): OK

201 (PersistentVolumeClaim): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (PersistentVolumeClaim): OK

202 (PersistentVolumeClaim): Accepted

401: Unauthorized

`deletecollection` delete collection of PersistentVolumeClaim

HTTP Request

DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

3.5 - PersistentVolume

PersistentVolume (PV) is a storage resource provisioned by an administrator.

apiVersion: v1

import "k8s.io/api/core/v1"

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

apiVersion: v1
kind: PersistentVolume
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (PersistentVolumeSpec)

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 (PersistentVolumeStatus)

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 is the specification of a persistent volume.

accessModes ([]string)

AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
capacity (map[string]Quantity)

A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
claimRef (ObjectReference)

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)

A 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.

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 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
    
    Required. A list of node selector terms. The terms are ORed.
    
    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 ([]NodeSelectorRequirement)
      
      A list of node selector requirements by node's labels.
    - nodeAffinity.required.nodeSelectorTerms.matchFields ([]NodeSelectorRequirement)
      
      A list of node selector requirements by node's fields.
persistentVolumeReclaimPolicy (string)

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)

Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
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

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

Local represents directly-attached storage with node affinity (Beta feature)
- local.path (string), required
  
  The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
- local.fsType (string)
  
  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 fileystem 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

*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
  
  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)
  
  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)
  
  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)
  
  Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". 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.

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- azureDisk.diskName (string), required
  
  The Name of the data disk in the blob storage
- azureDisk.diskURI (string), required
  
  The URI the data disk in the blob storage
- azureDisk.cachingMode (string)
  
  Host Caching mode: None, Read Only, Read Write.
- azureDisk.fsType (string)
  
  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)
  
  Expected values 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)
  
  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.

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
- azureFile.secretName (string), required
  
  the name of secret that contains Azure Storage Account Name and Key
- azureFile.shareName (string), required
  
  Share Name
- azureFile.readOnly (boolean)
  
  Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- azureFile.secretNamespace (string)
  
  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

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
  
  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)
  
  Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- cephfs.readOnly (boolean)
  
  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)
  
  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)
  
  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
  
  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)
  
  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

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
  
  volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- cinder.fsType (string)
  
  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)
  
  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)
  
  Optional: points to a secret object containing parameters used to connect to OpenStack.
  
  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).

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 is an alpha field and requires enabling ExpandCSIVolumes feature gate. 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.
  
  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.
  
  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)
  
  Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
- 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.
  
  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.
  
  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)
  
  Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
- csi.volumeAttributes (map[string]string)
  
  Attributes 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.

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)
  
  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)
  
  Optional: FC target lun number
- fc.readOnly (boolean)
  
  Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- fc.targetWWNs ([]string)
  
  Optional: FC target worldwide names (WWNs)
- fc.wwids ([]string)
  
  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.

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)
  
  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)
  
  Optional: Extra command options if any.
- flexVolume.readOnly (boolean)
  
  Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- flexVolume.secretRef (SecretReference)
  
  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.
  
  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

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)
  
  Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
- flocker.datasetUUID (string)
  
  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

*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
  
  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)
  
  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)
  
  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

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
  
  EndpointsName 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.

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
  
  Target iSCSI Qualified Name.
- iscsi.lun (int32), required
  
  iSCSI Target Lun number.
- iscsi.targetPortal (string), required
  
  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)
  
  whether support iSCSI Discovery CHAP authentication
- iscsi.chapAuthSession (boolean)
  
  whether support iSCSI Session CHAP authentication
- iscsi.fsType (string)
  
  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)
  
  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)
  
  iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
- iscsi.portals ([]string)
  
  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)
  
  CHAP Secret for iSCSI target and initiator authentication
  
  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

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

Represents a Photon Controller persistent disk resource.
- photonPersistentDisk.pdID (string), required
  
  ID that identifies Photon Controller persistent disk
- photonPersistentDisk.fsType (string)
  
  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

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)
  
  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

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

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
  
  The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- rbd.monitors ([]string), required
  
  A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- rbd.fsType (string)
  
  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)
  
  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
  
  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)
  
  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.

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
- scaleIO.gateway (string), required
  
  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.
  
  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
  
  The name of the storage system as configured in ScaleIO.
- scaleIO.fsType (string)
  
  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)
  
  The name of the ScaleIO Protection Domain for the configured storage.
- scaleIO.readOnly (boolean)
  
  Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- scaleIO.sslEnabled (boolean)
  
  Flag to enable/disable SSL communication with Gateway, default false
- scaleIO.storageMode (string)
  
  Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
- scaleIO.storagePool (string)
  
  The ScaleIO Storage Pool associated with the protection domain.
- scaleIO.volumeName (string)
  
  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

Represents a StorageOS persistent volume resource.
- storageos.fsType (string)
  
  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)
  
  Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- storageos.secretRef (ObjectReference)
  
  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

Represents a vSphere volume resource.
- vsphereVolume.volumePath (string), required
  
  Path that identifies vSphere volume vmdk
- vsphereVolume.fsType (string)
  
  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)
  
  Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- vsphereVolume.storagePolicyName (string)
  
  Storage Policy Based Management (SPBM) profile name.

PersistentVolumeStatus

PersistentVolumeStatus is the current status of a persistent volume.

message (string)

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 is a list of PersistentVolume items.

apiVersion: v1
kind: PersistentVolumeList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]PersistentVolume), required

List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

Operations

`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

pretty

Response

200 (PersistentVolume): 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

pretty

Response

200 (PersistentVolume): OK

401: Unauthorized

`list` list or watch objects of kind PersistentVolume

HTTP Request

GET /api/v1/persistentvolumes

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (PersistentVolumeList): OK

401: Unauthorized

`create` create a PersistentVolume

HTTP Request

POST /api/v1/persistentvolumes

Parameters

body: PersistentVolume, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PersistentVolume): OK

201 (PersistentVolume): Created

202 (PersistentVolume): 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: PersistentVolume, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PersistentVolume): OK

201 (PersistentVolume): 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: PersistentVolume, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PersistentVolume): OK

201 (PersistentVolume): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (PersistentVolume): OK

201 (PersistentVolume): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (PersistentVolume): OK

201 (PersistentVolume): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (PersistentVolume): OK

202 (PersistentVolume): Accepted

401: Unauthorized

`deletecollection` delete collection of PersistentVolume

HTTP Request

DELETE /api/v1/persistentvolumes

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

3.6 - StorageClass

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

apiVersion: storage.k8s.io/v1

import "k8s.io/api/storage/v1"

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.

apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata (ObjectMeta)

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

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 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)
  
  A list of topology selector requirements by labels.
  
  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
    
    An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
mountOptions ([]string)

Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, 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)

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. 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 is a collection of storage classes.

apiVersion: storage.k8s.io/v1
kind: StorageClassList
metadata (ListMeta)

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]StorageClass), required

Items is the list of StorageClasses

Operations

`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

pretty

Response

200 (StorageClass): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (StorageClassList): OK

401: Unauthorized

`create` create a StorageClass

HTTP Request

POST /apis/storage.k8s.io/v1/storageclasses

Parameters

body: StorageClass, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (StorageClass): OK

201 (StorageClass): Created

202 (StorageClass): 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: StorageClass, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (StorageClass): OK

201 (StorageClass): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (StorageClass): OK

201 (StorageClass): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (StorageClass): OK

202 (StorageClass): Accepted

401: Unauthorized

`deletecollection` delete collection of StorageClass

HTTP Request

DELETE /apis/storage.k8s.io/v1/storageclasses

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

3.7 - VolumeAttachment

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

apiVersion: storage.k8s.io/v1

import "k8s.io/api/storage/v1"

VolumeAttachment

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

VolumeAttachment objects are non-namespaced.

apiVersion: storage.k8s.io/v1
kind: VolumeAttachment
metadata (ObjectMeta)

Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (VolumeAttachmentSpec), required

Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
status (VolumeAttachmentStatus)

Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.

VolumeAttachmentSpec

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

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

The node that the volume should be attached to.
source (VolumeAttachmentSource), required

Source represents the volume that should be attached.

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 (PersistentVolumeSpec)
  
  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)
  
  Name of the persistent volume to attach.

VolumeAttachmentStatus

VolumeAttachmentStatus is the status of a VolumeAttachment request.

attached (boolean), required

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)

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.

VolumeError captures an error encountered during a volume operation.
- attachError.message (string)
  
  String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
- attachError.time (Time)
  
  Time the error was encountered.
  
  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)

Upon successful attach, this field is populated with any information returned by the attach operation 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)

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.

VolumeError captures an error encountered during a volume operation.
- detachError.message (string)
  
  String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
- detachError.time (Time)
  
  Time the error was encountered.
  
  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 is a collection of VolumeAttachment objects.

apiVersion: storage.k8s.io/v1
kind: VolumeAttachmentList
metadata (ListMeta)

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]VolumeAttachment), required

Items is the list of VolumeAttachments

Operations

`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

pretty

Response

200 (VolumeAttachment): 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

pretty

Response

200 (VolumeAttachment): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (VolumeAttachmentList): OK

401: Unauthorized

`create` create a VolumeAttachment

HTTP Request

POST /apis/storage.k8s.io/v1/volumeattachments

Parameters

body: VolumeAttachment, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (VolumeAttachment): OK

201 (VolumeAttachment): Created

202 (VolumeAttachment): 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: VolumeAttachment, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (VolumeAttachment): OK

201 (VolumeAttachment): 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: VolumeAttachment, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (VolumeAttachment): OK

201 (VolumeAttachment): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (VolumeAttachment): OK

201 (VolumeAttachment): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (VolumeAttachment): OK

201 (VolumeAttachment): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (VolumeAttachment): OK

202 (VolumeAttachment): Accepted

401: Unauthorized

`deletecollection` delete collection of VolumeAttachment

HTTP Request

DELETE /apis/storage.k8s.io/v1/volumeattachments

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

3.8 - CSIDriver

CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster.

apiVersion: storage.k8s.io/v1

import "k8s.io/api/storage/v1"

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.

apiVersion: storage.k8s.io/v1
kind: CSIDriver
metadata (ObjectMeta)

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 (CSIDriverSpec), required

Specification of the CSI Driver.

CSIDriverSpec

CSIDriverSpec is the specification of a CSIDriver.

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)

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 is beta, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate.

This field is immutable.

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)

If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. 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 VolumeConext 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 is immutable.
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.
storageCapacity (boolean)

If set to true, 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.

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 is immutable.

This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.
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.

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 is a collection of CSIDriver objects.

apiVersion: storage.k8s.io/v1
kind: CSIDriverList
metadata (ListMeta)

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]CSIDriver), required

items is the list of CSIDriver

Operations

`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

pretty

Response

200 (CSIDriver): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (CSIDriverList): OK

401: Unauthorized

`create` create a CSIDriver

HTTP Request

POST /apis/storage.k8s.io/v1/csidrivers

Parameters

body: CSIDriver, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (CSIDriver): OK

201 (CSIDriver): Created

202 (CSIDriver): 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: CSIDriver, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (CSIDriver): OK

201 (CSIDriver): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (CSIDriver): OK

201 (CSIDriver): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (CSIDriver): OK

202 (CSIDriver): Accepted

401: Unauthorized

`deletecollection` delete collection of CSIDriver

HTTP Request

DELETE /apis/storage.k8s.io/v1/csidrivers

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

3.9 - CSINode

CSINode holds information about all CSI drivers installed on a node.

apiVersion: storage.k8s.io/v1

import "k8s.io/api/storage/v1"

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.

apiVersion: storage.k8s.io/v1
kind: CSINode
metadata (ObjectMeta)

metadata.name must be the Kubernetes node name.
spec (CSINodeSpec), required

spec is the specification of CSINode

CSINodeSpec

CSINodeSpec holds information about the specification of all CSI drivers installed on a node

drivers ([]CSINodeDriver), required

Patch strategy: merge on key name

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.

CSINodeDriver holds information about the specification of one CSI driver installed on a node
- drivers.name (string), required
  
  This is 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.
  
  VolumeNodeResources is a set of resource limits for scheduling of volumes.
  - drivers.allocatable.count (int32)
    
    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)
  
  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 is a collection of CSINode objects.

apiVersion: storage.k8s.io/v1
kind: CSINodeList
metadata (ListMeta)

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]CSINode), required

items is the list of CSINode

Operations

`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

pretty

Response

200 (CSINode): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (CSINodeList): OK

401: Unauthorized

`create` create a CSINode

HTTP Request

POST /apis/storage.k8s.io/v1/csinodes

Parameters

body: CSINode, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (CSINode): OK

201 (CSINode): Created

202 (CSINode): 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: CSINode, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (CSINode): OK

201 (CSINode): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (CSINode): OK

201 (CSINode): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (CSINode): OK

202 (CSINode): Accepted

401: Unauthorized

`deletecollection` delete collection of CSINode

HTTP Request

DELETE /apis/storage.k8s.io/v1/csinodes

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

3.10 - CSIStorageCapacity v1beta1

CSIStorageCapacity stores the result of one CSI GetCapacity call.

apiVersion: storage.k8s.io/v1beta1

import "k8s.io/api/storage/v1beta1"

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 if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.

apiVersion: storage.k8s.io/v1beta1
kind: CSIStorageCapacity
metadata (ObjectMeta)

Standard object's metadata. The name has no particular meaning. It must be 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

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 (Quantity)

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 and treated like zero capacity.
maximumVolumeSize (Quantity)

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 (LabelSelector)

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 is a collection of CSIStorageCapacity objects.

apiVersion: storage.k8s.io/v1beta1
kind: CSIStorageCapacityList
metadata (ListMeta)

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]CSIStorageCapacity), required

Map: unique values on key name will be kept during a merge

Items is the list of CSIStorageCapacity objects.

Operations

`get` read the specified CSIStorageCapacity

HTTP Request

GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}

Parameters

name (in path): string, required

name of the CSIStorageCapacity
namespace (in path): string, required

namespace
pretty (in query): string

pretty

Response

200 (CSIStorageCapacity): OK

401: Unauthorized

`list` list or watch objects of kind CSIStorageCapacity

HTTP Request

GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities

Parameters

namespace (in path): string, required

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (CSIStorageCapacityList): OK

401: Unauthorized

`list` list or watch objects of kind CSIStorageCapacity

HTTP Request

GET /apis/storage.k8s.io/v1beta1/csistoragecapacities

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (CSIStorageCapacityList): OK

401: Unauthorized

`create` create a CSIStorageCapacity

HTTP Request

POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities

Parameters

namespace (in path): string, required

namespace
body: CSIStorageCapacity, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (CSIStorageCapacity): OK

201 (CSIStorageCapacity): Created

202 (CSIStorageCapacity): Accepted

401: Unauthorized

`update` replace the specified CSIStorageCapacity

HTTP Request

PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}

Parameters

name (in path): string, required

name of the CSIStorageCapacity
namespace (in path): string, required

namespace
body: CSIStorageCapacity, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (CSIStorageCapacity): OK

201 (CSIStorageCapacity): Created

401: Unauthorized

`patch` partially update the specified CSIStorageCapacity

HTTP Request

PATCH /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}

Parameters

name (in path): string, required

name of the CSIStorageCapacity
namespace (in path): string, required

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (CSIStorageCapacity): OK

201 (CSIStorageCapacity): Created

401: Unauthorized

`delete` delete a CSIStorageCapacity

HTTP Request

DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}

Parameters

name (in path): string, required

name of the CSIStorageCapacity
namespace (in path): string, required

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of CSIStorageCapacity

HTTP Request

DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

4 - Authentication Resources

4.1 - 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.

apiVersion: v1

import "k8s.io/api/core/v1"

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

apiVersion: v1
kind: ServiceAccount
metadata (ObjectMeta)

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 ([]LocalObjectReference)

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 ([]ObjectReference)

Patch strategy: merge on key name

Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret

ServiceAccountList

ServiceAccountList is a list of ServiceAccount objects

apiVersion: v1
kind: ServiceAccountList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]ServiceAccount), required

List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (ServiceAccount): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ServiceAccountList): OK

401: Unauthorized

`list` list or watch objects of kind ServiceAccount

HTTP Request

GET /api/v1/serviceaccounts

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ServiceAccountList): OK

401: Unauthorized

`create` create a ServiceAccount

HTTP Request

POST /api/v1/namespaces/{namespace}/serviceaccounts

Parameters

namespace (in path): string, required

namespace
body: ServiceAccount, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ServiceAccount): OK

201 (ServiceAccount): Created

202 (ServiceAccount): 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

namespace
body: ServiceAccount, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ServiceAccount): OK

201 (ServiceAccount): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (ServiceAccount): OK

201 (ServiceAccount): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (ServiceAccount): OK

202 (ServiceAccount): Accepted

401: Unauthorized

`deletecollection` delete collection of ServiceAccount

HTTP Request

DELETE /api/v1/namespaces/{namespace}/serviceaccounts

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

4.2 - TokenRequest

TokenRequest requests a token for a given service account.

apiVersion: authentication.k8s.io/v1

import "k8s.io/api/authentication/v1"

TokenRequest

TokenRequest requests a token for a given service account.

apiVersion: authentication.k8s.io/v1
kind: TokenRequest
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (TokenRequestSpec), required

Spec holds information about the request being evaluated
status (TokenRequestStatus)

Status is filled in by the server and indicates whether the token can be authenticated.

TokenRequestSpec

TokenRequestSpec contains client provided parameters of a token request.

audiences ([]string), required

Audiences are the intendend audiences of the token. A recipient of a token must identitfy 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.

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 is the result of a token request.

expirationTimestamp (Time), required

ExpirationTimestamp is the time of expiration of the returned token.

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

`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

namespace
body: TokenRequest, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (TokenRequest): OK

201 (TokenRequest): Created

202 (TokenRequest): Accepted

401: Unauthorized

4.3 - TokenReview

TokenReview attempts to authenticate a token to a known user.

apiVersion: authentication.k8s.io/v1

import "k8s.io/api/authentication/v1"

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.

apiVersion: authentication.k8s.io/v1
kind: TokenReview
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (TokenReviewSpec), required

Spec holds information about the request being evaluated
status (TokenReviewStatus)

Status is filled in by the server and indicates whether the request can be authenticated.

TokenReviewSpec

TokenReviewSpec is a description of the token authentication request.

audiences ([]string)

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 is the result of the token authentication request.

audiences ([]string)

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.

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)
  
  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

`create` create a TokenReview

HTTP Request

POST /apis/authentication.k8s.io/v1/tokenreviews

Parameters

body: TokenReview, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (TokenReview): OK

201 (TokenReview): Created

202 (TokenReview): Accepted

401: Unauthorized

4.4 - CertificateSigningRequest

CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued.

apiVersion: certificates.k8s.io/v1

import "k8s.io/api/certificates/v1"

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:

client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client-kubelet" signerName).
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.

apiVersion: certificates.k8s.io/v1
kind: CertificateSigningRequest
metadata (ObjectMeta)
spec (CertificateSigningRequestSpec), 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 (CertificateSigningRequestStatus)

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 contains the certificate request.

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.

As of v1.22, this field is beta and is controlled via the CSRDuration feature gate.
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 contains conditions used to indicate approved/denied/failed status of the request, and the issued certificate.

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".

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.
  
  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
  
  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 is a collection of CertificateSigningRequest objects

apiVersion: certificates.k8s.io/v1
kind: CertificateSigningRequestList
metadata (ListMeta)
items ([]CertificateSigningRequest), required

items is a collection of CertificateSigningRequest objects

Operations

`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

pretty

Response

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

pretty

Response

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

pretty

Response

401: Unauthorized

`list` list or watch objects of kind CertificateSigningRequest

HTTP Request

GET /apis/certificates.k8s.io/v1/certificatesigningrequests

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (CertificateSigningRequestList): OK

401: Unauthorized

`create` create a CertificateSigningRequest

HTTP Request

POST /apis/certificates.k8s.io/v1/certificatesigningrequests

Parameters

body: CertificateSigningRequest, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (CertificateSigningRequest): Created

202 (CertificateSigningRequest): 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: CertificateSigningRequest, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (CertificateSigningRequest): 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: CertificateSigningRequest, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (CertificateSigningRequest): 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: CertificateSigningRequest, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (CertificateSigningRequest): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

201 (CertificateSigningRequest): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

201 (CertificateSigningRequest): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

201 (CertificateSigningRequest): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of CertificateSigningRequest

HTTP Request

DELETE /apis/certificates.k8s.io/v1/certificatesigningrequests

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

5 - Authorization Resources

5.1 - LocalSubjectAccessReview

LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace.

apiVersion: authorization.k8s.io/v1

import "k8s.io/api/authorization/v1"

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.

apiVersion: authorization.k8s.io/v1
kind: LocalSubjectAccessReview
metadata (ObjectMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (SubjectAccessReviewSpec), 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 (SubjectAccessReviewStatus)

Status is filled in by the server and indicates whether the request is allowed or not

Operations

`create` create a LocalSubjectAccessReview

HTTP Request

POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews

Parameters

namespace (in path): string, required

namespace
body: LocalSubjectAccessReview, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (LocalSubjectAccessReview): OK

201 (LocalSubjectAccessReview): Created

202 (LocalSubjectAccessReview): Accepted

401: Unauthorized

5.2 - SelfSubjectAccessReview

SelfSubjectAccessReview checks whether or the current user can perform an action.

apiVersion: authorization.k8s.io/v1

import "k8s.io/api/authorization/v1"

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

apiVersion: authorization.k8s.io/v1
kind: SelfSubjectAccessReview
metadata (ObjectMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (SelfSubjectAccessReviewSpec), required

Spec holds information about the request being evaluated. user and groups must be empty
status (SubjectAccessReviewStatus)

Status is filled in by the server and indicates whether the request is allowed or not

SelfSubjectAccessReviewSpec

SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

nonResourceAttributes (NonResourceAttributes)

NonResourceAttributes describes information for a non-resource access request

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

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
- resourceAttributes.group (string)
  
  Group is the API Group of the Resource. "*" means all.
- 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

`create` create a SelfSubjectAccessReview

HTTP Request

POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews

Parameters

body: SelfSubjectAccessReview, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (SelfSubjectAccessReview): OK

201 (SelfSubjectAccessReview): Created

202 (SelfSubjectAccessReview): Accepted

401: Unauthorized

5.3 - SelfSubjectRulesReview

SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace.

apiVersion: authorization.k8s.io/v1

import "k8s.io/api/authorization/v1"

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.

apiVersion: authorization.k8s.io/v1
kind: SelfSubjectRulesReview
metadata (ObjectMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (SelfSubjectRulesReviewSpec), 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.

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
  
  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.
  
  NonResourceRule holds information that describes a rule for the non-resource
  - status.nonResourceRules.verbs ([]string), required
    
    Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
  - status.nonResourceRules.nonResourceURLs ([]string)
    
    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
  
  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.
  
  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
    
    Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
  - status.resourceRules.apiGroups ([]string)
    
    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)
    
    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)
    
    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 defines the specification for SelfSubjectRulesReview.

namespace (string)

Namespace to evaluate rules for. Required.

Operations

`create` create a SelfSubjectRulesReview

HTTP Request

POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews

Parameters

body: SelfSubjectRulesReview, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (SelfSubjectRulesReview): OK

201 (SelfSubjectRulesReview): Created

202 (SelfSubjectRulesReview): Accepted

401: Unauthorized

5.4 - SubjectAccessReview

SubjectAccessReview checks whether or not a user or group can perform an action.

apiVersion: authorization.k8s.io/v1

import "k8s.io/api/authorization/v1"

SubjectAccessReview

SubjectAccessReview checks whether or not a user or group can perform an action.

apiVersion: authorization.k8s.io/v1
kind: SubjectAccessReview
metadata (ObjectMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (SubjectAccessReviewSpec), required

Spec holds information about the request being evaluated
status (SubjectAccessReviewStatus)

Status is filled in by the server and indicates whether the request is allowed or not

SubjectAccessReviewSpec

SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

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)

Groups is the groups you're testing for.
nonResourceAttributes (NonResourceAttributes)

NonResourceAttributes describes information for a non-resource access request

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

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
- resourceAttributes.group (string)
  
  Group is the API Group of the Resource. "*" means all.
- 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

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

`create` create a SubjectAccessReview

HTTP Request

POST /apis/authorization.k8s.io/v1/subjectaccessreviews

Parameters

body: SubjectAccessReview, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (SubjectAccessReview): OK

201 (SubjectAccessReview): Created

202 (SubjectAccessReview): Accepted

401: Unauthorized

5.5 - ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

apiVersion: rbac.authorization.k8s.io/v1

import "k8s.io/api/rbac/v1"

ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata (ObjectMeta)

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.

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
- aggregationRule.clusterRoleSelectors ([]LabelSelector)
  
  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)

Rules holds all the PolicyRules for this ClusterRole

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)
  
  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.
- rules.resources ([]string)
  
  Resources is a list of resources this rule applies to. '*' represents all resources.
- rules.verbs ([]string), required
  
  Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs.
- rules.resourceNames ([]string)
  
  ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- rules.nonResourceURLs ([]string)
  
  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 is a collection of ClusterRoles

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleList
metadata (ListMeta)

Standard object's metadata.
items ([]ClusterRole), required

Items is a list of ClusterRoles

Operations

`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

pretty

Response

200 (ClusterRole): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ClusterRoleList): OK

401: Unauthorized

`create` create a ClusterRole

HTTP Request

POST /apis/rbac.authorization.k8s.io/v1/clusterroles

Parameters

body: ClusterRole, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ClusterRole): OK

201 (ClusterRole): Created

202 (ClusterRole): 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: ClusterRole, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ClusterRole): OK

201 (ClusterRole): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (ClusterRole): OK

201 (ClusterRole): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of ClusterRole

HTTP Request

DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

5.6 - ClusterRoleBinding

ClusterRoleBinding references a ClusterRole, but not contain it.

apiVersion: rbac.authorization.k8s.io/v1

import "k8s.io/api/rbac/v1"

ClusterRoleBinding

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata (ObjectMeta)

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.

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)

Subjects holds references to the objects the role applies to.

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 is a collection of ClusterRoleBindings

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBindingList
metadata (ListMeta)

Standard object's metadata.
items ([]ClusterRoleBinding), required

Items is a list of ClusterRoleBindings

Operations

`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

pretty

Response

200 (ClusterRoleBinding): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ClusterRoleBindingList): OK

401: Unauthorized

`create` create a ClusterRoleBinding

HTTP Request

POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

Parameters

body: ClusterRoleBinding, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ClusterRoleBinding): OK

201 (ClusterRoleBinding): Created

202 (ClusterRoleBinding): 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: ClusterRoleBinding, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ClusterRoleBinding): OK

201 (ClusterRoleBinding): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (ClusterRoleBinding): OK

201 (ClusterRoleBinding): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of ClusterRoleBinding

HTTP Request

DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

5.7 - Role

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

apiVersion: rbac.authorization.k8s.io/v1

import "k8s.io/api/rbac/v1"

Role

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata (ObjectMeta)

Standard object's metadata.
rules ([]PolicyRule)

Rules holds all the PolicyRules for this Role

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)
  
  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.
- rules.resources ([]string)
  
  Resources is a list of resources this rule applies to. '*' represents all resources.
- rules.verbs ([]string), required
  
  Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs.
- rules.resourceNames ([]string)
  
  ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- rules.nonResourceURLs ([]string)
  
  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 is a collection of Roles

apiVersion: rbac.authorization.k8s.io/v1
kind: RoleList
metadata (ListMeta)

Standard object's metadata.
items ([]Role), required

Items is a list of Roles

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (Role): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (RoleList): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (RoleList): 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

namespace
body: Role, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Role): OK

201 (Role): Created

202 (Role): 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

namespace
body: Role, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Role): OK

201 (Role): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Role): OK

201 (Role): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): 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

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

5.8 - RoleBinding

RoleBinding references a role, but does not contain it.

apiVersion: rbac.authorization.k8s.io/v1

import "k8s.io/api/rbac/v1"

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.

apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata (ObjectMeta)

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.

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)

Subjects holds references to the objects the role applies to.

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 is a collection of RoleBindings

apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBindingList
metadata (ListMeta)

Standard object's metadata.
items ([]RoleBinding), required

Items is a list of RoleBindings

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (RoleBinding): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (RoleBindingList): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (RoleBindingList): 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

namespace
body: RoleBinding, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (RoleBinding): OK

201 (RoleBinding): Created

202 (RoleBinding): 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

namespace
body: RoleBinding, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (RoleBinding): OK

201 (RoleBinding): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (RoleBinding): OK

201 (RoleBinding): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): 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

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

6 - Policy Resources

6.1 - LimitRange

LimitRange sets resource usage limits for each kind of resource in a Namespace.

apiVersion: v1

import "k8s.io/api/core/v1"

LimitRange

LimitRange sets resource usage limits for each kind of resource in a Namespace.

apiVersion: v1
kind: LimitRange
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (LimitRangeSpec)

Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

LimitRangeSpec

LimitRangeSpec defines a min/max usage limit for resources that match on kind.

limits ([]LimitRangeItem), required

Limits is the list of LimitRangeItem objects that are enforced.

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]Quantity)
  
  Default resource requirement limit value by resource name if resource limit is omitted.
- limits.defaultRequest (map[string]Quantity)
  
  DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
- limits.max (map[string]Quantity)
  
  Max usage constraints on this kind by resource name.
- limits.maxLimitRequestRatio (map[string]Quantity)
  
  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]Quantity)
  
  Min usage constraints on this kind by resource name.

LimitRangeList

LimitRangeList is a list of LimitRange items.

apiVersion: v1
kind: LimitRangeList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]LimitRange), required

Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (LimitRange): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (LimitRangeList): OK

401: Unauthorized

`list` list or watch objects of kind LimitRange

HTTP Request

GET /api/v1/limitranges

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (LimitRangeList): OK

401: Unauthorized

`create` create a LimitRange

HTTP Request

POST /api/v1/namespaces/{namespace}/limitranges

Parameters

namespace (in path): string, required

namespace
body: LimitRange, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (LimitRange): OK

201 (LimitRange): Created

202 (LimitRange): 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

namespace
body: LimitRange, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (LimitRange): OK

201 (LimitRange): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (LimitRange): OK

201 (LimitRange): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of LimitRange

HTTP Request

DELETE /api/v1/namespaces/{namespace}/limitranges

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

6.2 - ResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace.

apiVersion: v1

import "k8s.io/api/core/v1"

ResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace

apiVersion: v1
kind: ResourceQuota
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (ResourceQuotaSpec)

Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status (ResourceQuotaStatus)

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 defines the desired hard limits to enforce for Quota.

hard (map[string]Quantity)

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 scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.
- scopeSelector.matchExpressions ([]ScopedResourceSelectorRequirement)
  
  A list of scope selector requirements by scope of the resources.
  
  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)
    
    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)

A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.

hard (map[string]Quantity)

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]Quantity)

Used is the current observed total usage of the resource in the namespace.

ResourceQuotaList

ResourceQuotaList is a list of ResourceQuota items.

apiVersion: v1
kind: ResourceQuotaList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]ResourceQuota), required

Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (ResourceQuota): 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

namespace
pretty (in query): string

pretty

Response

200 (ResourceQuota): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ResourceQuotaList): OK

401: Unauthorized

`list` list or watch objects of kind ResourceQuota

HTTP Request

GET /api/v1/resourcequotas

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ResourceQuotaList): OK

401: Unauthorized

`create` create a ResourceQuota

HTTP Request

POST /api/v1/namespaces/{namespace}/resourcequotas

Parameters

namespace (in path): string, required

namespace
body: ResourceQuota, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ResourceQuota): OK

201 (ResourceQuota): Created

202 (ResourceQuota): 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

namespace
body: ResourceQuota, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ResourceQuota): OK

201 (ResourceQuota): 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

namespace
body: ResourceQuota, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (ResourceQuota): OK

201 (ResourceQuota): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (ResourceQuota): OK

201 (ResourceQuota): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (ResourceQuota): OK

201 (ResourceQuota): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (ResourceQuota): OK

202 (ResourceQuota): Accepted

401: Unauthorized

`deletecollection` delete collection of ResourceQuota

HTTP Request

DELETE /api/v1/namespaces/{namespace}/resourcequotas

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

6.3 - NetworkPolicy

NetworkPolicy describes what network traffic is allowed for a set of Pods.

apiVersion: networking.k8s.io/v1

import "k8s.io/api/networking/v1"

NetworkPolicy

NetworkPolicy describes what network traffic is allowed for a set of Pods

apiVersion: networking.k8s.io/v1
kind: NetworkPolicy
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (NetworkPolicySpec)

Specification of the desired behavior for this NetworkPolicy.

NetworkPolicySpec

NetworkPolicySpec provides the specification of a NetworkPolicy

podSelector (LabelSelector), required

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)

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)

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)

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)
  
  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.
  
  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.
    
    IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/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 IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
    - ingress.from.ipBlock.except ([]string)
      
      Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
  - ingress.from.namespaceSelector (LabelSelector)
    
    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 (LabelSelector)
    
    This 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)
  
  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.
  
  NetworkPolicyPort describes a port to allow traffic on
  - ingress.ports.port (IntOrString)
    
    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.
    
    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)
    
    If set, indicates that the range of ports from port to endPort, 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. This feature is in Beta state and is enabled by default. It can be disabled using the Feature Gate "NetworkPolicyEndPort".
  - ingress.ports.protocol (string)
    
    The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
egress ([]NetworkPolicyEgressRule)

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

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)
  
  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.
  
  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.
    
    IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/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 IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
    - egress.to.ipBlock.except ([]string)
      
      Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
  - egress.to.namespaceSelector (LabelSelector)
    
    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 (LabelSelector)
    
    This 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)
  
  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.
  
  NetworkPolicyPort describes a port to allow traffic on
  - egress.ports.port (IntOrString)
    
    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.
    
    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)
    
    If set, indicates that the range of ports from port to endPort, 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. This feature is in Beta state and is enabled by default. It can be disabled using the Feature Gate "NetworkPolicyEndPort".
  - egress.ports.protocol (string)
    
    The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.

NetworkPolicyList

NetworkPolicyList is a list of NetworkPolicy objects.

apiVersion: networking.k8s.io/v1
kind: NetworkPolicyList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]NetworkPolicy), required

Items is a list of schema objects.

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (NetworkPolicy): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (NetworkPolicyList): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (NetworkPolicyList): OK

401: Unauthorized

`create` create a NetworkPolicy

HTTP Request

POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies

Parameters

namespace (in path): string, required

namespace
body: NetworkPolicy, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (NetworkPolicy): OK

201 (NetworkPolicy): Created

202 (NetworkPolicy): 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

namespace
body: NetworkPolicy, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (NetworkPolicy): OK

201 (NetworkPolicy): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (NetworkPolicy): OK

201 (NetworkPolicy): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): 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

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

6.4 - PodDisruptionBudget

PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods.

apiVersion: policy/v1

import "k8s.io/api/policy/v1"

PodDisruptionBudget

PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

apiVersion: policy/v1
kind: PodDisruptionBudget
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (PodDisruptionBudgetSpec)

Specification of the desired behavior of the PodDisruptionBudget.
status (PodDisruptionBudgetStatus)

Most recently observed status of the PodDisruptionBudget.

PodDisruptionBudgetSpec

PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.

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".

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%".

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 (LabelSelector)

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.

PodDisruptionBudgetStatus

PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.

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.
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.
  
  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.

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 is a collection of PodDisruptionBudgets.

apiVersion: policy/v1
kind: PodDisruptionBudgetList
metadata (ListMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]PodDisruptionBudget), required

Items is a list of PodDisruptionBudgets

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (PodDisruptionBudget): 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

namespace
pretty (in query): string

pretty

Response

200 (PodDisruptionBudget): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (PodDisruptionBudgetList): OK

401: Unauthorized

`list` list or watch objects of kind PodDisruptionBudget

HTTP Request

GET /apis/policy/v1/poddisruptionbudgets

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (PodDisruptionBudgetList): OK

401: Unauthorized

`create` create a PodDisruptionBudget

HTTP Request

POST /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets

Parameters

namespace (in path): string, required

namespace
body: PodDisruptionBudget, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PodDisruptionBudget): OK

201 (PodDisruptionBudget): Created

202 (PodDisruptionBudget): 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

namespace
body: PodDisruptionBudget, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PodDisruptionBudget): OK

201 (PodDisruptionBudget): 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

namespace
body: PodDisruptionBudget, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PodDisruptionBudget): OK

201 (PodDisruptionBudget): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (PodDisruptionBudget): OK

201 (PodDisruptionBudget): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (PodDisruptionBudget): OK

201 (PodDisruptionBudget): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of PodDisruptionBudget

HTTP Request

DELETE /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets

Parameters

namespace (in path): string, required

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

6.5 - PodSecurityPolicy v1beta1

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.

apiVersion: policy/v1beta1

import "k8s.io/api/policy/v1beta1"

PodSecurityPolicy

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. Deprecated in 1.21.

apiVersion: policy/v1beta1
kind: PodSecurityPolicy
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (PodSecurityPolicySpec)

spec defines the policy enforced.

PodSecurityPolicySpec

PodSecurityPolicySpec defines the policy enforced.

runAsUser (RunAsUserStrategyOptions), required

runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.
- runAsUser.rule (string), required
  
  rule is the strategy that will dictate the allowable RunAsUser values that may be set.
- runAsUser.ranges ([]IDRange)
  
  ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs.
  
  IDRange provides a min/max of an allowed range of IDs.
  - runAsUser.ranges.max (int64), required
    
    max is the end of the range, inclusive.
  - runAsUser.ranges.min (int64), required
    
    min is the start of the range, inclusive.
runAsGroup (RunAsGroupStrategyOptions)

RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled.

RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy.
- runAsGroup.rule (string), required
  
  rule is the strategy that will dictate the allowable RunAsGroup values that may be set.
- runAsGroup.ranges ([]IDRange)
  
  ranges are the allowed ranges of gids that may be used. If you would like to force a single gid then supply a single range with the same start and end. Required for MustRunAs.
  
  IDRange provides a min/max of an allowed range of IDs.
  - runAsGroup.ranges.max (int64), required
    
    max is the end of the range, inclusive.
  - runAsGroup.ranges.min (int64), required
    
    min is the start of the range, inclusive.
fsGroup (FSGroupStrategyOptions), required

fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.

FSGroupStrategyOptions defines the strategy type and options used to create the strategy.
- fsGroup.ranges ([]IDRange)
  
  ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs.
  
  IDRange provides a min/max of an allowed range of IDs.
  - fsGroup.ranges.max (int64), required
    
    max is the end of the range, inclusive.
  - fsGroup.ranges.min (int64), required
    
    min is the start of the range, inclusive.
- fsGroup.rule (string)
  
  rule is the strategy that will dictate what FSGroup is used in the SecurityContext.
supplementalGroups (SupplementalGroupsStrategyOptions), required

supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.
- supplementalGroups.ranges ([]IDRange)
  
  ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs.
  
  IDRange provides a min/max of an allowed range of IDs.
  - supplementalGroups.ranges.max (int64), required
    
    max is the end of the range, inclusive.
  - supplementalGroups.ranges.min (int64), required
    
    min is the start of the range, inclusive.
- supplementalGroups.rule (string)
  
  rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
seLinux (SELinuxStrategyOptions), required

seLinux is the strategy that will dictate the allowable labels that may be set.

SELinuxStrategyOptions defines the strategy type and any options used to create the strategy.
- seLinux.rule (string), required
  
  rule is the strategy that will dictate the allowable labels that may be set.
- seLinux.seLinuxOptions (SELinuxOptions)
  
  seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
  
  SELinuxOptions are the labels to be applied to the container
  - seLinux.seLinuxOptions.level (string)
    
    Level is SELinux level label that applies to the container.
  - seLinux.seLinuxOptions.role (string)
    
    Role is a SELinux role label that applies to the container.
  - seLinux.seLinuxOptions.type (string)
    
    Type is a SELinux type label that applies to the container.
  - seLinux.seLinuxOptions.user (string)
    
    User is a SELinux user label that applies to the container.
readOnlyRootFilesystem (boolean)

readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
privileged (boolean)

privileged determines if a pod can request to be run as privileged.
allowPrivilegeEscalation (boolean)

allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
defaultAllowPrivilegeEscalation (boolean)

defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
allowedCSIDrivers ([]AllowedCSIDriver)

AllowedCSIDrivers is an allowlist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. An empty value indicates that any CSI driver can be used for inline ephemeral volumes. This is a beta field, and is only honored if the API server enables the CSIInlineVolume feature gate.

AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used.
- allowedCSIDrivers.name (string), required
  
  Name is the registered name of the CSI driver
allowedCapabilities ([]string)

allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities.
requiredDropCapabilities ([]string)

requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
defaultAddCapabilities ([]string)

defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list.
allowedFlexVolumes ([]AllowedFlexVolume)

allowedFlexVolumes is an allowlist of Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field.

AllowedFlexVolume represents a single Flexvolume that is allowed to be used.
- allowedFlexVolumes.driver (string), required
  
  driver is the name of the Flexvolume driver.
allowedHostPaths ([]AllowedHostPath)

allowedHostPaths is an allowlist of host paths. Empty indicates that all host paths may be used.

AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.
- allowedHostPaths.pathPrefix (string)
  
  pathPrefix is the path prefix that the host volume must match. It does not support *. Trailing slashes are trimmed when validating the path prefix with a host path.
  
  Examples: /foo would allow /foo, /foo/ and /foo/bar /foo would not allow /food or /etc/foo
- allowedHostPaths.readOnly (boolean)
  
  when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.
allowedProcMountTypes ([]string)

AllowedProcMountTypes is an allowlist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled.
allowedUnsafeSysctls ([]string)

allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to allowlist all allowed unsafe sysctls explicitly to avoid rejection.

Examples: e.g. "foo/" allows "foo/bar", "foo/baz", etc. e.g. "foo." allows "foo.bar", "foo.baz", etc.
forbiddenSysctls ([]string)

forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden.

Examples: e.g. "foo/" forbids "foo/bar", "foo/baz", etc. e.g. "foo." forbids "foo.bar", "foo.baz", etc.
hostIPC (boolean)

hostIPC determines if the policy allows the use of HostIPC in the pod spec.
hostNetwork (boolean)

hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
hostPID (boolean)

hostPID determines if the policy allows the use of HostPID in the pod spec.
hostPorts ([]HostPortRange)

hostPorts determines which host port ranges are allowed to be exposed.

HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined.
- hostPorts.max (int32), required
  
  max is the end of the range, inclusive.
- hostPorts.min (int32), required
  
  min is the start of the range, inclusive.
runtimeClass (RuntimeClassStrategyOptions)

runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod. If this field is omitted, the pod's runtimeClassName field is unrestricted. Enforcement of this field depends on the RuntimeClass feature gate being enabled.

RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod.
- runtimeClass.allowedRuntimeClassNames ([]string), required
  
  allowedRuntimeClassNames is an allowlist of RuntimeClass names that may be specified on a pod. A value of "*" means that any RuntimeClass name is allowed, and must be the only item in the list. An empty list requires the RuntimeClassName field to be unset.
- runtimeClass.defaultRuntimeClassName (string)
  
  defaultRuntimeClassName is the default RuntimeClassName to set on the pod. The default MUST be allowed by the allowedRuntimeClassNames list. A value of nil does not mutate the Pod.
volumes ([]string)

volumes is an allowlist of volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '*'.

PodSecurityPolicyList

PodSecurityPolicyList is a list of PodSecurityPolicy objects.

apiVersion: policy/v1beta1
kind: PodSecurityPolicyList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]PodSecurityPolicy), required

items is a list of schema objects.

Operations

`get` read the specified PodSecurityPolicy

HTTP Request

GET /apis/policy/v1beta1/podsecuritypolicies/{name}

Parameters

name (in path): string, required

name of the PodSecurityPolicy
pretty (in query): string

pretty

Response

200 (PodSecurityPolicy): OK

401: Unauthorized

`list` list or watch objects of kind PodSecurityPolicy

HTTP Request

GET /apis/policy/v1beta1/podsecuritypolicies

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (PodSecurityPolicyList): OK

401: Unauthorized

`create` create a PodSecurityPolicy

HTTP Request

POST /apis/policy/v1beta1/podsecuritypolicies

Parameters

body: PodSecurityPolicy, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PodSecurityPolicy): OK

201 (PodSecurityPolicy): Created

202 (PodSecurityPolicy): Accepted

401: Unauthorized

`update` replace the specified PodSecurityPolicy

HTTP Request

PUT /apis/policy/v1beta1/podsecuritypolicies/{name}

Parameters

name (in path): string, required

name of the PodSecurityPolicy
body: PodSecurityPolicy, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (PodSecurityPolicy): OK

201 (PodSecurityPolicy): Created

401: Unauthorized

`patch` partially update the specified PodSecurityPolicy

HTTP Request

PATCH /apis/policy/v1beta1/podsecuritypolicies/{name}

Parameters

name (in path): string, required

name of the PodSecurityPolicy
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (PodSecurityPolicy): OK

201 (PodSecurityPolicy): Created

401: Unauthorized

`delete` delete a PodSecurityPolicy

HTTP Request

DELETE /apis/policy/v1beta1/podsecuritypolicies/{name}

Parameters

name (in path): string, required

name of the PodSecurityPolicy
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (PodSecurityPolicy): OK

202 (PodSecurityPolicy): Accepted

401: Unauthorized

`deletecollection` delete collection of PodSecurityPolicy

HTTP Request

DELETE /apis/policy/v1beta1/podsecuritypolicies

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

7 - Extend Resources

7.1 - CustomResourceDefinition

CustomResourceDefinition represents a resource that should be exposed on the API server.

apiVersion: apiextensions.k8s.io/v1

import "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"

CustomResourceDefinition

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata (ObjectMeta)

Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (CustomResourceDefinitionSpec), required

spec describes how the user wants the resources to appear
status (CustomResourceDefinitionStatus)

status indicates the actual state of the CustomResourceDefinition

CustomResourceDefinitionSpec

CustomResourceDefinitionSpec describes how a user wants their resource to appear

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.

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)
  
  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 "kindList".
- names.shortNames ([]string)
  
  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

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.

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)
  
  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.
  
  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.
  
  CustomResourceValidation is a list of validation methods for CustomResources.
  - versions.schema.openAPIV3Schema (JSONSchemaProps)
    
    openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
- versions.subresources (CustomResourceSubresources)
  
  subresources specify what subresources this version of the defined custom resource have.
  
  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.
    
    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.
    
    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.

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.
  
  WebhookConversion describes how to call a conversion webhook
  - conversion.webhook.conversionReviewVersions ([]string), required
    
    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.
    
    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.
      
      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/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.

JSONSchemaProps

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

$ref (string)
$schema (string)
additionalItems (JSONSchemaPropsOrBool)

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.
additionalProperties (JSONSchemaPropsOrBool)

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.
allOf ([]JSONSchemaProps)
anyOf ([]JSONSchemaProps)
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.

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
definitions (map[string]JSONSchemaProps)
dependencies (map[string]JSONSchemaPropsOrStringArray)

JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.
description (string)
enum ([]JSON)

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
example (JSON)

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)

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)

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 (JSONSchemaProps)
nullable (boolean)
oneOf ([]JSONSchemaProps)
pattern (string)
patternProperties (map[string]JSONSchemaProps)
properties (map[string]JSONSchemaProps)
required ([]string)
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)

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.

CustomResourceDefinitionStatus

CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

acceptedNames (CustomResourceDefinitionNames)

acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.

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)
  
  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 "kindList".
- acceptedNames.shortNames ([]string)
  
  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

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.
  
  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)

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 is a list of CustomResourceDefinition objects.

items ([]CustomResourceDefinition), 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 (ListMeta)

Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Operations

`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

pretty

Response

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

pretty

Response

401: Unauthorized

`list` list or watch objects of kind CustomResourceDefinition

HTTP Request

GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (CustomResourceDefinitionList): OK

401: Unauthorized

`create` create a CustomResourceDefinition

HTTP Request

POST /apis/apiextensions.k8s.io/v1/customresourcedefinitions

Parameters

body: CustomResourceDefinition, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (CustomResourceDefinition): Created

202 (CustomResourceDefinition): 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: CustomResourceDefinition, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (CustomResourceDefinition): 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: CustomResourceDefinition, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (CustomResourceDefinition): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

201 (CustomResourceDefinition): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

201 (CustomResourceDefinition): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of CustomResourceDefinition

HTTP Request

DELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

7.2 - MutatingWebhookConfiguration

MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.

apiVersion: admissionregistration.k8s.io/v1

import "k8s.io/api/admissionregistration/v1"

MutatingWebhookConfiguration

MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.

apiVersion: admissionregistration.k8s.io/v1
kind: MutatingWebhookConfiguration
metadata (ObjectMeta)

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

Webhooks is a list of webhooks and the affected resources and operations.

MutatingWebhook describes an admission webhook and the resources and operations it applies to.
- webhooks.admissionReviewVersions ([]string), required
  
  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
  
  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.
    
    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.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 (LabelSelector)
  
  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 (LabelSelector)
  
  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)
  
  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.
  
  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)
    
    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)
    
    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)
    
    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)
    
    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 is a list of MutatingWebhookConfiguration.

apiVersion: admissionregistration.k8s.io/v1
kind: MutatingWebhookConfigurationList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]MutatingWebhookConfiguration), required

List of MutatingWebhookConfiguration.

Operations

`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

pretty

Response

401: Unauthorized

`list` list or watch objects of kind MutatingWebhookConfiguration

HTTP Request

GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (MutatingWebhookConfigurationList): OK

401: Unauthorized

`create` create a MutatingWebhookConfiguration

HTTP Request

POST /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations

Parameters

body: MutatingWebhookConfiguration, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (MutatingWebhookConfiguration): Created

202 (MutatingWebhookConfiguration): 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: MutatingWebhookConfiguration, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (MutatingWebhookConfiguration): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

201 (MutatingWebhookConfiguration): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of MutatingWebhookConfiguration

HTTP Request

DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

7.3 - ValidatingWebhookConfiguration

ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.

apiVersion: admissionregistration.k8s.io/v1

import "k8s.io/api/admissionregistration/v1"

ValidatingWebhookConfiguration

ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.

apiVersion: admissionregistration.k8s.io/v1
kind: ValidatingWebhookConfiguration
metadata (ObjectMeta)

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

Webhooks is a list of webhooks and the affected resources and operations.

ValidatingWebhook describes an admission webhook and the resources and operations it applies to.
- webhooks.admissionReviewVersions ([]string), required
  
  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
  
  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.
    
    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.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 (LabelSelector)
  
  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 (LabelSelector)
  
  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)
  
  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.
  
  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)
    
    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)
    
    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)
    
    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)
    
    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 is a list of ValidatingWebhookConfiguration.

apiVersion: admissionregistration.k8s.io/v1
kind: ValidatingWebhookConfigurationList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]ValidatingWebhookConfiguration), required

List of ValidatingWebhookConfiguration.

Operations

`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

pretty

Response

401: Unauthorized

`list` list or watch objects of kind ValidatingWebhookConfiguration

HTTP Request

GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (ValidatingWebhookConfigurationList): OK

401: Unauthorized

`create` create a ValidatingWebhookConfiguration

HTTP Request

POST /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations

Parameters

body: ValidatingWebhookConfiguration, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (ValidatingWebhookConfiguration): Created

202 (ValidatingWebhookConfiguration): 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: ValidatingWebhookConfiguration, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (ValidatingWebhookConfiguration): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

201 (ValidatingWebhookConfiguration): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of ValidatingWebhookConfiguration

HTTP Request

DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

8 - Cluster Resources

8.1 - Node

Node is a worker node in Kubernetes.

apiVersion: v1

import "k8s.io/api/core/v1"

Node

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

apiVersion: v1
kind: Node
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (NodeSpec)

Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status (NodeStatus)

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 describes the attributes that a node is created with.

configSource (NodeConfigSource)

Deprecated. If specified, the source of the node's configuration. The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field. This field is deprecated as of 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

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
  
  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)

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)

If specified, the node's taints.

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.
  
  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 is information about the current status of a node.

addresses ([]NodeAddress)

Patch strategy: merge on key type

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 http://pr.k8s.io/79391 for an example.

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]Quantity)

Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
capacity (map[string]Quantity)

Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
conditions ([]NodeCondition)

Patch strategy: merge on key type

Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition

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.
  
  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.
  
  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.

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.
  
  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
    
    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.
  
  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
    
    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.
  
  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
    
    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.

NodeDaemonEndpoints lists ports opened by daemons running on the Node.
- daemonEndpoints.kubeletEndpoint (DaemonEndpoint)
  
  Endpoint on which Kubelet is listening.
  
  DaemonEndpoint contains information about a single Daemon endpoint.
  - daemonEndpoints.kubeletEndpoint.Port (int32), required
    
    Port number of the given endpoint.
images ([]ContainerImage)

List of container images on this node

Describe a container image
- images.names ([]string)
  
  Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/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

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. docker://1.5.0).
- 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
  
  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.
volumesAttached ([]AttachedVolume)

List of volumes that are attached to the node.

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)

List of attachable volumes in use (mounted) by the node.

NodeList

NodeList is the whole list of all Nodes which have been registered with master.

apiVersion: v1
kind: NodeList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]Node), required

List of nodes

Operations

`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

pretty

Response

200 (Node): 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

pretty

Response

200 (Node): OK

401: Unauthorized

`list` list or watch objects of kind Node

HTTP Request

GET /api/v1/nodes

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (NodeList): OK

401: Unauthorized

`create` create a Node

HTTP Request

POST /api/v1/nodes

Parameters

body: Node, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Node): OK

201 (Node): Created

202 (Node): 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: Node, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Node): OK

201 (Node): 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: Node, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Node): OK

201 (Node): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Node): OK

201 (Node): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Node): OK

201 (Node): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of Node

HTTP Request

DELETE /api/v1/nodes

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

8.2 - Namespace

Namespace provides a scope for Names.

apiVersion: v1

import "k8s.io/api/core/v1"

Namespace

Namespace provides a scope for Names. Use of multiple namespaces is optional.

apiVersion: v1
kind: Namespace
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (NamespaceSpec)

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 (NamespaceStatus)

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 describes the attributes on a Namespace.

finalizers ([]string)

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 is information about the current status of a Namespace.

conditions ([]NamespaceCondition)

Patch strategy: merge on key type

Represents the latest available observations of a namespace's current state.

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)
  
  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 is a list of Namespaces.

apiVersion: v1
kind: NamespaceList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]Namespace), required

Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

Operations

`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

pretty

Response

200 (Namespace): 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

pretty

Response

200 (Namespace): OK

401: Unauthorized

`list` list or watch objects of kind Namespace

HTTP Request

GET /api/v1/namespaces

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (NamespaceList): OK

401: Unauthorized

`create` create a Namespace

HTTP Request

POST /api/v1/namespaces

Parameters

body: Namespace, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Namespace): OK

201 (Namespace): Created

202 (Namespace): 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: Namespace, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Namespace): OK

201 (Namespace): 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: Namespace, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Namespace): OK

201 (Namespace): 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: Namespace, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Namespace): OK

201 (Namespace): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Namespace): OK

201 (Namespace): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Namespace): OK

201 (Namespace): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

8.3 - Event

Event is a report of an event somewhere in the cluster.

apiVersion: events.k8s.io/v1

import "k8s.io/api/events/v1"

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.

apiVersion: events.k8s.io/v1
kind: Event
metadata (ObjectMeta)

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.

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.

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.

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.

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 (ObjectReference)

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 (ObjectReference)

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.

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.
  
  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 is a list of Event objects.

apiVersion: events.k8s.io/v1
kind: EventList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]Event), required

items is a list of schema objects.

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (Event): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (EventList): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (EventList): OK

401: Unauthorized

`create` create an Event

HTTP Request

POST /apis/events.k8s.io/v1/namespaces/{namespace}/events

Parameters

namespace (in path): string, required

namespace
body: Event, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Event): OK

201 (Event): Created

202 (Event): 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

namespace
body: Event, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Event): OK

201 (Event): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Event): OK

201 (Event): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): 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

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

8.4 - APIService

APIService represents a server for a particular GroupVersion.

apiVersion: apiregistration.k8s.io/v1

import "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"

APIService

APIService represents a server for a particular GroupVersion. Name must be "version.group".

apiVersion: apiregistration.k8s.io/v1
kind: APIService
metadata (ObjectMeta)

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (APIServiceSpec)

Spec contains information for locating and communicating with a server
status (APIServiceStatus)

Status contains derived information about an API server

APIServiceSpec

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

groupPriorityMinimum (int32), required

GroupPriorityMininum 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 GroupPriorityMininum 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.

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 contains derived information about an API server

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.

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.
  
  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 is a list of APIService objects.

apiVersion: apiregistration.k8s.io/v1
kind: APIServiceList
metadata (ListMeta)

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]APIService), required

Items is the list of APIService

Operations

`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

pretty

Response

200 (APIService): 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

pretty

Response

200 (APIService): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (APIServiceList): OK

401: Unauthorized

`create` create an APIService

HTTP Request

POST /apis/apiregistration.k8s.io/v1/apiservices

Parameters

body: APIService, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (APIService): OK

201 (APIService): Created

202 (APIService): 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: APIService, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (APIService): OK

201 (APIService): 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: APIService, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (APIService): OK

201 (APIService): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (APIService): OK

201 (APIService): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (APIService): OK

201 (APIService): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of APIService

HTTP Request

DELETE /apis/apiregistration.k8s.io/v1/apiservices

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

8.5 - Lease

Lease defines a lease concept.

apiVersion: coordination.k8s.io/v1

import "k8s.io/api/coordination/v1"

Lease

Lease defines a lease concept.

apiVersion: coordination.k8s.io/v1
kind: Lease
metadata (ObjectMeta)

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (LeaseSpec)

Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

LeaseSpec

LeaseSpec is a specification of a Lease.

acquireTime (MicroTime)

acquireTime is a time when the current lease was acquired.

MicroTime is version of Time with microsecond level precision.
holderIdentity (string)

holderIdentity contains the identity of the holder of a current lease.
leaseDurationSeconds (int32)

leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.
leaseTransitions (int32)

leaseTransitions is the number of transitions of a lease between holders.
renewTime (MicroTime)

renewTime is a time when the current holder of a lease has last updated the lease.

MicroTime is version of Time with microsecond level precision.

LeaseList

LeaseList is a list of Lease objects.

apiVersion: coordination.k8s.io/v1
kind: LeaseList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]Lease), required

Items is a list of schema objects.

Operations

`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

namespace
pretty (in query): string

pretty

Response

200 (Lease): 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

namespace
allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (LeaseList): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (LeaseList): OK

401: Unauthorized

`create` create a Lease

HTTP Request

POST /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

Parameters

namespace (in path): string, required

namespace
body: Lease, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Lease): OK

201 (Lease): Created

202 (Lease): 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

namespace
body: Lease, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (Lease): OK

201 (Lease): 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

namespace
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (Lease): OK

201 (Lease): 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

namespace
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): 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

namespace
body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

8.6 - RuntimeClass

RuntimeClass defines a class of container runtime supported in the cluster.

apiVersion: node.k8s.io/v1

import "k8s.io/api/node/v1"

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/

apiVersion: node.k8s.io/v1
kind: RuntimeClass
metadata (ObjectMeta)

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/ This field is in beta starting v1.18 and is only honored by servers that enable the PodOverhead feature.

Overhead structure represents the resource overhead associated with running a pod.
- overhead.podFixed (map[string]Quantity)
  
  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.

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.
  
  The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching 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 is a list of RuntimeClass objects.

apiVersion: node.k8s.io/v1
kind: RuntimeClassList
metadata (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]RuntimeClass), required

Items is a list of schema objects.

Operations

`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

pretty

Response

200 (RuntimeClass): 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

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (RuntimeClassList): OK

401: Unauthorized

`create` create a RuntimeClass

HTTP Request

POST /apis/node.k8s.io/v1/runtimeclasses

Parameters

body: RuntimeClass, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (RuntimeClass): OK

201 (RuntimeClass): Created

202 (RuntimeClass): 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: RuntimeClass, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (RuntimeClass): OK

201 (RuntimeClass): 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: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (RuntimeClass): OK

201 (RuntimeClass): 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: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of RuntimeClass

HTTP Request

DELETE /apis/node.k8s.io/v1/runtimeclasses

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

8.7 - FlowSchema v1beta1

FlowSchema defines the schema of a group of flows.

apiVersion: flowcontrol.apiserver.k8s.io/v1beta1

import "k8s.io/api/flowcontrol/v1beta1"

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".

apiVersion: flowcontrol.apiserver.k8s.io/v1beta1
kind: FlowSchema
metadata (ObjectMeta)

metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (FlowSchemaSpec)

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 (FlowSchemaStatus)

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 describes how the FlowSchema's specification looks like.

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.

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.
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.

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.
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.

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.
  
  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.
    
    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.
    
    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.
    
    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.
  
  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.
  
  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) least one member of namespaces matches the request.
  - 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 represents the current state of a FlowSchema.

conditions ([]FlowSchemaCondition)

Map: unique values on key type will be kept during a merge

conditions is a list of the current states of FlowSchema.

FlowSchemaCondition describes conditions for a FlowSchema.
- conditions.lastTransitionTime (Time)
  
  lastTransitionTime is the last time the condition transitioned from one status to another.
  
  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 is a list of FlowSchema objects.

apiVersion: flowcontrol.apiserver.k8s.io/v1beta1
kind: FlowSchemaList
metadata (ListMeta)

metadata is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]FlowSchema), required

items is a list of FlowSchemas.

Operations

`get` read the specified FlowSchema

HTTP Request

GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}

Parameters

name (in path): string, required

name of the FlowSchema
pretty (in query): string

pretty

Response

200 (FlowSchema): OK

401: Unauthorized

`get` read status of the specified FlowSchema

HTTP Request

GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status

Parameters

name (in path): string, required

name of the FlowSchema
pretty (in query): string

pretty

Response

200 (FlowSchema): OK

401: Unauthorized

`list` list or watch objects of kind FlowSchema

HTTP Request

GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (FlowSchemaList): OK

401: Unauthorized

`create` create a FlowSchema

HTTP Request

POST /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas

Parameters

body: FlowSchema, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (FlowSchema): OK

201 (FlowSchema): Created

202 (FlowSchema): Accepted

401: Unauthorized

`update` replace the specified FlowSchema

HTTP Request

PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}

Parameters

name (in path): string, required

name of the FlowSchema
body: FlowSchema, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (FlowSchema): OK

201 (FlowSchema): Created

401: Unauthorized

`update` replace status of the specified FlowSchema

HTTP Request

PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status

Parameters

name (in path): string, required

name of the FlowSchema
body: FlowSchema, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

200 (FlowSchema): OK

201 (FlowSchema): Created

401: Unauthorized

`patch` partially update the specified FlowSchema

HTTP Request

PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}

Parameters

name (in path): string, required

name of the FlowSchema
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (FlowSchema): OK

201 (FlowSchema): Created

401: Unauthorized

`patch` partially update status of the specified FlowSchema

HTTP Request

PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status

Parameters

name (in path): string, required

name of the FlowSchema
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

200 (FlowSchema): OK

201 (FlowSchema): Created

401: Unauthorized

`delete` delete a FlowSchema

HTTP Request

DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}

Parameters

name (in path): string, required

name of the FlowSchema
body: DeleteOptions
dryRun (in query): string

dryRun
gracePeriodSeconds (in query): integer

gracePeriodSeconds
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

`deletecollection` delete collection of FlowSchema

HTTP Request

DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas

Parameters

body: DeleteOptions
continue (in query): string

continue
dryRun (in query): string

dryRun
fieldSelector (in query): string

fieldSelector
gracePeriodSeconds (in query): integer

gracePeriodSeconds
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
propagationPolicy (in query): string

propagationPolicy
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds

Response

200 (Status): OK

401: Unauthorized

8.8 - PriorityLevelConfiguration v1beta1

PriorityLevelConfiguration represents the configuration of a priority level.

apiVersion: flowcontrol.apiserver.k8s.io/v1beta1

import "k8s.io/api/flowcontrol/v1beta1"

PriorityLevelConfiguration

PriorityLevelConfiguration represents the configuration of a priority level.

apiVersion: flowcontrol.apiserver.k8s.io/v1beta1
kind: PriorityLevelConfiguration
metadata (ObjectMeta)

metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (PriorityLevelConfigurationSpec)

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 (PriorityLevelConfigurationStatus)

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 specifies the configuration of a priority level.

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.
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".

*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.assuredConcurrencyShares (int32)
  
  assuredConcurrencyShares (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) --- the number of requests that may be executing at a time --- for each such priority level:
```
        ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) )
```
  bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30.
- limited.limitResponse (LimitResponse)
  
  limitResponse indicates what to do with requests that can not be executed right now
  
  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".
    
    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.

PriorityLevelConfigurationStatus

PriorityLevelConfigurationStatus represents the current state of a "request-priority".

conditions ([]PriorityLevelConfigurationCondition)

Map: unique values on key type will be kept during a merge

conditions is the current state of "request-priority".

PriorityLevelConfigurationCondition defines the condition of priority level.
- conditions.lastTransitionTime (Time)
  
  lastTransitionTime is the last time the condition transitioned from one status to another.
  
  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 is a list of PriorityLevelConfiguration objects.

apiVersion: flowcontrol.apiserver.k8s.io/v1beta1
kind: PriorityLevelConfigurationList
metadata (ListMeta)

metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]PriorityLevelConfiguration), required

items is a list of request-priorities.

Operations

`get` read the specified PriorityLevelConfiguration

HTTP Request

GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}

Parameters

name (in path): string, required

name of the PriorityLevelConfiguration
pretty (in query): string

pretty

Response

401: Unauthorized

`get` read status of the specified PriorityLevelConfiguration

HTTP Request

GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status

Parameters

name (in path): string, required

name of the PriorityLevelConfiguration
pretty (in query): string

pretty

Response

401: Unauthorized

`list` list or watch objects of kind PriorityLevelConfiguration

HTTP Request

GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations

Parameters

allowWatchBookmarks (in query): boolean

allowWatchBookmarks
continue (in query): string

continue
fieldSelector (in query): string

fieldSelector
labelSelector (in query): string

labelSelector
limit (in query): integer

limit
pretty (in query): string

pretty
resourceVersion (in query): string

resourceVersion
resourceVersionMatch (in query): string

resourceVersionMatch
timeoutSeconds (in query): integer

timeoutSeconds
watch (in query): boolean

watch

Response

200 (PriorityLevelConfigurationList): OK

401: Unauthorized

`create` create a PriorityLevelConfiguration

HTTP Request

POST /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations

Parameters

body: PriorityLevelConfiguration, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (PriorityLevelConfiguration): Created

202 (PriorityLevelConfiguration): Accepted

401: Unauthorized

`update` replace the specified PriorityLevelConfiguration

HTTP Request

PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}

Parameters

name (in path): string, required

name of the PriorityLevelConfiguration
body: PriorityLevelConfiguration, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (PriorityLevelConfiguration): Created

401: Unauthorized

`update` replace status of the specified PriorityLevelConfiguration

HTTP Request

PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status

Parameters

name (in path): string, required

name of the PriorityLevelConfiguration
body: PriorityLevelConfiguration, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
pretty (in query): string

pretty

Response

201 (PriorityLevelConfiguration): Created

401: Unauthorized

`patch` partially update the specified PriorityLevelConfiguration

HTTP Request

PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}

Parameters

name (in path): string, required

name of the PriorityLevelConfiguration
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response

201 (PriorityLevelConfiguration): Created

401: Unauthorized

`patch` partially update status of the specified PriorityLevelConfiguration

HTTP Request

PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status

Parameters

name (in path): string, required

name of the PriorityLevelConfiguration
body: Patch, required
dryRun (in query): string

dryRun
fieldManager (in query): string

fieldManager
force (in query): boolean

force
pretty (in query): string

pretty

Response