v1¶

class pulumi_kubernetes.storage.v1.CSIDriver(resource_name, opts=None, spec=None, metadata=None, __name__=None, __opts__=None)¶

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.

Create a CSIDriver resource with the given unique name, arguments, and options.

Parameters

• resource_name (str) – The unique name of the resource.

• opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.

• spec (pulumi.Input[dict]) – Specification of the CSI Driver.

• metadata (pulumi.Input[dict]) – 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

apiVersion: pulumi.Output[str] = None¶

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

kind: pulumi.Output[str] = None¶

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

metadata: pulumi.Output[dict] = None¶

Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec: pulumi.Output[dict] = None¶

Specification of the CSI Driver.

static get(resource_name, id, opts=None)¶

Get the state of an existing CSIDriver resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters

• resource_name (str) – Unique name used to register this resource with Pulumi.

• id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

• opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kubernetes.storage.v1.CSIDriverList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶

CSIDriverList is a collection of CSIDriver objects.

Create a CSIDriverList resource with the given unique name, arguments, and options.

Parameters

• resource_name (str) – The unique name of the resource.

• opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.

• items (pulumi.Input[list]) – items is the list of CSIDriver

• metadata (pulumi.Input[dict]) – Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

apiVersion: pulumi.Output[str] = None¶

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

kind: pulumi.Output[str] = None¶

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

items: pulumi.Output[list] = None¶

items is the list of CSIDriver

metadata: pulumi.Output[dict] = None¶

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

static get(resource_name, id, opts=None)¶

Get the state of an existing CSIDriverList resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters

• resource_name (str) – Unique name used to register this resource with Pulumi.

• id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

• opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kubernetes.storage.v1.CSINode(resource_name, opts=None, spec=None, metadata=None, __name__=None, __opts__=None)¶

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.

Create a CSINode resource with the given unique name, arguments, and options.

Parameters

• resource_name (str) – The unique name of the resource.

• opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.

• spec (pulumi.Input[dict]) – spec is the specification of CSINode

• metadata (pulumi.Input[dict]) – metadata.name must be the Kubernetes node name.

apiVersion: pulumi.Output[str] = None¶

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

kind: pulumi.Output[str] = None¶

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

metadata: pulumi.Output[dict] = None¶

metadata.name must be the Kubernetes node name.

spec: pulumi.Output[dict] = None¶

spec is the specification of CSINode

static get(resource_name, id, opts=None)¶

Get the state of an existing CSINode resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters

• resource_name (str) – Unique name used to register this resource with Pulumi.

• id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

• opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kubernetes.storage.v1.CSINodeList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶

CSINodeList is a collection of CSINode objects.

Create a CSINodeList resource with the given unique name, arguments, and options.

Parameters

• resource_name (str) – The unique name of the resource.

• opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.

• items (pulumi.Input[list]) – items is the list of CSINode

• metadata (pulumi.Input[dict]) – Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

apiVersion: pulumi.Output[str] = None¶

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

kind: pulumi.Output[str] = None¶

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

items: pulumi.Output[list] = None¶

items is the list of CSINode

metadata: pulumi.Output[dict] = None¶

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

static get(resource_name, id, opts=None)¶

Get the state of an existing CSINodeList resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters

• resource_name (str) – Unique name used to register this resource with Pulumi.

• id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

• opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kubernetes.storage.v1.StorageClass(resource_name, opts=None, provisioner=None, allow_volume_expansion=None, allowed_topologies=None, metadata=None, mount_options=None, parameters=None, reclaim_policy=None, volume_binding_mode=None, __name__=None, __opts__=None)¶

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.

Create a StorageClass resource with the given unique name, arguments, and options.

Parameters

• resource_name (str) – The unique name of the resource.

• opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.

• provisioner (pulumi.Input[str]) – Provisioner indicates the type of the provisioner.

• allow_volume_expansion (pulumi.Input[bool]) – AllowVolumeExpansion shows whether the storage class allow volume expand

