Skip to content

Commit b90901f

Browse files
stuggiclaude
andcommitted
Add Future Enhancements section to backup/restore README
Document two future enhancements under consideration: 1. Backup/Restore During Partial Updates - Current limitation: Does NOT work during partial updates - OpenStackVersion CR loses in-flight state information - Results in loss of service images from older releases - Related: OSPRH-26244, OSPRH-26246 2. Resource Labeling for ControlPlane vs DataPlane Separation - Operators could label resources with component ownership - Would enable complete separation of backup/restore procedures - Clearer resource ownership and smaller backups Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent c993cd5 commit b90901f

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

docs/dev/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,42 @@ This is a **safe state** - the actual dataplane nodes are running correctly; onl
9595
### Pre-Provisioned Nodes Only
9696

9797
The current DataPlane backup/restore procedure is designed for **NodeSets with `preProvisioned: true`**. For nodes provisioned via OpenStackBaremetalSet and Metal3, additional procedures are required.
98+
99+
## Future Enhancements
100+
101+
The following features are under consideration for future implementation:
102+
103+
### Backup/Restore During Partial Updates
104+
105+
**Current Limitation:**
106+
Backup/restore does **not work** when the environment is in a partially updated state. If a minor update is in progress (e.g., operators updated but ControlPlane or DataPlane CRs not yet updated), the OpenStackVersion CR does not correctly restore the in-flight update state. This results in loss of service container images from older releases.
107+
108+
**Impact:**
109+
- **Must complete updates fully** before backup (operators + ControlPlane + DataPlane all at the same version)
110+
- Backup during partial update will lose version tracking information
111+
- Restore will fail or result in incorrect service image versions
112+
113+
**Proposed Enhancement:**
114+
- Properly handle OpenStackVersion CR in-flight state during backup/restore
115+
- Preserve service image information across all release versions involved in the update
116+
- Detect and warn when attempting backup during partial update
117+
118+
**Related Issues:**
119+
- [OSPRH-26244](https://issues.redhat.com/browse/OSPRH-26244) - Backup/restore support
120+
- [OSPRH-26246](https://issues.redhat.com/browse/OSPRH-26246) - Backup only possible for fully updated environments
121+
122+
### Resource Labeling for ControlPlane vs DataPlane Separation
123+
124+
**Current Limitation:**
125+
All Secrets and ConfigMaps are backed up together in the ControlPlane backup because there is today no reliable way to distinguish which resources belong to ControlPlane vs DataPlane. Some resources may be shared between both.
126+
127+
**Proposed Enhancement:**
128+
Operators could label all resources they create or reference (including user-provided Secrets/ConfigMaps) with component labels such as:
129+
- `openstack.org/component: controlplane`
130+
- `openstack.org/component: dataplane`
131+
132+
**Benefits:**
133+
- Enable complete separation of ControlPlane and DataPlane backup/restore procedures
134+
- Allow restoring only DataPlane resources without ControlPlane
135+
- Clearer resource ownership and dependency tracking
136+
- Smaller, more focused backups

0 commit comments

Comments
 (0)