Fork me on GitHub

Module meta/v1

@pulumi/kubernetes > meta > v1

Index

types/input.ts types/output.ts

function isAPIGroup

isAPIGroup(o: any): boolean

function isAPIGroupList

isAPIGroupList(o: any): boolean

function isAPIResourceList

isAPIResourceList(o: any): boolean

function isAPIVersions

isAPIVersions(o: any): boolean

function isDeleteOptions

isDeleteOptions(o: any): boolean

function isOwnerReference

isOwnerReference(o: any): boolean

function isStatus

isStatus(o: any): boolean

interface APIGroup

APIGroup contains the name, the supported versions, and the preferred version of a group.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property name

name: string;

name is the name of the group.

property preferredVersion

preferredVersion: GroupVersionForDiscovery;

preferredVersion is the version preferred by the API server, which probably is the storage version.

property serverAddressByClientCIDRs

serverAddressByClientCIDRs: ServerAddressByClientCIDR[];

a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.

property versions

versions: GroupVersionForDiscovery[];

versions are the versions supported in this group.

interface APIGroupList

APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property groups

groups: APIGroup[];

groups is a list of APIGroup.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

interface APIResource

APIResource specifies the name of a resource and whether it is namespaced.

property categories

categories: string[];

categories is a list of the grouped resources this resource belongs to (e.g. ‘all’)

property group

group: string;

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale”.

property kind

kind: string;

kind is the kind for the resource (e.g. ‘Foo’ is the kind for a resource ‘foo’)

property name

name: string;

name is the plural name of the resource.

property namespaced

namespaced: boolean;

namespaced indicates if a resource is namespaced or not.

property shortNames

shortNames: string[];

shortNames is a list of suggested short names of the resource.

property singularName

singularName: string;

singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.

property verbs

verbs: string[];

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

property version

version: string;

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource’s group)”.

interface APIResourceList

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property groupVersion

groupVersion: string;

groupVersion is the group and version this APIResourceList is for.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property resources

resources: APIResource[];

resources contains the name of the resources and if they are namespaced.

interface APIVersions

APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property serverAddressByClientCIDRs

serverAddressByClientCIDRs: ServerAddressByClientCIDR[];

a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.

property versions

versions: string[];

versions are the api versions that are available.

interface DeleteOptions

DeleteOptions may be provided when deleting an API object.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property gracePeriodSeconds

gracePeriodSeconds: number;

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property orphanDependents

orphanDependents: boolean;

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

property preconditions

preconditions: Preconditions;

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

property propagationPolicy

propagationPolicy: string;

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

interface GroupVersionForDiscovery

GroupVersion contains the “group/version” and “version” string of a version. It is made a struct to keep extensibility.

property groupVersion

groupVersion: string;

groupVersion specifies the API group and version in the form “group/version”

property version

version: string;

version specifies the version in the form of “version”. This is to save the clients the trouble of splitting the GroupVersion.

interface Initializer

Initializer is information about an initializer that has not yet completed.

property name

name: string;

name of the process that is responsible for initializing this object.

interface Initializers

Initializers tracks the progress of initialization.

property pending

pending: Initializer[];

Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

property result

result: Status;

If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.

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: { ... };

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

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

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

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/api-conventions.md#concurrency-control-and-consistency

property selfLink

selfLink: string;

selfLink is a URL representing this object. Populated by the system. Read-only.

interface ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

property annotations

annotations: { ... };

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

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/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 initializers

initializers: Initializers;

An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven’t explicitly asked to observe uninitialized objects.

When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.

property labels

labels: { ... };

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 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/api-conventions.md#concurrency-control-and-consistency

property selfLink

selfLink: string;

SelfLink is a URL representing this object. Populated by the system. Read-only.

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

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, 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/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 Preconditions

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

property uid

uid: string;

Specifies the target UID.

interface ServerAddressByClientCIDR

ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.

property clientCIDR

clientCIDR: string;

The CIDR with which clients can match their IP to figure out the server address that they should use.

property serverAddress

serverAddress: string;

Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

interface Status

Status is a return value for calls that don’t return other objects.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property code

code: number;

Suggested HTTP return code for this status, 0 if not set.

property details

details: StatusDetails;

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property message

message: string;

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

property metadata

metadata: ListMeta;

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property reason

reason: string;

A machine-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

property status

status: string;

Status of the operation. One of: “Success” or “Failure”. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

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

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

interface WatchEvent

Event represents a single event to a watched resource.

property object

object: RawExtension;

Object is:

  • If Type is Added or Modified: the new state of the object.
  • If Type is Deleted: the state of the object immediately before deletion.
  • If Type is Error: *Status is recommended; other types may make sense depending on context.

property type

type: string;