Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

backup large-dir

Perform volumetric archive backups of very large directories.

Command Format:

peppykeep backup large-dir <SUBCOMMAND> [OPTIONS]

Subcommand

  • backup large-dir run
  • backup large-dir list
  • backup large-dir verify
  • backup large-dir restore

run

Purpose:

  • scanned directory
  • Planning for Volume Breakdown
  • Generate .ppk Volume Archive
  • Perform volume encryption as configured
  • Optional upload object storage
  • Generate manifest.json' and state.json`
peppykeep backup large-dir run \
  --config-home /path/to/conf \
  --data-dir /path/to/large-dir \
  --project-key project-a \
  --chunk-size 4GiB

Real Execution:

peppykeep backup large-dir run \
  --apply \
  --config-home /path/to/conf \
  --data-dir /path/to/large-dir \
  --project-key project-a \
  --chunk-size 4GiB \
  --compress none \
  --upload

Current Supported Parameters:

  • --data-dir
  • --project-key
  • --chunk-size
  • --compress <none|gzip|zstd>
  • --upload
  • --resume

zstd currently retains only parameters, the execution link is not yet implemented. --resume is used to continue outstanding tasks.

list

peppykeep backup large-dir list \
  --config-home /path/to/conf \
  --project-key project-a \
  --top 10

Output Focus:

  • TaskId
  • Project
  • Status
  • Files
  • Parts
  • Upload
  • TaskDir

verify

peppykeep backup large-dir verify \
  --config-home /path/to/conf \
  --project-key project-a

Verify by Task ID:

peppykeep backup large-dir verify \
  --config-home /path/to/conf \
  --task-id 1774341702215

The current verify only verifies the local task structure and the local volume file, not the integrity of the remote object.

restore

peppykeep backup large-dir restore \
  --config-home /path/to/conf \
  --project-key project-a \
  --output-dir /path/to/restore-out

Restore by Task ID:

peppykeep backup large-dir restore \
  --config-home /path/to/conf \
  --task-id 1774341702215 \
  --output-dir /path/to/restore-out

When you need to explicitly specify a private key and prompt for a password:

peppykeep backup large-dir restore \
  --config-home /path/to/conf \
  --task-id 1774341702215 \
  --output-dir /path/to/restore-out \
  --decrypt-private-key-file /path/to/ppk.key \
  --prompt-for-private-key-passphrase

The current restore only recovers from the local task directory and is not responsible for automatically downloading missing volumes from the remote object store.

Task Directory

<local_tmp_home>/tasks/<project-key>-<task-id>/

Common documents:

manifest.json
state.json
parts/

Among them:

  • manifest.json: task meta information, volume breakdown information, file list
  • state.json: execution status
  • parts/: volumetric archiving and encryption products