• allowed_topologies (pulumi.Input[list]) – 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.

• metadata (pulumi.Input[dict]) – Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• mount_options (pulumi.Input[list]) – Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. [“ro”, “soft”]. Not validated - mount of the PVs will simply fail if one is invalid.

• parameters (pulumi.Input[dict]) – Parameters holds the parameters for the provisioner that should create volumes of this storage class.

• reclaim_policy (pulumi.Input[str]) – Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

• volume_binding_mode (pulumi.Input[str]) – 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.

apiVersion: pulumi.Output[str] = None¶

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

kind: pulumi.Output[str] = None¶

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

allow_volume_expansion: pulumi.Output[bool] = None¶

AllowVolumeExpansion shows whether the storage class allow volume expand

allowed_topologies: pulumi.Output[list] = None¶

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.

metadata: pulumi.Output[dict] = None¶

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

mount_options: pulumi.Output[list] = None¶

Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. [“ro”, “soft”]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters: pulumi.Output[dict] = None¶

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner: pulumi.Output[str] = None¶

Provisioner indicates the type of the provisioner.

reclaim_policy: pulumi.Output[str] = None¶

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

volume_binding_mode: pulumi.Output[str] = None¶

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.

static get(resource_name, id, opts=None)¶

Get the state of an existing StorageClass resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters

• resource_name (str) – Unique name used to register this resource with Pulumi.

• id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

• opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kubernetes.storage.v1.StorageClassList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶

StorageClassList is a collection of storage classes.

Create a StorageClassList resource with the given unique name, arguments, and options.

Parameters

• resource_name (str) – The unique name of the resource.

• opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.

• items (pulumi.Input[list]) – Items is the list of StorageClasses

• metadata (pulumi.Input[dict]) – Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

apiVersion: pulumi.Output[str] = None¶

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

kind: pulumi.Output[str] = None¶

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

items: pulumi.Output[list] = None¶

Items is the list of StorageClasses

metadata: pulumi.Output[dict] = None¶

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

static get(resource_name, id, opts=None)¶

Get the state of an existing StorageClassList resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters

• resource_name (str) – Unique name used to register this resource with Pulumi.

• id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

• opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kubernetes.storage.v1.VolumeAttachment(resource_name, opts=None, spec=None, metadata=None, __name__=None, __opts__=None)¶

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

VolumeAttachment objects are non-namespaced.

Create a VolumeAttachment resource with the given unique name, arguments, and options.

Parameters

• resource_name (str) – The unique name of the resource.

• opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.

• spec (pulumi.Input[dict]) – Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.

• metadata (pulumi.Input[dict]) – Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

apiVersion: pulumi.Output[str] = None¶

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

kind: pulumi.Output[str] = None¶

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

metadata: pulumi.Output[dict] = None¶

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

spec: pulumi.Output[dict] = None¶

Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.

status: pulumi.Output[dict] = None¶

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

static get(resource_name, id, opts=None)¶

Get the state of an existing VolumeAttachment resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters

• resource_name (str) – Unique name used to register this resource with Pulumi.

• id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

• opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kubernetes.storage.v1.VolumeAttachmentList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶

VolumeAttachmentList is a collection of VolumeAttachment objects.

Create a VolumeAttachmentList resource with the given unique name, arguments, and options.

Parameters

• resource_name (str) – The unique name of the resource.

• opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.

• items (pulumi.Input[list]) – Items is the list of VolumeAttachments

• metadata (pulumi.Input[dict]) – Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

apiVersion: pulumi.Output[str] = None¶

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

kind: pulumi.Output[str] = None¶

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

items: pulumi.Output[list] = None¶

Items is the list of VolumeAttachments

metadata: pulumi.Output[dict] = None¶

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

static get(resource_name, id, opts=None)¶

Get the state of an existing VolumeAttachmentList resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters

• resource_name (str) – Unique name used to register this resource with Pulumi.

• id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

• opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str