podvolumebackup_v1.json

{
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "PodVolumeBackupSpec is the specification for a PodVolumeBackup.",
      "properties": {
        "backupStorageLocation": {
          "description": "BackupStorageLocation is the name of the backup storage location\nwhere the backup repository is stored.",
          "type": "string"
        },
        "node": {
          "description": "Node is the name of the node that the Pod is running on.",
          "type": "string"
        },
        "pod": {
          "description": "Pod is a reference to the pod containing the volume to be backed up.",
          "properties": {
            "apiVersion": {
              "description": "API version of the referent.",
              "type": "string"
            },
            "fieldPath": {
              "description": "If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object.\nTODO: this design is not final and this field is subject to change in the future.",
              "type": "string"
            },
            "kind": {
              "description": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
              "type": "string"
            },
            "name": {
              "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
              "type": "string"
            },
            "namespace": {
              "description": "Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
              "type": "string"
            },
            "resourceVersion": {
              "description": "Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
              "type": "string"
            },
            "uid": {
              "description": "UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
              "type": "string"
            }
          },
          "type": "object",
          "x-kubernetes-map-type": "atomic",
          "additionalProperties": false
        },
        "repoIdentifier": {
          "description": "RepoIdentifier is the backup repository identifier.",
          "type": "string"
        },
        "tags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Tags are a map of key-value pairs that should be applied to the\nvolume backup as tags.",
          "type": "object"
        },
        "uploaderSettings": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "UploaderSettings are a map of key-value pairs that should be applied to the\nuploader configuration.",
          "nullable": true,
          "type": "object"
        },
        "uploaderType": {
          "description": "UploaderType is the type of the uploader to handle the data transfer.",
          "enum": [
            "kopia",
            "restic",
            ""
          ],
          "type": "string"
        },
        "volume": {
          "description": "Volume is the name of the volume within the Pod to be backed\nup.",
          "type": "string"
        }
      },
      "required": [
        "backupStorageLocation",
        "node",
        "pod",
        "repoIdentifier",
        "volume"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "PodVolumeBackupStatus is the current status of a PodVolumeBackup.",
      "properties": {
        "completionTimestamp": {
          "description": "CompletionTimestamp records the time a backup was completed.\nCompletion time is recorded even on failed backups.\nCompletion time is recorded before uploading the backup object.\nThe server's time is used for CompletionTimestamps",
          "format": "date-time",
          "nullable": true,
          "type": "string"
        },
        "message": {
          "description": "Message is a message about the pod volume backup's status.",
          "type": "string"
        },
        "path": {
          "description": "Path is the full path within the controller pod being backed up.",
          "type": "string"
        },
        "phase": {
          "description": "Phase is the current state of the PodVolumeBackup.",
          "enum": [
            "New",
            "InProgress",
            "Completed",
            "Failed"
          ],
          "type": "string"
        },
        "progress": {
          "description": "Progress holds the total number of bytes of the volume and the current\nnumber of backed up bytes. This can be used to display progress information\nabout the backup operation.",
          "properties": {
            "bytesDone": {
              "format": "int64",
              "type": "integer"
            },
            "totalBytes": {
              "format": "int64",
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "snapshotID": {
          "description": "SnapshotID is the identifier for the snapshot of the pod volume.",
          "type": "string"
        },
        "startTimestamp": {
          "description": "StartTimestamp records the time a backup was started.\nSeparate from CreationTimestamp, since that value changes\non restores.\nThe server's time is used for StartTimestamps",
          "format": "date-time",
          "nullable": true,
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}