Skip to content

Commit cd3f52b

Browse files
stuggiclaude
andcommitted
[b/r] Rename docs/dev/webhook to docs/dev/backup-restore
Rename the documentation directory to reflect the controller-based approach. Update all internal path references. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 5368a89 commit cd3f52b

24 files changed

Lines changed: 30 additions & 30 deletions

docs/dev/backup-restore-webhook-compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ spec:
482482
# Add staged deployment annotation via ConfigMap-based resource modifiers
483483
# The ConfigMap adds core.openstack.org/deployment-stage=infrastructure-only
484484
# to OpenStackControlPlane during restore
485-
# See: docs/dev/webhook/restore/00-resource-modifiers-configmap.yaml
485+
# See: docs/dev/backup-restore/restore/00-resource-modifiers-configmap.yaml
486486
resourceModifier:
487487
kind: ConfigMap
488488
name: openstack-restore-resource-modifiers

docs/dev/webhook/backup-restore-controller-design.md renamed to docs/dev/backup-restore/backup-restore-controller-design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1046,7 +1046,7 @@ oc get backup -n openshift-adp -w
10461046
**Example Manual Restore:**
10471047
```bash
10481048
# Step 0: Create the resource modifier ConfigMap (required for all restores)
1049-
oc apply -f docs/dev/webhook/restore/00-resource-modifiers-configmap.yaml
1049+
oc apply -f docs/dev/backup-restore/restore/00-resource-modifiers-configmap.yaml
10501050
10511051
# Order 00: PVCs (Storage Foundation)
10521052
cat <<EOF | oc apply -f -

docs/dev/webhook/backup-restore-controller-implementation.md renamed to docs/dev/backup-restore/backup-restore-controller-implementation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ We use two separate OADP backups:
371371
372372
### Restore CRs
373373
374-
Restore CRs are in `docs/dev/webhook/restore/`. Each uses a shared resource modifier ConfigMap (`00-resource-modifiers-configmap.yaml`) that:
374+
Restore CRs are in `docs/dev/backup-restore/restore/`. Each uses a shared resource modifier ConfigMap (`00-resource-modifiers-configmap.yaml`) that:
375375
- Strips `kubectl.kubernetes.io/last-applied-configuration` annotations
376376
- Adds `deployment-stage: infrastructure-only` annotation to OpenStackControlPlane
377377
@@ -406,14 +406,14 @@ RabbitMQ clusters generate new random credentials on creation, but EDPM nodes st
406406
4. Create RabbitMQUser CRs to import the old credentials
407407
5. Clean up the temporary namespace
408408
409-
See `docs/dev/webhook/restore/06b-restore-rabbitmq-secrets.yaml` for the manual procedure or the restore playbook (`docs/dev/webhook/restore/restore-openstack.yaml`) for automation.
409+
See `docs/dev/backup-restore/restore/06b-restore-rabbitmq-secrets.yaml` for the manual procedure or the restore playbook (`docs/dev/backup-restore/restore/restore-openstack.yaml`) for automation.
410410
411411
### Automated Restore Playbook
412412
413-
The Ansible playbook at `docs/dev/webhook/restore/restore-openstack.yaml` orchestrates the full restore flow:
413+
The Ansible playbook at `docs/dev/backup-restore/restore/restore-openstack.yaml` orchestrates the full restore flow:
414414
415415
```bash
416-
ansible-playbook docs/dev/webhook/restore/restore-openstack.yaml \
416+
ansible-playbook docs/dev/backup-restore/restore/restore-openstack.yaml \
417417
-e pvc_backup_name=openstack-backup-pvcs \
418418
-e resources_backup_name=openstack-backup-resources
419419
```
@@ -469,11 +469,11 @@ oc get volumesnapshot -n openstack
469469
470470
```bash
471471
# Apply restore CRs in order and wait for each
472-
oc apply -f docs/dev/webhook/restore/01-restore-order-00-pvcs.yaml
472+
oc apply -f docs/dev/backup-restore/restore/01-restore-order-00-pvcs.yaml
473473
oc wait --for=jsonpath='{.status.phase}'=Completed restore/openstack-restore-00-pvcs -n openshift-adp --timeout=15m
474474

