The module lifecycle stage: General Availability
The module has requirements for installation

The Deckhouse Kubernetes Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.

DataExport

Scope: Namespaced
Version: v1alpha1

Resource for exporting persistent volume files and blocks.
  • spec
    object
    • spec.publicIngress
      string
      Type of public ingress for external access.

      Allowed values: KubernetesAPI, ConsoleFrontend

    • spec.publish
      boolean
      Enable external access to the exporter pod outside the cluster.
    • spec.targetRef
      object

      Required value

      Reference to the target resource for export.
      • spec.targetRef.kind
        string
        Type of the target resource for export.

        Allowed values: PersistentVolumeClaim, VolumeSnapshot, VirtualDisk, VirtualDiskSnapshot

      • spec.targetRef.name
        string
        Name of the target resource for export.
    • spec.ttl
      string

      Required value

      Time-to-live duration after the last user request. Acceptable values - <number>s, <number>m, <number>h, e.g. 5m, 2h45m, 1d

      Pattern: ^([0-9]+(\.[0-9]+)?h)?([0-9]+(\.[0-9]+)?m)?([0-9]+s)?$

  • status
    object
    Status information for the DataExport resource.
    • status.accessTimestamp
      string
      Timestamp of the last access to the exported data.
    • status.ca
      string
      Base64 encoded CA certificate for TLS connection to the exporter pod.
    • status.conditions
      array of objects
      Array of conditions describing the current state of the DataExport resource.
      • status.conditions.lastTransitionTime
        string
        Last time the condition transitioned from one status to another.
      • status.conditions.message
        string
        Message describing the condition.
      • status.conditions.observedGeneration
        integer
        Observed generation of the resource when the condition was last updated.
      • status.conditions.reason
        string
        Reason for the current condition status.

        Allowed values: Pending, ValidationFailed, PodReady, Expired

      • status.conditions.status
        string
        Status of the condition.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        Type of the condition.

        Allowed values: Ready, Expired

    • status.publicURL
      string
      Public URL for external access (e.g., https://data-exporter.<public-domain>/<namespace>/<DataExport-name>).
    • status.url
      string
      Internal URL of the exporter pod (e.g., https://X.X.X.X:8085).
    • status.volumeMode
      string
      Volume mode of the exported data.

      Allowed values: Block, Filesystem

DataImport

Scope: Namespaced
Version: v1alpha1

Resource for importing data to PV, VolumeSnapshot, VirtualDisk, or VirtualDiskSnapshot.
  • spec
    object
    • spec.publish
      boolean
      Expose the importer pod outside the cluster.

      Default: false

    • spec.targetRef
      object

      Required value

      Target resource reference with a template.
      • spec.targetRef.kind
        string

        Required value

        Target resource type.

        Allowed values: PersistentVolumeClaim

      • spec.targetRef.pvcTemplate
        object

        Required value

        PersistentVolumeClaim template.
        • spec.targetRef.pvcTemplate.metadata
          object
          PersistentVolumeClaim metadata.
          • spec.targetRef.pvcTemplate.metadata.annotations
            object
            PersistentVolumeClaim annotations.
          • spec.targetRef.pvcTemplate.metadata.labels
            object
            PersistentVolumeClaim labels.
          • spec.targetRef.pvcTemplate.metadata.name
            string
            PersistentVolumeClaim name.
        • spec.targetRef.pvcTemplate.spec
          object
          PersistentVolumeClaim specification.
          • spec.targetRef.pvcTemplate.spec.accessModes
            array of strings
            Desired access modes for the volume.
            • spec.targetRef.pvcTemplate.spec.accessModes.Element of the array
              string

              Allowed values: ReadWriteOnce, ReadOnlyMany, ReadWriteMany, ReadWriteOncePod

          • spec.targetRef.pvcTemplate.spec.resources
            object
            Minimum resource requirements for the volume.
            • spec.targetRef.pvcTemplate.spec.resources.requests
              object
              Minimum amount of compute resources required.
          • spec.targetRef.pvcTemplate.spec.storageClassName
            string
            Name of the StorageClass required by the PersistentVolumeClaim.
          • spec.targetRef.pvcTemplate.spec.volumeMode
            string
            Volume mode required by the PersistentVolumeClaim.

            Allowed values: Block, Filesystem

    • spec.ttl
      string

      Required value

      Time-to-live duration after the last user request.

      Acceptable values:

      • <number>s
      • <number>m
      • <number>h

      For example, 5m, 2h45m, or 1d.

      Pattern: ^([0-9]+(\.[0-9]+)?h)?([0-9]+(\.[0-9]+)?m)?([0-9]+s)?$

    • spec.waitForFirstConsumer
      boolean
      If set to false, a load pod is created to trigger volume population when the StorageClass has volumeBindingMode set to WaitForFirstConsumer.

      Default: true

  • status
    object
    DataImport resource status details.
    • status.accessTimestamp
      string
      Last access timestamp updated by the importer pod.
    • status.ca
      string
      Base64-encoded CA certificate for establishing a TLS connection to the importer pod.
    • status.conditions
      array of objects
      • status.conditions.lastTransitionTime
        string

        Last time the condition transitioned from one status to another.

        This should be when the underlying condition changed. If the last transition time is not known, then using the time when the API field changed is acceptable.

      • status.conditions.message
        string

        Human-readable message indicating details about the transition.

        This may be an empty string.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer

        The .metadata.generation that the condition was set based upon.

        For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date. with respect to the current state of the instance.

        Allowed values: 0 <= X

      • status.conditions.reason
        string
        Current condition status reason.

        Allowed values: Pending, PVCCreated, PodReady, IngressReady, Expired, Deleted, UploadFinished, Completed

      • status.conditions.status
        string
        Condition status.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        Condition type.

        Allowed values: Ready, Expired, UploadFinished, Completed

    • status.publicURL
      string
      Public URL of the importer service.
    • status.url
      string
      Internal URL of the importer service.
    • status.volumeMode
      string
      Volume mode of the exported data.

      Allowed values: Block, Filesystem