1. Docs
  2. Reference
  3. API
  4. @pulumi/kubernetes
  5. types
  6. output

Module types/output

This page documents the language specification for the kubernetes package. If you're looking for help working with the inputs, outputs, or functions of kubernetes resources in a Pulumi program, please see the resource documentation for examples and API reference.

namespace admissionregistration.v1

namespace admissionregistration.v1beta1

namespace apiextensions.v1

namespace apiextensions.v1beta1

namespace apiregistration.v1

namespace apiregistration.v1beta1

namespace apps.v1

namespace apps.v1beta1

namespace apps.v1beta2

namespace auditregistration.v1alpha1

namespace authentication.v1

namespace authentication.v1beta1

namespace authorization.v1

namespace authorization.v1beta1

namespace autoscaling.v1

namespace autoscaling.v2beta1

namespace autoscaling.v2beta2

namespace batch.v1

namespace batch.v1beta1

namespace batch.v2alpha1

namespace certificates.v1beta1

namespace coordination.v1

namespace coordination.v1beta1

namespace core.v1

namespace discovery.v1beta1

namespace events.v1beta1

namespace extensions.v1beta1

namespace flowcontrol.v1alpha1

namespace meta.v1

namespace networking.v1

namespace networking.v1beta1

namespace node.v1alpha1

namespace node.v1beta1

namespace policy.v1beta1

namespace rbac.v1

namespace rbac.v1alpha1

namespace rbac.v1beta1

namespace scheduling.v1

namespace scheduling.v1alpha1

namespace scheduling.v1beta1

namespace settings.v1alpha1

namespace storage.v1

namespace storage.v1alpha1

namespace storage.v1beta1

namespace admissionregistration.v1

interface MutatingWebhook

interface MutatingWebhook

MutatingWebhook describes an admission webhook and the resources and operations it applies to.

property admissionReviewVersions

admissionReviewVersions: string[];

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.

property clientConfig

clientConfig: WebhookClientConfig;

ClientConfig defines how to communicate with the hook. Required

property failurePolicy

failurePolicy: string;

FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.

property matchPolicy

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”

property name

name: string;

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.

property namespaceSelector

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.

property objectSelector

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.

property reinvocationPolicy

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

property rules

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.

property sideEffects

sideEffects: string;

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

property timeoutSeconds

timeoutSeconds: number;

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.

interface MutatingWebhookConfiguration

interface MutatingWebhookConfiguration

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

property apiVersion

apiVersion: "admissionregistration.k8s.io/v1";

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

property kind

kind: "MutatingWebhookConfiguration";

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

property metadata

metadata: ObjectMeta;

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

property webhooks

webhooks: MutatingWebhook[];

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

interface RuleWithOperations

interface RuleWithOperations

RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.

property apiGroups

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.

property apiVersions

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.

property operations

operations: string[];

Operations is the operations the admission hook cares about - CREATE, UPDATE, or * for all operations. If ‘*’ is present, the length of the slice must be one. Required.

property resources

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.

property scope

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

interface ServiceReference

interface ServiceReference

ServiceReference holds a reference to Service.legacy.k8s.io

property name

name: string;

name is the name of the service. Required

property namespace

namespace: string;

namespace is the namespace of the service. Required

property path

path: string;

path is an optional URL path which will be sent in any request to this service.

property port

port: number;

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

interface ValidatingWebhook

interface ValidatingWebhook

ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

property admissionReviewVersions

admissionReviewVersions: string[];

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.

property clientConfig

clientConfig: WebhookClientConfig;

ClientConfig defines how to communicate with the hook. Required

property failurePolicy

failurePolicy: string;

FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.

property matchPolicy

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”

property name

name: string;

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.

property namespaceSelector

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.

property objectSelector

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.

property rules

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.

property sideEffects

sideEffects: string;

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

property timeoutSeconds

timeoutSeconds: number;

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.

interface ValidatingWebhookConfiguration

interface ValidatingWebhookConfiguration

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

property apiVersion

apiVersion: "admissionregistration.k8s.io/v1";

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

property kind

kind: "ValidatingWebhookConfiguration";

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

property metadata

metadata: ObjectMeta;

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

property webhooks

webhooks: ValidatingWebhook[];

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

interface WebhookClientConfig

interface WebhookClientConfig

WebhookClientConfig contains the information to make a TLS connection with the webhook

property caBundle

caBundle: string;

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.

property service

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.

property url

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.

namespace admissionregistration.v1beta1

interface MutatingWebhook

interface MutatingWebhook

MutatingWebhook describes an admission webhook and the resources and operations it applies to.

property admissionReviewVersions

admissionReviewVersions: string[];

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. Default to ['v1beta1'].

property clientConfig

clientConfig: WebhookClientConfig;

ClientConfig defines how to communicate with the hook. Required

property failurePolicy

failurePolicy: string;

FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.

property matchPolicy

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 “Exact”

property name

name: string;

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.

property namespaceSelector

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.

property objectSelector

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.

property reinvocationPolicy

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

property rules

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.

property sideEffects

sideEffects: string;

SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change 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. Defaults to Unknown.

property timeoutSeconds

timeoutSeconds: number;

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

interface MutatingWebhookConfiguration

interface MutatingWebhookConfiguration

MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 MutatingWebhookConfiguration instead.

property apiVersion

apiVersion: "admissionregistration.k8s.io/v1beta1";

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

property kind

kind: "MutatingWebhookConfiguration";

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

property metadata

metadata: ObjectMeta;

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

property webhooks

webhooks: MutatingWebhook[];

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

interface RuleWithOperations

interface RuleWithOperations

RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.

property apiGroups

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.

property apiVersions

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.

property operations

operations: string[];

Operations is the operations the admission hook cares about - CREATE, UPDATE, or * for all operations. If ‘*’ is present, the length of the slice must be one. Required.

property resources

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.

property scope

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

interface ServiceReference

interface ServiceReference

ServiceReference holds a reference to Service.legacy.k8s.io

property name

name: string;

name is the name of the service. Required

property namespace

namespace: string;

namespace is the namespace of the service. Required

property path

path: string;

path is an optional URL path which will be sent in any request to this service.

property port

port: number;

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

interface ValidatingWebhook

interface ValidatingWebhook

ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

property admissionReviewVersions

admissionReviewVersions: string[];

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. Default to ['v1beta1'].

property clientConfig

clientConfig: WebhookClientConfig;

ClientConfig defines how to communicate with the hook. Required

property failurePolicy

failurePolicy: string;

FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.

property matchPolicy

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 “Exact”

property name

name: string;

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.

property namespaceSelector

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.

property objectSelector

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.

property rules

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.

property sideEffects

sideEffects: string;

SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change 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. Defaults to Unknown.

property timeoutSeconds

timeoutSeconds: number;

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

interface ValidatingWebhookConfiguration

interface ValidatingWebhookConfiguration

ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 ValidatingWebhookConfiguration instead.

property apiVersion

apiVersion: "admissionregistration.k8s.io/v1beta1";

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

property kind

kind: "ValidatingWebhookConfiguration";

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

property metadata

metadata: ObjectMeta;

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

property webhooks

webhooks: ValidatingWebhook[];

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

interface WebhookClientConfig

interface WebhookClientConfig

WebhookClientConfig contains the information to make a TLS connection with the webhook

property caBundle

caBundle: string;

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.

property service

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.

property url

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.

namespace apiextensions.v1

interface CustomResourceColumnDefinition

interface CustomResourceColumnDefinition

CustomResourceColumnDefinition specifies a column for server side printing.

property description

description: string;

description is a human readable description of this column.

property format

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.

property jsonPath

jsonPath: string;

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.

property name

name: string;

name is a human readable name for the column.

property priority

priority: number;

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.

property type

type: string;

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.

interface CustomResourceConversion

interface CustomResourceConversion

CustomResourceConversion describes how to convert different versions of a CR.

property strategy

strategy: string;

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.

property webhook

webhook: WebhookConversion;

webhook describes how to call the conversion webhook. Required when strategy is set to Webhook.

interface CustomResourceDefinition

interface CustomResourceDefinition

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

property apiVersion

apiVersion: "apiextensions.k8s.io/v1";

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

property kind

kind: "CustomResourceDefinition";

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

property metadata

metadata: ObjectMeta;

property spec

spec: CustomResourceDefinitionSpec;

spec describes how the user wants the resources to appear

property status

status: CustomResourceDefinitionStatus;

status indicates the actual state of the CustomResourceDefinition

interface CustomResourceDefinitionCondition

interface CustomResourceDefinitionCondition

CustomResourceDefinitionCondition contains details for the current condition of this pod.

property lastTransitionTime

lastTransitionTime: string;

lastTransitionTime last time the condition transitioned from one status to another.

property message

message: string;

message is a human-readable message indicating details about last transition.

property reason

reason: string;

reason is a unique, one-word, CamelCase reason for the condition’s last transition.

property status

status: string;

status is the status of the condition. Can be True, False, Unknown.

property type

type: string;

type is the type of the condition. Types include Established, NamesAccepted and Terminating.

interface CustomResourceDefinitionNames

interface CustomResourceDefinitionNames

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

property categories

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.

property kind

kind: string;

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.

property listKind

listKind: string;

listKind is the serialized kind of the list for this resource. Defaults to “kindList”.

property plural

plural: string;

plural is the plural name of the resource to serve. The custom resources are served under /apis/&lt;group&gt;/&lt;version&gt;/.../&lt;plural&gt;. Must match the name of the CustomResourceDefinition (in the form &lt;names.plural&gt;.&lt;group&gt;). Must be all lowercase.

property shortNames

shortNames: string[];

shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get &lt;shortname&gt;. It must be all lowercase.

property singular

singular: string;

singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

interface CustomResourceDefinitionSpec

interface CustomResourceDefinitionSpec

CustomResourceDefinitionSpec describes how a user wants their resource to appear

property conversion

conversion: CustomResourceConversion;

conversion defines conversion settings for the CRD.

property group

group: string;

group is the API group of the defined custom resource. The custom resources are served under /apis/&lt;group&gt;/.... Must match the name of the CustomResourceDefinition (in the form &lt;names.plural&gt;.&lt;group&gt;).

property names

names: CustomResourceDefinitionNames;

names specify the resource and kind names for the custom resource.

property preserveUnknownFields

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.

property scope

scope: string;

scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster and Namespaced.

property versions

versions: CustomResourceDefinitionVersion[];

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.

interface CustomResourceDefinitionStatus

interface CustomResourceDefinitionStatus

CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

property acceptedNames

acceptedNames: CustomResourceDefinitionNames;

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

property conditions

conditions: CustomResourceDefinitionCondition[];

conditions indicate state for particular aspects of a CustomResourceDefinition

property storedVersions

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.

interface CustomResourceDefinitionVersion

interface CustomResourceDefinitionVersion

CustomResourceDefinitionVersion describes a version for CRD.

property additionalPrinterColumns

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.

property name

name: string;

name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at /apis/&lt;group&gt;/&lt;version&gt;/... if served is true.

property schema

schema: CustomResourceValidation;

schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.

property served

served: boolean;

served is a flag enabling/disabling this version from being served via REST APIs

property storage

storage: boolean;

storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.

property subresources

subresources: CustomResourceSubresources;

subresources specify what subresources this version of the defined custom resource have.

interface CustomResourceSubresources

interface CustomResourceSubresources

CustomResourceSubresources defines the status and scale subresources for CustomResources.

property scale

scale: CustomResourceSubresourceScale;

scale indicates the custom resource should serve a /scale subresource that returns an autoscaling/v1 Scale object.

property status

status: any;

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.

interface CustomResourceSubresourceScale

interface CustomResourceSubresourceScale

CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

property labelSelectorPath

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.

property specReplicasPath

specReplicasPath: string;

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.

property statusReplicasPath

statusReplicasPath: string;

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.

interface CustomResourceValidation

interface CustomResourceValidation

CustomResourceValidation is a list of validation methods for CustomResources.

property openAPIV3Schema

openAPIV3Schema: JSONSchemaProps;

openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.

interface ExternalDocumentation

interface ExternalDocumentation

ExternalDocumentation allows referencing an external resource for extended documentation.

property description

description: string;

property url

url: string;

interface JSONSchemaProps

interface JSONSchemaProps

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

property $ref

$ref: string;

property $schema

$schema: string;

property additionalItems

additionalItems: JSONSchemaProps | boolean;

property additionalProperties

additionalProperties: JSONSchemaProps | boolean;

property allOf

allOf: JSONSchemaProps[];

property anyOf

anyOf: JSONSchemaProps[];

property default

default: any;

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.

property definitions

definitions: {[key: string]: JSONSchemaProps};

property dependencies

dependencies: {[key: string]: JSONSchemaProps | string[]};

property description

description: string;

property enum

enum: any[];

property example

example: any;

property exclusiveMaximum

exclusiveMaximum: boolean;

property exclusiveMinimum

exclusiveMinimum: boolean;

property externalDocs

externalDocs: ExternalDocumentation;

property format

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)1{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)2{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)3{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)4{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.

property id

id: string;

property items

items: JSONSchemaProps | any[];

property maxItems

maxItems: number;

property maxLength

maxLength: number;

property maxProperties

maxProperties: number;

property maximum

maximum: number;

property minItems

minItems: number;

property minLength

minLength: number;

property minProperties

minProperties: number;

property minimum

minimum: number;

property multipleOf

multipleOf: number;

property not

not: JSONSchemaProps;

property nullable

nullable: boolean;

property oneOf

oneOf: JSONSchemaProps[];

property pattern

pattern: string;

property patternProperties

patternProperties: {[key: string]: JSONSchemaProps};

property properties

properties: {[key: string]: JSONSchemaProps};

property required

required: string[];

property title

title: string;

property type

type: string;

property uniqueItems

uniqueItems: boolean;

property x_kubernetes_embedded_resource

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

property x_kubernetes_int_or_string

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

property x_kubernetes_list_map_keys

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.

property x_kubernetes_list_type

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.

property x_kubernetes_map_type

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.

property x_kubernetes_preserve_unknown_fields

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.

interface ServiceReference

interface ServiceReference

ServiceReference holds a reference to Service.legacy.k8s.io

property name

name: string;

name is the name of the service. Required

property namespace

namespace: string;

namespace is the namespace of the service. Required

property path

path: string;

path is an optional URL path at which the webhook will be contacted.

property port

port: number;

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.

interface WebhookClientConfig

interface WebhookClientConfig

WebhookClientConfig contains the information to make a TLS connection with the webhook.

property caBundle

caBundle: string;

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.

property service

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.

property url

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.

interface WebhookConversion

interface WebhookConversion

WebhookConversion describes how to call a conversion webhook

property clientConfig

clientConfig: WebhookClientConfig;

clientConfig is the instructions for how to call the webhook if strategy is Webhook.

property conversionReviewVersions

conversionReviewVersions: string[];

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.

namespace apiextensions.v1beta1

interface CustomResourceColumnDefinition

interface CustomResourceColumnDefinition

CustomResourceColumnDefinition specifies a column for server side printing.

property JSONPath

JSONPath: string;

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.

property description

description: string;

description is a human readable description of this column.

property format

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.

property name

name: string;

name is a human readable name for the column.

property priority

priority: number;

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.

property type

type: string;

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.

interface CustomResourceConversion

interface CustomResourceConversion

CustomResourceConversion describes how to convert different versions of a CR.

property conversionReviewVersions

conversionReviewVersions: string[];

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. Defaults to ["v1beta1"].

property strategy

strategy: string;

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.webhookClientConfig to be set.

property webhookClientConfig

webhookClientConfig: WebhookClientConfig;

webhookClientConfig is the instructions for how to call the webhook if strategy is Webhook. Required when strategy is set to Webhook.

interface CustomResourceDefinition

interface CustomResourceDefinition

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. Deprecated in v1.16, planned for removal in v1.19. Use apiextensions.k8s.io/v1 CustomResourceDefinition instead.

property apiVersion

apiVersion: "apiextensions.k8s.io/v1beta1";

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

property kind

kind: "CustomResourceDefinition";

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

property metadata

metadata: ObjectMeta;

property spec

spec: CustomResourceDefinitionSpec;

spec describes how the user wants the resources to appear

property status

status: CustomResourceDefinitionStatus;

status indicates the actual state of the CustomResourceDefinition

interface CustomResourceDefinitionCondition

interface CustomResourceDefinitionCondition

CustomResourceDefinitionCondition contains details for the current condition of this pod.

property lastTransitionTime

lastTransitionTime: string;

lastTransitionTime last time the condition transitioned from one status to another.

property message

message: string;

message is a human-readable message indicating details about last transition.

property reason

reason: string;

reason is a unique, one-word, CamelCase reason for the condition’s last transition.

property status

status: string;

status is the status of the condition. Can be True, False, Unknown.

property type

type: string;

type is the type of the condition. Types include Established, NamesAccepted and Terminating.

interface CustomResourceDefinitionNames

interface CustomResourceDefinitionNames

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

property categories

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.

property kind

kind: string;

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.

property listKind

listKind: string;

listKind is the serialized kind of the list for this resource. Defaults to “kindList”.

property plural

plural: string;

plural is the plural name of the resource to serve. The custom resources are served under /apis/&lt;group&gt;/&lt;version&gt;/.../&lt;plural&gt;. Must match the name of the CustomResourceDefinition (in the form &lt;names.plural&gt;.&lt;group&gt;). Must be all lowercase.

property shortNames

shortNames: string[];

shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get &lt;shortname&gt;. It must be all lowercase.

property singular

singular: string;

singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

interface CustomResourceDefinitionSpec

interface CustomResourceDefinitionSpec

CustomResourceDefinitionSpec describes how a user wants their resource to appear

property additionalPrinterColumns

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 present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.

property conversion

conversion: CustomResourceConversion;

conversion defines conversion settings for the CRD.

property group

group: string;

group is the API group of the defined custom resource. The custom resources are served under /apis/&lt;group&gt;/.... Must match the name of the CustomResourceDefinition (in the form &lt;names.plural&gt;.&lt;group&gt;).

property names

names: CustomResourceDefinitionNames;

names specify the resource and kind names for the custom resource.

property preserveUnknownFields

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. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the x-kubernetes-preserve-unknown-fields: true extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.

property scope

scope: string;

scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster and Namespaced. Default is Namespaced.

property subresources

subresources: CustomResourceSubresources;

subresources specify what subresources the defined custom resource has. If present, this field configures subresources for all versions. Top-level and per-version subresources are mutually exclusive.

property validation

validation: CustomResourceValidation;

validation describes the schema used for validation and pruning of the custom resource. If present, this validation schema is used to validate all versions. Top-level and per-version schemas are mutually exclusive.

property version

version: string;

version is the API version of the defined custom resource. The custom resources are served under /apis/&lt;group&gt;/&lt;version&gt;/.... Must match the name of the first item in the versions list if version and versions are both specified. Optional if versions is specified. Deprecated: use versions instead.

property versions

versions: CustomResourceDefinitionVersion[];

versions is the list of all API versions of the defined custom resource. Optional if version is specified. The name of the first item in the versions list must match the version field if version and versions are both specified. 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.

interface CustomResourceDefinitionStatus

interface CustomResourceDefinitionStatus

CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

property acceptedNames

acceptedNames: CustomResourceDefinitionNames;

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

property conditions

conditions: CustomResourceDefinitionCondition[];

conditions indicate state for particular aspects of a CustomResourceDefinition

property storedVersions

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.

interface CustomResourceDefinitionVersion

interface CustomResourceDefinitionVersion

CustomResourceDefinitionVersion describes a version for CRD.

property additionalPrinterColumns

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. Top-level and per-version columns are mutually exclusive. Per-version columns must not all be set to identical values (top-level columns should be used instead). If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.

property name

name: string;

name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at /apis/&lt;group&gt;/&lt;version&gt;/... if served is true.

property schema

schema: CustomResourceValidation;

schema describes the schema used for validation and pruning of this version of the custom resource. Top-level and per-version schemas are mutually exclusive. Per-version schemas must not all be set to identical values (top-level validation schema should be used instead).

property served

served: boolean;

served is a flag enabling/disabling this version from being served via REST APIs

property storage

storage: boolean;

storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.

property subresources

subresources: CustomResourceSubresources;

subresources specify what subresources this version of the defined custom resource have. Top-level and per-version subresources are mutually exclusive. Per-version subresources must not all be set to identical values (top-level subresources should be used instead).

interface CustomResourceSubresources

interface CustomResourceSubresources

CustomResourceSubresources defines the status and scale subresources for CustomResources.

property scale

scale: CustomResourceSubresourceScale;

scale indicates the custom resource should serve a /scale subresource that returns an autoscaling/v1 Scale object.

property status

status: any;

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.

interface CustomResourceSubresourceScale

interface CustomResourceSubresourceScale

CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

property labelSelectorPath

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.

property specReplicasPath

specReplicasPath: string;

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.

property statusReplicasPath

statusReplicasPath: string;

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.

interface CustomResourceValidation

interface CustomResourceValidation

CustomResourceValidation is a list of validation methods for CustomResources.

property openAPIV3Schema

openAPIV3Schema: JSONSchemaProps;

openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.

interface ExternalDocumentation

interface ExternalDocumentation

ExternalDocumentation allows referencing an external resource for extended documentation.

property description

description: string;

property url

url: string;

interface JSONSchemaProps

interface JSONSchemaProps

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

property $ref

$ref: string;

property $schema

$schema: string;

property additionalItems

additionalItems: JSONSchemaProps | boolean;

property additionalProperties

additionalProperties: JSONSchemaProps | boolean;

property allOf

allOf: JSONSchemaProps[];

property anyOf

anyOf: JSONSchemaProps[];

property default

default: any;

default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. CustomResourceDefinitions with defaults must be created using the v1 (or newer) CustomResourceDefinition API.

property definitions

definitions: {[key: string]: JSONSchemaProps};

property dependencies

dependencies: {[key: string]: JSONSchemaProps | string[]};

property description

description: string;

property enum

enum: any[];

property example

example: any;

property exclusiveMaximum

exclusiveMaximum: boolean;

property exclusiveMinimum

exclusiveMinimum: boolean;

property externalDocs

externalDocs: ExternalDocumentation;

property format

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)5{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)6{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)7{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)8{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.

property id

id: string;

property items

items: JSONSchemaProps | any[];

property maxItems

maxItems: number;

property maxLength

maxLength: number;

property maxProperties

maxProperties: number;

property maximum

maximum: number;

property minItems

minItems: number;

property minLength

minLength: number;

property minProperties

minProperties: number;

property minimum

minimum: number;

property multipleOf

multipleOf: number;

property not

not: JSONSchemaProps;

property nullable

nullable: boolean;

property oneOf

oneOf: JSONSchemaProps[];

property pattern

pattern: string;

property patternProperties

patternProperties: {[key: string]: JSONSchemaProps};

property properties

properties: {[key: string]: JSONSchemaProps};

property required

required: string[];

property title

title: string;

property type

type: string;

property uniqueItems

uniqueItems: boolean;

property x_kubernetes_embedded_resource

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

property x_kubernetes_int_or_string

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

property x_kubernetes_list_map_keys

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.

property x_kubernetes_list_type

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.

property x_kubernetes_map_type

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.

property x_kubernetes_preserve_unknown_fields

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.

interface ServiceReference

interface ServiceReference

ServiceReference holds a reference to Service.legacy.k8s.io

property name

name: string;

name is the name of the service. Required

property namespace

namespace: string;

namespace is the namespace of the service. Required

property path

path: string;

path is an optional URL path at which the webhook will be contacted.

property port

port: number;

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.

interface WebhookClientConfig

interface WebhookClientConfig

WebhookClientConfig contains the information to make a TLS connection with the webhook.

property caBundle

caBundle: string;

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.

property service

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.

property url

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.

namespace apiregistration.v1

interface APIService

interface APIService

APIService represents a server for a particular GroupVersion. Name must be “version.group”.

property apiVersion

apiVersion: "apiregistration.k8s.io/v1";

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

property kind

kind: "APIService";

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

property metadata

metadata: ObjectMeta;

property spec

spec: APIServiceSpec;

Spec contains information for locating and communicating with a server

property status

status: APIServiceStatus;

Status contains derived information about an API server

interface APIServiceCondition

interface APIServiceCondition

APIServiceCondition describes the state of an APIService at a particular point

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

Human-readable message indicating details about last transition.

property reason

reason: string;

Unique, one-word, CamelCase reason for the condition’s last transition.

property status

status: string;

Status is the status of the condition. Can be True, False, Unknown.

property type

type: string;

Type is the type of the condition.

interface APIServiceSpec

interface APIServiceSpec

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

property caBundle

caBundle: string;

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.

property group

group: string;

Group is the API group name this server hosts

property groupPriorityMinimum

groupPriorityMinimum: number;

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

property insecureSkipTLSVerify

insecureSkipTLSVerify: boolean;

InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.

property service

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.

property version

version: string;

Version is the API version this server hosts. For example, “v1”

property versionPriority

versionPriority: number;

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.

interface APIServiceStatus

interface APIServiceStatus

APIServiceStatus contains derived information about an API server

property conditions

conditions: APIServiceCondition[];

Current service state of apiService.

interface ServiceReference

interface ServiceReference

ServiceReference holds a reference to Service.legacy.k8s.io

property name

name: string;

Name is the name of the service

property namespace

namespace: string;

Namespace is the namespace of the service

property port

port: number;

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

namespace apiregistration.v1beta1

interface APIService

interface APIService

APIService represents a server for a particular GroupVersion. Name must be “version.group”.

property apiVersion

apiVersion: "apiregistration.k8s.io/v1beta1";

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

property kind

kind: "APIService";

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

property metadata

metadata: ObjectMeta;

property spec

spec: APIServiceSpec;

Spec contains information for locating and communicating with a server

property status

status: APIServiceStatus;

Status contains derived information about an API server

interface APIServiceCondition

interface APIServiceCondition

APIServiceCondition describes the state of an APIService at a particular point

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

Human-readable message indicating details about last transition.

property reason

reason: string;

Unique, one-word, CamelCase reason for the condition’s last transition.

property status

status: string;

Status is the status of the condition. Can be True, False, Unknown.

property type

type: string;

Type is the type of the condition.

interface APIServiceSpec

interface APIServiceSpec

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

property caBundle

caBundle: string;

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.

property group

group: string;

Group is the API group name this server hosts

property groupPriorityMinimum

groupPriorityMinimum: number;

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

property insecureSkipTLSVerify

insecureSkipTLSVerify: boolean;

InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.

property service

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.

property version

version: string;

Version is the API version this server hosts. For example, “v1”

property versionPriority

versionPriority: number;

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.

interface APIServiceStatus

interface APIServiceStatus

APIServiceStatus contains derived information about an API server

property conditions

conditions: APIServiceCondition[];

Current service state of apiService.

interface ServiceReference

interface ServiceReference

ServiceReference holds a reference to Service.legacy.k8s.io

property name

name: string;

Name is the name of the service

property namespace

namespace: string;

Namespace is the namespace of the service

property port

port: number;

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

namespace apps.v1

interface ControllerRevision

interface ControllerRevision

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

property apiVersion

apiVersion: "apps/v1";

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

property data

data: any;

Data is the serialized representation of the state.

property kind

kind: "ControllerRevision";

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

property metadata

metadata: ObjectMeta;

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

property revision

revision: number;

Revision indicates the revision of the state represented by Data.

interface DaemonSet

interface DaemonSet

DaemonSet represents the configuration of a daemon set.

property apiVersion

apiVersion: "apps/v1";

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

property kind

kind: "DaemonSet";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: DaemonSetSpec;

The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: DaemonSetStatus;

The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface DaemonSetCondition

interface DaemonSetCondition

DaemonSetCondition describes the state of a DaemonSet at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of DaemonSet condition.

interface DaemonSetSpec

interface DaemonSetSpec

DaemonSetSpec is the specification of a daemon set.

property minReadySeconds

minReadySeconds: number;

The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).

