Module storage/v1beta1

@pulumi/kubernetes > storage > v1beta1

Index

types/input.ts types/output.ts

function isStorageClass

isStorageClass(o: any): boolean

function isStorageClassList

isStorageClassList(o: any): boolean

function isVolumeAttachment

isVolumeAttachment(o: any): boolean

function isVolumeAttachmentList

isVolumeAttachmentList(o: any): boolean

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: 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 metadata

metadata: ObjectMeta;

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/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: { ... };

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 StorageClassList

StorageClassList is a collection of storage classes.

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 items

items: StorageClass[];

Items is the list of StorageClasses

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 metadata

metadata: ListMeta;

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

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: 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 metadata

metadata: ObjectMeta;

Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/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 VolumeAttachmentList

VolumeAttachmentList is a collection of VolumeAttachment 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 items

items: VolumeAttachment[];

Items is the list of VolumeAttachments

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 metadata

metadata: ListMeta;

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

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 persistentVolumeName

persistentVolumeName: string;

Name of the persistent volume to attach.

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

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

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

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.