Skip to content

Update docs for changes to Recovery Service#461

Merged
fghaas merged 8 commits intocleura:mainfrom
colder-is-better:rec-service-refresh
Mar 18, 2026
Merged

Update docs for changes to Recovery Service#461
fghaas merged 8 commits intocleura:mainfrom
colder-is-better:rec-service-refresh

Conversation

@colder-is-better
Copy link
Contributor

Refresh public documentation in light of new recovery service features (snapshot retention days, immutable snapshots).

@colder-is-better colder-is-better self-assigned this Mar 17, 2026
@colder-is-better colder-is-better requested a review from fghaas March 17, 2026 16:20
@fghaas fghaas requested a review from murwall March 17, 2026 16:21
fghaas
fghaas previously approved these changes Mar 17, 2026
Copy link
Contributor

@fghaas fghaas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks excellent to me at this point. Thanks!

Will go ahead and merge if @murwall either approves, or declines to get involved in the next 12 hours. :)

Copy link

@murwall murwall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I think this looks very good.
A few things popped up while reading the disaster-recovery.md.
First, we have renamed the service from "disaster recovery" to "recovery service" and it would make sense to refer to the same name here.

The other thought I had is related to this text:
Provided snapshots are available, you can restore a server or a single volume to any of those snapshots. For instance, you may discover that due to faulty application logic or simply a bug, you are now experiencing data corruption. Then, one of your options would be to [go back in time](https://github.com/colder-is-better/cleura-docs/blob/78acf236ceadd536d315c491bf11eae41932d486/docs/howto/openstack/nova/restore-srv-to-snap.md) by restoring one of the available snapshots and keep going from there.

With the new recovery service, the best benefit is the possibility to restore any snapshot to a new volume. This will be the default way of restoring data in most cases. You create a new volume, attach it to your server and copy over the data that you want to restore or replace the entire mount with the new restored volume.

As for restoring onto the same volume, there are some rules that apply:

  • Only the last snapshot can be restored
  • The existing volume that you want to replace with a the latest snapshot, must be in status=available. This effectively means that right now you can't restore onto a volume that is used as a boot device. The only exception would be if you delete the server, keep the volume, restore onto the volume, and boot a new server from the volume. But that is just cumbersome and it would be a lot easier to just restore to a new volume and boot a new volume from it.


Had you chosen to restore an **older** snapshot, then you could also restore it to a **new** volume.

The only time you can restore a snapshot to an existing volume is when the snapshot comes from a non-boot volume and is the newest.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@murwall Re this comment:

As for restoring onto the same volume, there are some rules that apply:

  • Only the last snapshot can be restored
  • The existing volume that you want to replace with a the latest snapshot, must be in status=available. This effectively means that right now you can't restore onto a volume that is used as a boot device.

Isn't that what this sentence here says?

* Introduce and explain new recovery service
  features (retention days, immutable snapshots),
* make sure the old "disaster recovery" term is
  not used anymore.
Re-create new server guide screenshots
due to changes in the CCMP UI.
Introduce and explain the new recovery service features.
While at it, make sure the old "disaster recovery" term
is not used anymore.
* Mention the upgrade packages during boot option,
* make the note against using the console visible
  to both the CCMP and the CLI part of the guide,
* improve syntax and brevity, and
* deal with white space issues.
Copy link
Contributor

@fghaas fghaas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@colder-is-better, fix errors that are self-evident from locally running tox, please.

Due to the features of the new recovery service,
rewrite the How-To guide and re-create the screenshots.

While at it, make sure the old "disaster recovery" term
is not used anymore.
@fghaas
Copy link
Contributor

fghaas commented Mar 18, 2026

@colder-is-better Again, get in the habit of running the tox command before pushing, please.

This requires a new redirect_maps mapping in mkdocs.yml, so old
links continue to work. While at it, we update the menu system for
background documentation to now have a "Recovery service" link.
Make sure the old "disaster recovery" term is not used anymore.
In the guide for converting a boot-from-image server to a
boot-from-volume one, we now use the "recovery service" term.
While at it, we fix an internal link to point to the correct
background document on the new recovery service.
@colder-is-better
Copy link
Contributor Author

@fghaas All screenshots in the "Converting a boot-from-image server to boot-from-volume" guide should be re-created: the old "Disaster recovery" option is still visible, and there are also UI changes. Should I update the current PR or create a new one?

Copy link
Contributor

@fghaas fghaas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now.

@colder-is-better
Copy link
Contributor Author

@fghaas Unless @murwall wants to take a final look, we should go ahead and merge this.

@fghaas
Copy link
Contributor

fghaas commented Mar 18, 2026

@colder-is-better I think we've addressed all the comments that @murwall made. I'll merge and deploy.

@fghaas fghaas merged commit 4357683 into cleura:main Mar 18, 2026
4 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants