Recovery Manager: Difference between revisions
m Trim and add a scope note: the Recovery Manager currently recovers osn.db only; a fuller configuration download/recovery workflow is planned, so this page deliberately stays brief |
m Unwrap hard-wrapped prose lines - MediaWiki collapses a single newline inside a paragraph, so the wrapping had no effect on rendering and was inconsistent with the rest of the wiki. Rendered output is unchanged. |
||
| Line 1: | Line 1: | ||
[[Category:admin_guide]] | [[Category:admin_guide]] | ||
The '''Recovery Manager''' restores the QuantaStor internal configuration | The '''Recovery Manager''' restores the QuantaStor internal configuration database (<code>osn.db</code>) from a backup. Use it when a system has been re-installed and you need the previous configuration back -- Storage Volumes, Network Shares, Users, Hosts, Schedules and the other logical objects. | ||
database (<code>osn.db</code>) from a backup. Use it when a system has been | |||
re-installed and you need the previous configuration back -- Storage Volumes, | |||
Network Shares, Users, Hosts, Schedules and the other logical objects. | |||
'''Navigation:''' Storage Management --> Storage Systems --> ''select a Storage System'' --> Recovery Manager ''(toolbar)'' | '''Navigation:''' Storage Management --> Storage Systems --> ''select a Storage System'' --> Recovery Manager ''(toolbar)'' | ||
| Line 12: | Line 9: | ||
[[File:ss_recovery_manager.png|thumb|center|800px|Recovery Manager, listing the configuration database backups discovered on the started Storage Pools.]] | [[File:ss_recovery_manager.png|thumb|center|800px|Recovery Manager, listing the configuration database backups discovered on the started Storage Pools.]] | ||
'''Scope note:''' the Recovery Manager currently recovers the | '''Scope note:''' the Recovery Manager currently recovers the <code>osn.db</code> configuration database only. A full configuration download and recovery workflow covers considerably more than this, and is planned for a future release. Treat this page as covering the database recovery step, not configuration recovery as a whole. | ||
<code>osn.db</code> configuration database only. A full configuration download | |||
and recovery workflow covers considerably more than this, and is planned for a | |||
future release. Treat this page as covering the database recovery step, not | |||
configuration recovery as a whole. | |||
'''Your data does not depend on this database.''' Storage Pools, and the volumes | '''Your data does not depend on this database.''' Storage Pools, and the volumes and shares within them, carry their own metadata and are recovered by importing the pool. The configuration database holds the logical objects layered on top, which is why a pool imported into a freshly installed system comes back with its volumes intact but without the hosts, schedules and users that referenced them. | ||
and shares within them, carry their own metadata and are recovered by importing | |||
the pool. The configuration database holds the logical objects layered on top, | |||
which is why a pool imported into a freshly installed system comes back with its | |||
volumes intact but without the hosts, schedules and users that referenced them. | |||
'''In a Storage Grid this matters much less''', because the configuration | '''In a Storage Grid this matters much less''', because the configuration database is replicated across all grid nodes; a node rejoining a grid picks the configuration up from its peers. | ||
database is replicated across all grid nodes; a node rejoining a grid picks the | |||
configuration up from its peers. | |||
== Using the Recovery Manager == | == Using the Recovery Manager == | ||
| Line 35: | Line 22: | ||
# Press '''OK'''. | # Press '''OK'''. | ||
The list is built from backups found on the '''started''' Storage Pools, so if | The list is built from backups found on the '''started''' Storage Pools, so if the backup you expect is missing, import and start the pool holding it first. | ||
the backup you expect is missing, import and start the pool holding it first. | |||
Backups are named by rotation slot -- <code>osn.db.backup.hourly.N</code> and | Backups are named by rotation slot -- <code>osn.db.backup.hourly.N</code> and <code>osn.db.backup.daily.N</code>. The count of each is set by <code>max_db_backups</code> in <code>/opt/osnexus/quantastor/conf/quantastor.conf</code> (default '''5'''; 0 disables pool backups). A backup failure raises a '''Configuration DB Backup Failure''' alert -- see [[Call-home / Alerting|Alert Manager]]. | ||
<code>osn.db.backup.daily.N</code>. The count of each is set by | |||
<code>max_db_backups</code> in | |||
<code>/opt/osnexus/quantastor/conf/quantastor.conf</code> (default '''5'''; 0 | |||
disables pool backups). A backup failure raises a '''Configuration DB Backup | |||
Failure''' alert -- see [[Call-home / Alerting|Alert Manager]]. | |||
== Cautions == | == Cautions == | ||
'''Do not restore a backup taken from a different system.''' The database | '''Do not restore a backup taken from a different system.''' The database carries the system's unique ID, so this can leave two systems claiming the same UUID, which causes grid problems. | ||
carries the system's unique ID, so this can leave two systems claiming the same | |||
UUID, which causes grid problems. | |||
'''Network configuration recovery can cut off your own session.''' If the | '''Network configuration recovery can cut off your own session.''' If the restored network settings differ from the current ones, your connection drops when the address changes. Where ports may become unreachable, make the change from the console rather than the web interface. | ||
restored network settings differ from the current ones, your connection drops | |||
when the address changes. Where ports may become unreachable, make the change | |||
from the console rather than the web interface. | |||
'''The restore replaces the running configuration.''' If you are unsure which | '''The restore replaces the running configuration.''' If you are unsure which backup is correct, contact OSNEXUS support at support@osnexus.com before restoring rather than working through them by trial. | ||
backup is correct, contact OSNEXUS support at support@osnexus.com before | |||
restoring rather than working through them by trial. | |||
== Restoring by hand == | == Restoring by hand == | ||
The database is a SQLite file and can be replaced directly if the dialog is not | The database is a SQLite file and can be replaced directly if the dialog is not available -- for example on a system whose web interface will not start: | ||
available -- for example on a system whose web interface will not start: | |||
<pre> | <pre> | ||
Revision as of 18:21, 2 September 2026
The Recovery Manager restores the QuantaStor internal configuration database (osn.db) from a backup. Use it when a system has been re-installed and you need the previous configuration back -- Storage Volumes, Network Shares, Users, Hosts, Schedules and the other logical objects.
Navigation: Storage Management --> Storage Systems --> select a Storage System --> Recovery Manager (toolbar)
It is also on the right-click context menu for a Storage System.
Scope note: the Recovery Manager currently recovers the osn.db configuration database only. A full configuration download and recovery workflow covers considerably more than this, and is planned for a future release. Treat this page as covering the database recovery step, not configuration recovery as a whole.
Your data does not depend on this database. Storage Pools, and the volumes and shares within them, carry their own metadata and are recovered by importing the pool. The configuration database holds the logical objects layered on top, which is why a pool imported into a freshly installed system comes back with its volumes intact but without the hosts, schedules and users that referenced them.
In a Storage Grid this matters much less, because the configuration database is replicated across all grid nodes; a node rejoining a grid picks the configuration up from its peers.
Using the Recovery Manager
- Select the Storage System to recover.
- Choose a backup from the list. Each row shows its name, file size and creation time.
- Optionally tick Include network configuration recovery -- see the cautions below.
- Press OK.
The list is built from backups found on the started Storage Pools, so if the backup you expect is missing, import and start the pool holding it first.
Backups are named by rotation slot -- osn.db.backup.hourly.N and osn.db.backup.daily.N. The count of each is set by max_db_backups in /opt/osnexus/quantastor/conf/quantastor.conf (default 5; 0 disables pool backups). A backup failure raises a Configuration DB Backup Failure alert -- see Alert Manager.
Cautions
Do not restore a backup taken from a different system. The database carries the system's unique ID, so this can leave two systems claiming the same UUID, which causes grid problems.
Network configuration recovery can cut off your own session. If the restored network settings differ from the current ones, your connection drops when the address changes. Where ports may become unreachable, make the change from the console rather than the web interface.
The restore replaces the running configuration. If you are unsure which backup is correct, contact OSNEXUS support at support@osnexus.com before restoring rather than working through them by trial.
Restoring by hand
The database is a SQLite file and can be replaced directly if the dialog is not available -- for example on a system whose web interface will not start:
systemctl stop quantastor cp <backup-file> /var/opt/osnexus/quantastor/osn.db systemctl start quantastor
Related pages
- Storage System -- system-level configuration and the Modify dialog
- Upgrade Manager -- includes a re-install / boot drive swap procedure that uses the Recovery Manager
- Alert Manager -- the Configuration DB Backup Failure alert