package
0.11.1
Repository: https://github.com/heptio/ark.git
Documentation: pkg.go.dev

# Functions

CustomResources returns a map of all custom resources within the Ark API group, keyed on Kind.
Resource gets an Ark GroupResource for a specified resource.

# Constants

BackupNameLabel is the label key used to identify a backup by name.
BackupPhaseCompleted means the backup has run successfully without errors.
BackupPhaseDeleting means the backup and all its associated data are being deleted.
BackupPhaseFailed means the backup ran but encountered an error that prevented it from completing successfully.
BackupPhaseFailedValidation means the backup has failed the controller's validations and therefore will not run.
BackupPhaseInProgress means the backup is currently executing.
BackupPhaseNew means the backup has been created but not yet processed by the BackupController.
BackupStorageLocationAccessModeReadOnly represents read-only access to a BackupStorageLocation.
BackupStorageLocationAccessModeReadWrite represents read and write access to a BackupStorageLocation.
BackupStorageLocationPhaseAvailable means the location is available to read and write from.
BackupStorageLocationPhaseUnavailable means the location is unavailable to read and write from.
BackupUIDLabel is the label key used to identify a backup by uid.
ClusterScopedDir is the name of the directory containing cluster-scoped resources within an Ark backup.
DefaultNamespace is the Kubernetes namespace that is used by default for the Ark server and API objects.
DeleteBackupRequestPhaseInProgress means the DeleteBackupRequest is being processed.
DeleteBackupRequestPhaseNew means the DeleteBackupRequest has not been processed yet.
DeleteBackupRequestPhaseProcessed means the DeleteBackupRequest has been processed.
DownloadRequestPhaseNew means the DownloadRequest has not been processed by the DownloadRequestController yet.
DownloadRequestPhaseProcessed means the DownloadRequest has been processed by the DownloadRequestController.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GroupName is the group name for the Ark API.
HookErrorModeContinue means that an error from a hook is acceptable, and the backup can proceed.
HookErrorModeFail means that an error from a hook is problematic, and the backup should be in error.
MetadataDir is a top-level directory expected in backups which contains files that store metadata about the backup, such as the backup version.
NamespaceScopedDir is the name of the directory containing namespace-scoped resource within an Ark backup.
PodUIDLabel is the label key used to identify a pod by uid.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PodVolumeOperationTimeoutAnnotation is the annotation key used to apply a backup/restore-specific timeout value for pod volume operations (i.e.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResourcesDir is a top-level directory expected in backups which contains sub-directories for each resource type in the backup.
No description provided by the author
No description provided by the author
No description provided by the author
ResticVolumeNamespaceLabel is the label key used to identify which namespace a restic repository stores pod volume backups for.
RestoreLabelKey is the label key that's applied to all resources that are created during a restore.
RestoreNameLabel is the label key used to identify a restore by name.
RestorePhaseCompleted means the restore has finished executing.
RestorePhaseFailed means the restore was unable to execute.
RestorePhaseFailedValidation means the restore has failed the controller's validations and therefore will not run.
RestorePhaseInProgress means the restore is currently executing.
RestorePhaseNew means the restore has been created but not yet processed by the RestoreController.
RestoreUIDLabel is the label key used to identify a restore by uid.
SchedulePhaseEnabled means the schedule has been validated and will now be triggering backups according to the schedule spec.
SchedulePhaseFailedValidation means the schedule has failed the controller's validations and therefore will not trigger backups.
SchedulePhaseNew means the schedule has been created but not yet processed by the ScheduleController.
ServerStatusRequestPhaseNew means the ServerStatusRequest has not been processed yet.
ServerStatusRequestPhaseProcessed means the ServerStatusRequest has been processed.
StorageLocationLabel is the label key used to identify the storage location of a backup.
VolumeSnapshotLocationPhaseAvailable means the location is available to read and write from.
VolumeSnapshotLocationPhaseUnavailable means the location is unavailable to read and write from.

# Variables

AddToScheme applies the SchemeBuilder functions to a specified scheme.
SchemeBuilder collects the scheme builder functions for the Ark API.
SchemeGroupVersion is the GroupVersion for the Ark API.

# Structs

Backup is an Ark resource that respresents the capture of Kubernetes cluster state at a point in time (API objects and associated volume state).
BackupHooks contains custom behaviors that should be executed at different phases of the backup.
BackupList is a list of Backups.
BackupResourceHook defines a hook for a resource.
BackupResourceHookSpec defines one or more BackupResourceHooks that should be executed based on the rules defined for namespaces, resources, and label selector.
BackupSpec defines the specification for an Ark backup.
BackupStatus captures the current status of an Ark backup.
BackupStorageLocation is a location where Ark stores backup objects.
BackupStorageLocationList is a list of BackupStorageLocations.
BackupStorageLocationSpec defines the specification for an Ark BackupStorageLocation.
BackupStorageLocationStatus describes the current status of an Ark BackupStorageLocation.
DeleteBackupRequest is a request to delete one or more backups.
DeleteBackupRequestList is a list of DeleteBackupRequests.
DeleteBackupRequestSpec is the specification for which backups to delete.
DeleteBackupRequestStatus is the current status of a DeleteBackupRequest.
DownloadRequest is a request to download an artifact from backup object storage, such as a backup log file.
DownloadRequestList is a list of DownloadRequests.
DownloadRequestSpec is the specification for a download request.
DownloadRequestStatus is the current status of a DownloadRequest.
DownloadTarget is the specification for what kind of file to download, and the name of the resource with which it's associated.
ExecHook is a hook that uses the pod exec API to execute a command in a container in a pod.
ObjectStorageLocation specifies the settings necessary to connect to a provider's object storage.
Deprecated: Consumers should switch to the same type in github.com/heptio/velero/pkg/apis/velero/v1 instead.
PodVolumeBackupList is a list of PodVolumeBackups.
PodVolumeBackupSpec is the specification for a PodVolumeBackup.
PodVolumeBackupStatus is the current status of a PodVolumeBackup.
Deprecated: Consumers should switch to the same type in github.com/heptio/velero/pkg/apis/velero/v1 instead.
PodVolumeRestoreList is a list of PodVolumeRestores.
PodVolumeRestoreSpec is the specification for a PodVolumeRestore.
PodVolumeRestoreStatus is the current status of a PodVolumeRestore.
Deprecated: Consumers should switch to the same type in github.com/heptio/velero/pkg/apis/velero/v1 instead.
ResticRepositoryList is a list of ResticRepositories.
ResticRepositorySpec is the specification for a ResticRepository.
ResticRepositoryStatus is the current status of a ResticRepository.
Restore is an Ark resource that represents the application of resources from an Ark backup to a target Kubernetes cluster.
RestoreList is a list of Restores.
RestoreResult is a collection of messages that were generated during execution of a restore.
RestoreSpec defines the specification for an Ark restore.
RestoreStatus captures the current status of an Ark restore Deprecated: Consumers should switch to the same type in github.com/heptio/velero/pkg/apis/velero/v1 instead.
Schedule is an Ark resource that represents a pre-scheduled or periodic Backup that should be run.
ScheduleList is a list of Schedules.
ScheduleSpec defines the specification for an Ark schedule Deprecated: Consumers should switch to the same type in github.com/heptio/velero/pkg/apis/velero/v1 instead.
ScheduleStatus captures the current state of an Ark schedule Deprecated: Consumers should switch to the same type in github.com/heptio/velero/pkg/apis/velero/v1 instead.
ServerStatusRequest is a request to access current status information about the Ark server.
ServerStatusRequestList is a list of ServerStatusRequests.
ServerStatusRequestSpec is the specification for a ServerStatusRequest.
ServerStatusRequestStatus is the current status of a ServerStatusRequest.
StorageType represents the type of storage that a backup location uses.
VolumeBackupInfo captures the required information about a PersistentVolume at backup time to be able to restore it later.
VolumeSnapshotLocation is a location where Ark stores volume snapshots.
VolumeSnapshotLocationList is a list of VolumeSnapshotLocations.
VolumeSnapshotLocationSpec defines the specification for an Ark VolumeSnapshotLocation.
VolumeSnapshotLocationStatus describes the current status of an Ark VolumeSnapshotLocation.

# Type aliases

BackupPhase is a string representation of the lifecycle phase of an Ark backup.
BackupStorageLocationAccessMode represents the permissions for a BackupStorageLocation.
BackupStorageLocationPhase is the lifecyle phase of an Ark BackupStorageLocation.
DeleteBackupRequestPhase represents the lifecycle phase of a DeleteBackupRequest.
DownloadRequestPhase represents the lifecycle phase of a DownloadRequest.
DownloadTargetKind represents what type of file to download.
HookErrorMode defines how Ark should treat an error from a hook.
PodVolumeBackupPhase represents the lifecycle phase of a PodVolumeBackup.
PodVolumeRestorePhase represents the lifecycle phase of a PodVolumeRestore.
ResticRepositoryPhase represents the lifecycle phase of a ResticRepository.
RestorePhase is a string representation of the lifecycle phase of an Ark restore Deprecated: Consumers should switch to the same type in github.com/heptio/velero/pkg/apis/velero/v1 instead.
SchedulePhase is a string representation of the lifecycle phase of an Ark schedule Deprecated: Consumers should switch to the same type in github.com/heptio/velero/pkg/apis/velero/v1 instead.
ServerStatusRequestPhase represents the lifecycle phase of a ServerStatusRequest.
VolumeSnapshotLocationPhase is the lifecyle phase of an Ark VolumeSnapshotLocation.