Skip to content

Commit 3e8d490

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 Quick Start, directory structure, prerequisites, Velero version notes, and See Also references accordingly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 81b07cb commit 3e8d490

3 files changed

Lines changed: 63 additions & 30 deletions

File tree

docs/dev/backup-restore/README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,8 @@ To disable: `-e cifmw_backup_restore_snapshot_move_data=false`.
5151
|------|-------------|
5252
| [`minio/`](minio/) | MinIO deployment (S3-compatible storage for OADP) |
5353
| [`oadp/`](oadp/) | OADP operator installation and configuration |
54-
| [`backup/`](backup/) | OADP Backup CRs and backup playbook |
55-
| [`restore/`](restore/) | OADP Restore CRs, manual restore docs, and restore playbook |
56-
| [`scripts/`](scripts/) | Helper scripts (`restore-galera.sh`, `list-backup-candidates.sh`) |
54+
| [`backup/`](backup/) | OADP Backup CR reference |
55+
| [`restore/`](restore/) | OADP Restore CR reference, manual database and RabbitMQ restore |
5756
| [`backup-restore-controller-design.md`](backup-restore-controller-design.md) | Design: CRD labels, controller-based labeling, restore ordering |
5857
| [`backup-restore-controller-implementation.md`](backup-restore-controller-implementation.md) | Implementation guide for the OpenStackBackupConfig controller |
5958
| [`backup-restore-pvc-enhancement.md`](backup-restore-pvc-enhancement.md) | Enhancement proposal: serialize CRs to PVC |
@@ -64,10 +63,9 @@ To disable: `-e cifmw_backup_restore_snapshot_move_data=false`.
6463

6564
1. **OpenShift CLI (`oc`) installed** — version compatible with your cluster
6665
2. **Cluster access** — cluster admin or namespace admin for the `openstack` namespace
67-
3. **Ansible** — for running backup/restore playbooks
68-
4. **`jq`** — for JSON manipulation during Galera backup job creation
69-
5. **OADP operator** installed and configured (see [`oadp/README.md`](oadp/README.md) and [`minio/README.md`](minio/README.md))
70-
6. **CSI Volume Snapshot support** — required for PVC backup/restore
66+
3. **Ansible** — for running ci-framework backup/restore playbooks
67+
4. **OADP operator** installed and configured (see [`oadp/README.md`](oadp/README.md) and [`minio/README.md`](minio/README.md))
68+
5. **CSI Volume Snapshot support** — required for PVC backup/restore
7169

7270
### CSI Volume Snapshot Support
7371