property revisionHistoryLimit

revisionHistoryLimit: number;

The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

property selector

selector: LabelSelector;

A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property template

template: PodTemplateSpec;

An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

property updateStrategy

updateStrategy: DaemonSetUpdateStrategy;

An update strategy to replace existing DaemonSet pods with new pods.

interface DaemonSetStatus

interface DaemonSetStatus

DaemonSetStatus represents the current status of a daemon set.

property collisionCount

collisionCount: number;

Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

property conditions

conditions: DaemonSetCondition[];

Represents the latest available observations of a DaemonSet’s current state.

property currentNumberScheduled

currentNumberScheduled: number;

The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

property desiredNumberScheduled

desiredNumberScheduled: number;

The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

property numberAvailable

numberAvailable: number;

The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)

property numberMisscheduled

numberMisscheduled: number;

The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

property numberReady

numberReady: number;

The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.

property numberUnavailable

numberUnavailable: number;

The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)

property observedGeneration

observedGeneration: number;

The most recent generation observed by the daemon set controller.

property updatedNumberScheduled

updatedNumberScheduled: number;

The total number of nodes that are running updated daemon pod

interface DaemonSetUpdateStrategy

interface DaemonSetUpdateStrategy

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

property rollingUpdate

rollingUpdate: RollingUpdateDaemonSet;

Rolling update config params. Present only if type = “RollingUpdate”.

property type

type: string;

Type of daemon set update. Can be “RollingUpdate” or “OnDelete”. Default is RollingUpdate.

interface Deployment

interface Deployment

Deployment enables declarative updates for Pods and ReplicaSets.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. The Deployment has begun to be updated by the Deployment controller. If the current generation of the Deployment is > 1, then this means that the current generation must be different from the generation reported by the last outputs.
  2. There exists a ReplicaSet whose revision is equal to the current revision of the Deployment.
  3. The Deployment’s ‘.status.conditions’ has a status of type ‘Available’ whose ‘status’ member is set to ‘True’.
  4. If the Deployment has generation > 1, then ‘.status.conditions’ has a status of type ‘Progressing’, whose ‘status’ member is set to ‘True’, and whose ‘reason’ is ‘NewReplicaSetAvailable’. For generation <= 1, this status field does not exist, because it doesn’t do a rollout (i.e., it simply creates the Deployment and corresponding ReplicaSet), and therefore there is no rollout to mark as ‘Progressing’.

If the Deployment has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "apps/v1";

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

property kind

kind: "Deployment";

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

property metadata

metadata: ObjectMeta;

Standard object metadata.

property spec

spec: DeploymentSpec;

Specification of the desired behavior of the Deployment.

property status

status: DeploymentStatus;

Most recently observed status of the Deployment.

interface DeploymentCondition

interface DeploymentCondition

DeploymentCondition describes the state of a deployment at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property lastUpdateTime

lastUpdateTime: string;

The last time this condition was updated.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of deployment condition.

interface DeploymentSpec

interface DeploymentSpec

DeploymentSpec is the specification of the desired behavior of the Deployment.

property minReadySeconds

minReadySeconds: number;

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

property paused

paused: boolean;

Indicates that the deployment is paused.

property progressDeadlineSeconds

progressDeadlineSeconds: number;

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

property replicas

replicas: number;

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

property revisionHistoryLimit

revisionHistoryLimit: number;

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

property selector

selector: LabelSelector;

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template’s labels.

property strategy

strategy: DeploymentStrategy;

The deployment strategy to use to replace existing pods with new ones.

property template

template: PodTemplateSpec;

Template describes the pods that will be created.

interface DeploymentStatus

interface DeploymentStatus

DeploymentStatus is the most recently observed status of the Deployment.

property availableReplicas

availableReplicas: number;

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

property collisionCount

collisionCount: number;

Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.

property conditions

conditions: DeploymentCondition[];

Represents the latest available observations of a deployment’s current state.

property observedGeneration

observedGeneration: number;

The generation observed by the deployment controller.

property readyReplicas

readyReplicas: number;

Total number of ready pods targeted by this deployment.

property replicas

replicas: number;

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

property unavailableReplicas

unavailableReplicas: number;

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.

property updatedReplicas

updatedReplicas: number;

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

interface DeploymentStrategy

interface DeploymentStrategy

DeploymentStrategy describes how to replace existing pods with new ones.

property rollingUpdate

rollingUpdate: RollingUpdateDeployment;

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

property type

type: string;

Type of deployment. Can be “Recreate” or “RollingUpdate”. Default is RollingUpdate.

interface ReplicaSet

interface ReplicaSet

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

property apiVersion

apiVersion: "apps/v1";

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

property kind

kind: "ReplicaSet";

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

property metadata

metadata: ObjectMeta;

If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property spec

spec: ReplicaSetSpec;

Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: ReplicaSetStatus;

Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface ReplicaSetCondition

interface ReplicaSetCondition

ReplicaSetCondition describes the state of a replica set at a certain point.

property lastTransitionTime

lastTransitionTime: string;

The last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of replica set condition.

interface ReplicaSetSpec

interface ReplicaSetSpec

ReplicaSetSpec is the specification of a ReplicaSet.

property minReadySeconds

minReadySeconds: number;

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

property replicas

replicas: number;

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

property selector

selector: LabelSelector;

Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property template

template: PodTemplateSpec;

Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

interface ReplicaSetStatus

interface ReplicaSetStatus

ReplicaSetStatus represents the current status of a ReplicaSet.

property availableReplicas

availableReplicas: number;

The number of available replicas (ready for at least minReadySeconds) for this replica set.

property conditions

conditions: ReplicaSetCondition[];

Represents the latest available observations of a replica set’s current state.

property fullyLabeledReplicas

fullyLabeledReplicas: number;

The number of pods that have labels matching the labels of the pod template of the replicaset.

property observedGeneration

observedGeneration: number;

ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

property readyReplicas

readyReplicas: number;

The number of ready replicas for this replica set.

property replicas

replicas: number;

Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

interface RollingUpdateDaemonSet

interface RollingUpdateDaemonSet

Spec to control the desired behavior of daemon set rolling update.

property maxUnavailable

maxUnavailable: number | string;

The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.

interface RollingUpdateDeployment

interface RollingUpdateDeployment

Spec to control the desired behavior of rolling update.

property maxSurge

maxSurge: number | string;

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

property maxUnavailable

maxUnavailable: number | string;

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

interface RollingUpdateStatefulSetStrategy

interface RollingUpdateStatefulSetStrategy

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

property partition

partition: number;

Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.

interface StatefulSet

interface StatefulSet

StatefulSet represents a set of pods with consistent identities. Identities are defined as: - Network: A single stable DNS and hostname. - Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. The value of ‘spec.replicas’ matches ‘.status.replicas’, ‘.status.currentReplicas’, and ‘.status.readyReplicas’.
  2. The value of ‘.status.updateRevision’ matches ‘.status.currentRevision’.

If the StatefulSet has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "apps/v1";

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

property kind

kind: "StatefulSet";

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

property metadata

metadata: ObjectMeta;

property spec

spec: StatefulSetSpec;

Spec defines the desired identities of pods in this set.

property status

status: StatefulSetStatus;

Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

interface StatefulSetCondition

interface StatefulSetCondition

StatefulSetCondition describes the state of a statefulset at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of statefulset condition.

interface StatefulSetSpec

interface StatefulSetSpec

A StatefulSetSpec is the specification of a StatefulSet.

property podManagementPolicy

podManagementPolicy: string;

podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.

property replicas

replicas: number;

replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.

property revisionHistoryLimit

revisionHistoryLimit: number;

revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet’s revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.

property selector

selector: LabelSelector;

selector is a label query over pods that should match the replica count. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property serviceName

serviceName: string;

serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where “pod-specific-string” is managed by the StatefulSet controller.

property template

template: PodTemplateSpec;

template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.

property updateStrategy

updateStrategy: StatefulSetUpdateStrategy;

updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

property volumeClaimTemplates

volumeClaimTemplates: PersistentVolumeClaim[];

volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

interface StatefulSetStatus

interface StatefulSetStatus

StatefulSetStatus represents the current state of a StatefulSet.

property collisionCount

collisionCount: number;

collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

property conditions

conditions: StatefulSetCondition[];

Represents the latest available observations of a statefulset’s current state.

property currentReplicas

currentReplicas: number;

currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.

property currentRevision

currentRevision: string;

currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).

property observedGeneration

observedGeneration: number;

observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet’s generation, which is updated on mutation by the API Server.

property readyReplicas

readyReplicas: number;

readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.

property replicas

replicas: number;

replicas is the number of Pods created by the StatefulSet controller.

property updateRevision

updateRevision: string;

updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)

property updatedReplicas

updatedReplicas: number;

updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

interface StatefulSetUpdateStrategy

interface StatefulSetUpdateStrategy

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

property rollingUpdate

rollingUpdate: RollingUpdateStatefulSetStrategy;

RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.

property type

type: string;

Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.

namespace apps.v1beta1

interface ControllerRevision

interface ControllerRevision

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

property apiVersion

apiVersion: "apps/v1beta1";

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

property data

data: any;

Data is the serialized representation of the state.

property kind

kind: "ControllerRevision";

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

property metadata

metadata: ObjectMeta;

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

property revision

revision: number;

Revision indicates the revision of the state represented by Data.

interface Deployment

interface Deployment

Deployment enables declarative updates for Pods and ReplicaSets.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. The Deployment has begun to be updated by the Deployment controller. If the current generation of the Deployment is > 1, then this means that the current generation must be different from the generation reported by the last outputs.
  2. There exists a ReplicaSet whose revision is equal to the current revision of the Deployment.
  3. The Deployment’s ‘.status.conditions’ has a status of type ‘Available’ whose ‘status’ member is set to ‘True’.
  4. If the Deployment has generation > 1, then ‘.status.conditions’ has a status of type ‘Progressing’, whose ‘status’ member is set to ‘True’, and whose ‘reason’ is ‘NewReplicaSetAvailable’. For generation <= 1, this status field does not exist, because it doesn’t do a rollout (i.e., it simply creates the Deployment and corresponding ReplicaSet), and therefore there is no rollout to mark as ‘Progressing’.

If the Deployment has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "apps/v1beta1";

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

property kind

kind: "Deployment";

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

property metadata

metadata: ObjectMeta;

Standard object metadata.

property spec

spec: DeploymentSpec;

Specification of the desired behavior of the Deployment.

property status

status: DeploymentStatus;

Most recently observed status of the Deployment.

interface DeploymentCondition

interface DeploymentCondition

DeploymentCondition describes the state of a deployment at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property lastUpdateTime

lastUpdateTime: string;

The last time this condition was updated.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of deployment condition.

interface DeploymentSpec

interface DeploymentSpec

DeploymentSpec is the specification of the desired behavior of the Deployment.

property minReadySeconds

minReadySeconds: number;

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

property paused

paused: boolean;

Indicates that the deployment is paused.

property progressDeadlineSeconds

progressDeadlineSeconds: number;

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

property replicas

replicas: number;

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

property revisionHistoryLimit

revisionHistoryLimit: number;

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2.

property rollbackTo

rollbackTo: RollbackConfig;

DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.

property selector

selector: LabelSelector;

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.

property strategy

strategy: DeploymentStrategy;

The deployment strategy to use to replace existing pods with new ones.

property template

template: PodTemplateSpec;

Template describes the pods that will be created.

interface DeploymentStatus

interface DeploymentStatus

DeploymentStatus is the most recently observed status of the Deployment.

property availableReplicas

availableReplicas: number;

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

property collisionCount

collisionCount: number;

Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.

property conditions

conditions: DeploymentCondition[];

Represents the latest available observations of a deployment’s current state.

property observedGeneration

observedGeneration: number;

The generation observed by the deployment controller.

property readyReplicas

readyReplicas: number;

Total number of ready pods targeted by this deployment.

property replicas

replicas: number;

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

property unavailableReplicas

unavailableReplicas: number;

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.

property updatedReplicas

updatedReplicas: number;

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

interface DeploymentStrategy

interface DeploymentStrategy

DeploymentStrategy describes how to replace existing pods with new ones.

property rollingUpdate

rollingUpdate: RollingUpdateDeployment;

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

property type

type: string;

Type of deployment. Can be “Recreate” or “RollingUpdate”. Default is RollingUpdate.

interface RollbackConfig

interface RollbackConfig

DEPRECATED.

property revision

revision: number;

The revision to rollback to. If set to 0, rollback to the last revision.

interface RollingUpdateDeployment

interface RollingUpdateDeployment

Spec to control the desired behavior of rolling update.

property maxSurge

maxSurge: number | string;

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

property maxUnavailable

maxUnavailable: number | string;

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

interface RollingUpdateStatefulSetStrategy

interface RollingUpdateStatefulSetStrategy

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

property partition

partition: number;

Partition indicates the ordinal at which the StatefulSet should be partitioned.

interface StatefulSet

interface StatefulSet

StatefulSet represents a set of pods with consistent identities. Identities are defined as: - Network: A single stable DNS and hostname. - Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. The value of ‘spec.replicas’ matches ‘.status.replicas’, ‘.status.currentReplicas’, and ‘.status.readyReplicas’.
  2. The value of ‘.status.updateRevision’ matches ‘.status.currentRevision’.

If the StatefulSet has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "apps/v1beta1";

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

property kind

kind: "StatefulSet";

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

property metadata

metadata: ObjectMeta;

property spec

spec: StatefulSetSpec;

Spec defines the desired identities of pods in this set.

property status

status: StatefulSetStatus;

Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

interface StatefulSetCondition

interface StatefulSetCondition

StatefulSetCondition describes the state of a statefulset at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of statefulset condition.

interface StatefulSetSpec

interface StatefulSetSpec

A StatefulSetSpec is the specification of a StatefulSet.

property podManagementPolicy

podManagementPolicy: string;

podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.

property replicas

replicas: number;

replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.

property revisionHistoryLimit

revisionHistoryLimit: number;

revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet’s revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.

property selector

selector: LabelSelector;

selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property serviceName

serviceName: string;

serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where “pod-specific-string” is managed by the StatefulSet controller.

property template

template: PodTemplateSpec;

template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.

property updateStrategy

updateStrategy: StatefulSetUpdateStrategy;

updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

property volumeClaimTemplates

volumeClaimTemplates: PersistentVolumeClaim[];

volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

interface StatefulSetStatus

interface StatefulSetStatus

StatefulSetStatus represents the current state of a StatefulSet.

property collisionCount

collisionCount: number;

collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

property conditions

conditions: StatefulSetCondition[];

Represents the latest available observations of a statefulset’s current state.

property currentReplicas

currentReplicas: number;

currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.

property currentRevision

currentRevision: string;

currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).

property observedGeneration

observedGeneration: number;

observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet’s generation, which is updated on mutation by the API Server.

property readyReplicas

readyReplicas: number;

readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.

property replicas

replicas: number;

replicas is the number of Pods created by the StatefulSet controller.

property updateRevision

updateRevision: string;

updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)

property updatedReplicas

updatedReplicas: number;

updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

interface StatefulSetUpdateStrategy

interface StatefulSetUpdateStrategy

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

property rollingUpdate

rollingUpdate: RollingUpdateStatefulSetStrategy;

RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.

property type

type: string;

Type indicates the type of the StatefulSetUpdateStrategy.

namespace apps.v1beta2

interface ControllerRevision

interface ControllerRevision

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

property apiVersion

apiVersion: "apps/v1beta2";

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

property data

data: any;

Data is the serialized representation of the state.

property kind

kind: "ControllerRevision";

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

property metadata

metadata: ObjectMeta;

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

property revision

revision: number;

Revision indicates the revision of the state represented by Data.

interface DaemonSet

interface DaemonSet

DaemonSet represents the configuration of a daemon set.

property apiVersion

apiVersion: "apps/v1beta2";

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

property kind

kind: "DaemonSet";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: DaemonSetSpec;

The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: DaemonSetStatus;

The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface DaemonSetCondition

interface DaemonSetCondition

DaemonSetCondition describes the state of a DaemonSet at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of DaemonSet condition.

interface DaemonSetSpec

interface DaemonSetSpec

DaemonSetSpec is the specification of a daemon set.

property minReadySeconds

minReadySeconds: number;

The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).

property revisionHistoryLimit

revisionHistoryLimit: number;

The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

property selector

selector: LabelSelector;

A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property template

template: PodTemplateSpec;

An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

property updateStrategy

updateStrategy: DaemonSetUpdateStrategy;

An update strategy to replace existing DaemonSet pods with new pods.

interface DaemonSetStatus

interface DaemonSetStatus

DaemonSetStatus represents the current status of a daemon set.

property collisionCount

collisionCount: number;

Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

property conditions

conditions: DaemonSetCondition[];

Represents the latest available observations of a DaemonSet’s current state.

property currentNumberScheduled

currentNumberScheduled: number;

The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

property desiredNumberScheduled

desiredNumberScheduled: number;

The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

property numberAvailable

numberAvailable: number;

The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)

property numberMisscheduled

numberMisscheduled: number;

The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

property numberReady

numberReady: number;

The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.

property numberUnavailable

numberUnavailable: number;

The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)

property observedGeneration

observedGeneration: number;

The most recent generation observed by the daemon set controller.

property updatedNumberScheduled

updatedNumberScheduled: number;

The total number of nodes that are running updated daemon pod

interface DaemonSetUpdateStrategy

interface DaemonSetUpdateStrategy

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

property rollingUpdate

rollingUpdate: RollingUpdateDaemonSet;

Rolling update config params. Present only if type = “RollingUpdate”.

property type

type: string;

Type of daemon set update. Can be “RollingUpdate” or “OnDelete”. Default is RollingUpdate.

interface Deployment

interface Deployment

Deployment enables declarative updates for Pods and ReplicaSets.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. The Deployment has begun to be updated by the Deployment controller. If the current generation of the Deployment is > 1, then this means that the current generation must be different from the generation reported by the last outputs.
  2. There exists a ReplicaSet whose revision is equal to the current revision of the Deployment.
  3. The Deployment’s ‘.status.conditions’ has a status of type ‘Available’ whose ‘status’ member is set to ‘True’.
  4. If the Deployment has generation > 1, then ‘.status.conditions’ has a status of type ‘Progressing’, whose ‘status’ member is set to ‘True’, and whose ‘reason’ is ‘NewReplicaSetAvailable’. For generation <= 1, this status field does not exist, because it doesn’t do a rollout (i.e., it simply creates the Deployment and corresponding ReplicaSet), and therefore there is no rollout to mark as ‘Progressing’.

If the Deployment has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "apps/v1beta2";

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

property kind

kind: "Deployment";

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

property metadata

metadata: ObjectMeta;

Standard object metadata.

property spec

spec: DeploymentSpec;

Specification of the desired behavior of the Deployment.

property status

status: DeploymentStatus;

Most recently observed status of the Deployment.

interface DeploymentCondition

interface DeploymentCondition

DeploymentCondition describes the state of a deployment at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property lastUpdateTime

lastUpdateTime: string;

The last time this condition was updated.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of deployment condition.

interface DeploymentSpec

interface DeploymentSpec

DeploymentSpec is the specification of the desired behavior of the Deployment.

property minReadySeconds

minReadySeconds: number;

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

property paused

paused: boolean;

Indicates that the deployment is paused.

property progressDeadlineSeconds

progressDeadlineSeconds: number;

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

property replicas

replicas: number;

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

property revisionHistoryLimit

revisionHistoryLimit: number;

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

property selector

selector: LabelSelector;

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template’s labels.

property strategy

strategy: DeploymentStrategy;

The deployment strategy to use to replace existing pods with new ones.

property template

template: PodTemplateSpec;

Template describes the pods that will be created.

interface DeploymentStatus

interface DeploymentStatus

DeploymentStatus is the most recently observed status of the Deployment.

property availableReplicas

availableReplicas: number;

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

property collisionCount

collisionCount: number;

Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.

property conditions

conditions: DeploymentCondition[];

Represents the latest available observations of a deployment’s current state.

property observedGeneration

observedGeneration: number;

The generation observed by the deployment controller.

property readyReplicas

readyReplicas: number;

Total number of ready pods targeted by this deployment.

property replicas

replicas: number;

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

property unavailableReplicas

unavailableReplicas: number;

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.

property updatedReplicas

updatedReplicas: number;

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

interface DeploymentStrategy

interface DeploymentStrategy

DeploymentStrategy describes how to replace existing pods with new ones.

property rollingUpdate

rollingUpdate: RollingUpdateDeployment;

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

property type

type: string;

Type of deployment. Can be “Recreate” or “RollingUpdate”. Default is RollingUpdate.

interface ReplicaSet

interface ReplicaSet

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

property apiVersion

apiVersion: "apps/v1beta2";

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

property kind

kind: "ReplicaSet";

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

property metadata

metadata: ObjectMeta;

If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property spec

spec: ReplicaSetSpec;

Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: ReplicaSetStatus;

Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface ReplicaSetCondition

interface ReplicaSetCondition

ReplicaSetCondition describes the state of a replica set at a certain point.

property lastTransitionTime

lastTransitionTime: string;

The last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of replica set condition.

interface ReplicaSetSpec

interface ReplicaSetSpec

ReplicaSetSpec is the specification of a ReplicaSet.

property minReadySeconds

minReadySeconds: number;

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

property replicas

replicas: number;

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

property selector

selector: LabelSelector;

Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property template

template: PodTemplateSpec;

Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

interface ReplicaSetStatus

interface ReplicaSetStatus

ReplicaSetStatus represents the current status of a ReplicaSet.

property availableReplicas

availableReplicas: number;

The number of available replicas (ready for at least minReadySeconds) for this replica set.

property conditions

conditions: ReplicaSetCondition[];

Represents the latest available observations of a replica set’s current state.

property fullyLabeledReplicas

fullyLabeledReplicas: number;

The number of pods that have labels matching the labels of the pod template of the replicaset.

property observedGeneration

observedGeneration: number;

ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

property readyReplicas

readyReplicas: number;

The number of ready replicas for this replica set.

property replicas

replicas: number;

Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

interface RollingUpdateDaemonSet

interface RollingUpdateDaemonSet

Spec to control the desired behavior of daemon set rolling update.

property maxUnavailable

maxUnavailable: number | string;

The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.

interface RollingUpdateDeployment

interface RollingUpdateDeployment

Spec to control the desired behavior of rolling update.

property maxSurge

maxSurge: number | string;

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

property maxUnavailable

maxUnavailable: number | string;

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

interface RollingUpdateStatefulSetStrategy

interface RollingUpdateStatefulSetStrategy

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

property partition

partition: number;

Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.

interface StatefulSet

interface StatefulSet

StatefulSet represents a set of pods with consistent identities. Identities are defined as: - Network: A single stable DNS and hostname. - Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. The value of ‘spec.replicas’ matches ‘.status.replicas’, ‘.status.currentReplicas’, and ‘.status.readyReplicas’.
  2. The value of ‘.status.updateRevision’ matches ‘.status.currentRevision’.

If the StatefulSet has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "apps/v1beta2";

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

property kind

kind: "StatefulSet";

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

property metadata

metadata: ObjectMeta;

property spec

spec: StatefulSetSpec;

Spec defines the desired identities of pods in this set.

property status

status: StatefulSetStatus;

Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

interface StatefulSetCondition

interface StatefulSetCondition

StatefulSetCondition describes the state of a statefulset at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of statefulset condition.

interface StatefulSetSpec

interface StatefulSetSpec

A StatefulSetSpec is the specification of a StatefulSet.

property podManagementPolicy

podManagementPolicy: string;

podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.

property replicas

replicas: number;

replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.

property revisionHistoryLimit

revisionHistoryLimit: number;

revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet’s revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.

property selector

selector: LabelSelector;

selector is a label query over pods that should match the replica count. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property serviceName

serviceName: string;

serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where “pod-specific-string” is managed by the StatefulSet controller.

property template

template: PodTemplateSpec;

template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.

property updateStrategy

updateStrategy: StatefulSetUpdateStrategy;

updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

property volumeClaimTemplates

volumeClaimTemplates: PersistentVolumeClaim[];

volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

interface StatefulSetStatus

interface StatefulSetStatus

StatefulSetStatus represents the current state of a StatefulSet.

property collisionCount

collisionCount: number;

collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

property conditions

conditions: StatefulSetCondition[];

Represents the latest available observations of a statefulset’s current state.

property currentReplicas

currentReplicas: number;

currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.

property currentRevision

currentRevision: string;

currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).

property observedGeneration

observedGeneration: number;

observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet’s generation, which is updated on mutation by the API Server.

property readyReplicas

readyReplicas: number;

readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.

property replicas

replicas: number;

replicas is the number of Pods created by the StatefulSet controller.

property updateRevision

updateRevision: string;

updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)

property updatedReplicas

updatedReplicas: number;

updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

interface StatefulSetUpdateStrategy

interface StatefulSetUpdateStrategy

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

property rollingUpdate

rollingUpdate: RollingUpdateStatefulSetStrategy;

RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.

property type

type: string;

Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.

namespace auditregistration.v1alpha1

interface AuditSink

interface AuditSink

AuditSink represents a cluster level audit sink

property apiVersion

apiVersion: "auditregistration.k8s.io/v1alpha1";

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

property kind

kind: "AuditSink";

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

property metadata

metadata: ObjectMeta;

property spec

spec: AuditSinkSpec;

Spec defines the audit configuration spec

interface AuditSinkSpec

interface AuditSinkSpec

AuditSinkSpec holds the spec for the audit sink

property policy

policy: Policy;

Policy defines the policy for selecting which events should be sent to the webhook required

property webhook

webhook: Webhook;

Webhook to send events required

interface Policy

interface Policy

Policy defines the configuration of how audit events are logged

property level

level: string;

The Level that all requests are recorded at. available options: None, Metadata, Request, RequestResponse required

property stages

stages: string[];

Stages is a list of stages for which events are created.

interface ServiceReference

interface ServiceReference

ServiceReference holds a reference to Service.legacy.k8s.io

property name

name: string;

name is the name of the service. Required

property namespace

namespace: string;

namespace is the namespace of the service. Required

property path

path: string;

path is an optional URL path which will be sent in any request to this service.

property port

port: number;

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

interface Webhook

interface Webhook

Webhook holds the configuration of the webhook

property clientConfig

clientConfig: WebhookClientConfig;

ClientConfig holds the connection parameters for the webhook required

property throttle

throttle: WebhookThrottleConfig;

Throttle holds the options for throttling the webhook

interface WebhookClientConfig

interface WebhookClientConfig

WebhookClientConfig contains the information to make a connection with the webhook

property caBundle

caBundle: string;

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.

property service

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.

property url

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.

interface WebhookThrottleConfig

interface WebhookThrottleConfig

WebhookThrottleConfig holds the configuration for throttling events

property burst

burst: number;

ThrottleBurst is the maximum number of events sent at the same moment default 15 QPS

property qps

qps: number;

ThrottleQPS maximum number of batches per second default 10 QPS

namespace authentication.v1

interface BoundObjectReference

interface BoundObjectReference

BoundObjectReference is a reference to an object that a token is bound to.

property apiVersion

apiVersion: string;

API version of the referent.

property kind

kind: string;

Kind of the referent. Valid kinds are ‘Pod’ and ‘Secret’.

property name

name: string;

Name of the referent.

property uid

uid: string;

UID of the referent.

interface TokenRequestSpec

interface TokenRequestSpec

TokenRequestSpec contains client provided parameters of a token request.

property audiences

audiences: string[];

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.

property boundObjectRef

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.

property expirationSeconds

expirationSeconds: number;

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.

interface TokenRequestStatus

interface TokenRequestStatus

TokenRequestStatus is the result of a token request.

property expirationTimestamp

expirationTimestamp: string;

ExpirationTimestamp is the time of expiration of the returned token.

property token

token: string;

Token is the opaque bearer token.

interface TokenReviewSpec

interface TokenReviewSpec

TokenReviewSpec is a description of the token authentication request.

property audiences

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.

property token

token: string;

Token is the opaque bearer token.

interface TokenReviewStatus

interface TokenReviewStatus

TokenReviewStatus is the result of the token authentication request.

property audiences

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.

property authenticated

authenticated: boolean;

Authenticated indicates that the token was associated with a known user.

property error

error: string;

Error indicates that the token couldn’t be checked

property user

user: UserInfo;

User is the UserInfo associated with the provided token.

interface UserInfo

interface UserInfo

UserInfo holds the information about the user needed to implement the user.Info interface.

property extra

extra: {[key: string]: string[]};

Any additional information provided by the authenticator.

property groups

groups: string[];

The names of groups this user is a part of.

property uid

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.

property username

username: string;

The name that uniquely identifies this user among all active users.

namespace authentication.v1beta1

interface TokenReviewSpec

interface TokenReviewSpec

TokenReviewSpec is a description of the token authentication request.

property audiences

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.

property token

token: string;

Token is the opaque bearer token.

interface TokenReviewStatus

interface TokenReviewStatus

TokenReviewStatus is the result of the token authentication request.

property audiences

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.

property authenticated

authenticated: boolean;

Authenticated indicates that the token was associated with a known user.

property error

error: string;

Error indicates that the token couldn’t be checked

property user

user: UserInfo;

User is the UserInfo associated with the provided token.

interface UserInfo

interface UserInfo

UserInfo holds the information about the user needed to implement the user.Info interface.

property extra

extra: {[key: string]: string[]};

Any additional information provided by the authenticator.

property groups

groups: string[];

The names of groups this user is a part of.

property uid

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.

property username

username: string;

The name that uniquely identifies this user among all active users.

namespace authorization.v1

interface NonResourceAttributes

interface NonResourceAttributes

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

property path

path: string;

Path is the URL path of the request

property verb

verb: string;

Verb is the standard HTTP verb

interface NonResourceRule

interface NonResourceRule

NonResourceRule holds information that describes a rule for the non-resource

property nonResourceURLs

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.

property verbs

verbs: string[];

Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. “*” means all.

interface ResourceAttributes

interface ResourceAttributes

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

property group

group: string;

Group is the API Group of the Resource. “*” means all.

property name

name: string;

Name is the name of the resource being requested for a “get” or deleted for a “delete”. “” (empty) means all.

property namespace

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

property resource

resource: string;

Resource is one of the existing resource types. “*” means all.

property subresource

subresource: string;

Subresource is one of the existing resource types. “” means none.

property verb

verb: string;

Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. “*” means all.

property version

version: string;

Version is the API Version of the Resource. “*” means all.

interface ResourceRule

interface ResourceRule

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.

property apiGroups

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.

property resourceNames

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.

property resources

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.

property verbs

verbs: string[];

Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. “*” means all.

interface SelfSubjectAccessReviewSpec

interface SelfSubjectAccessReviewSpec

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

property nonResourceAttributes

nonResourceAttributes: NonResourceAttributes;

NonResourceAttributes describes information for a non-resource access request

property resourceAttributes

resourceAttributes: ResourceAttributes;

ResourceAuthorizationAttributes describes information for a resource access request

interface SelfSubjectRulesReviewSpec

interface SelfSubjectRulesReviewSpec

property namespace

namespace: string;

Namespace to evaluate rules for. Required.

interface SubjectAccessReviewSpec

interface SubjectAccessReviewSpec

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

property extra

extra: {[key: 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.

property groups

groups: string[];

Groups is the groups you’re testing for.

property nonResourceAttributes

nonResourceAttributes: NonResourceAttributes;

NonResourceAttributes describes information for a non-resource access request

property resourceAttributes

resourceAttributes: ResourceAttributes;

ResourceAuthorizationAttributes describes information for a resource access request

property uid

uid: string;

UID information about the requesting user.

property 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

interface SubjectAccessReviewStatus

interface SubjectAccessReviewStatus

SubjectAccessReviewStatus

property allowed

allowed: boolean;

Allowed is required. True if the action would be allowed, false otherwise.

property denied

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.

property evaluationError

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.

property reason

reason: string;

Reason is optional. It indicates why a request was allowed or denied.

interface SubjectRulesReviewStatus

interface SubjectRulesReviewStatus

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.

property evaluationError

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.

property incomplete

incomplete: boolean;

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.

property nonResourceRules

nonResourceRules: NonResourceRule[];

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.

property resourceRules

resourceRules: ResourceRule[];

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.

namespace authorization.v1beta1

interface NonResourceAttributes

interface NonResourceAttributes

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

property path

path: string;

Path is the URL path of the request

property verb

verb: string;

Verb is the standard HTTP verb

interface NonResourceRule

interface NonResourceRule

NonResourceRule holds information that describes a rule for the non-resource

property nonResourceURLs

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.

property verbs

verbs: string[];

Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. “*” means all.

interface ResourceAttributes

interface ResourceAttributes

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

property group

group: string;

Group is the API Group of the Resource. “*” means all.

property name

name: string;

Name is the name of the resource being requested for a “get” or deleted for a “delete”. “” (empty) means all.

property namespace

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

property resource

resource: string;

Resource is one of the existing resource types. “*” means all.

property subresource

subresource: string;

Subresource is one of the existing resource types. “” means none.

property verb

verb: string;

Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. “*” means all.

property version

version: string;

Version is the API Version of the Resource. “*” means all.

interface ResourceRule

interface ResourceRule

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.

property apiGroups

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.

property resourceNames

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.

property resources

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.

property verbs

verbs: string[];

Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. “*” means all.

interface SelfSubjectAccessReviewSpec

interface SelfSubjectAccessReviewSpec

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

property nonResourceAttributes

nonResourceAttributes: NonResourceAttributes;

NonResourceAttributes describes information for a non-resource access request

property resourceAttributes

resourceAttributes: ResourceAttributes;

ResourceAuthorizationAttributes describes information for a resource access request

interface SelfSubjectRulesReviewSpec

interface SelfSubjectRulesReviewSpec

property namespace

namespace: string;

Namespace to evaluate rules for. Required.

interface SubjectAccessReviewSpec

interface SubjectAccessReviewSpec

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

property extra

extra: {[key: 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.

property group

group: string[];

Groups is the groups you’re testing for.

property nonResourceAttributes

nonResourceAttributes: NonResourceAttributes;

NonResourceAttributes describes information for a non-resource access request

property resourceAttributes

resourceAttributes: ResourceAttributes;

ResourceAuthorizationAttributes describes information for a resource access request

property uid

uid: string;

UID information about the requesting user.

property user

user: string;

User is the user you’re testing for. If you specify “User” but not “Group”, then is it interpreted as “What if User were not a member of any groups

interface SubjectAccessReviewStatus

interface SubjectAccessReviewStatus

SubjectAccessReviewStatus

property allowed

allowed: boolean;

Allowed is required. True if the action would be allowed, false otherwise.

property denied

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.

property evaluationError

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.

property reason

reason: string;

Reason is optional. It indicates why a request was allowed or denied.

interface SubjectRulesReviewStatus

interface SubjectRulesReviewStatus

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.

property evaluationError

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.

property incomplete

incomplete: boolean;

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.

property nonResourceRules

nonResourceRules: NonResourceRule[];

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.

property resourceRules

resourceRules: ResourceRule[];

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.

namespace autoscaling.v1

interface CrossVersionObjectReference

interface CrossVersionObjectReference

CrossVersionObjectReference contains enough information to let you identify the referred resource.

property apiVersion

apiVersion: string;

API version of the referent

property kind

kind: string;

Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

property name

name: string;

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

interface HorizontalPodAutoscaler

interface HorizontalPodAutoscaler

configuration of a horizontal pod autoscaler.

property apiVersion

apiVersion: "autoscaling/v1";

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

property kind

kind: "HorizontalPodAutoscaler";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: HorizontalPodAutoscalerSpec;

behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.

property status

status: HorizontalPodAutoscalerStatus;

current information about the autoscaler.

interface HorizontalPodAutoscalerSpec

interface HorizontalPodAutoscalerSpec

specification of a horizontal pod autoscaler.

property maxReplicas

maxReplicas: number;

upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.

property minReplicas

minReplicas: number;

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.

property scaleTargetRef

scaleTargetRef: CrossVersionObjectReference;

reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.

property targetCPUUtilizationPercentage

targetCPUUtilizationPercentage: number;

target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.

interface HorizontalPodAutoscalerStatus

interface HorizontalPodAutoscalerStatus

current status of a horizontal pod autoscaler

property currentCPUUtilizationPercentage

currentCPUUtilizationPercentage: number;

current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.

property currentReplicas

currentReplicas: number;

current number of replicas of pods managed by this autoscaler.

property desiredReplicas

desiredReplicas: number;

desired number of replicas of pods managed by this autoscaler.

property lastScaleTime

lastScaleTime: string;

last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.

property observedGeneration

observedGeneration: number;

most recent generation observed by this autoscaler.

namespace autoscaling.v2beta1

interface CrossVersionObjectReference

interface CrossVersionObjectReference

CrossVersionObjectReference contains enough information to let you identify the referred resource.

property apiVersion

apiVersion: string;

API version of the referent

property kind

kind: string;

Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

property name

name: string;

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

interface ExternalMetricSource

interface ExternalMetricSource

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). Exactly one “target” type should be set.

property metricName

metricName: string;

metricName is the name of the metric in question.

property metricSelector

metricSelector: LabelSelector;

metricSelector is used to identify a specific time series within a given metric.

property targetAverageValue

targetAverageValue: string;

targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue.

property targetValue

targetValue: string;

targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue.

interface ExternalMetricStatus

interface ExternalMetricStatus

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

property currentAverageValue

currentAverageValue: string;

currentAverageValue is the current value of metric averaged over autoscaled pods.

property currentValue

currentValue: string;

currentValue is the current value of the metric (as a quantity)

property metricName

metricName: string;

metricName is the name of a metric used for autoscaling in metric system.

property metricSelector

metricSelector: LabelSelector;

metricSelector is used to identify a specific time series within a given metric.

interface HorizontalPodAutoscaler

interface HorizontalPodAutoscaler

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

property apiVersion

apiVersion: "autoscaling/v2beta1";

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

property kind

kind: "HorizontalPodAutoscaler";

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

property metadata

metadata: ObjectMeta;

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

property spec

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.

property status

status: HorizontalPodAutoscalerStatus;

status is the current information about the autoscaler.

interface HorizontalPodAutoscalerCondition

interface HorizontalPodAutoscalerCondition

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

property lastTransitionTime

lastTransitionTime: string;

lastTransitionTime is the last time the condition transitioned from one status to another

property message

message: string;

message is a human-readable explanation containing details about the transition

property reason

reason: string;

reason is the reason for the condition’s last transition.

property status

status: string;

status is the status of the condition (True, False, Unknown)

property type

type: string;

type describes the current condition

interface HorizontalPodAutoscalerSpec

interface HorizontalPodAutoscalerSpec

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

property maxReplicas

maxReplicas: number;

maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.

property metrics

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.

property minReplicas

minReplicas: number;

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.

property scaleTargetRef

scaleTargetRef: CrossVersionObjectReference;

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.

interface HorizontalPodAutoscalerStatus

interface HorizontalPodAutoscalerStatus

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

property conditions

conditions: HorizontalPodAutoscalerCondition[];

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

property currentMetrics

currentMetrics: MetricStatus[];

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

property currentReplicas

currentReplicas: number;

currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.

property desiredReplicas

desiredReplicas: number;

desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.

property lastScaleTime

lastScaleTime: string;

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.

property observedGeneration

observedGeneration: number;

observedGeneration is the most recent generation observed by this autoscaler.

interface MetricSpec

interface MetricSpec

MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).

property external

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

property object

object: ObjectMetricSource;

object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).

property pods

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.

property resource

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.

property type

type: string;

type is the type of metric source. It should be one of “Object”, “Pods” or “Resource”, each mapping to a matching field in the object.

interface MetricStatus

interface MetricStatus

MetricStatus describes the last-read state of a single metric.

property external

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

property object

object: ObjectMetricStatus;

object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).

property pods

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.

property resource

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.

property type

type: string;

type is the type of metric source. It will be one of “Object”, “Pods” or “Resource”, each corresponds to a matching field in the object.

interface ObjectMetricSource

interface ObjectMetricSource

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

property averageValue

averageValue: string;

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

property metricName

metricName: string;

metricName is the name of the metric in question.

property selector

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.

property target

target: CrossVersionObjectReference;

target is the described Kubernetes object.

property targetValue

targetValue: string;

targetValue is the target value of the metric (as a quantity).

interface ObjectMetricStatus

interface ObjectMetricStatus

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

property averageValue

averageValue: string;

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

property currentValue

currentValue: string;

currentValue is the current value of the metric (as a quantity).

property metricName

metricName: string;

metricName is the name of the metric in question.

property selector

selector: LabelSelector;

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the ObjectMetricSource, 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.

property target

target: CrossVersionObjectReference;

target is the described Kubernetes object.

interface PodsMetricSource

interface PodsMetricSource

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.

property metricName

metricName: string;

metricName is the name of the metric in question

property selector

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.

property targetAverageValue

targetAverageValue: string;

targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity)

interface PodsMetricStatus

interface PodsMetricStatus

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

property currentAverageValue

currentAverageValue: string;

currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity)

property metricName

metricName: string;

metricName is the name of the metric in question

property selector

selector: LabelSelector;

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the PodsMetricSource, 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.

interface ResourceMetricSource

interface ResourceMetricSource

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.

property name

name: string;

name is the name of the resource in question.

property targetAverageUtilization

targetAverageUtilization: number;

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

property targetAverageValue

targetAverageValue: string;

targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the “pods” metric source type.

interface ResourceMetricStatus

interface ResourceMetricStatus

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.

property currentAverageUtilization

currentAverageUtilization: number;

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. It will only be present if targetAverageValue was set in the corresponding metric specification.

property currentAverageValue

currentAverageValue: string;

currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the “pods” metric source type. It will always be set, regardless of the corresponding metric specification.

property name

name: string;

name is the name of the resource in question.

namespace autoscaling.v2beta2

interface CrossVersionObjectReference

interface CrossVersionObjectReference

CrossVersionObjectReference contains enough information to let you identify the referred resource.

property apiVersion

apiVersion: string;

API version of the referent

property kind

kind: string;

Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

property name

name: string;

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

interface ExternalMetricSource

interface ExternalMetricSource

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

property metric

metric: MetricIdentifier;

metric identifies the target metric by name and selector

property target

target: MetricTarget;

target specifies the target value for the given metric

interface ExternalMetricStatus

interface ExternalMetricStatus

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

property current

current: MetricValueStatus;

current contains the current value for the given metric

property metric

metric: MetricIdentifier;

metric identifies the target metric by name and selector

interface HorizontalPodAutoscaler

interface HorizontalPodAutoscaler

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

property apiVersion

apiVersion: "autoscaling/v2beta2";

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

property kind

kind: "HorizontalPodAutoscaler";

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

property metadata

metadata: ObjectMeta;

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

property spec

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.

property status

status: HorizontalPodAutoscalerStatus;

status is the current information about the autoscaler.

interface HorizontalPodAutoscalerBehavior

interface HorizontalPodAutoscalerBehavior

HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

property scaleDown

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

property scaleUp

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.

interface HorizontalPodAutoscalerCondition

interface HorizontalPodAutoscalerCondition

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

property lastTransitionTime

lastTransitionTime: string;

lastTransitionTime is the last time the condition transitioned from one status to another

property message

message: string;

message is a human-readable explanation containing details about the transition

property reason

reason: string;

reason is the reason for the condition’s last transition.

property status

status: string;

status is the status of the condition (True, False, Unknown)

property type

type: string;

type describes the current condition

interface HorizontalPodAutoscalerSpec

interface HorizontalPodAutoscalerSpec

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

property behavior

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.

property maxReplicas

maxReplicas: number;

maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.

property metrics

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.

property minReplicas

minReplicas: number;

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.

property scaleTargetRef

scaleTargetRef: CrossVersionObjectReference;

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.

interface HorizontalPodAutoscalerStatus

interface HorizontalPodAutoscalerStatus

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

property conditions

conditions: HorizontalPodAutoscalerCondition[];

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

property currentMetrics

currentMetrics: MetricStatus[];

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

property currentReplicas

currentReplicas: number;

currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.

property desiredReplicas

desiredReplicas: number;

desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.

property lastScaleTime

lastScaleTime: string;

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.

property observedGeneration

observedGeneration: number;

observedGeneration is the most recent generation observed by this autoscaler.

interface HPAScalingPolicy

interface HPAScalingPolicy

HPAScalingPolicy is a single policy which must hold true for a specified past interval.

property periodSeconds

periodSeconds: number;

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

property type

type: string;

Type is used to specify the scaling policy.

property value

value: number;

Value contains the amount of change which is permitted by the policy. It must be greater than zero

interface HPAScalingRules

interface HPAScalingRules

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.

property policies

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

property selectPolicy

selectPolicy: string;

selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.

property stabilizationWindowSeconds

stabilizationWindowSeconds: number;

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

interface MetricIdentifier

interface MetricIdentifier

MetricIdentifier defines the name and optionally selector for a metric

property name

name: string;

name is the name of the given metric

property selector

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.

interface MetricSpec

interface MetricSpec

MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).

property external

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

property object

object: ObjectMetricSource;

object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).

property pods

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.

property resource

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.

property type

type: string;

type is the type of metric source. It should be one of “Object”, “Pods” or “Resource”, each mapping to a matching field in the object.

interface MetricStatus

interface MetricStatus

MetricStatus describes the last-read state of a single metric.

property external

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

property object

object: ObjectMetricStatus;

object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).

property pods

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.

property resource

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.

property type

type: string;

type is the type of metric source. It will be one of “Object”, “Pods” or “Resource”, each corresponds to a matching field in the object.

interface MetricTarget

interface MetricTarget

MetricTarget defines the target value, average value, or average utilization of a specific metric

property averageUtilization

averageUtilization: number;

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

property averageValue

averageValue: string;

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)

property type

type: string;

type represents whether the metric type is Utilization, Value, or AverageValue

property value

value: string;

value is the target value of the metric (as a quantity).

interface MetricValueStatus

interface MetricValueStatus

MetricValueStatus holds the current value for a metric

property averageUtilization

averageUtilization: number;

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.

property averageValue

averageValue: string;

averageValue is the current value of the average of the metric across all relevant pods (as a quantity)

property value

value: string;

value is the current value of the metric (as a quantity).

interface ObjectMetricSource

interface ObjectMetricSource

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

property describedObject

describedObject: CrossVersionObjectReference;

property metric

metric: MetricIdentifier;

