persistent_volume_claim

State module for managing Kubernetes PersistentVolumeClaim(s).

async idem_k8s.states.k8s.core.v1.persistent_volume_claim.present(hub, ctx, name: str, metadata: metadata, spec: spec, resource_id: str = None) → Dict[str, Any]

Creates a PersistentVolumeClaim.

Parameters:

• name (str) – An Idem name of the resource.

• resource_id (str, Optional) – An identifier of the resource in the provider. Defaults to None.

• metadata (dict) – Standard object’s metadata. More info: Kubernetes metadata reference

• spec (dict) – Spec defines the desired characteristics of a volume requested by a pod author. More info: Kubernetes spec reference

Request Syntax:

[pvc-name]:
  k8s.core.v1.persistent_volume_claim.present:
    - name: 'string'
    - metadata: Dict
    - spec: Dict
    - resource_id: 'string'

Returns:

Dict[str, Any]

Examples

resource_is_present:
  k8s.core.v1.persistent_volume_claim.present:
    - name: "pvc-1"
    - metadata:
        name: "pvc-1"
        labels:
          name: "pvc-1"
        annotations:
          volume.beta.kubernetes.io/storage-class: "sc-1"
    - spec:
        access_modes:
          - ReadWriteMany
        resources:
          requests:
            storage: 1Mi

async idem_k8s.states.k8s.core.v1.persistent_volume_claim.absent(hub, ctx, name: str, metadata: Dict = {'namespace': 'default'}, resource_id: str = None) → Dict[str, Any]

Deletes a PersistentVolumeClaim.

Parameters:

• name (str) – An Idem name of the resource.

• resource_id (str, Optional) – An identifier of the resource in the provider. Defaults to None.

• metadata (dict, Optional) –

  Standard object’s metadata. Defaults to metadata with ‘default’ namespace, in case of value not provided in absent state. More info: Kubernetes metadata reference

Request Syntax:

[service-name]:
  k8s.core.v1.service.absent:
    - name: 'string'
    - metadata: Dict
    - resource_id: 'string'

Returns:

Dict[str, Any]

Examples

resource_is_absent:
  k8s.core.v1.persistent_volume_claim.absent:
    - name: "pvc-1"
    - resource_id: "pvc-1"
    - metadata:
        namespace: "default"

async idem_k8s.states.k8s.core.v1.persistent_volume_claim.describe(hub, ctx) → Dict[str, Dict[str, Any]]

Describes the resource in a way that can be recreated/managed with the corresponding “present” function.

list or watch objects of kind PersistentVolumeClaim.

Returns:

Dict[str, Any]

Examples

$ idem describe k8s.core.v1.persistent_volume_claim