Files
cozystack/examples/backups/vmi/run-all.sh
T
Andrey Kolkov 9cc3a9e459 test(vmi): add VMInstance and standalone VMDisk backup/restore e2e round-trips
The disabled hack/e2e-chainsaw/backup/ suite was a Chainsaw port of the retired
backup.bats, written against the old backup API, so the VMInstance and standalone
VMDisk Velero paths had no e2e coverage. Replace it with two round-trips in the
vminstance suite that drive the validated examples/backups/{vmi,vmdisk} scripts,
so the documented demo and the automated test stay in step.

Both run un-gated in CI:
- vminstance-2-backup-roundtrip boots a tiny cirros VM (u1.nano, 2Gi), backs it
  up via BackupClass + BackupJob, restores in place, and asserts the VM returns
  Running off a disk PVC the restore created: a new uid, Velero's restore-name
  label and the -orig- PVC keepOriginalPVC leaves behind. The label alone is not
  enough, because existingResourcePolicy: update also stamps it on a PVC Velero
  only patched, which moves no data. A guest-side boot proof is unavailable: the
  KubeVirt CR disables serial-console logging and cirros ships no guest-agent.
- vmdisk-2-backup-roundtrip imports a 5Gi disk, backs it up, and restores it in
  place with the same three assertions. The controller prepares the target
  (suspend HelmRelease, delete DataVolume, rename PVC). On a WaitForFirstConsumer
  class the Velero data mover waits for a Pod to select a node for the restored
  PVC, which a detached disk never gets, so the script starts a pause Pod on the
  new PVC, standing in for the VM that would attach it.

The disk storageClass is an override (default replicated; the CI steps pass the
lane's COZY_E2E_STORAGE_CLASS, 'local' on the DRBD-off gate) and the script waits
are bounded so their worst case stays under the 40m op timeout, sized to keep the
whole parallel:1 suite inside the 215m job cap. On failure the catch also dumps
the Velero Restore, DataDownload and DataUpload objects. Each harness stands up a
throwaway in-cluster BSL (the platform cozy-default BSL derives the external S3
endpoint, unroutable in kind); its finally resumes the suspended HelmReleases,
reclaims the keepOriginalPVC orig PVC and its LINSTOR volume, and drains the
Velero backups before deleting the BSL. The example scripts are non-interactive
so the harness can drive them.

Assisted-by: LLM
Signed-off-by: Andrey Kolkov <androndo@gmail.com>
2026-10-13 18:05:45 +04:00

62 lines
2.4 KiB
Bash
Executable File

#!/bin/bash
# Convenience runner + e2e harness for the VMInstance backup/restore demo.
#
# Runs the numbered steps 01..07 a human reads, in order, non-interactively,
# stopping on the first failure (set -e). This is the SAME sequence the docs
# walk through, so the documented flow and the automated test can never drift.
#
# Flow: Velero strategies -> BackupClass -> VMDisk + VMInstance (waits until the
# VM is booted) -> ad-hoc BackupJob (waits Succeeded) -> in-place RestoreJob
# (waits Succeeded, waits for the VM to boot again) -> cross-namespace to-copy
# RestoreJob (waits Succeeded).
#
# Override NAMESPACE / BACKUP_STORAGE_LOCATION / TARGET_NAMESPACE via the
# environment; see 00-helpers.sh. hack/e2e-chainsaw/vminstance/ drives this file
# as the vminstance-2-backup-roundtrip e2e test, run un-gated in CI.
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/00-helpers.sh"
print_header "VMInstance Backup & Restore Demo"
log_info "Namespace: ${NAMESPACE} BackupStorageLocation: ${BACKUP_STORAGE_LOCATION}"
SCRIPTS=(
"01-create-strategies.sh"
"02-create-backupclass.sh"
"03-create-vmdisk.sh"
"04-create-vminstance.sh"
"05-create-backupjob.sh"
"06-restore-in-place.sh"
)
# Cross-namespace to-copy restore is the heaviest step (a second full VM in a
# fresh namespace). SKIP_RESTORE_TO_COPY=1 drops it — used by the lightweight CI
# round-trip, which proves backup + in-place restore is enough.
if [[ "${SKIP_RESTORE_TO_COPY:-0}" != "1" ]]; then
SCRIPTS+=("07-restore-to-copy.sh")
fi
for script in "${SCRIPTS[@]}"; do
if [[ -x "$SCRIPT_DIR/$script" ]]; then
"$SCRIPT_DIR/$script"
separator
else
log_error "Script not found or not executable: $script"
exit 1
fi
done
print_header "Demo Complete"
log_success "All steps completed successfully!"
log_info "What was demonstrated:"
echo " 1. Created Velero backup strategies for VMInstance and VMDisk" >&2
echo " 2. Created BackupClass binding strategies to application types" >&2
echo " 3. Provisioned a VMDisk and VMInstance" >&2
echo " 4. Created a backup of the VMInstance via BackupJob" >&2
echo " 5. Restored the VMInstance in-place" >&2
if [[ "${SKIP_RESTORE_TO_COPY:-0}" != "1" ]]; then
echo " 6. Restored the VMInstance to a copy in a different namespace" >&2
fi
log_info "To clean up resources: ./cleanup.sh"