metric identifies the target metric by name and selector

property target

target: MetricTarget;

target specifies the target value for the given metric

interface ObjectMetricStatus

interface ObjectMetricStatus

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

property current

current: MetricValueStatus;

current contains the current value for the given metric

property describedObject

describedObject: CrossVersionObjectReference;

property metric

metric: MetricIdentifier;

metric identifies the target metric by name and selector

interface PodsMetricSource

interface PodsMetricSource

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.

property metric

metric: MetricIdentifier;

metric identifies the target metric by name and selector

property target

target: MetricTarget;

target specifies the target value for the given metric

interface PodsMetricStatus

interface PodsMetricStatus

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

property current

current: MetricValueStatus;

current contains the current value for the given metric

property metric

metric: MetricIdentifier;

metric identifies the target metric by name and selector

interface ResourceMetricSource

interface ResourceMetricSource

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.

property name

name: string;

name is the name of the resource in question.

property target

target: MetricTarget;

target specifies the target value for the given metric

interface ResourceMetricStatus

interface ResourceMetricStatus

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.

property current

current: MetricValueStatus;

current contains the current value for the given metric

property name

name: string;

Name is the name of the resource in question.

namespace batch.v1

interface Job

interface Job

Job represents the configuration of a single job.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. The Job’s ‘.status.startTime’ is set, which indicates that the Job has started running.
  2. The Job’s ‘.status.conditions’ has a status of type ‘Complete’, and a ‘status’ set to ‘True’.
  3. The Job’s ‘.status.conditions’ do not have a status of type ‘Failed’, with a ‘status’ set to ‘True’. If this condition is set, we should fail the Job immediately.

If the Job has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "batch/v1";

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

property kind

kind: "Job";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: JobSpec;

Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: JobStatus;

Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface JobCondition

interface JobCondition

JobCondition describes current state of a job.

property lastProbeTime

lastProbeTime: string;

Last time the condition was checked.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transit from one status to another.

property message

message: string;

Human readable message indicating details about last transition.

property reason

reason: string;

(brief) reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of job condition, Complete or Failed.

interface JobSpec

interface JobSpec

JobSpec describes how the job execution will look like.

property activeDeadlineSeconds

activeDeadlineSeconds: number;

Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

property backoffLimit

backoffLimit: number;

Specifies the number of retries before marking this job failed. Defaults to 6

property completions

completions: number;

Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

property manualSelector

manualSelector: boolean;

manualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector

property parallelism

parallelism: number;

Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

property selector

selector: LabelSelector;

A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property template

template: PodTemplateSpec;

Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

property ttlSecondsAfterFinished

ttlSecondsAfterFinished: number;

ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won’t be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.

interface JobStatus

interface JobStatus

JobStatus represents the current state of a Job.

property active

active: number;

The number of actively running pods.

property completionTime

completionTime: string;

Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

property conditions

conditions: JobCondition[];

The latest available observations of an object’s current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

property failed

failed: number;

The number of pods which reached phase Failed.

property startTime

startTime: string;

Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

property succeeded

succeeded: number;

The number of pods which reached phase Succeeded.

namespace batch.v1beta1

interface CronJob

interface CronJob

CronJob represents the configuration of a single cron job.

property apiVersion

apiVersion: "batch/v1beta1";

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

property kind

kind: "CronJob";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: CronJobSpec;

Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: CronJobStatus;

Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface CronJobSpec

interface CronJobSpec

CronJobSpec describes how the job execution will look like and when it will actually run.

property concurrencyPolicy

concurrencyPolicy: string;

Specifies how to treat concurrent executions of a Job. Valid values are: - “Allow” (default): allows CronJobs to run concurrently; - “Forbid”: forbids concurrent runs, skipping next run if previous run hasn’t finished yet; - “Replace”: cancels currently running job and replaces it with a new one

property failedJobsHistoryLimit

failedJobsHistoryLimit: number;

The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

property jobTemplate

jobTemplate: JobTemplateSpec;

Specifies the job that will be created when executing a CronJob.

property schedule

schedule: string;

The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

property startingDeadlineSeconds

startingDeadlineSeconds: number;

Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

property successfulJobsHistoryLimit

successfulJobsHistoryLimit: number;

The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.

property suspend

suspend: boolean;

This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

interface CronJobStatus

interface CronJobStatus

CronJobStatus represents the current state of a cron job.

property active

active: ObjectReference[];

A list of pointers to currently running jobs.

property lastScheduleTime

lastScheduleTime: string;

Information when was the last time the job was successfully scheduled.

interface JobTemplateSpec

interface JobTemplateSpec

JobTemplateSpec describes the data a Job should have when created from a template

property metadata

metadata: ObjectMeta;

Standard object’s metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property spec

spec: JobSpec;

Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

namespace batch.v2alpha1

interface CronJob

interface CronJob

CronJob represents the configuration of a single cron job.

property apiVersion

apiVersion: "batch/v2alpha1";

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

property kind

kind: "CronJob";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: CronJobSpec;

Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: CronJobStatus;

Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface CronJobSpec

interface CronJobSpec

CronJobSpec describes how the job execution will look like and when it will actually run.

property concurrencyPolicy

concurrencyPolicy: string;

Specifies how to treat concurrent executions of a Job. Valid values are: - “Allow” (default): allows CronJobs to run concurrently; - “Forbid”: forbids concurrent runs, skipping next run if previous run hasn’t finished yet; - “Replace”: cancels currently running job and replaces it with a new one

property failedJobsHistoryLimit

failedJobsHistoryLimit: number;

The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.

property jobTemplate

jobTemplate: JobTemplateSpec;

Specifies the job that will be created when executing a CronJob.

property schedule

schedule: string;

The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

property startingDeadlineSeconds

startingDeadlineSeconds: number;

Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

property successfulJobsHistoryLimit

successfulJobsHistoryLimit: number;

The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.

property suspend

suspend: boolean;

This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

interface CronJobStatus

interface CronJobStatus

CronJobStatus represents the current state of a cron job.

property active

active: ObjectReference[];

A list of pointers to currently running jobs.

property lastScheduleTime

lastScheduleTime: string;

Information when was the last time the job was successfully scheduled.

interface JobTemplateSpec

interface JobTemplateSpec

JobTemplateSpec describes the data a Job should have when created from a template

property metadata

metadata: ObjectMeta;

Standard object’s metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property spec

spec: JobSpec;

Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

namespace certificates.v1beta1

interface CertificateSigningRequest

interface CertificateSigningRequest

Describes a certificate signing request

property apiVersion

apiVersion: "certificates.k8s.io/v1beta1";

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

property kind

kind: "CertificateSigningRequest";

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

property metadata

metadata: ObjectMeta;

property spec

spec: CertificateSigningRequestSpec;

The certificate request itself and any additional information.

property status

status: CertificateSigningRequestStatus;

Derived information about the request.

interface CertificateSigningRequestCondition

interface CertificateSigningRequestCondition

property lastUpdateTime

lastUpdateTime: string;

timestamp for the last update to this condition

property message

message: string;

human readable message with details about the request state

property reason

reason: string;

brief reason for the request state

property type

type: string;

request approval state, currently Approved or Denied.

interface CertificateSigningRequestSpec

interface CertificateSigningRequestSpec

This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.

property extra

extra: {[key: string]: string[]};

Extra information about the requesting user. See user.Info interface for details.

property groups

groups: string[];

Group information about the requesting user. See user.Info interface for details.

property request

request: string;

Base64-encoded PKCS#10 CSR data

property signerName

signerName: string;

Requested signer for the request. It is a qualified name in the form: scope-hostname.io/name. If empty, it will be defaulted: 1. If it’s a kubelet client certificate, it is assigned “kubernetes.io/kube-apiserver-client-kubelet”. 2. If it’s a kubelet serving certificate, it is assigned “kubernetes.io/kubelet-serving”. 3. Otherwise, it is assigned “kubernetes.io/legacy-unknown”. Distribution of trust for signers happens out of band. You can select on this field using spec.signerName.

property uid

uid: string;

UID information about the requesting user. See user.Info interface for details.

property usages

usages: string[];

allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12

property username

username: string;

Information about the requesting user. See user.Info interface for details.

interface CertificateSigningRequestStatus

interface CertificateSigningRequestStatus

property certificate

certificate: string;

If request was approved, the controller will place the issued certificate here.

property conditions

conditions: CertificateSigningRequestCondition[];

Conditions applied to the request, such as approval or denial.

namespace coordination.v1

interface Lease

interface Lease

Lease defines a lease concept.

property apiVersion

apiVersion: "coordination.k8s.io/v1";

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

property kind

kind: "Lease";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: LeaseSpec;

Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface LeaseSpec

interface LeaseSpec

LeaseSpec is a specification of a Lease.

property acquireTime

acquireTime: string;

acquireTime is a time when the current lease was acquired.

property holderIdentity

holderIdentity: string;

holderIdentity contains the identity of the holder of a current lease.

property leaseDurationSeconds

leaseDurationSeconds: number;

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.

property leaseTransitions

leaseTransitions: number;

leaseTransitions is the number of transitions of a lease between holders.

property renewTime

renewTime: string;

renewTime is a time when the current holder of a lease has last updated the lease.

namespace coordination.v1beta1

interface Lease

interface Lease

Lease defines a lease concept.

property apiVersion

apiVersion: "coordination.k8s.io/v1beta1";

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

property kind

kind: "Lease";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: LeaseSpec;

Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface LeaseSpec

interface LeaseSpec

LeaseSpec is a specification of a Lease.

property acquireTime

acquireTime: string;

acquireTime is a time when the current lease was acquired.

property holderIdentity

holderIdentity: string;

holderIdentity contains the identity of the holder of a current lease.

property leaseDurationSeconds

leaseDurationSeconds: number;

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.

property leaseTransitions

leaseTransitions: number;

leaseTransitions is the number of transitions of a lease between holders.

property renewTime

renewTime: string;

renewTime is a time when the current holder of a lease has last updated the lease.

namespace core.v1

interface Affinity

interface Affinity

Affinity is a group of affinity scheduling rules.

property nodeAffinity

nodeAffinity: NodeAffinity;

Describes node affinity scheduling rules for the pod.

property podAffinity

podAffinity: PodAffinity;

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

property podAntiAffinity

podAntiAffinity: PodAntiAffinity;

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

interface AttachedVolume

interface AttachedVolume

AttachedVolume describes a volume attached to a node

property devicePath

devicePath: string;

DevicePath represents the device path where the volume should be available

property name

name: string;

Name of the attached volume

interface AWSElasticBlockStoreVolumeSource

interface AWSElasticBlockStoreVolumeSource

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.

property fsType

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

property partition

partition: number;

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

property readOnly

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

property volumeID

volumeID: string;

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

interface AzureDiskVolumeSource

interface AzureDiskVolumeSource

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

property cachingMode

cachingMode: string;

Host Caching mode: None, Read Only, Read Write.

property diskName

diskName: string;

The Name of the data disk in the blob storage

property diskURI

diskURI: string;

The URI the data disk in the blob storage

property fsType

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.

property kind

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

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

interface AzureFilePersistentVolumeSource

interface AzureFilePersistentVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretName

secretName: string;

the name of secret that contains Azure Storage Account Name and Key

property secretNamespace

secretNamespace: string;

the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod

property shareName

shareName: string;

Share Name

interface AzureFileVolumeSource

interface AzureFileVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretName

secretName: string;

the name of secret that contains Azure Storage Account Name and Key

property shareName

shareName: string;

Share Name

interface Capabilities

interface Capabilities

Adds and removes POSIX capabilities from running containers.

property add

add: string[];

Added capabilities

property drop

drop: string[];

Removed capabilities

interface CephFSPersistentVolumeSource

interface CephFSPersistentVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

property monitors

monitors: string[];

Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

property path

path: string;

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

property readOnly

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

property secretFile

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

property secretRef

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

property user

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

interface CephFSVolumeSource

interface CephFSVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

property monitors

monitors: string[];

Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

property path

path: string;

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

property readOnly

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

property secretFile

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

property secretRef

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

property user

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

interface CinderPersistentVolumeSource

interface CinderPersistentVolumeSource

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.

property fsType

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

property readOnly

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

property secretRef

secretRef: SecretReference;

Optional: points to a secret object containing parameters used to connect to OpenStack.

property volumeID

volumeID: string;

volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

interface CinderVolumeSource

interface CinderVolumeSource

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.

property fsType

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

property readOnly

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

property secretRef

secretRef: LocalObjectReference;

Optional: points to a secret object containing parameters used to connect to OpenStack.

property volumeID

volumeID: string;

volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

interface ClientIPConfig

interface ClientIPConfig

ClientIPConfig represents the configurations of Client IP based session affinity.

property timeoutSeconds

timeoutSeconds: number;

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

interface ComponentCondition

interface ComponentCondition

Information about the condition of a component.

property error

error: string;

Condition error code for a component. For example, a health check error code.

property message

message: string;

Message about the condition for a component. For example, information about a health check.

property status

status: string;

Status of the condition for a component. Valid values for “Healthy”: “True”, “False”, or “Unknown”.

property type

type: string;

Type of condition for a component. Valid value: “Healthy”

interface ComponentStatus

interface ComponentStatus

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

property apiVersion

apiVersion: "v1";

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

property conditions

conditions: ComponentCondition[];

List of component conditions observed

property kind

kind: "ComponentStatus";

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

property metadata

metadata: ObjectMeta;

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

interface ConfigMap

interface ConfigMap

ConfigMap holds configuration data for pods to consume.

property apiVersion

apiVersion: "v1";

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

property binaryData

binaryData: {[key: string]: string};

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.

property data

data: {[key: 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.

property immutable

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. This is an alpha field enabled by ImmutableEphemeralVolumes feature gate.

property kind

kind: "ConfigMap";

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

property metadata

metadata: ObjectMeta;

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

interface ConfigMapEnvSource

interface ConfigMapEnvSource

ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.

The contents of the target ConfigMap’s Data field will represent the key-value pairs as environment variables.

property name

name: string;

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

property optional

optional: boolean;

Specify whether the ConfigMap must be defined

interface ConfigMapKeySelector

interface ConfigMapKeySelector

Selects a key from a ConfigMap.

property key

key: string;

The key to select.

property name

name: string;

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

property optional

optional: boolean;

Specify whether the ConfigMap or its key must be defined

interface ConfigMapNodeConfigSource

interface ConfigMapNodeConfigSource

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.

property kubeletConfigKey

kubeletConfigKey: string;

KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.

property name

name: string;

Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.

property namespace

namespace: string;

Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.

property resourceVersion

resourceVersion: string;

ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

property uid

uid: string;

UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

interface ConfigMapProjection

interface ConfigMapProjection

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.

property items

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

property name

name: string;

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

property optional

optional: boolean;

Specify whether the ConfigMap or its keys must be defined

interface ConfigMapVolumeSource

interface ConfigMapVolumeSource

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.

property defaultMode

defaultMode: number;

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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.

property items

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

property name

name: string;

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

property optional

optional: boolean;

Specify whether the ConfigMap or its keys must be defined

interface Container

interface Container

A single application container that you want to run within a pod.

property args

args: string[];

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

property command

command: string[];

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

property env

env: EnvVar[];

List of environment variables to set in the container. Cannot be updated.

property envFrom

envFrom: EnvFromSource[];

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

property image

image: string;

Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

property imagePullPolicy

imagePullPolicy: string;

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

property lifecycle

lifecycle: Lifecycle;

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

property livenessProbe

livenessProbe: Probe;

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

property name

name: string;

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

property ports

ports: ContainerPort[];

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Cannot be updated.

property readinessProbe

readinessProbe: Probe;

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

property resources

resources: ResourceRequirements;

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

property securityContext

securityContext: SecurityContext;

Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

property startupProbe

startupProbe: Probe;

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

property stdin

stdin: boolean;

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

property stdinOnce

stdinOnce: boolean;

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

property terminationMessagePath

terminationMessagePath: string;

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

property terminationMessagePolicy

terminationMessagePolicy: string;

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

property tty

tty: boolean;

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

property volumeDevices

volumeDevices: VolumeDevice[];

volumeDevices is the list of block devices to be used by the container.

property volumeMounts

volumeMounts: VolumeMount[];

Pod volumes to mount into the container’s filesystem. Cannot be updated.

property workingDir

workingDir: string;

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

interface ContainerImage

interface ContainerImage

Describe a container image

property names

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”]

property sizeBytes

sizeBytes: number;

The size of the image in bytes.

interface ContainerPort

interface ContainerPort

ContainerPort represents a network port in a single container.

property containerPort

containerPort: number;

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

property hostIP

hostIP: string;

What host IP to bind the external port to.

property hostPort

hostPort: number;

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

property name

name: string;

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

property protocol

protocol: string;

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.

interface ContainerState

interface ContainerState

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

property running

running: ContainerStateRunning;

Details about a running container

property terminated

terminated: ContainerStateTerminated;

Details about a terminated container

property waiting

waiting: ContainerStateWaiting;

Details about a waiting container

interface ContainerStateRunning

interface ContainerStateRunning

ContainerStateRunning is a running state of a container.

property startedAt

startedAt: string;

Time at which the container was last (re-)started

interface ContainerStateTerminated

interface ContainerStateTerminated

ContainerStateTerminated is a terminated state of a container.

property containerID

containerID: string;

Container’s ID in the format ‘docker://<container_id>‘

property exitCode

exitCode: number;

Exit status from the last termination of the container

property finishedAt

finishedAt: string;

Time at which the container last terminated

property message

message: string;

Message regarding the last termination of the container

property reason

reason: string;

(brief) reason from the last termination of the container

property signal

signal: number;

Signal from the last termination of the container

property startedAt

startedAt: string;

Time at which previous execution of the container started

interface ContainerStateWaiting

interface ContainerStateWaiting

ContainerStateWaiting is a waiting state of a container.

property message

message: string;

Message regarding why the container is not yet running.

property reason

reason: string;

(brief) reason the container is not yet running.

interface ContainerStatus

interface ContainerStatus

ContainerStatus contains details for the current status of this container.

property containerID

containerID: string;

Container’s ID in the format ‘docker://<container_id>’.

property image

image: string;

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images

property imageID

imageID: string;

ImageID of the container’s image.

property lastState

lastState: ContainerState;

Details about the container’s last termination condition.

property name

name: string;

This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

property ready

ready: boolean;

Specifies whether the container has passed its readiness probe.

property restartCount

restartCount: number;

The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.

property started

started: boolean;

Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.

property state

state: ContainerState;

Details about the container’s current condition.

interface CSIPersistentVolumeSource

interface CSIPersistentVolumeSource

Represents storage that is managed by an external CSI volume driver (Beta feature)

property controllerExpandSecretRef

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.

property controllerPublishSecretRef

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.

property driver

driver: string;

Driver is the name of the driver to use for this volume. Required.

property fsType

fsType: string;

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”.

property nodePublishSecretRef

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.

property nodeStageSecretRef

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.

property readOnly

readOnly: boolean;

Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).

property volumeAttributes

volumeAttributes: {[key: string]: string};

Attributes of the volume to publish.

property volumeHandle

volumeHandle: string;

VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.

interface CSIVolumeSource

interface CSIVolumeSource

Represents a source location of a volume to mount, managed by an external CSI driver

property driver

driver: string;

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.

property fsType

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.

property nodePublishSecretRef

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.

property readOnly

readOnly: boolean;

Specifies a read-only configuration for the volume. Defaults to false (read/write).

property volumeAttributes

volumeAttributes: {[key: string]: string};

VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values.

interface DaemonEndpoint

interface DaemonEndpoint

DaemonEndpoint contains information about a single Daemon endpoint.

property Port

Port: number;

Port number of the given endpoint.

interface DownwardAPIProjection

interface DownwardAPIProjection

Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

property items

items: DownwardAPIVolumeFile[];

Items is a list of DownwardAPIVolume file

interface DownwardAPIVolumeFile

interface DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

property fieldRef

fieldRef: ObjectFieldSelector;

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

property mode

mode: number;

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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.

property path

path: string;

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

property resourceFieldRef

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.

interface DownwardAPIVolumeSource

interface DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

property defaultMode

defaultMode: number;

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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.

property items

items: DownwardAPIVolumeFile[];

Items is a list of downward API volume file

interface EmptyDirVolumeSource

interface EmptyDirVolumeSource

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

property medium

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

property sizeLimit

sizeLimit: string;

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

interface EndpointAddress

interface EndpointAddress

EndpointAddress is a tuple that describes single IP address.

property hostname

hostname: string;

The Hostname of this endpoint

property ip

ip: string;

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.

property nodeName

nodeName: string;

Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

property targetRef

targetRef: ObjectReference;

Reference to object providing the endpoint.

interface EndpointPort

interface EndpointPort

EndpointPort is a tuple that describes a single port.

property appProtocol

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

property name

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.

property port

port: number;

The port number of the endpoint.

property protocol

protocol: string;

The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

interface Endpoints

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

property apiVersion

apiVersion: "v1";

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

property kind

kind: "Endpoints";

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

property metadata

metadata: ObjectMeta;

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

property subsets

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.

interface EndpointSubset

interface EndpointSubset

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 ]

property addresses

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.

property notReadyAddresses

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.

property ports

ports: EndpointPort[];

Port numbers available on the related IP addresses.

interface EnvFromSource

interface EnvFromSource

EnvFromSource represents the source of a set of ConfigMaps

property configMapRef

configMapRef: ConfigMapEnvSource;

The ConfigMap to select from

property prefix

prefix: string;

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

property secretRef

secretRef: SecretEnvSource;

The Secret to select from

interface EnvVar

interface EnvVar

EnvVar represents an environment variable present in a Container.

property name

name: string;

Name of the environment variable. Must be a C_IDENTIFIER.

property value

value: string;

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.

property valueFrom

valueFrom: EnvVarSource;

Source for the environment variable’s value. Cannot be used if value is not empty.

interface EnvVarSource

interface EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

property configMapKeyRef

configMapKeyRef: ConfigMapKeySelector;

Selects a key of a ConfigMap.

property fieldRef

fieldRef: ObjectFieldSelector;

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

property resourceFieldRef

resourceFieldRef: ResourceFieldSelector;

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

property secretKeyRef

secretKeyRef: SecretKeySelector;

Selects a key of a secret in the pod’s namespace

interface EphemeralContainer

interface EphemeralContainer

An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod’s ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.

property args

args: string[];

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

property command

command: string[];

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

property env

env: EnvVar[];

List of environment variables to set in the container. Cannot be updated.

property envFrom

envFrom: EnvFromSource[];

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

property image

image: string;

Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images

property imagePullPolicy

imagePullPolicy: string;

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

property lifecycle

lifecycle: Lifecycle;

Lifecycle is not allowed for ephemeral containers.

property livenessProbe

livenessProbe: Probe;

Probes are not allowed for ephemeral containers.

property name

name: string;

Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.

property ports

ports: ContainerPort[];

Ports are not allowed for ephemeral containers.

property readinessProbe

readinessProbe: Probe;

Probes are not allowed for ephemeral containers.

property resources

resources: ResourceRequirements;

Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.

property securityContext

securityContext: SecurityContext;

SecurityContext is not allowed for ephemeral containers.

property startupProbe

startupProbe: Probe;

Probes are not allowed for ephemeral containers.

property stdin

stdin: boolean;

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

property stdinOnce

stdinOnce: boolean;

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

property targetContainerName

targetContainerName: string;

If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature.

property terminationMessagePath

terminationMessagePath: string;

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

property terminationMessagePolicy

terminationMessagePolicy: string;

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

property tty

tty: boolean;

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

property volumeDevices

volumeDevices: VolumeDevice[];

volumeDevices is the list of block devices to be used by the container.

property volumeMounts

volumeMounts: VolumeMount[];

Pod volumes to mount into the container’s filesystem. Cannot be updated.

property workingDir

workingDir: string;

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

interface Event

interface Event

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

property action

action: string;

What action was taken/failed regarding to the Regarding object.

property apiVersion

apiVersion: "v1";

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

property count

count: number;

The number of times this event has occurred.

property eventTime

eventTime: string;

Time when this Event was first observed.

property firstTimestamp

firstTimestamp: string;

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

property involvedObject

involvedObject: ObjectReference;

The object that this event is about.

property kind

kind: "Event";

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

property lastTimestamp

lastTimestamp: string;

The time at which the most recent occurrence of this event was recorded.

property message

message: string;

A human-readable description of the status of this operation.

property metadata

metadata: ObjectMeta;

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

property reason

reason: string;

This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.

related: ObjectReference;

Optional secondary object for more complex actions.

property reportingComponent

reportingComponent: string;

Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.

property reportingInstance

reportingInstance: string;

ID of the controller instance, e.g. kubelet-xyzf.

property series

series: EventSeries;

Data about the Event series this event represents or nil if it’s a singleton Event.

property source

source: EventSource;

The component reporting this event. Should be a short machine understandable string.

property type

type: string;

Type of this event (Normal, Warning), new types could be added in the future