475475
# Continue with each order...
476-
# See docs/dev/webhook/restore/README.md for full procedure
476+
# See docs/dev/backup-restore/restore/README.md for full procedure
477477
```
478478
479479
## Troubleshooting
@@ -514,8 +514,8 @@ oc wait --for=jsonpath='{.status.phase}'=Completed restore/openstack-restore-00-
514514
515515
## See Also
516516
517-
- Design document: `docs/dev/webhook/backup-restore-controller-design.md`
518-
- Backup CRs: `docs/dev/webhook/backup/`
519-
- Restore CRs: `docs/dev/webhook/restore/`
520-
- Restore playbook: `docs/dev/webhook/restore/restore-openstack.yaml`
517+
- Design document: `docs/dev/backup-restore/backup-restore-controller-design.md`
518+
- Backup CRs: `docs/dev/backup-restore/backup/`
519+
- Restore CRs: `docs/dev/backup-restore/restore/`
520+
- Restore playbook: `docs/dev/backup-restore/restore/restore-openstack.yaml`
521521
- Restore scripts: `docs/dev/scripts/restore-galera-latest.sh`

docs/dev/webhook/backup-restore-pvc-enhancement.md renamed to docs/dev/backup-restore/backup-restore-pvc-enhancement.md

File renamed without changes.
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ We use a two-backup strategy:
4242
Use the backup playbook to orchestrate the full backup flow:
4343

4444
```bash
45-
ansible-playbook docs/dev/webhook/backup/backup-openstack.yaml
45+
ansible-playbook docs/dev/backup-restore/backup/backup-openstack.yaml
4646
```
4747

4848
The playbook runs three steps:
@@ -54,13 +54,13 @@ PVC backup labels are set automatically by service operators (glance-operator, m
5454

5555
Override defaults with extra vars:
5656
```bash
57-
ansible-playbook docs/dev/webhook/backup/backup-openstack.yaml \
57+
ansible-playbook docs/dev/backup-restore/backup/backup-openstack.yaml \
5858
-e openstack_namespace=openstack \
5959
-e storage_location=velero-1 \
6060
-e backup_ttl=168h
6161

6262
# With Data Mover (upload snapshots to S3/MinIO):
63-
ansible-playbook docs/dev/webhook/backup/backup-openstack.yaml \
63+
ansible-playbook docs/dev/backup-restore/backup/backup-openstack.yaml \
6464
-e snapshot_move_data=true
6565
```
6666

@@ -186,6 +186,6 @@ spec:
186186

187187
## See Also
188188

189-
- Restore CRs: `docs/dev/webhook/restore/`
190-
- Implementation guide: `docs/dev/webhook/backup-restore-controller-implementation.md`
191-
- Design document: `docs/dev/webhook/backup-restore-controller-design.md`
189+
- Restore CRs: `docs/dev/backup-restore/restore/`
190+
- Implementation guide: `docs/dev/backup-restore/backup-restore-controller-implementation.md`
191+
- Design document: `docs/dev/backup-restore/backup-restore-controller-design.md`

docs/dev/webhook/backup/backup-openstack-pvcs-datamover.yaml renamed to docs/dev/backup-restore/backup/backup-openstack-pvcs-datamover.yaml

File renamed without changes.

docs/dev/webhook/backup/backup-openstack-pvcs.yaml renamed to docs/dev/backup-restore/backup/backup-openstack-pvcs.yaml

File renamed without changes.

docs/dev/webhook/backup/backup-openstack-resources.yaml renamed to docs/dev/backup-restore/backup/backup-openstack-resources.yaml

File renamed without changes.

docs/dev/webhook/backup/backup-openstack.yaml renamed to docs/dev/backup-restore/backup/backup-openstack.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
# - PVC sizes use binary units (Gi, not G) - see OSPRH-27441
1717
#
1818
# Usage:
19-
# ansible-playbook docs/dev/webhook/backup/backup-openstack.yaml
19+
# ansible-playbook docs/dev/backup-restore/backup/backup-openstack.yaml
2020
# # With Data Mover (upload snapshots to S3/MinIO):
21-
# ansible-playbook docs/dev/webhook/backup/backup-openstack.yaml -e snapshot_move_data=true
21+
# ansible-playbook docs/dev/backup-restore/backup/backup-openstack.yaml -e snapshot_move_data=true
2222
#
2323
# Variables:
2424
# openstack_namespace: Target namespace (default: openstack)
@@ -232,4 +232,4 @@
232232
- "To verify:"
233233
- " oc get backup -n {{ oadp_namespace }} | grep {{ backup_name_suffix }}"
234234
- ""
235-
- "To restore, see: docs/dev/webhook/restore/README.md"
235+
- "To restore, see: docs/dev/backup-restore/restore/README.md"

docs/dev/webhook/disaster-recovery-guide.md renamed to docs/dev/backup-restore/disaster-recovery-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1799,7 +1799,7 @@ spec:
17991799

18001800
# Remove last-applied-configuration and add deployment-stage annotation
18011801
# via ConfigMap-based resource modifiers
1802-
# See: docs/dev/webhook/restore/00-resource-modifiers-configmap.yaml
1802+
# See: docs/dev/backup-restore/restore/00-resource-modifiers-configmap.yaml
18031803
resourceModifier:
18041804
kind: ConfigMap
18051805
name: openstack-restore-resource-modifiers

0 commit comments

Comments
 (0)