Skip to content

Commit 81b07cb

Browse files
stuggiclaude
andcommitted
[b/r] Update Quick Start to use ci-framework playbooks
The backup/restore playbooks have moved to the ci-framework repo. Update the Quick Start section to reference the new playbook location and ci-framework variable names. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 9eafdbd commit 81b07cb

1 file changed

Lines changed: 33 additions & 8 deletions

File tree

docs/dev/backup-restore/README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,42 @@ playbooks for orchestration.
99

1010
## Quick Start
1111

12+
The backup/restore playbooks are in the
13+
[ci-framework](https://github.com/openstack-k8s-operators/ci-framework) repo.
14+
1215
```bash
13-
# Backup
14-
ansible-playbook docs/dev/backup-restore/backup/backup-openstack.yaml
15-
# With Data Mover (upload snapshots to S3/MinIO):
16-
ansible-playbook docs/dev/backup-restore/backup/backup-openstack.yaml -e snapshot_move_data=true
17-
18-
# Restore
19-
ansible-playbook docs/dev/backup-restore/restore/restore-openstack.yaml \
20-
-e backup_timestamp=20260311-081234
16+
# Full lifecycle (install deps, backup, cleanup, restore):
17+
ansible-playbook playbooks/backup_restore.yaml
18+
19+
# Install deps only:
20+
ansible-playbook playbooks/backup_restore.yaml \
21+
-e cifmw_backup_restore_install_deps=true \
22+
-e cifmw_backup_restore_run_backup=false \
23+
-e cifmw_backup_restore_run_cleanup=false \
24+
-e cifmw_backup_restore_run_restore=false
25+
26+
# Backup only (deps already installed):
27+
ansible-playbook playbooks/backup_restore.yaml \
28+
-e cifmw_backup_restore_install_deps=false \
29+
-e cifmw_backup_restore_run_backup=true \
30+
-e cifmw_backup_restore_run_cleanup=false \
31+
-e cifmw_backup_restore_run_restore=false
32+
33+
# Cleanup + restore (backup already done):
34+
ansible-playbook playbooks/backup_restore.yaml \
35+
-e cifmw_backup_restore_install_deps=false \
36+
-e cifmw_backup_restore_run_backup=false \
37+
-e cifmw_backup_restore_run_cleanup=true \
38+
-e cifmw_backup_restore_run_restore=true \
39+
-e cifmw_backup_restore_backup_timestamp=20260311-081234
2140
```
2241

42+
The restore triggers an EDPM deployment to resync credentials but does
43+
not wait for it to complete. Monitor the deployment status separately.
44+
45+
Data Mover (upload PVC snapshots to S3/MinIO) is enabled by default.
46+
To disable: `-e cifmw_backup_restore_snapshot_move_data=false`.
47+
2348
## Directory Structure
2449

2550
| Path | Description |

0 commit comments

Comments
 (0)