interface EventSeries

interface EventSeries

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

property count

count: number;

Number of occurrences in this series up to the last heartbeat time

property lastObservedTime

lastObservedTime: string;

Time of the last occurrence observed

property state

state: string;

State of this Series: Ongoing or Finished Deprecated. Planned removal for 1.18

interface EventSource

interface EventSource

EventSource contains information for an event.

property component

component: string;

Component from which the event is generated.

property host

host: string;

Node name on which the event is generated.

interface ExecAction

interface ExecAction

ExecAction describes a “run in container” action.

property command

command: string[];

Command is the command line to execute inside the container, the working directory for the command is root (‘/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (‘|’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

interface FCVolumeSource

interface FCVolumeSource

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.

property fsType

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.

property lun

lun: number;

Optional: FC target lun number

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property targetWWNs

targetWWNs: string[];

Optional: FC target worldwide names (WWNs)

property wwids

wwids: string[];

Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

interface FlexPersistentVolumeSource

interface FlexPersistentVolumeSource

FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.

property driver

driver: string;

Driver is the name of the driver to use for this volume.

property fsType

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.

property options

options: {[key: string]: string};

Optional: Extra command options if any.

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

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.

interface FlexVolumeSource

interface FlexVolumeSource

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

property driver

driver: string;

Driver is the name of the driver to use for this volume.

property fsType

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.

property options

options: {[key: string]: string};

Optional: Extra command options if any.

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

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.

interface FlockerVolumeSource

interface FlockerVolumeSource

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.

property datasetName

datasetName: string;

Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated

property datasetUUID

datasetUUID: string;

UUID of the dataset. This is unique identifier of a Flocker dataset

interface GCEPersistentDiskVolumeSource

interface GCEPersistentDiskVolumeSource

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.

property fsType

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

property partition

partition: number;

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

property pdName

pdName: string;

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

property readOnly

readOnly: boolean;

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

interface GitRepoVolumeSource

interface GitRepoVolumeSource

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.

property directory

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.

property repository

repository: string;

Repository URL

property revision

revision: string;

Commit hash for the specified revision.

interface GlusterfsPersistentVolumeSource

interface GlusterfsPersistentVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

property endpoints

endpoints: string;

EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

property endpointsNamespace

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

property path

path: string;

Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

property readOnly

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

interface GlusterfsVolumeSource

interface GlusterfsVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

property endpoints

endpoints: string;

EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

property path

path: string;

Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

property readOnly

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

interface Handler

interface Handler

Handler defines a specific action that should be taken

property exec

exec: ExecAction;

One and only one of the following should be specified. Exec specifies the action to take.

property httpGet

httpGet: HTTPGetAction;

HTTPGet specifies the http request to perform.

property tcpSocket

tcpSocket: TCPSocketAction;

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

interface HostAlias

interface HostAlias

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.

property hostnames

hostnames: string[];

Hostnames for the above IP address.

property ip

ip: string;

IP address of the host file entry.

interface HostPathVolumeSource

interface HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

property path

path: string;

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

property type

type: string;

Type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

interface HTTPGetAction

interface HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

property host

host: string;

Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

property httpHeaders

httpHeaders: HTTPHeader[];

Custom headers to set in the request. HTTP allows repeated headers.

property path

path: string;

Path to access on the HTTP server.

property port

port: number | string;

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

property scheme

scheme: string;

Scheme to use for connecting to the host. Defaults to HTTP.

interface HTTPHeader

interface HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

property name

name: string;

The header field name

property value

value: string;

The header field value

interface ISCSIPersistentVolumeSource

interface ISCSIPersistentVolumeSource

ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

property chapAuthDiscovery

chapAuthDiscovery: boolean;

whether support iSCSI Discovery CHAP authentication

property chapAuthSession

chapAuthSession: boolean;

whether support iSCSI Session CHAP authentication

property fsType

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

property initiatorName

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.

property iqn

iqn: string;

Target iSCSI Qualified Name.

property iscsiInterface

iscsiInterface: string;

iSCSI Interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).

property lun

lun: number;

iSCSI Target Lun number.

property portals

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

property readOnly

readOnly: boolean;

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

property secretRef

secretRef: SecretReference;

CHAP Secret for iSCSI target and initiator authentication

property targetPortal

targetPortal: string;

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

interface ISCSIVolumeSource

interface ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

property chapAuthDiscovery

chapAuthDiscovery: boolean;

whether support iSCSI Discovery CHAP authentication

property chapAuthSession

chapAuthSession: boolean;

whether support iSCSI Session CHAP authentication

property fsType

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

property initiatorName

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.

property iqn

iqn: string;

Target iSCSI Qualified Name.

property iscsiInterface

iscsiInterface: string;

iSCSI Interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).

property lun

lun: number;

iSCSI Target Lun number.

property portals

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

property readOnly

readOnly: boolean;

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

property secretRef

secretRef: LocalObjectReference;

CHAP Secret for iSCSI target and initiator authentication

property targetPortal

targetPortal: string;

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

interface KeyToPath

interface KeyToPath

Maps a string key to a path within a volume.

property key

key: string;

The key to project.

property mode

mode: number;

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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.

property path

path: string;

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

interface Lifecycle

interface Lifecycle

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

property postStart

postStart: Handler;

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

property preStop

preStop: Handler;

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod’s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

interface LimitRange

interface LimitRange

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

property apiVersion

apiVersion: "v1";

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

property kind

kind: "LimitRange";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: LimitRangeSpec;

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

interface LimitRangeItem

interface LimitRangeItem

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

property default

default: {[key: string]: string};

Default resource requirement limit value by resource name if resource limit is omitted.

property defaultRequest

defaultRequest: {[key: string]: string};

DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.

property max

max: {[key: string]: string};

Max usage constraints on this kind by resource name.

property maxLimitRequestRatio

maxLimitRequestRatio: {[key: string]: string};

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.

property min

min: {[key: string]: string};

Min usage constraints on this kind by resource name.

property type

type: string;

Type of resource that this limit applies to.

interface LimitRangeSpec

interface LimitRangeSpec

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

property limits

limits: LimitRangeItem[];

Limits is the list of LimitRangeItem objects that are enforced.

interface LoadBalancerIngress

interface LoadBalancerIngress

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

property hostname

hostname: string;

Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)

property ip

ip: string;

IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

interface LoadBalancerStatus

interface LoadBalancerStatus

LoadBalancerStatus represents the status of a load-balancer.

property ingress

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.

interface LocalObjectReference

interface LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

property name

name: string;

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

interface LocalVolumeSource

interface LocalVolumeSource

Local represents directly-attached storage with node affinity (Beta feature)

property fsType

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.

property path

path: string;

The full path to the volume on the node. It can be either a directory or block device (disk, partition, …).

interface Namespace

interface Namespace

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

property apiVersion

apiVersion: "v1";

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

property kind

kind: "Namespace";

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

property metadata

metadata: ObjectMeta;

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

property spec

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

property 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

interface NamespaceCondition

interface NamespaceCondition

NamespaceCondition contains details about state of namespace.

property lastTransitionTime

lastTransitionTime: string;

property message

message: string;

property reason

reason: string;

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of namespace controller condition.

interface NamespaceSpec

interface NamespaceSpec

NamespaceSpec describes the attributes on a Namespace.

property finalizers

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/

interface NamespaceStatus

interface NamespaceStatus

NamespaceStatus is information about the current status of a Namespace.

property conditions

conditions: NamespaceCondition[];

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

property phase

phase: string;

Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

interface NFSVolumeSource

interface NFSVolumeSource

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

property path

path: string;

Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

property readOnly

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

property server

server: string;

Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

interface Node

interface Node

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

property apiVersion

apiVersion: "v1";

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

property kind

kind: "Node";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: NodeSpec;

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

property 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

interface NodeAddress

interface NodeAddress

NodeAddress contains information for the node’s address.

property address

address: string;

The node address.

property type

type: string;

Node address type, one of Hostname, ExternalIP or InternalIP.

interface NodeAffinity

interface NodeAffinity

Node affinity is a group of node affinity scheduling rules.

property preferredDuringSchedulingIgnoredDuringExecution

preferredDuringSchedulingIgnoredDuringExecution: PreferredSchedulingTerm[];

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.

property requiredDuringSchedulingIgnoredDuringExecution

requiredDuringSchedulingIgnoredDuringExecution: NodeSelector;

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

interface NodeCondition

interface NodeCondition

NodeCondition contains condition information for a node.

property lastHeartbeatTime

lastHeartbeatTime: string;

Last time we got an update on a given condition.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transit from one status to another.

property message

message: string;

Human readable message indicating details about last transition.

property reason

reason: string;

(brief) reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of node condition.

interface NodeConfigSource

interface NodeConfigSource

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

property configMap

configMap: ConfigMapNodeConfigSource;

ConfigMap is a reference to a Node’s ConfigMap

interface NodeConfigStatus

interface NodeConfigStatus

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

property active

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.

property assigned

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.

property error

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.

property lastKnownGood

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.

interface NodeDaemonEndpoints

interface NodeDaemonEndpoints

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

property kubeletEndpoint

kubeletEndpoint: DaemonEndpoint;

Endpoint on which Kubelet is listening.

interface NodeSelector

interface NodeSelector

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.

property nodeSelectorTerms

nodeSelectorTerms: NodeSelectorTerm[];

Required. A list of node selector terms. The terms are ORed.

interface NodeSelectorRequirement

interface NodeSelectorRequirement

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

property key

key: string;

The label key that the selector applies to.

property operator

operator: string;

Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

property values

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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

interface NodeSelectorTerm

interface NodeSelectorTerm

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.

property matchExpressions

matchExpressions: NodeSelectorRequirement[];

A list of node selector requirements by node’s labels.

property matchFields

matchFields: NodeSelectorRequirement[];

A list of node selector requirements by node’s fields.

interface NodeSpec

interface NodeSpec

NodeSpec describes the attributes that a node is created with.

property configSource

configSource: NodeConfigSource;

If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field

property externalID

externalID: string;

Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966

property podCIDR

podCIDR: string;

PodCIDR represents the pod IP range assigned to the node.

property podCIDRs

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.

property providerID

providerID: string;

ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>

property taints

taints: Taint[];

If specified, the node’s taints.

property unschedulable

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

interface NodeStatus

interface NodeStatus

NodeStatus is information about the current status of a node.

property addresses

addresses: NodeAddress[];

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.

property allocatable

allocatable: {[key: string]: string};

Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.

property capacity

capacity: {[key: string]: string};

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

property conditions

conditions: NodeCondition[];

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

property config

config: NodeConfigStatus;

Status of the config assigned to the node via the dynamic Kubelet config feature.

property daemonEndpoints

daemonEndpoints: NodeDaemonEndpoints;

Endpoints of daemons running on the Node.

property images

images: ContainerImage[];

List of container images on this node

property nodeInfo

nodeInfo: NodeSystemInfo;

Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info

property phase

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.

property volumesAttached

volumesAttached: AttachedVolume[];

List of volumes that are attached to the node.

property volumesInUse

volumesInUse: string[];

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

interface NodeSystemInfo

interface NodeSystemInfo

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

property architecture

architecture: string;

The Architecture reported by the node

property bootID

bootID: string;

Boot ID reported by the node.

property containerRuntimeVersion

containerRuntimeVersion: string;

ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

property kernelVersion

kernelVersion: string;

Kernel Version reported by the node from ‘uname -r’ (e.g. 3.16.0-0.bpo.4-amd64).

property kubeProxyVersion

kubeProxyVersion: string;

KubeProxy Version reported by the node.

property kubeletVersion

kubeletVersion: string;

Kubelet Version reported by the node.

property machineID

machineID: string;

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

property operatingSystem

operatingSystem: string;

The Operating System reported by the node

property osImage

osImage: string;

OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

property systemUUID

systemUUID: string;

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/getting-system-uuid.html

interface ObjectFieldSelector

interface ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

property apiVersion

apiVersion: string;

Version of the schema the FieldPath is written in terms of, defaults to “v1”.

property fieldPath

fieldPath: string;

Path of the field to select in the specified API version.

interface ObjectReference

interface ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.

property apiVersion

apiVersion: string;

API version of the referent.

property fieldPath

fieldPath: string;

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

property kind

kind: string;

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

property name

name: string;

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

property namespace

namespace: string;

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

property resourceVersion

resourceVersion: string;

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

property uid

uid: string;

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

interface PersistentVolume

interface 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

property apiVersion

apiVersion: "v1";

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

property kind

kind: "PersistentVolume";

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

property metadata

metadata: ObjectMeta;

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

property spec

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

property status

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

interface PersistentVolumeClaim

interface PersistentVolumeClaim

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

property apiVersion

apiVersion: "v1";

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

property kind

kind: "PersistentVolumeClaim";

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

property metadata

metadata: ObjectMeta;

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

property spec

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

property status

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

interface PersistentVolumeClaimCondition

interface PersistentVolumeClaimCondition

PersistentVolumeClaimCondition contails details about state of pvc

property lastProbeTime

lastProbeTime: string;

Last time we probed the condition.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

Human-readable message indicating details about last transition.

property reason

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.

property status

status: string;

property type

type: string;

interface PersistentVolumeClaimSpec

interface PersistentVolumeClaimSpec

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

property accessModes

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

property dataSource

dataSource: TypedLocalObjectReference;

This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) 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 specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.

property resources

resources: ResourceRequirements;

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

property selector

selector: LabelSelector;

A label query over volumes to consider for binding.

property storageClassName

storageClassName: string;

Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

property volumeMode

volumeMode: string;

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

property volumeName

volumeName: string;

VolumeName is the binding reference to the PersistentVolume backing this claim.

interface PersistentVolumeClaimStatus

interface PersistentVolumeClaimStatus

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

property accessModes

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

property capacity

capacity: {[key: string]: string};

Represents the actual resources of the underlying volume.

property conditions

conditions: PersistentVolumeClaimCondition[];

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

property phase

phase: string;

Phase represents the current phase of PersistentVolumeClaim.

interface PersistentVolumeClaimVolumeSource

interface PersistentVolumeClaimVolumeSource

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

property claimName

claimName: string;

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

property readOnly

readOnly: boolean;

Will force the ReadOnly setting in VolumeMounts. Default false.

interface PersistentVolumeSpec

interface PersistentVolumeSpec

PersistentVolumeSpec is the specification of a persistent volume.

property accessModes

accessModes: string[];

AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

property awsElasticBlockStore

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

property azureDisk

azureDisk: AzureDiskVolumeSource;

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

property azureFile

azureFile: AzureFilePersistentVolumeSource;

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

property capacity

capacity: {[key: string]: string};

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

property cephfs

cephfs: CephFSPersistentVolumeSource;

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

property cinder

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

property claimRef

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

property csi

csi: CSIPersistentVolumeSource;

CSI represents storage that is handled by an external CSI driver (Beta feature).

property fc

fc: FCVolumeSource;

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

property flexVolume

flexVolume: FlexPersistentVolumeSource;

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

property flocker

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

property gcePersistentDisk

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

property glusterfs

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

property hostPath

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

property iscsi

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.

property local

local: LocalVolumeSource;

Local represents directly-attached storage with node affinity

property mountOptions

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

property nfs

nfs: NFSVolumeSource;

NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

property nodeAffinity

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.

property persistentVolumeReclaimPolicy

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

property photonPersistentDisk

photonPersistentDisk: PhotonPersistentDiskVolumeSource;

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

property portworxVolume

portworxVolume: PortworxVolumeSource;

PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

property quobyte

quobyte: QuobyteVolumeSource;

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

property rbd

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

property scaleIO

scaleIO: ScaleIOPersistentVolumeSource;

ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

property storageClassName

storageClassName: string;

Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.

property storageos

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

property volumeMode

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.

property vsphereVolume

vsphereVolume: VsphereVirtualDiskVolumeSource;

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

interface PersistentVolumeStatus

interface PersistentVolumeStatus

PersistentVolumeStatus is the current status of a persistent volume.

property message

message: string;

A human-readable message indicating details about why the volume is in this state.

property phase

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

property reason

reason: string;

Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

interface PhotonPersistentDiskVolumeSource

interface PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

property fsType

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.

property pdID

pdID: string;

ID that identifies Photon Controller persistent disk

interface Pod

interface Pod

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. The Pod is scheduled (“PodScheduled”” ‘.status.condition’ is true).
  2. The Pod is initialized (“Initialized” ‘.status.condition’ is true).
  3. The Pod is ready (“Ready” ‘.status.condition’ is true) and the ‘.status.phase’ is set to “Running”. Or (for Jobs): The Pod succeeded (‘.status.phase’ set to “Succeeded”).

If the Pod has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "v1";

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

property kind

kind: "Pod";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: PodSpec;

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: PodStatus;

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface PodAffinity

interface PodAffinity

Pod affinity is a group of inter pod affinity scheduling rules.

property preferredDuringSchedulingIgnoredDuringExecution

preferredDuringSchedulingIgnoredDuringExecution: WeightedPodAffinityTerm[];

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

property requiredDuringSchedulingIgnoredDuringExecution

requiredDuringSchedulingIgnoredDuringExecution: PodAffinityTerm[];

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

interface PodAffinityTerm

interface PodAffinityTerm

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

property labelSelector

labelSelector: LabelSelector;

A label query over a set of resources, in this case pods.

property namespaces

namespaces: string[];

namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means “this pod’s namespace”

property topologyKey

topologyKey: string;

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

interface PodAntiAffinity

interface PodAntiAffinity

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

property preferredDuringSchedulingIgnoredDuringExecution

preferredDuringSchedulingIgnoredDuringExecution: WeightedPodAffinityTerm[];

The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding “weight” to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

property requiredDuringSchedulingIgnoredDuringExecution

requiredDuringSchedulingIgnoredDuringExecution: PodAffinityTerm[];

If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

interface PodCondition

interface PodCondition

PodCondition contains details for the current condition of this pod.

property lastProbeTime

lastProbeTime: string;

Last time we probed the condition.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

Human-readable message indicating details about last transition.

property reason

reason: string;

Unique, one-word, CamelCase reason for the condition’s last transition.

property status

status: string;

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

property type

type: string;

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

interface PodDNSConfig

interface PodDNSConfig

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

property nameservers

nameservers: string[];

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

property options

options: PodDNSConfigOption[];

A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

property searches

searches: string[];

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

interface PodDNSConfigOption

interface PodDNSConfigOption

PodDNSConfigOption defines DNS resolver options of a pod.

property name

name: string;

Required.

property value

value: string;

interface PodIP

interface PodIP

IP address information for entries in the (plural) PodIPs field. Each entry includes: IP: An IP address allocated to the pod. Routable at least within the cluster.

property ip

ip: string;

ip is an IP address (IPv4 or IPv6) assigned to the pod

interface PodReadinessGate

interface PodReadinessGate

PodReadinessGate contains the reference to a pod condition

property conditionType

conditionType: string;

ConditionType refers to a condition in the pod’s condition list with matching type.

interface PodSecurityContext

interface PodSecurityContext

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

property fsGroup

fsGroup: number;

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

  1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw—-

If unset, the Kubelet will not modify the ownership and permissions of any volume.

property fsGroupChangePolicy

fsGroupChangePolicy: string;

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified defaults to “Always”.

property runAsGroup

runAsGroup: number;

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

property runAsNonRoot

runAsNonRoot: boolean;

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

property runAsUser

runAsUser: number;

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

property seLinuxOptions

seLinuxOptions: SELinuxOptions;

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

property supplementalGroups

supplementalGroups: number[];

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

property sysctls

sysctls: Sysctl[];

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.

property windowsOptions

windowsOptions: WindowsSecurityContextOptions;

The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

interface PodSpec

interface PodSpec

PodSpec is a description of a pod.

property activeDeadlineSeconds

activeDeadlineSeconds: number;

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

property affinity

affinity: Affinity;

If specified, the pod’s scheduling constraints

property automountServiceAccountToken

automountServiceAccountToken: boolean;

AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

property containers

containers: Container[];

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.

property dnsConfig

dnsConfig: PodDNSConfig;

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

property dnsPolicy

dnsPolicy: string;

Set DNS policy for the pod. Defaults to “ClusterFirst”. Valid values are ‘ClusterFirstWithHostNet’, ‘ClusterFirst’, ‘Default’ or ‘None’. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ‘ClusterFirstWithHostNet’.

enableServiceLinks: boolean;

EnableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true.

property ephemeralContainers

ephemeralContainers: EphemeralContainer[];

List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod’s ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.

property hostAliases

hostAliases: HostAlias[];

HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified. This is only valid for non-hostNetwork pods.

property hostIPC

hostIPC: boolean;

Use the host’s ipc namespace. Optional: Default to false.

property hostNetwork

hostNetwork: boolean;

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

property hostPID

hostPID: boolean;

Use the host’s pid namespace. Optional: Default to false.

property hostname

hostname: string;

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

property imagePullSecrets

imagePullSecrets: LocalObjectReference[];

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

property initContainers

initContainers: Container[];

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

property nodeName

nodeName: string;

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

property nodeSelector

nodeSelector: {[key: string]: string};

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

property overhead

overhead: {[key: string]: string};

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.

property preemptionPolicy

preemptionPolicy: string;

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.

property priority

priority: number;

The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.

property priorityClassName

priorityClassName: string;

If specified, indicates the pod’s priority. “system-node-critical” and “system-cluster-critical” are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.

property readinessGates

readinessGates: PodReadinessGate[];

If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to “True” More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md

property restartPolicy

restartPolicy: string;

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

property runtimeClassName

runtimeClassName: string;

RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the “legacy” RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.

property schedulerName

schedulerName: string;

If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

property securityContext

securityContext: PodSecurityContext;

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

property serviceAccount

serviceAccount: string;

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

property serviceAccountName

serviceAccountName: string;

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

property shareProcessNamespace

shareProcessNamespace: boolean;

Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.

property subdomain

subdomain: string;

If specified, the fully qualified Pod hostname will be “<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>”. If not specified, the pod will not have a domainname at all.

property terminationGracePeriodSeconds

terminationGracePeriodSeconds: number;

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

property tolerations

tolerations: Toleration[];

If specified, the pod’s tolerations.

property topologySpreadConstraints

topologySpreadConstraints: TopologySpreadConstraint[];

TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.

property volumes

volumes: Volume[];

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

interface PodStatus

interface PodStatus

PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.

property conditions

conditions: PodCondition[];

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

property containerStatuses

containerStatuses: ContainerStatus[];

The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

property ephemeralContainerStatuses

ephemeralContainerStatuses: ContainerStatus[];

Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature.

property hostIP

hostIP: string;

IP address of the host to which the pod is assigned. Empty if not yet scheduled.

property initContainerStatuses

initContainerStatuses: ContainerStatus[];

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

property message

message: string;

A human readable message indicating details about why the pod is in this condition.

property nominatedNodeName

nominatedNodeName: string;

nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.

property phase

phase: string;

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod’s status. There are five possible phase values:

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

property podIP

podIP: string;

IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.

property podIPs

podIPs: PodIP[];

podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.

property qosClass

qosClass: string;

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

property reason

reason: string;

A brief CamelCase message indicating details about why the pod is in this state. e.g. ‘Evicted’

property startTime

startTime: string;

RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

interface PodTemplate

interface PodTemplate

PodTemplate describes a template for creating copies of a predefined pod.

property apiVersion

apiVersion: "v1";

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

property kind

kind: "PodTemplate";

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

property metadata

metadata: ObjectMeta;

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

property template

template: PodTemplateSpec;

Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface PodTemplateSpec

interface PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template

property metadata

metadata: ObjectMeta;

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

property spec

spec: PodSpec;

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface PortworxVolumeSource

interface PortworxVolumeSource

PortworxVolumeSource represents a Portworx volume resource.

property fsType

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.

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property volumeID

volumeID: string;

VolumeID uniquely identifies a Portworx volume

interface PreferredSchedulingTerm

interface PreferredSchedulingTerm

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

property preference

preference: NodeSelectorTerm;

A node selector term, associated with the corresponding weight.

property weight

weight: number;

Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

interface Probe

interface Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

property exec

exec: ExecAction;

One and only one of the following should be specified. Exec specifies the action to take.

property failureThreshold

failureThreshold: number;

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

property httpGet

httpGet: HTTPGetAction;

HTTPGet specifies the http request to perform.

property initialDelaySeconds

initialDelaySeconds: number;

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

property periodSeconds

periodSeconds: number;

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

property successThreshold

successThreshold: number;

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

property tcpSocket

tcpSocket: TCPSocketAction;

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

property timeoutSeconds

timeoutSeconds: number;

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

interface ProjectedVolumeSource

interface ProjectedVolumeSource

Represents a projected volume source

property defaultMode

defaultMode: number;

Mode bits to use on created files by default. Must be a value between 0 and 0777. 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.

property sources

sources: VolumeProjection[];

list of volume projections

interface QuobyteVolumeSource

interface QuobyteVolumeSource

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

property group