@@ -114,11 +112,10 @@ VELERO_POD=$(oc get pods -n openshift-adp -l deploy=velero \
114112
oc exec -n openshift-adp ${VELERO_POD} -- /velero version
115113
```
116114

117-
[Velero v1.16+](https://github.com/vmware-tanzu/velero/releases/tag/v1.16.0)
118-
(expected in OADP for OCP 4.19+) adds the `ignoreDelayBinding` flag for
119-
node-agent, improving Data Mover handling of `WaitForFirstConsumer` PVCs.
120-
See [`restore/README.md`](restore/README.md) for details and workarounds
121-
for earlier versions.
115+
OCP 4.20 ships OADP 1.5 with Velero v1.16+, which adds the
116+
`ignoreDelayBinding` flag for node-agent, improving Data Mover handling
117+
of `WaitForFirstConsumer` PVCs. On OCP 4.18/4.19 with older OADP
118+
versions, see [`restore/README.md`](restore/README.md) for workarounds.
122119

123120
## Backup Scope
124121

@@ -274,4 +271,4 @@ Metal3, additional procedures are required.
274271

275272
- MinIO setup: [`minio/README.md`](minio/README.md)
276273
- OADP setup: [`oadp/README.md`](oadp/README.md)
277-
- Restore scripts: [`scripts/restore-galera.sh`](scripts/restore-galera.sh)
274+
- ci-framework playbooks: [ci-framework](https://github.com/openstack-k8s-operators/ci-framework)

docs/dev/backup-restore/minio/README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,31 @@ see [`../oadp/README.md`](../oadp/README.md).
1010
- `oc` CLI tool installed and configured
1111
- Sufficient storage for MinIO (PVs available in your cluster)
1212

13-
## Quick Start (Ansible Playbook)
13+
## Quick Start (ci-framework)
14+
15+
MinIO is deployed automatically as part of the dependency installation
16+
step in the
17+
[ci-framework](https://github.com/openstack-k8s-operators/ci-framework)
18+
backup/restore playbook:
1419

1520
```bash
16-
ansible-playbook docs/dev/backup-restore/minio/setup-minio.yaml
17-
# With custom parameters:
18-
ansible-playbook docs/dev/backup-restore/minio/setup-minio.yaml \
19-
-e minio_storage_class=local-storage -e minio_storage_size=100Gi
21+
ansible-playbook playbooks/backup_restore.yaml \
22+
-e cifmw_backup_restore_install_deps=true \
23+
-e cifmw_backup_restore_run_backup=false \
24+
-e cifmw_backup_restore_run_cleanup=false \
25+
-e cifmw_backup_restore_run_restore=false
2026
```
2127

28+
Configurable variables (see `roles/deploy_minio/defaults/main.yml`):
29+
30+
| Variable | Default | Description |
31+
|----------|---------|-------------|
32+
| `cifmw_deploy_minio_namespace` | `minio` | Namespace for MinIO |
33+
| `cifmw_deploy_minio_storage_size` | `10Gi` | PVC size |
34+
| `cifmw_deploy_minio_storage_class` | `""` (default) | StorageClass |
35+
| `cifmw_deploy_minio_root_user` | `minio` | Root user |
36+
| `cifmw_deploy_minio_root_password` | `minio123` | Root password |
37+
2238
## Manual Setup
2339

2440
### Step 1: Create MinIO Namespace

docs/dev/backup-restore/oadp/README.md

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,36 @@ it with a MinIO backend. For MinIO deployment, see
1212
- MinIO service account credentials (Access Key and Secret Key)
1313
- `oc` CLI tool installed and configured
1414

15-
## Quick Start (Ansible Playbook)
15+
## Quick Start (ci-framework)
16+
17+
OADP is installed automatically as part of the dependency installation
18+
step in the
19+
[ci-framework](https://github.com/openstack-k8s-operators/ci-framework)
20+
backup/restore playbook (after MinIO):
1621

1722
```bash
18-
ansible-playbook docs/dev/backup-restore/oadp/setup-oadp.yaml \
19-
-e minio_access_key_id=<ACCESS_KEY_ID> \
20-
-e minio_secret_access_key=<SECRET_ACCESS_KEY>
23+
ansible-playbook playbooks/backup_restore.yaml \
24+
-e cifmw_backup_restore_install_deps=true \
25+
-e cifmw_backup_restore_run_backup=false \
26+
-e cifmw_backup_restore_run_cleanup=false \
27+
-e cifmw_backup_restore_run_restore=false
2128
```
2229

30+
Configurable variables (see `roles/openshift_adp/defaults/main.yml`):
31+
32+
| Variable | Default | Description |
33+
|----------|---------|-------------|
34+
| `cifmw_openshift_adp_namespace` | `openshift-adp` | OADP namespace |
35+
| `cifmw_openshift_adp_channel` | `stable` | OLM subscription channel |
36+
| `cifmw_openshift_adp_enable_node_agent` | `true` | Enable Kopia node agent (Data Mover) |
37+
| `cifmw_openshift_adp_s3_bucket` | `velero` | S3 bucket name |
38+
| `cifmw_openshift_adp_s3_prefix` | `rhoso` | Bucket prefix |
39+
| `cifmw_openshift_adp_s3_insecure_skip_tls` | `true` | Skip TLS verification |
40+
41+
The S3 credentials (`cifmw_openshift_adp_s3_access_key`,
42+
`cifmw_openshift_adp_s3_secret_key`) are passed automatically from the
43+
`deploy_minio` role output.
44+
2345
## Manual Setup
2446

2547
### Step 1: Install OADP Operator
@@ -46,7 +68,7 @@ metadata:
4668
name: redhat-oadp-operator
4769
namespace: openshift-adp
4870
spec:
49-
channel: stable-1.4
71+
channel: stable
5072
installPlanApproval: Automatic
5173
name: redhat-oadp-operator
5274
source: redhat-operators
@@ -159,13 +181,11 @@ VELERO_POD=$(oc get pods -n openshift-adp -l deploy=velero \
159181
oc exec -n openshift-adp ${VELERO_POD} -- /velero version
160182
```
161183

162-
[Velero v1.16+](https://github.com/vmware-tanzu/velero/releases/tag/v1.16.0)
163-
(expected in OADP for OCP 4.19+) adds the `ignoreDelayBinding` flag for
164-
node-agent, improving Data Mover handling of `WaitForFirstConsumer` PVCs.
165-
[velero#9343](https://github.com/vmware-tanzu/velero/issues/9343) /
166-
[velero#9532](https://github.com/vmware-tanzu/velero/pull/9532) adds PV
167-
topology constraints as pod affinities on data mover pods — check v1.18.1
168-
or v1.19 release notes when released.
184+
OCP 4.20 ships OADP 1.5 with Velero v1.16+, which adds the
185+
`ignoreDelayBinding` flag for node-agent, improving Data Mover handling
186+
of `WaitForFirstConsumer` PVCs. On OCP 4.18/4.19 with older OADP
187+
versions, see [`../restore/README.md`](../restore/README.md) for
188+
workarounds.
169189

170190
## Test Backup and Restore (Optional)
171191

0 commit comments

Comments
 (0)