group: string;

Group to map volume access to Default is no group

property readOnly

readOnly: boolean;

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

property registry

registry: string;

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

property tenant

tenant: string;

Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

property user

user: string;

User to map volume access to Defaults to serivceaccount user

property volume

volume: string;

Volume is a string that references an already created Quobyte volume by name.

interface RBDPersistentVolumeSource

interface RBDPersistentVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

property fsType

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

property image

image: string;

The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

property keyring

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

property monitors

monitors: string[];

A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

property pool

pool: string;

The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

property readOnly

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

property secretRef

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

property user

user: string;

The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

interface RBDVolumeSource

interface RBDVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

property fsType

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

property image

image: string;

The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

property keyring

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

property monitors

monitors: string[];

A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

property pool

pool: string;

The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

property readOnly

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

property secretRef

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

property user

user: string;

The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

interface ReplicationController

interface ReplicationController

ReplicationController represents the configuration of a replication controller.

property apiVersion

apiVersion: "v1";

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

property kind

kind: "ReplicationController";

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

property metadata

metadata: ObjectMeta;

If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property spec

spec: ReplicationControllerSpec;

Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: ReplicationControllerStatus;

Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface ReplicationControllerCondition

interface ReplicationControllerCondition

ReplicationControllerCondition describes the state of a replication controller at a certain point.

property lastTransitionTime

lastTransitionTime: string;

The last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of replication controller condition.

interface ReplicationControllerSpec

interface ReplicationControllerSpec

ReplicationControllerSpec is the specification of a replication controller.

property minReadySeconds

minReadySeconds: number;

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

property replicas

replicas: number;

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

property selector

selector: {[key: string]: string};

Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property template

template: PodTemplateSpec;

Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

interface ReplicationControllerStatus

interface ReplicationControllerStatus

ReplicationControllerStatus represents the current status of a replication controller.

property availableReplicas

availableReplicas: number;

The number of available replicas (ready for at least minReadySeconds) for this replication controller.

property conditions

conditions: ReplicationControllerCondition[];

Represents the latest available observations of a replication controller’s current state.

property fullyLabeledReplicas

fullyLabeledReplicas: number;

The number of pods that have labels matching the labels of the pod template of the replication controller.

property observedGeneration

observedGeneration: number;

ObservedGeneration reflects the generation of the most recently observed replication controller.

property readyReplicas

readyReplicas: number;

The number of ready replicas for this replication controller.

property replicas

replicas: number;

Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

interface ResourceFieldSelector

interface ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format

property containerName

containerName: string;

Container name: required for volumes, optional for env vars

property divisor

divisor: string;

Specifies the output format of the exposed resources, defaults to “1”

property resource

resource: string;

Required: resource to select

interface ResourceQuota

interface ResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace

property apiVersion

apiVersion: "v1";

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

property kind

kind: "ResourceQuota";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: ResourceQuotaSpec;

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

property 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

interface ResourceQuotaSpec

interface ResourceQuotaSpec

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

property hard

hard: {[key: string]: string};

hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

property scopeSelector

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.

property scopes

scopes: string[];

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

interface ResourceQuotaStatus

interface ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.

property hard

hard: {[key: string]: string};

Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

property used

used: {[key: string]: string};

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

interface ResourceRequirements

interface ResourceRequirements

ResourceRequirements describes the compute resource requirements.

property limits

limits: {[key: string]: string};

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

property requests

requests: {[key: string]: string};

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-compute-resources-container/

interface ScaleIOPersistentVolumeSource

interface ScaleIOPersistentVolumeSource

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

property fsType

fsType: string;

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Default is “xfs”

property gateway

gateway: string;

The host address of the ScaleIO API Gateway.

property protectionDomain

protectionDomain: string;

The name of the ScaleIO Protection Domain for the configured storage.

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

secretRef: SecretReference;

SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

property sslEnabled

sslEnabled: boolean;

Flag to enable/disable SSL communication with Gateway, default false

property storageMode

storageMode: string;

Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

property storagePool

storagePool: string;

The ScaleIO Storage Pool associated with the protection domain.

property system

system: string;

The name of the storage system as configured in ScaleIO.

property volumeName

volumeName: string;

The name of a volume already created in the ScaleIO system that is associated with this volume source.

interface ScaleIOVolumeSource

interface ScaleIOVolumeSource

ScaleIOVolumeSource represents a persistent ScaleIO volume

property fsType

fsType: string;

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Default is “xfs”.

property gateway

gateway: string;

The host address of the ScaleIO API Gateway.

property protectionDomain

protectionDomain: string;

The name of the ScaleIO Protection Domain for the configured storage.

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

secretRef: LocalObjectReference;

SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

property sslEnabled

sslEnabled: boolean;

Flag to enable/disable SSL communication with Gateway, default false

property storageMode

storageMode: string;

Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

property storagePool

storagePool: string;

The ScaleIO Storage Pool associated with the protection domain.

property system

system: string;

The name of the storage system as configured in ScaleIO.

property volumeName

volumeName: string;

The name of a volume already created in the ScaleIO system that is associated with this volume source.

interface ScopedResourceSelectorRequirement

interface ScopedResourceSelectorRequirement

A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.

property operator

operator: string;

Represents a scope’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.

property scopeName

scopeName: string;

The name of the scope that the selector applies to.

property values

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.

interface ScopeSelector

interface ScopeSelector

A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

property matchExpressions

matchExpressions: ScopedResourceSelectorRequirement[];

A list of scope selector requirements by scope of the resources.

interface Secret

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

Note: While Pulumi automatically encrypts the ‘data’ and ‘stringData’ fields, this encryption only applies to Pulumi’s context, including the state file, the Service, the CLI, etc. Kubernetes does not encrypt Secret resources by default, and the contents are visible to users with access to the Secret in Kubernetes using tools like ‘kubectl’.

For more information on securing Kubernetes Secrets, see the following links: https://kubernetes.io/docs/concepts/configuration/secret/#security-properties https://kubernetes.io/docs/concepts/configuration/secret/#risks

property apiVersion

apiVersion: "v1";

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

property data

data: {[key: string]: string};

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

property immutable

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. This is an alpha field enabled by ImmutableEphemeralVolumes feature gate.

property kind

kind: "Secret";

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

property metadata

metadata: ObjectMeta;

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

property stringData

stringData: {[key: string]: string};

stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.

property type

type: string;

Used to facilitate programmatic handling of secret data.

interface SecretEnvSource

interface SecretEnvSource

SecretEnvSource selects a Secret to populate the environment variables with.

The contents of the target Secret’s Data field will represent the key-value pairs as environment variables.

property name

name: string;

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

property optional

optional: boolean;

Specify whether the Secret must be defined

interface SecretKeySelector

interface SecretKeySelector

SecretKeySelector selects a key of a Secret.

property key

key: string;

The key of the secret to select from. Must be a valid secret key.

property name

name: string;

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

property optional

optional: boolean;

Specify whether the Secret or its key must be defined

interface SecretProjection

interface SecretProjection

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.

property items

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

property name

name: string;

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

property optional

optional: boolean;

Specify whether the Secret or its key must be defined

interface SecretReference

interface SecretReference

SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

property name

name: string;

Name is unique within a namespace to reference a secret resource.

property namespace

namespace: string;

Namespace defines the space within which the secret name must be unique.

interface SecretVolumeSource

interface SecretVolumeSource

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.

property defaultMode

defaultMode: number;

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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.

property items

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

property optional

optional: boolean;

Specify whether the Secret or its keys must be defined

property secretName

secretName: string;

Name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

interface SecurityContext

interface SecurityContext

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

property allowPrivilegeEscalation

allowPrivilegeEscalation: boolean;

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN

property capabilities

capabilities: Capabilities;

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

property privileged

privileged: boolean;

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

property procMount

procMount: string;

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.

property readOnlyRootFilesystem

readOnlyRootFilesystem: boolean;

Whether this container has a read-only root filesystem. Default is false.

property runAsGroup

runAsGroup: number;

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

property runAsNonRoot

runAsNonRoot: boolean;

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

property runAsUser

runAsUser: number;

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

property seLinuxOptions

seLinuxOptions: SELinuxOptions;

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

property windowsOptions

windowsOptions: WindowsSecurityContextOptions;

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

interface SELinuxOptions

interface SELinuxOptions

SELinuxOptions are the labels to be applied to the container

property level

level: string;

Level is SELinux level label that applies to the container.

property role

role: string;

Role is a SELinux role label that applies to the container.

property type

type: string;

Type is a SELinux type label that applies to the container.

property user

user: string;

User is a SELinux user label that applies to the container.

interface Service

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

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. Service object exists.
  2. Related Endpoint objects are created. Each time we get an update, wait 10 seconds for any stragglers.
  3. The endpoints objects target some number of living objects (unless the Service is an “empty headless” Service [1] or a Service with ‘.spec.type: ExternalName’).
  4. External IP address is allocated (if Service has ‘.spec.type: LoadBalancer’).

Known limitations: Services targeting ReplicaSets (and, by extension, Deployments, StatefulSets, etc.) with ‘.spec.replicas’ set to 0 are not handled, and will time out. To work around this limitation, set ‘pulumi.com/skipAwait: “true”’ on ‘.metadata.annotations’ for the Service. Work to handle this case is in progress [2].

[1] https://kubernetes.io/docs/concepts/services-networking/service/#headless-services [2] https://github.com/pulumi/pulumi-kubernetes/pull/703

If the Service has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "v1";

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

property kind

kind: "Service";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: ServiceSpec;

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

property 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

interface ServiceAccount

interface 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

property apiVersion

apiVersion: "v1";

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

property automountServiceAccountToken

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.

property imagePullSecrets

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

property kind

kind: "ServiceAccount";

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

property metadata

metadata: ObjectMeta;

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

property secrets

secrets: ObjectReference[];

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

interface ServiceAccountTokenProjection

interface ServiceAccountTokenProjection

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

property audience

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.

property expirationSeconds

expirationSeconds: number;

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.

property path

path: string;

Path is the path relative to the mount point of the file to project the token into.

interface ServicePort

interface ServicePort

ServicePort contains information on service’s port.

property appProtocol

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

property name

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.

property nodePort

nodePort: number;

The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport

property port

port: number;

The port that will be exposed by this service.

property protocol

protocol: string;

The IP protocol for this port. Supports “TCP”, “UDP”, and “SCTP”. Default is TCP.

property targetPort

targetPort: number | string;

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

interface ServiceSpec

interface ServiceSpec

ServiceSpec describes the attributes that a user creates on a service.

property clusterIP

clusterIP: string;

clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are “None”, empty string (“”), or a valid IP address. “None” can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

property externalIPs

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.

property externalName

externalName: string;

externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.

property externalTrafficPolicy

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.

property healthCheckNodePort

healthCheckNodePort: number;

healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local.

property ipFamily

ipFamily: string;

ipFamily specifies whether this Service has a preference for a particular IP family (e.g. IPv4 vs. IPv6). If a specific IP family is requested, the clusterIP field will be allocated from that family, if it is available in the cluster. If no IP family is requested, the cluster’s primary IP family will be used. Other IP fields (loadBalancerIP, loadBalancerSourceRanges, externalIPs) and controllers which allocate external load-balancers should use the same IP family. Endpoints for this Service will be of this family. This field is immutable after creation. Assigning a ServiceIPFamily not available in the cluster (e.g. IPv6 in IPv4 only cluster) is an error condition and will fail during clusterIP assignment.

property loadBalancerIP

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.

property loadBalancerSourceRanges

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/configure-cloud-provider-firewall/

property ports

ports: ServicePort[];

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

property publishNotReadyAddresses

publishNotReadyAddresses: boolean;

publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet’s Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery.

property selector

selector: {[key: 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/

property sessionAffinity

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

property sessionAffinityConfig

sessionAffinityConfig: SessionAffinityConfig;

sessionAffinityConfig contains the configurations of session affinity.

property topologyKeys

topologyKeys: string[];

topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value “*” may be used to mean “any topology”. This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied.

property type

type: string;

type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. “ExternalName” maps to the specified externalName. “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. If clusterIP is “None”, no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. “NodePort” builds on ClusterIP and allocates a port on every node which routes to the clusterIP. “LoadBalancer” builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types

interface ServiceStatus

interface ServiceStatus

ServiceStatus represents the current status of a service.

property loadBalancer

loadBalancer: LoadBalancerStatus;

LoadBalancer contains the current status of the load-balancer, if one is present.

interface SessionAffinityConfig

interface SessionAffinityConfig

SessionAffinityConfig represents the configurations of session affinity.

property clientIP

clientIP: ClientIPConfig;

clientIP contains the configurations of Client IP based session affinity.

interface StorageOSPersistentVolumeSource

interface StorageOSPersistentVolumeSource

Represents a StorageOS persistent volume resource.

property fsType

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.

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

secretRef: ObjectReference;

SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

property volumeName

volumeName: string;

VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

property volumeNamespace

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.

interface StorageOSVolumeSource

interface StorageOSVolumeSource

Represents a StorageOS persistent volume resource.

property fsType

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.

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

secretRef: LocalObjectReference;

SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

property volumeName

volumeName: string;

VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

property volumeNamespace

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.

interface Sysctl

interface Sysctl

Sysctl defines a kernel parameter to be set

property name

name: string;

Name of a property to set

property value

value: string;

Value of a property to set

interface Taint

interface Taint

The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.

property effect

effect: string;

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

property key

key: string;

Required. The taint key to be applied to a node.

property timeAdded

timeAdded: string;

TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

property value

value: string;

The taint value corresponding to the taint key.

interface TCPSocketAction

interface TCPSocketAction

TCPSocketAction describes an action based on opening a socket

property host

host: string;

Optional: Host name to connect to, defaults to the pod IP.

property port

port: number | string;

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

interface Toleration

interface Toleration

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

property effect

effect: string;

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

property key

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.

property operator

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.

property tolerationSeconds

tolerationSeconds: number;

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.

property value

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.

interface TopologySelectorLabelRequirement

interface TopologySelectorLabelRequirement

A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

property key

key: string;

The label key that the selector applies to.

property values

values: string[];

An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

interface TopologySelectorTerm

interface TopologySelectorTerm

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.

property matchLabelExpressions

matchLabelExpressions: TopologySelectorLabelRequirement[];

A list of topology selector requirements by labels.

interface TopologySpreadConstraint

interface TopologySpreadConstraint

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

property labelSelector

labelSelector: LabelSelector;

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

property maxSkew

maxSkew: number;

MaxSkew describes the degree to which pods may be unevenly distributed. It’s the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. It’s a required field. Default value is 1 and 0 is not allowed.

property topologyKey

topologyKey: string;

TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a “bucket”, and try to put balanced number of pods into each bucket. It’s a required field.

property whenUnsatisfiable

whenUnsatisfiable: string;

WhenUnsatisfiable indicates how to deal with a pod if it doesn’t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It’s considered as “Unsatisfiable” if and only if placing incoming pod on any topology violates “MaxSkew”. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won’t make it more imbalanced. It’s a required field.

interface TypedLocalObjectReference

interface TypedLocalObjectReference

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

property apiGroup

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.

property kind

kind: string;

Kind is the type of resource being referenced

property name

name: string;

Name is the name of resource being referenced

interface Volume

interface Volume

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

property awsElasticBlockStore

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

property azureDisk

azureDisk: AzureDiskVolumeSource;

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

property azureFile

azureFile: AzureFileVolumeSource;

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

property cephfs

cephfs: CephFSVolumeSource;

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

property cinder

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

property configMap

configMap: ConfigMapVolumeSource;

ConfigMap represents a configMap that should populate this volume

property csi

csi: CSIVolumeSource;

CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature).

property downwardAPI

downwardAPI: DownwardAPIVolumeSource;

DownwardAPI represents downward API about the pod that should populate this volume

property emptyDir

emptyDir: EmptyDirVolumeSource;

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

property fc

fc: FCVolumeSource;

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

property flexVolume

flexVolume: FlexVolumeSource;

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

property flocker

flocker: FlockerVolumeSource;

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

property gcePersistentDisk

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

property gitRepo

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.

property glusterfs

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

property hostPath

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

property iscsi

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

property name

name: string;

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

property nfs

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

property persistentVolumeClaim

persistentVolumeClaim: PersistentVolumeClaimVolumeSource;

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

property photonPersistentDisk

photonPersistentDisk: PhotonPersistentDiskVolumeSource;

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

property portworxVolume

portworxVolume: PortworxVolumeSource;

PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

property projected

projected: ProjectedVolumeSource;

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

property quobyte

quobyte: QuobyteVolumeSource;

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

property rbd

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

property scaleIO

scaleIO: ScaleIOVolumeSource;

ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

property secret

secret: SecretVolumeSource;

Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

property storageos

storageos: StorageOSVolumeSource;

StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

property vsphereVolume

vsphereVolume: VsphereVirtualDiskVolumeSource;

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

interface VolumeDevice

interface VolumeDevice

volumeDevice describes a mapping of a raw block device within a container.

property devicePath

devicePath: string;

devicePath is the path inside of the container that the device will be mapped to.

property name

name: string;

name must match the name of a persistentVolumeClaim in the pod

interface VolumeMount

interface VolumeMount

VolumeMount describes a mounting of a Volume within a container.

property mountPath

mountPath: string;

Path within the container at which the volume should be mounted. Must not contain ‘:‘.

property mountPropagation

mountPropagation: string;

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

property name

name: string;

This must match the Name of a Volume.

property readOnly

readOnly: boolean;

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

property subPath

subPath: string;

Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

property subPathExpr

subPathExpr: string;

Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to “” (volume’s root). SubPathExpr and SubPath are mutually exclusive.

interface VolumeNodeAffinity

interface VolumeNodeAffinity

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

property required

required: NodeSelector;

Required specifies hard node constraints that must be met.

interface VolumeProjection

interface VolumeProjection

Projection that may be projected along with other supported volume types

property configMap

configMap: ConfigMapProjection;

information about the configMap data to project

property downwardAPI

downwardAPI: DownwardAPIProjection;

information about the downwardAPI data to project

property secret

secret: SecretProjection;

information about the secret data to project

property serviceAccountToken

serviceAccountToken: ServiceAccountTokenProjection;

information about the serviceAccountToken data to project

interface VsphereVirtualDiskVolumeSource

interface VsphereVirtualDiskVolumeSource

Represents a vSphere volume resource.

property fsType

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.

property storagePolicyID

storagePolicyID: string;

Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

property storagePolicyName

storagePolicyName: string;

Storage Policy Based Management (SPBM) profile name.

property volumePath

volumePath: string;

Path that identifies vSphere volume vmdk

interface WeightedPodAffinityTerm

interface WeightedPodAffinityTerm

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

property podAffinityTerm

podAffinityTerm: PodAffinityTerm;

Required. A pod affinity term, associated with the corresponding weight.

property weight

weight: number;

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

interface WindowsSecurityContextOptions

interface WindowsSecurityContextOptions

WindowsSecurityContextOptions contain Windows-specific options and credentials.

property gmsaCredentialSpec

gmsaCredentialSpec: string;

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

property gmsaCredentialSpecName

gmsaCredentialSpecName: string;

GMSACredentialSpecName is the name of the GMSA credential spec to use.

property runAsUserName

runAsUserName: string;

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

namespace discovery.v1beta1

interface Endpoint

interface Endpoint

Endpoint represents a single logical “backend” implementing a service.

property addresses

addresses: string[];

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.

property conditions

conditions: EndpointConditions;

conditions contains information about the current status of the endpoint.

property hostname

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 pass DNS Label (RFC 1123) validation.

property targetRef

targetRef: ObjectReference;

targetRef is a reference to a Kubernetes object that represents this endpoint.

property topology

topology: {[key: string]: string};

topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node where the endpoint is located. This should match the corresponding node label. * topology.kubernetes.io/zone: the value indicates the zone where the endpoint is located. This should match the corresponding node label. * topology.kubernetes.io/region: the value indicates the region where the endpoint is located. This should match the corresponding node label.

interface EndpointConditions

interface EndpointConditions

EndpointConditions represents the current condition of an endpoint.

property ready

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.

interface EndpointPort

interface EndpointPort

EndpointPort represents a Port used by an EndpointSlice

property appProtocol

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.

property name

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.

property port

port: number;

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.

property protocol

protocol: string;

The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

interface EndpointSlice

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

property addressType

addressType: string;

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.

property apiVersion

apiVersion: "discovery.k8s.io/v1beta1";

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

property endpoints

endpoints: Endpoint[];

endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.

property kind

kind: "EndpointSlice";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property ports

ports: EndpointPort[];

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.

namespace events.v1beta1

interface Event

interface Event

Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.

property action

action: string;

What action was taken/failed regarding to the regarding object.

property apiVersion

apiVersion: "events.k8s.io/v1beta1";

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

property deprecatedCount

deprecatedCount: number;

Deprecated field assuring backward compatibility with core.v1 Event type

property deprecatedFirstTimestamp

deprecatedFirstTimestamp: string;

Deprecated field assuring backward compatibility with core.v1 Event type

property deprecatedLastTimestamp

deprecatedLastTimestamp: string;

Deprecated field assuring backward compatibility with core.v1 Event type

property deprecatedSource

deprecatedSource: EventSource;

Deprecated field assuring backward compatibility with core.v1 Event type

property eventTime

eventTime: string;

Required. Time when this Event was first observed.

property kind

kind: "Event";

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

property metadata

metadata: ObjectMeta;

property note

note: string;

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

property reason

reason: string;

Why the action was taken.

property regarding

regarding: ObjectReference;

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;

Optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.

property reportingController

reportingController: string;

Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.

property reportingInstance

reportingInstance: string;

ID of the controller instance, e.g. kubelet-xyzf.

property series

series: EventSeries;

Data about the Event series this event represents or nil if it’s a singleton Event.

property type

type: string;

Type of this event (Normal, Warning), new types could be added in the future.

interface EventSeries

interface EventSeries

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

property count

count: number;

Number of occurrences in this series up to the last heartbeat time

property lastObservedTime

lastObservedTime: string;

Time when last Event from the series was seen before last heartbeat.

property state

state: string;

Information whether this series is ongoing or finished. Deprecated. Planned removal for 1.18

namespace extensions.v1beta1

interface AllowedCSIDriver

interface AllowedCSIDriver

AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used.

property name

name: string;

Name is the registered name of the CSI driver

interface AllowedFlexVolume

interface AllowedFlexVolume

AllowedFlexVolume represents a single Flexvolume that is allowed to be used. Deprecated: use AllowedFlexVolume from policy API Group instead.

property driver

driver: string;

driver is the name of the Flexvolume driver.

interface AllowedHostPath

interface AllowedHostPath

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. Deprecated: use AllowedHostPath from policy API Group instead.

property pathPrefix

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

property readOnly

readOnly: boolean;

when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.

interface DaemonSet

interface DaemonSet

DaemonSet represents the configuration of a daemon set.

property apiVersion

apiVersion: "extensions/v1beta1";

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

property kind

kind: "DaemonSet";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: DaemonSetSpec;

The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: DaemonSetStatus;

The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface DaemonSetCondition

interface DaemonSetCondition

DaemonSetCondition describes the state of a DaemonSet at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of DaemonSet condition.

interface DaemonSetSpec

interface DaemonSetSpec

DaemonSetSpec is the specification of a daemon set.

property minReadySeconds

minReadySeconds: number;

The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).

property revisionHistoryLimit

revisionHistoryLimit: number;

The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

property selector

selector: LabelSelector;

A label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property template

template: PodTemplateSpec;

An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

property templateGeneration

templateGeneration: number;

DEPRECATED. A sequence number representing a specific generation of the template. Populated by the system. It can be set only during the creation.

property updateStrategy

updateStrategy: DaemonSetUpdateStrategy;

An update strategy to replace existing DaemonSet pods with new pods.

interface DaemonSetStatus

interface DaemonSetStatus

DaemonSetStatus represents the current status of a daemon set.

property collisionCount

collisionCount: number;

Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

property conditions

conditions: DaemonSetCondition[];

Represents the latest available observations of a DaemonSet’s current state.

property currentNumberScheduled

currentNumberScheduled: number;

The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

property desiredNumberScheduled

desiredNumberScheduled: number;

The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

property numberAvailable

numberAvailable: number;

The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)

property numberMisscheduled

numberMisscheduled: number;

The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

property numberReady

numberReady: number;

The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.

property numberUnavailable

numberUnavailable: number;

The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)

property observedGeneration

observedGeneration: number;

The most recent generation observed by the daemon set controller.

property updatedNumberScheduled

updatedNumberScheduled: number;

The total number of nodes that are running updated daemon pod

interface DaemonSetUpdateStrategy

interface DaemonSetUpdateStrategy

property rollingUpdate

rollingUpdate: RollingUpdateDaemonSet;

Rolling update config params. Present only if type = “RollingUpdate”.

property type

type: string;

Type of daemon set update. Can be “RollingUpdate” or “OnDelete”. Default is OnDelete.

interface Deployment

interface Deployment

Deployment enables declarative updates for Pods and ReplicaSets.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. The Deployment has begun to be updated by the Deployment controller. If the current generation of the Deployment is > 1, then this means that the current generation must be different from the generation reported by the last outputs.
  2. There exists a ReplicaSet whose revision is equal to the current revision of the Deployment.
  3. The Deployment’s ‘.status.conditions’ has a status of type ‘Available’ whose ‘status’ member is set to ‘True’.
  4. If the Deployment has generation > 1, then ‘.status.conditions’ has a status of type ‘Progressing’, whose ‘status’ member is set to ‘True’, and whose ‘reason’ is ‘NewReplicaSetAvailable’. For generation <= 1, this status field does not exist, because it doesn’t do a rollout (i.e., it simply creates the Deployment and corresponding ReplicaSet), and therefore there is no rollout to mark as ‘Progressing’.

If the Deployment has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "extensions/v1beta1";

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

property kind

kind: "Deployment";

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

property metadata

metadata: ObjectMeta;

Standard object metadata.

property spec

spec: DeploymentSpec;

Specification of the desired behavior of the Deployment.

property status

status: DeploymentStatus;

Most recently observed status of the Deployment.

interface DeploymentCondition

interface DeploymentCondition

DeploymentCondition describes the state of a deployment at a certain point.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property lastUpdateTime

lastUpdateTime: string;

The last time this condition was updated.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of deployment condition.

interface DeploymentSpec

interface DeploymentSpec

DeploymentSpec is the specification of the desired behavior of the Deployment.

property minReadySeconds

minReadySeconds: number;

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

property paused

paused: boolean;

Indicates that the deployment is paused and will not be processed by the deployment controller.

property progressDeadlineSeconds

progressDeadlineSeconds: number;

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. This is set to the max value of int32 (i.e. 2147483647) by default, which means “no deadline”.

property replicas

replicas: number;

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

property revisionHistoryLimit

revisionHistoryLimit: number;

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. This is set to the max value of int32 (i.e. 2147483647) by default, which means “retaining all old RelicaSets”.

property rollbackTo

rollbackTo: RollbackConfig;

DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.

property selector

selector: LabelSelector;

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.

property strategy

strategy: DeploymentStrategy;

The deployment strategy to use to replace existing pods with new ones.

property template

template: PodTemplateSpec;

Template describes the pods that will be created.

interface DeploymentStatus

interface DeploymentStatus

DeploymentStatus is the most recently observed status of the Deployment.

property availableReplicas

availableReplicas: number;

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

property collisionCount

collisionCount: number;

Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.

property conditions

conditions: DeploymentCondition[];

Represents the latest available observations of a deployment’s current state.

property observedGeneration

observedGeneration: number;

The generation observed by the deployment controller.

property readyReplicas

readyReplicas: number;

Total number of ready pods targeted by this deployment.

property replicas

replicas: number;

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

property unavailableReplicas

unavailableReplicas: number;

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.

property updatedReplicas

updatedReplicas: number;

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

interface DeploymentStrategy

interface DeploymentStrategy

DeploymentStrategy describes how to replace existing pods with new ones.

property rollingUpdate

rollingUpdate: RollingUpdateDeployment;

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

property type

type: string;

Type of deployment. Can be “Recreate” or “RollingUpdate”. Default is RollingUpdate.

interface FSGroupStrategyOptions

interface FSGroupStrategyOptions

FSGroupStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use FSGroupStrategyOptions from policy API Group instead.

property ranges

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.

property rule

rule: string;

rule is the strategy that will dictate what FSGroup is used in the SecurityContext.

interface HostPortRange

interface HostPortRange

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. Deprecated: use HostPortRange from policy API Group instead.

property max

max: number;

max is the end of the range, inclusive.

property min

min: number;

min is the start of the range, inclusive.

interface HTTPIngressPath

interface HTTPIngressPath

HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.

property backend

backend: IngressBackend;

Backend defines the referenced service endpoint to which the traffic will be forwarded to.

property path

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 ‘/’. When unspecified, all paths from incoming requests are matched.

property pathType

pathType: string;

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. Defaults to ImplementationSpecific.

interface HTTPIngressRuleValue

interface HTTPIngressRuleValue

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last ‘/’ and before the first ‘?’ or ‘#’.

property paths

paths: HTTPIngressPath[];

A collection of paths that map requests to backends.

interface IDRange

interface IDRange

IDRange provides a min/max of an allowed range of IDs. Deprecated: use IDRange from policy API Group instead.

property max

max: number;

max is the end of the range, inclusive.

property min

min: number;

min is the start of the range, inclusive.

interface Ingress

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

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. Ingress object exists.
  2. Endpoint objects exist with matching names for each Ingress path (except when Service type is ExternalName).
  3. Ingress entry exists for ‘.status.loadBalancer.ingress’.

If the Ingress has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "extensions/v1beta1";

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

property kind

kind: "Ingress";

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

property metadata

metadata: ObjectMeta;

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

property spec

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

property 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

interface IngressBackend

interface IngressBackend

IngressBackend describes all endpoints for a given service and port.

property resource

resource: TypedLocalObjectReference;

Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.

property serviceName

serviceName: string;

Specifies the name of the referenced service.

property servicePort

servicePort: number | string;

Specifies the port of the referenced service.

interface IngressRule

interface IngressRule

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.

property host

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.

property http

http: HTTPIngressRuleValue;

interface IngressSpec

interface IngressSpec

IngressSpec describes the Ingress the user wishes to exist.

property backend

backend: IngressBackend;

A default backend capable of servicing requests that don’t match any rule. At least one of ‘backend’ or ‘rules’ must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.

property ingressClassName

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.

property rules

rules: IngressRule[];

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

property tls

tls: IngressTLS[];

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.

interface IngressStatus

interface IngressStatus

IngressStatus describe the current state of the Ingress.

property loadBalancer

loadBalancer: LoadBalancerStatus;

LoadBalancer contains the current status of the load-balancer.

interface IngressTLS

interface IngressTLS

IngressTLS describes the transport layer security associated with an Ingress.

property hosts

hosts: string[];

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.

property secretName

secretName: string;

SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL 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.

interface IPBlock

interface IPBlock

DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock. IPBlock describes a particular CIDR (Ex. “192.168.1.1/24”) 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.

property cidr

cidr: string;

CIDR is a string representing the IP Block Valid examples are “192.168.1.1/24”

property except

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” Except values will be rejected if they are outside the CIDR range

interface NetworkPolicy

interface NetworkPolicy

DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy. NetworkPolicy describes what network traffic is allowed for a set of Pods

property apiVersion

apiVersion: "extensions/v1beta1";

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

property kind

kind: "NetworkPolicy";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: NetworkPolicySpec;

Specification of the desired behavior for this NetworkPolicy.

interface NetworkPolicyEgressRule

interface NetworkPolicyEgressRule

DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/NetworkPolicyEgressRule. 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

property ports

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.

property to

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.

interface NetworkPolicyIngressRule

interface NetworkPolicyIngressRule

DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule. This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.

property from

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.

property ports

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.

interface NetworkPolicyPeer

interface NetworkPolicyPeer

DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer.

property ipBlock

ipBlock: IPBlock;

IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.

property namespaceSelector

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.

property podSelector

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.

interface NetworkPolicyPort

interface NetworkPolicyPort

DEPRECATED 1.9 - This group version of NetworkPolicyPort is deprecated by networking/v1/NetworkPolicyPort.

property port

port: number | string;

If specified, 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.

property protocol

protocol: string;

Optional. The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.

interface NetworkPolicySpec

interface NetworkPolicySpec

DEPRECATED 1.9 - This group version of NetworkPolicySpec is deprecated by networking/v1/NetworkPolicySpec.

property egress

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

property ingress

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

property podSelector

podSelector: LabelSelector;

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.

property policyTypes

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

interface PodSecurityPolicy

interface PodSecurityPolicy

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. Deprecated: use PodSecurityPolicy from policy API Group instead.

property apiVersion

apiVersion: "extensions/v1beta1";

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

property kind

kind: "PodSecurityPolicy";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: PodSecurityPolicySpec;

spec defines the policy enforced.

interface PodSecurityPolicySpec

interface PodSecurityPolicySpec

PodSecurityPolicySpec defines the policy enforced. Deprecated: use PodSecurityPolicySpec from policy API Group instead.

property allowPrivilegeEscalation

allowPrivilegeEscalation: boolean;

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

property allowedCSIDrivers

allowedCSIDrivers: AllowedCSIDriver[];

AllowedCSIDrivers is a whitelist 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.

property allowedCapabilities

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.

property allowedFlexVolumes

allowedFlexVolumes: AllowedFlexVolume[];

allowedFlexVolumes is a whitelist of allowed 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.

property allowedHostPaths

allowedHostPaths: AllowedHostPath[];

allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used.

property allowedProcMountTypes

allowedProcMountTypes: string[];

AllowedProcMountTypes is a whitelist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled.

property allowedUnsafeSysctls

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

property defaultAddCapabilities

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.

property defaultAllowPrivilegeEscalation

defaultAllowPrivilegeEscalation: boolean;

defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.

property forbiddenSysctls

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.

property fsGroup

fsGroup: FSGroupStrategyOptions;

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

property hostIPC

hostIPC: boolean;

hostIPC determines if the policy allows the use of HostIPC in the pod spec.

property hostNetwork

hostNetwork: boolean;

hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.

property hostPID

hostPID: boolean;

hostPID determines if the policy allows the use of HostPID in the pod spec.

property hostPorts

hostPorts: HostPortRange[];

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

property privileged

privileged: boolean;

privileged determines if a pod can request to be run as privileged.

property readOnlyRootFilesystem

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.

property requiredDropCapabilities

requiredDropCapabilities: string[];

requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.

property runAsGroup

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.

property runAsUser

runAsUser: RunAsUserStrategyOptions;

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

property runtimeClass

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.

property seLinux

seLinux: SELinuxStrategyOptions;

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

property supplementalGroups

supplementalGroups: SupplementalGroupsStrategyOptions;

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

property volumes

volumes: string[];

volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use ‘*‘.

interface ReplicaSet

interface ReplicaSet

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

property apiVersion

apiVersion: "extensions/v1beta1";

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

property kind

kind: "ReplicaSet";

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

property metadata

metadata: ObjectMeta;

If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property spec

spec: ReplicaSetSpec;

Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

property status

status: ReplicaSetStatus;

Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface ReplicaSetCondition

interface ReplicaSetCondition

ReplicaSetCondition describes the state of a replica set at a certain point.

property lastTransitionTime

lastTransitionTime: string;

The last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of replica set condition.

interface ReplicaSetSpec

interface ReplicaSetSpec

ReplicaSetSpec is the specification of a ReplicaSet.

property minReadySeconds

minReadySeconds: number;

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

property replicas

replicas: number;

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

property selector

selector: LabelSelector;

Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

property template

template: PodTemplateSpec;

Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

interface ReplicaSetStatus

interface ReplicaSetStatus

ReplicaSetStatus represents the current status of a ReplicaSet.

property availableReplicas

availableReplicas: number;

The number of available replicas (ready for at least minReadySeconds) for this replica set.

property conditions

conditions: ReplicaSetCondition[];

Represents the latest available observations of a replica set’s current state.

property fullyLabeledReplicas

fullyLabeledReplicas: number;

The number of pods that have labels matching the labels of the pod template of the replicaset.

property observedGeneration

observedGeneration: number;

ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

property readyReplicas

readyReplicas: number;

The number of ready replicas for this replica set.

property replicas

replicas: number;

Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

interface RollbackConfig

interface RollbackConfig

DEPRECATED.

property revision

revision: number;

The revision to rollback to. If set to 0, rollback to the last revision.

interface RollingUpdateDaemonSet

interface RollingUpdateDaemonSet

Spec to control the desired behavior of daemon set rolling update.

property maxUnavailable

maxUnavailable: number | string;

The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.

interface RollingUpdateDeployment

interface RollingUpdateDeployment

Spec to control the desired behavior of rolling update.

property maxSurge

maxSurge: number | string;

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

property maxUnavailable

maxUnavailable: number | string;

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

interface RunAsGroupStrategyOptions

interface RunAsGroupStrategyOptions

RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use RunAsGroupStrategyOptions from policy API Group instead.

property ranges

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.

property rule

rule: string;

rule is the strategy that will dictate the allowable RunAsGroup values that may be set.

interface RunAsUserStrategyOptions

interface RunAsUserStrategyOptions

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use RunAsUserStrategyOptions from policy API Group instead.

property ranges

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.

property rule

rule: string;

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

interface RuntimeClassStrategyOptions

interface RuntimeClassStrategyOptions

RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod.

property allowedRuntimeClassNames

allowedRuntimeClassNames: string[];

allowedRuntimeClassNames is a whitelist 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.

property defaultRuntimeClassName

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.

interface SELinuxStrategyOptions

interface SELinuxStrategyOptions

SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use SELinuxStrategyOptions from policy API Group instead.

property rule

rule: string;

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

property seLinuxOptions

seLinuxOptions: SELinuxOptions;

seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

interface SupplementalGroupsStrategyOptions

interface SupplementalGroupsStrategyOptions

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use SupplementalGroupsStrategyOptions from policy API Group instead.

property ranges

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.

property rule

rule: string;

rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.

namespace flowcontrol.v1alpha1

interface FlowDistinguisherMethod

interface FlowDistinguisherMethod

FlowDistinguisherMethod specifies the method of a flow distinguisher.

property type

type: string;

type is the type of flow distinguisher method The supported types are “ByUser” and “ByNamespace”. Required.

interface FlowSchema

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

property apiVersion

apiVersion: "flowcontrol.apiserver.k8s.io/v1alpha1";

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

property kind

kind: "FlowSchema";

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

property metadata

metadata: ObjectMeta;

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

property spec

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

property 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

interface FlowSchemaCondition

interface FlowSchemaCondition

FlowSchemaCondition describes conditions for a FlowSchema.

property lastTransitionTime

lastTransitionTime: string;

lastTransitionTime is the last time the condition transitioned from one status to another.

property message

message: string;

message is a human-readable message indicating details about last transition.

property reason

reason: string;

reason is a unique, one-word, CamelCase reason for the condition’s last transition.

property status

status: string;

status is the status of the condition. Can be True, False, Unknown. Required.

property type

type: string;

type is the type of the condition. Required.

interface FlowSchemaSpec

interface FlowSchemaSpec

FlowSchemaSpec describes how the FlowSchema’s specification looks like.

property distinguisherMethod

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.

property matchingPrecedence

matchingPrecedence: number;

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.

property priorityLevelConfiguration

priorityLevelConfiguration: PriorityLevelConfigurationReference;

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.

property rules

rules: PolicyRulesWithSubjects[];

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.

interface FlowSchemaStatus

interface FlowSchemaStatus

FlowSchemaStatus represents the current state of a FlowSchema.

property conditions

conditions: FlowSchemaCondition[];

conditions is a list of the current states of FlowSchema.

interface GroupSubject

interface GroupSubject

GroupSubject holds detailed information for group-kind subject.

property name

name: string;

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.

interface LimitedPriorityLevelConfiguration

interface LimitedPriorityLevelConfiguration

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?

property assuredConcurrencyShares

assuredConcurrencyShares: number;

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.

property limitResponse

limitResponse: LimitResponse;

limitResponse indicates what to do with requests that can not be executed right now

interface LimitResponse

interface LimitResponse

LimitResponse defines how to handle requests that can not be executed right now.

property queuing

queuing: QueuingConfiguration;

queuing holds the configuration parameters for queuing. This field may be non-empty only if type is "Queue".

property type

type: string;

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.

interface NonResourcePolicyRule

interface NonResourcePolicyRule

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.

property nonResourceURLs

nonResourceURLs: string[];

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.

property verbs

verbs: string[];

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.

interface PolicyRulesWithSubjects

interface PolicyRulesWithSubjects

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.

property nonResourceRules

nonResourceRules: NonResourcePolicyRule[];

nonResourceRules is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL.

property resourceRules

resourceRules: ResourcePolicyRule[];

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.

property subjects

subjects: Subject[];

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.

interface PriorityLevelConfiguration

interface PriorityLevelConfiguration

PriorityLevelConfiguration represents the configuration of a priority level.

property apiVersion

apiVersion: "flowcontrol.apiserver.k8s.io/v1alpha1";

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

property kind

kind: "PriorityLevelConfiguration";

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

property metadata

metadata: ObjectMeta;

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

property spec

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

property 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

interface PriorityLevelConfigurationCondition

interface PriorityLevelConfigurationCondition

PriorityLevelConfigurationCondition defines the condition of priority level.

property lastTransitionTime

lastTransitionTime: string;

lastTransitionTime is the last time the condition transitioned from one status to another.

property message

message: string;

message is a human-readable message indicating details about last transition.

property reason

reason: string;

reason is a unique, one-word, CamelCase reason for the condition’s last transition.

property status

status: string;

status is the status of the condition. Can be True, False, Unknown. Required.

property type

type: string;

type is the type of the condition. Required.

interface PriorityLevelConfigurationReference

interface PriorityLevelConfigurationReference

PriorityLevelConfigurationReference contains information that points to the “request-priority” being used.

property name

name: string;

name is the name of the priority level configuration being referenced Required.

interface PriorityLevelConfigurationSpec

interface PriorityLevelConfigurationSpec

PriorityLevelConfigurationSpec specifies the configuration of a priority level.

property limited

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

property type

type: string;

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.

interface PriorityLevelConfigurationStatus

interface PriorityLevelConfigurationStatus

PriorityLevelConfigurationStatus represents the current state of a “request-priority”.

property conditions

conditions: PriorityLevelConfigurationCondition[];

conditions is the current state of “request-priority”.

interface QueuingConfiguration

interface QueuingConfiguration

QueuingConfiguration holds the configuration parameters for queuing

property handSize

handSize: number;

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.

property queueLengthLimit

queueLengthLimit: number;

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.

property queues

queues: number;

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.

interface ResourcePolicyRule

interface ResourcePolicyRule

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, © at least one member of resources matches the request, and (d) least one member of namespaces matches the request.

property apiGroups

apiGroups: string[];

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.

property clusterScope

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.

property namespaces

namespaces: string[];

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.

property resources

resources: string[];

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.

property verbs

verbs: string[];

verbs is a list of matching verbs and may not be empty. “*” matches all verbs and, if present, must be the only entry. Required.

interface ServiceAccountSubject

interface ServiceAccountSubject

ServiceAccountSubject holds detailed information for service-account-kind subject.

property name

name: string;

name is the name of matching ServiceAccount objects, or “*” to match regardless of name. Required.

property namespace

namespace: string;

namespace is the namespace of matching ServiceAccount objects. Required.

interface Subject

interface Subject

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.

property group

group: GroupSubject;

property kind

kind: string;

Required

property serviceAccount

serviceAccount: ServiceAccountSubject;

property user

user: UserSubject;

interface UserSubject

interface UserSubject

UserSubject holds detailed information for user-kind subject.

property name

name: string;

name is the username that matches, or “*” to match all usernames. Required.

namespace meta.v1

interface LabelSelector

interface LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

property matchExpressions

matchExpressions: LabelSelectorRequirement[];

matchExpressions is a list of label selector requirements. The requirements are ANDed.

property matchLabels

matchLabels: {[key: string]: string};

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

interface LabelSelectorRequirement

interface LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

property key

key: string;

key is the label key that the selector applies to.

property operator

operator: string;

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

property values

values: string[];

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

interface ListMeta

interface ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

property continue

continue: string;

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

property remainingItemCount

remainingItemCount: number;

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

property resourceVersion

resourceVersion: string;

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink: string;

selfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

interface ManagedFieldsEntry

interface ManagedFieldsEntry

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

property apiVersion

apiVersion: string;

APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

property fieldsType

fieldsType: string;

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”

property fieldsV1

fieldsV1: any;

FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.

property manager

manager: string;

Manager is an identifier of the workflow managing these fields.

property operation

operation: string;

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.

property time

time: string;

Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’

interface ObjectMeta

interface ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

property annotations

annotations: {[key: string]: string};

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property clusterName

clusterName: string;

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

property creationTimestamp

creationTimestamp: string;

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property deletionGracePeriodSeconds

deletionGracePeriodSeconds: number;

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

property deletionTimestamp

deletionTimestamp: string;

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

property finalizers

finalizers: string[];

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

property generateName

generateName: string;

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

property generation

generation: number;

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

property labels

labels: {[key: string]: string};

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property managedFields

managedFields: ManagedFieldsEntry[];

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.

property name

name: string;

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

property namespace

namespace: string;

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

property ownerReferences

ownerReferences: OwnerReference[];

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

property resourceVersion

resourceVersion: string;

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink: string;

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

property uid

uid: string;

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

interface OwnerReference

interface OwnerReference

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

property apiVersion

apiVersion: string;

API version of the referent.

property blockOwnerDeletion

blockOwnerDeletion: boolean;

If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

property controller

controller: boolean;

If true, this reference points to the managing controller.

property kind

kind: string;

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

property name

name: string;

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

property uid

uid: string;

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

interface StatusCause

interface StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

property field

field: string;

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

Examples: “name” - the field “name” on the current resource “items[0].name” - the field “name” on the first array entry in “items”

property message

message: string;

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

property reason

reason: string;

A machine-readable description of the cause of the error. If this value is empty there is no information available.

interface StatusDetails

interface StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

property causes

causes: StatusCause[];

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

property group

group: string;

The group attribute of the resource associated with the status StatusReason.

property kind

kind: string;

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

property name

name: string;

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

property retryAfterSeconds

retryAfterSeconds: number;

If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.

property uid

uid: string;

UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

namespace networking.v1

interface IPBlock

interface IPBlock

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.

property cidr

cidr: string;

CIDR is a string representing the IP Block Valid examples are “192.168.1.1/24” or “2001:db9::/64”

property except

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

interface NetworkPolicy

interface NetworkPolicy

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

property apiVersion

apiVersion: "networking.k8s.io/v1";

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

property kind

kind: "NetworkPolicy";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: NetworkPolicySpec;

Specification of the desired behavior for this NetworkPolicy.

interface NetworkPolicyEgressRule

interface NetworkPolicyEgressRule

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

property ports

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.

property to

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.

interface NetworkPolicyIngressRule

interface NetworkPolicyIngressRule

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.

property from

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.

property ports

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.

interface NetworkPolicyPeer

interface NetworkPolicyPeer

NetworkPolicyPeer describes a peer to allow traffic from. Only certain combinations of fields are allowed

property ipBlock

ipBlock: IPBlock;

IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.

property namespaceSelector

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.

property podSelector

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.

interface NetworkPolicyPort

interface NetworkPolicyPort

NetworkPolicyPort describes a port to allow traffic on

property port

port: number | string;

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.

property protocol

protocol: string;

The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.

interface NetworkPolicySpec

interface NetworkPolicySpec

NetworkPolicySpec provides the specification of a NetworkPolicy

property egress

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

property ingress

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)

property podSelector

podSelector: LabelSelector;

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.

property policyTypes

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

namespace networking.v1beta1

interface HTTPIngressPath

interface HTTPIngressPath

HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.

property backend

backend: IngressBackend;

Backend defines the referenced service endpoint to which the traffic will be forwarded to.

property path

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 ‘/’. When unspecified, all paths from incoming requests are matched.

property pathType

pathType: string;

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. Defaults to ImplementationSpecific.

interface HTTPIngressRuleValue

interface HTTPIngressRuleValue

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last ‘/’ and before the first ‘?’ or ‘#’.

property paths

paths: HTTPIngressPath[];

A collection of paths that map requests to backends.

interface Ingress

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

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

  1. Ingress object exists.
  2. Endpoint objects exist with matching names for each Ingress path (except when Service type is ExternalName).
  3. Ingress entry exists for ‘.status.loadBalancer.ingress’.

If the Ingress has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the ‘customTimeouts’ option on the resource.

property apiVersion

apiVersion: "networking.k8s.io/v1beta1";

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

property kind

kind: "Ingress";

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

property metadata

metadata: ObjectMeta;

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

property spec

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

property 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

interface IngressBackend

interface IngressBackend

IngressBackend describes all endpoints for a given service and port.

property resource

resource: TypedLocalObjectReference;

Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.

property serviceName

serviceName: string;

Specifies the name of the referenced service.

property servicePort

servicePort: number | string;

Specifies the port of the referenced service.

interface IngressClass

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

property apiVersion

apiVersion: "networking.k8s.io/v1beta1";

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

property kind

kind: "IngressClass";

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

property metadata

metadata: ObjectMeta;

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

property spec

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

interface IngressClassSpec

interface IngressClassSpec

IngressClassSpec provides information about the class of an Ingress.

property controller

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.

property parameters

parameters: TypedLocalObjectReference;

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.

interface IngressRule

interface IngressRule

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.

property host

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.

property http

http: HTTPIngressRuleValue;

interface IngressSpec

interface IngressSpec

IngressSpec describes the Ingress the user wishes to exist.

property backend

backend: IngressBackend;

A default backend capable of servicing requests that don’t match any rule. At least one of ‘backend’ or ‘rules’ must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.

property ingressClassName

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.

property rules

rules: IngressRule[];

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

property tls

tls: IngressTLS[];

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.

interface IngressStatus

interface IngressStatus

IngressStatus describe the current state of the Ingress.

property loadBalancer

loadBalancer: LoadBalancerStatus;

LoadBalancer contains the current status of the load-balancer.

interface IngressTLS

interface IngressTLS

IngressTLS describes the transport layer security associated with an Ingress.

property hosts

hosts: string[];

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.

property secretName

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.

namespace node.v1alpha1

interface Overhead

interface Overhead

Overhead structure represents the resource overhead associated with running a pod.

property podFixed

podFixed: {[key: string]: string};

PodFixed represents the fixed resource overhead associated with running a pod.

interface RuntimeClass

interface 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 (currently) 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://git.k8s.io/enhancements/keps/sig-node/runtime-class.md

property apiVersion

apiVersion: "node.k8s.io/v1alpha1";

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

property kind

kind: "RuntimeClass";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: RuntimeClassSpec;

Specification of the RuntimeClass More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

interface RuntimeClassSpec

interface RuntimeClassSpec

RuntimeClassSpec is a specification of a RuntimeClass. It contains parameters that are required to describe the RuntimeClass to the Container Runtime Interface (CRI) implementation, as well as any other components that need to understand how the pod will be run. The RuntimeClassSpec is immutable.

property overhead

overhead: Overhead;

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.

property runtimeHandler

runtimeHandler: string;

RuntimeHandler 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 RuntimeHandler must conform to the DNS Label (RFC 1123) requirements and is immutable.

property scheduling

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.

interface Scheduling

interface Scheduling

Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass.

property nodeSelector

nodeSelector: {[key: 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.

property tolerations

tolerations: Toleration[];

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.

namespace node.v1beta1

interface Overhead

interface Overhead

Overhead structure represents the resource overhead associated with running a pod.

property podFixed

podFixed: {[key: string]: string};

PodFixed represents the fixed resource overhead associated with running a pod.

interface RuntimeClass

interface 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 (currently) 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://git.k8s.io/enhancements/keps/sig-node/runtime-class.md

property apiVersion

apiVersion: "node.k8s.io/v1beta1";

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

property handler

handler: string;

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 conform to the DNS Label (RFC 1123) requirements, and is immutable.

property kind

kind: "RuntimeClass";

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

property metadata

metadata: ObjectMeta;

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

property overhead

overhead: Overhead;

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.

property scheduling

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.

interface Scheduling

interface Scheduling

Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass.

property nodeSelector

nodeSelector: {[key: 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.

property tolerations

tolerations: Toleration[];

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.

namespace policy.v1beta1

interface AllowedCSIDriver

interface AllowedCSIDriver

AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used.

property name

name: string;

Name is the registered name of the CSI driver

interface AllowedFlexVolume

interface AllowedFlexVolume

AllowedFlexVolume represents a single Flexvolume that is allowed to be used.

property driver

driver: string;

driver is the name of the Flexvolume driver.

interface AllowedHostPath

interface AllowedHostPath

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.

property pathPrefix

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

property readOnly

readOnly: boolean;

when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.

interface FSGroupStrategyOptions

interface FSGroupStrategyOptions

FSGroupStrategyOptions defines the strategy type and options used to create the strategy.

property ranges

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.

property rule

rule: string;

rule is the strategy that will dictate what FSGroup is used in the SecurityContext.

interface HostPortRange

interface HostPortRange

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.

property max

max: number;

max is the end of the range, inclusive.

property min

min: number;

min is the start of the range, inclusive.

interface IDRange

interface IDRange

IDRange provides a min/max of an allowed range of IDs.

property max

max: number;

max is the end of the range, inclusive.

property min

min: number;

min is the start of the range, inclusive.

interface PodDisruptionBudget

interface PodDisruptionBudget

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

property apiVersion

apiVersion: "policy/v1beta1";

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

property kind

kind: "PodDisruptionBudget";

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

property metadata

metadata: ObjectMeta;

property spec

spec: PodDisruptionBudgetSpec;

Specification of the desired behavior of the PodDisruptionBudget.

property status

status: PodDisruptionBudgetStatus;

Most recently observed status of the PodDisruptionBudget.

interface PodDisruptionBudgetSpec

interface PodDisruptionBudgetSpec

PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.

property maxUnavailable

maxUnavailable: number | string;

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

property minAvailable

minAvailable: number | string;

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

property selector

selector: LabelSelector;

Label query over pods whose evictions are managed by the disruption budget.

interface PodDisruptionBudgetStatus

interface PodDisruptionBudgetStatus

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

property currentHealthy

currentHealthy: number;

current number of healthy pods

property desiredHealthy

desiredHealthy: number;

minimum desired number of healthy pods

property disruptedPods

disruptedPods: {[key: string]: string};

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.

property disruptionsAllowed

disruptionsAllowed: number;

Number of pod disruptions that are currently allowed.

property expectedPods

expectedPods: number;

total number of pods counted by this disruption budget

property observedGeneration

observedGeneration: number;

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.

interface PodSecurityPolicy

interface PodSecurityPolicy

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

property apiVersion

apiVersion: "policy/v1beta1";

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

property kind

kind: "PodSecurityPolicy";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: PodSecurityPolicySpec;

spec defines the policy enforced.

interface PodSecurityPolicySpec

interface PodSecurityPolicySpec

PodSecurityPolicySpec defines the policy enforced.

property allowPrivilegeEscalation

allowPrivilegeEscalation: boolean;

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

property allowedCSIDrivers

allowedCSIDrivers: AllowedCSIDriver[];

AllowedCSIDrivers is a whitelist 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 an alpha field, and is only honored if the API server enables the CSIInlineVolume feature gate.

property allowedCapabilities

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.

property allowedFlexVolumes

allowedFlexVolumes: AllowedFlexVolume[];

allowedFlexVolumes is a whitelist of allowed 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.

property allowedHostPaths

allowedHostPaths: AllowedHostPath[];

allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used.

property allowedProcMountTypes

allowedProcMountTypes: string[];

AllowedProcMountTypes is a whitelist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled.

property allowedUnsafeSysctls

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

property defaultAddCapabilities

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.

property defaultAllowPrivilegeEscalation

defaultAllowPrivilegeEscalation: boolean;

defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.

property forbiddenSysctls

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.

property fsGroup

fsGroup: FSGroupStrategyOptions;

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

property hostIPC

hostIPC: boolean;

hostIPC determines if the policy allows the use of HostIPC in the pod spec.

property hostNetwork

hostNetwork: boolean;

hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.

property hostPID

hostPID: boolean;

hostPID determines if the policy allows the use of HostPID in the pod spec.

property hostPorts

hostPorts: HostPortRange[];

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

property privileged

privileged: boolean;

privileged determines if a pod can request to be run as privileged.

property readOnlyRootFilesystem

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.

property requiredDropCapabilities

requiredDropCapabilities: string[];

requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.

property runAsGroup

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.

property runAsUser

runAsUser: RunAsUserStrategyOptions;

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

property runtimeClass

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.

property seLinux

seLinux: SELinuxStrategyOptions;

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

property supplementalGroups

supplementalGroups: SupplementalGroupsStrategyOptions;

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

property volumes

volumes: string[];

volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use ‘*‘.

interface RunAsGroupStrategyOptions

interface RunAsGroupStrategyOptions

RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy.

property ranges

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.

property rule

rule: string;

rule is the strategy that will dictate the allowable RunAsGroup values that may be set.

interface RunAsUserStrategyOptions

interface RunAsUserStrategyOptions

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.

property ranges

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.

property rule

rule: string;

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

interface RuntimeClassStrategyOptions

interface RuntimeClassStrategyOptions

RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod.

property allowedRuntimeClassNames

allowedRuntimeClassNames: string[];

allowedRuntimeClassNames is a whitelist 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.

property defaultRuntimeClassName

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.

interface SELinuxStrategyOptions

interface SELinuxStrategyOptions

SELinuxStrategyOptions defines the strategy type and any options used to create the strategy.

property rule

rule: string;

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

property seLinuxOptions

seLinuxOptions: SELinuxOptions;

seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

interface SupplementalGroupsStrategyOptions

interface SupplementalGroupsStrategyOptions

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.

property ranges

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.

property rule

rule: string;

rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.

namespace rbac.v1

interface AggregationRule

interface AggregationRule

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

property clusterRoleSelectors

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

interface ClusterRole

interface ClusterRole

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

property aggregationRule

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.

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1";

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

property kind

kind: "ClusterRole";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property rules

rules: PolicyRule[];

Rules holds all the PolicyRules for this ClusterRole

interface ClusterRoleBinding

interface ClusterRoleBinding

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

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1";

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

property kind

kind: "ClusterRoleBinding";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property roleRef

roleRef: RoleRef;

RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.

property subjects

subjects: Subject[];

Subjects holds references to the objects the role applies to.

interface PolicyRule

interface PolicyRule

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.

property apiGroups

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.

property nonResourceURLs

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.

property resourceNames

resourceNames: string[];

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

property resources

resources: string[];

Resources is a list of resources this rule applies to. ResourceAll represents all resources.

property verbs

verbs: string[];

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

interface Role

interface Role

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

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1";

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

property kind

kind: "Role";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property rules

rules: PolicyRule[];

Rules holds all the PolicyRules for this Role

interface RoleBinding

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

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1";

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

property kind

kind: "RoleBinding";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property roleRef

roleRef: RoleRef;

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.

property subjects

subjects: Subject[];

Subjects holds references to the objects the role applies to.

interface RoleRef

interface RoleRef

RoleRef contains information that points to the role being used

property apiGroup

apiGroup: string;

APIGroup is the group for the resource being referenced

property kind

kind: string;

Kind is the type of resource being referenced

property name

name: string;

Name is the name of resource being referenced

interface Subject

interface Subject

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.

property apiGroup

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.

property kind

kind: string;

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.

property name

name: string;

Name of the object being referenced.

property namespace

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.

namespace rbac.v1alpha1

interface AggregationRule

interface AggregationRule

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

property clusterRoleSelectors

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

interface ClusterRole

interface ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.20.

property aggregationRule

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.

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1alpha1";

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

property kind

kind: "ClusterRole";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property rules

rules: PolicyRule[];

Rules holds all the PolicyRules for this ClusterRole

interface ClusterRoleBinding

interface ClusterRoleBinding

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.20.

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1alpha1";

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

property kind

kind: "ClusterRoleBinding";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property roleRef

roleRef: RoleRef;

RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.

property subjects

subjects: Subject[];

Subjects holds references to the objects the role applies to.

interface PolicyRule

interface PolicyRule

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.

property apiGroups

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.

property nonResourceURLs

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.

property resourceNames

resourceNames: string[];

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

property resources

resources: string[];

Resources is a list of resources this rule applies to. ResourceAll represents all resources.

property verbs

verbs: string[];

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

interface Role

interface Role

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.20.

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1alpha1";

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

property kind

kind: "Role";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property rules

rules: PolicyRule[];

Rules holds all the PolicyRules for this Role

interface RoleBinding

interface 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. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.20.

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1alpha1";

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

property kind

kind: "RoleBinding";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property roleRef

roleRef: RoleRef;

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.

property subjects

subjects: Subject[];

Subjects holds references to the objects the role applies to.

interface RoleRef

interface RoleRef

RoleRef contains information that points to the role being used

property apiGroup

apiGroup: string;

APIGroup is the group for the resource being referenced

property kind

kind: string;

Kind is the type of resource being referenced

property name

name: string;

Name is the name of resource being referenced

interface Subject

interface Subject

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.

property apiVersion

apiVersion: string;

APIVersion holds the API group and version of the referenced subject. Defaults to “v1” for ServiceAccount subjects. Defaults to “rbac.authorization.k8s.io/v1alpha1” for User and Group subjects.

property kind

kind: string;

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.

property name

name: string;

Name of the object being referenced.

property namespace

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.

namespace rbac.v1beta1

interface AggregationRule

interface AggregationRule

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

property clusterRoleSelectors

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

interface ClusterRole

interface ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.20.

property aggregationRule

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.

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1beta1";

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

property kind

kind: "ClusterRole";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property rules

rules: PolicyRule[];

Rules holds all the PolicyRules for this ClusterRole

interface ClusterRoleBinding

interface ClusterRoleBinding

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.20.

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1beta1";

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

property kind

kind: "ClusterRoleBinding";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property roleRef

roleRef: RoleRef;

RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.

property subjects

subjects: Subject[];

Subjects holds references to the objects the role applies to.

interface PolicyRule

interface PolicyRule

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.

property apiGroups

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.

property nonResourceURLs

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.

property resourceNames

resourceNames: string[];

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

property resources

resources: string[];

Resources is a list of resources this rule applies to. ‘’ represents all resources in the specified apiGroups. ‘/foo’ represents the subresource ‘foo’ for all resources in the specified apiGroups.

property verbs

verbs: string[];

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

interface Role

interface Role

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.20.

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1beta1";

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

property kind

kind: "Role";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property rules

rules: PolicyRule[];

Rules holds all the PolicyRules for this Role

interface RoleBinding

interface 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. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.20.

property apiVersion

apiVersion: "rbac.authorization.k8s.io/v1beta1";

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

property kind

kind: "RoleBinding";

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

property metadata

metadata: ObjectMeta;

Standard object’s metadata.

property roleRef

roleRef: RoleRef;

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.

property subjects

subjects: Subject[];

Subjects holds references to the objects the role applies to.

interface RoleRef

interface RoleRef

RoleRef contains information that points to the role being used

property apiGroup

apiGroup: string;

APIGroup is the group for the resource being referenced

property kind

kind: string;

Kind is the type of resource being referenced

property name

name: string;

Name is the name of resource being referenced

interface Subject

interface Subject

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.

property apiGroup

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.

property kind

kind: string;

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.

property name

name: string;

Name of the object being referenced.

property namespace

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.

namespace scheduling.v1

interface PriorityClass

interface PriorityClass

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

property apiVersion

apiVersion: "scheduling.k8s.io/v1";

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

property description

description: string;

description is an arbitrary string that usually provides guidelines on when this priority class should be used.

property globalDefault

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.

property kind

kind: "PriorityClass";

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

property metadata

metadata: ObjectMeta;

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

property preemptionPolicy

preemptionPolicy: string;

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.

property value

value: number;

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.

namespace scheduling.v1alpha1

interface PriorityClass

interface PriorityClass

DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

property apiVersion

apiVersion: "scheduling.k8s.io/v1alpha1";

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

property description

description: string;

description is an arbitrary string that usually provides guidelines on when this priority class should be used.

property globalDefault

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.

property kind

kind: "PriorityClass";

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

property metadata

metadata: ObjectMeta;

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

property preemptionPolicy

preemptionPolicy: string;

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.

property value

value: number;

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.

namespace scheduling.v1beta1

interface PriorityClass

interface PriorityClass

DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

property apiVersion

apiVersion: "scheduling.k8s.io/v1beta1";

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

property description

description: string;

description is an arbitrary string that usually provides guidelines on when this priority class should be used.

property globalDefault

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.

property kind

kind: "PriorityClass";

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

property metadata

metadata: ObjectMeta;

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

property preemptionPolicy

preemptionPolicy: string;

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.

property value

value: number;

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.

namespace settings.v1alpha1

interface PodPreset

interface PodPreset

PodPreset is a policy resource that defines additional runtime requirements for a Pod.

property apiVersion

apiVersion: "settings.k8s.io/v1alpha1";

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

property kind

kind: "PodPreset";

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

property metadata

metadata: ObjectMeta;

property spec

spec: PodPresetSpec;

interface PodPresetSpec

interface PodPresetSpec

PodPresetSpec is a description of a pod preset.

property env

env: EnvVar[];

Env defines the collection of EnvVar to inject into containers.

property envFrom

envFrom: EnvFromSource[];

EnvFrom defines the collection of EnvFromSource to inject into containers.

property selector

selector: LabelSelector;

Selector is a label query over a set of resources, in this case pods. Required.

property volumeMounts

volumeMounts: VolumeMount[];

VolumeMounts defines the collection of VolumeMount to inject into containers.

property volumes

volumes: Volume[];

Volumes defines the collection of Volume to inject into the pod.

namespace storage.v1

interface CSIDriver

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

property apiVersion

apiVersion: "storage.k8s.io/v1";

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

property kind

kind: "CSIDriver";

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

property metadata

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

property spec

spec: CSIDriverSpec;

Specification of the CSI Driver.

interface CSIDriverSpec

interface CSIDriverSpec

CSIDriverSpec is the specification of a CSIDriver.

property attachRequired

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.

property podInfoOnMount

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

property volumeLifecycleModes

volumeLifecycleModes: string[];

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.

interface CSINode

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

property apiVersion

apiVersion: "storage.k8s.io/v1";

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

property kind

kind: "CSINode";

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

property metadata

metadata: ObjectMeta;

metadata.name must be the Kubernetes node name.

property spec

spec: CSINodeSpec;

spec is the specification of CSINode

interface CSINodeDriver

interface CSINodeDriver

CSINodeDriver holds information about the specification of one CSI driver installed on a node

property allocatable

allocatable: VolumeNodeResources;

allocatable represents the volume resources of a node that are available for scheduling. This field is beta.

property name

name: string;

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.

property nodeID

nodeID: string;

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.

property topologyKeys

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.

interface CSINodeSpec

interface CSINodeSpec

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

property drivers

drivers: CSINodeDriver[];

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.

interface StorageClass

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

property allowVolumeExpansion

allowVolumeExpansion: boolean;

AllowVolumeExpansion shows whether the storage class allow volume expand

property allowedTopologies

allowedTopologies: TopologySelectorTerm[];

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.

property apiVersion

apiVersion: "storage.k8s.io/v1";

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

property kind

kind: "StorageClass";

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

property metadata

metadata: ObjectMeta;

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

property mountOptions

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.

property parameters

parameters: {[key: string]: string};

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

property provisioner

provisioner: string;

Provisioner indicates the type of the provisioner.

property reclaimPolicy

reclaimPolicy: string;

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

property volumeBindingMode

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.

interface VolumeAttachment

interface VolumeAttachment

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

VolumeAttachment objects are non-namespaced.

property apiVersion

apiVersion: "storage.k8s.io/v1";

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

property kind

kind: "VolumeAttachment";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: VolumeAttachmentSpec;

Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.

property status

status: VolumeAttachmentStatus;

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

interface VolumeAttachmentSource

interface VolumeAttachmentSource

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.

property inlineVolumeSpec

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 alpha-level and is only honored by servers that enabled the CSIMigration feature.

property persistentVolumeName

persistentVolumeName: string;

Name of the persistent volume to attach.

interface VolumeAttachmentSpec

interface VolumeAttachmentSpec

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

property attacher

attacher: string;

Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().

property nodeName

nodeName: string;

The node that the volume should be attached to.

property source

source: VolumeAttachmentSource;

Source represents the volume that should be attached.

interface VolumeAttachmentStatus

interface VolumeAttachmentStatus

VolumeAttachmentStatus is the status of a VolumeAttachment request.

property attachError

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.

property attached

attached: boolean;

Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.

property attachmentMetadata

attachmentMetadata: {[key: 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.

property detachError

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.

interface VolumeError

interface VolumeError

VolumeError captures an error encountered during a volume operation.

property message

message: string;

String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.

property time

time: string;

Time the error was encountered.

interface VolumeNodeResources

interface VolumeNodeResources

VolumeNodeResources is a set of resource limits for scheduling of volumes.

property count

count: number;

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.

namespace storage.v1alpha1

interface VolumeAttachment

interface VolumeAttachment

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

VolumeAttachment objects are non-namespaced.

property apiVersion

apiVersion: "storage.k8s.io/v1alpha1";

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

property kind

kind: "VolumeAttachment";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: VolumeAttachmentSpec;

Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.

property status

status: VolumeAttachmentStatus;

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

interface VolumeAttachmentSource

interface VolumeAttachmentSource

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.

property inlineVolumeSpec

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 alpha-level and is only honored by servers that enabled the CSIMigration feature.

property persistentVolumeName

persistentVolumeName: string;

Name of the persistent volume to attach.

interface VolumeAttachmentSpec

interface VolumeAttachmentSpec

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

property attacher

attacher: string;

Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().

property nodeName

nodeName: string;

The node that the volume should be attached to.

property source

source: VolumeAttachmentSource;

Source represents the volume that should be attached.

interface VolumeAttachmentStatus

interface VolumeAttachmentStatus

VolumeAttachmentStatus is the status of a VolumeAttachment request.

property attachError

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.

property attached

attached: boolean;

Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.

property attachmentMetadata

attachmentMetadata: {[key: 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.

property detachError

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.

interface VolumeError

interface VolumeError

VolumeError captures an error encountered during a volume operation.

property message

message: string;

String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.

property time

time: string;

Time the error was encountered.

namespace storage.v1beta1

interface CSIDriver

interface CSIDriver

CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. 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.

property apiVersion

apiVersion: "storage.k8s.io/v1beta1";

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

property kind

kind: "CSIDriver";

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

property metadata

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

property spec

spec: CSIDriverSpec;

Specification of the CSI Driver.

interface CSIDriverSpec

interface CSIDriverSpec

CSIDriverSpec is the specification of a CSIDriver.

property attachRequired

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.

property podInfoOnMount

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

property volumeLifecycleModes

volumeLifecycleModes: string[];

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.

interface CSINode

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

property apiVersion

apiVersion: "storage.k8s.io/v1beta1";

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

property kind

kind: "CSINode";

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

property metadata

metadata: ObjectMeta;

metadata.name must be the Kubernetes node name.

property spec

spec: CSINodeSpec;

spec is the specification of CSINode

interface CSINodeDriver

interface CSINodeDriver

CSINodeDriver holds information about the specification of one CSI driver installed on a node

property allocatable

allocatable: VolumeNodeResources;

allocatable represents the volume resources of a node that are available for scheduling.

property name

name: string;

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.

property nodeID

nodeID: string;

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.

property topologyKeys

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.

interface CSINodeSpec

interface CSINodeSpec

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

property drivers

drivers: CSINodeDriver[];

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.

interface StorageClass

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

property allowVolumeExpansion

allowVolumeExpansion: boolean;

AllowVolumeExpansion shows whether the storage class allow volume expand

property allowedTopologies

allowedTopologies: TopologySelectorTerm[];

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.

property apiVersion

apiVersion: "storage.k8s.io/v1beta1";

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

property kind

kind: "StorageClass";

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

property metadata

metadata: ObjectMeta;

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

property mountOptions

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.

property parameters

parameters: {[key: string]: string};

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

property provisioner

provisioner: string;

Provisioner indicates the type of the provisioner.

property reclaimPolicy

reclaimPolicy: string;

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

property volumeBindingMode

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.

interface VolumeAttachment

interface VolumeAttachment

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

VolumeAttachment objects are non-namespaced.

property apiVersion

apiVersion: "storage.k8s.io/v1beta1";

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

property kind

kind: "VolumeAttachment";

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

property metadata

metadata: ObjectMeta;

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

property spec

spec: VolumeAttachmentSpec;

Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.

property status

status: VolumeAttachmentStatus;

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

interface VolumeAttachmentSource

interface VolumeAttachmentSource

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.

property inlineVolumeSpec

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 alpha-level and is only honored by servers that enabled the CSIMigration feature.

property persistentVolumeName

persistentVolumeName: string;

Name of the persistent volume to attach.

interface VolumeAttachmentSpec

interface VolumeAttachmentSpec

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

property attacher

attacher: string;

Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().

property nodeName

nodeName: string;

The node that the volume should be attached to.

property source

source: VolumeAttachmentSource;

Source represents the volume that should be attached.

interface VolumeAttachmentStatus

interface VolumeAttachmentStatus

VolumeAttachmentStatus is the status of a VolumeAttachment request.

property attachError

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.

property attached

attached: boolean;

Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.

property attachmentMetadata

attachmentMetadata: {[key: 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.

property detachError

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.

interface VolumeError

interface VolumeError

VolumeError captures an error encountered during a volume operation.

property message

message: string;

String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.

property time

time: string;

Time the error was encountered.

interface VolumeNodeResources

interface VolumeNodeResources

VolumeNodeResources is a set of resource limits for scheduling of volumes.

property count

count: number;

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 nil, then the supported number of volumes on this node is unbounded.

  1. 0-9a-f [return]
  2. 0-9a-f [return]
  3. 0-9a-f [return]
  4. 0-9a-f [return]
  5. 0-9a-f [return]
  6. 0-9a-f [return]
  7. 0-9a-f [return]
  8. 0-9a-f [return]