diff --git a/README.md b/README.md index 278fc41..1d7cd05 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,27 @@ To develop install `jekyll` and `ruby-kramdown` and start the jekyll server with `./serve.sh` To just start a live server without local dependencies via Docker run `./docker.sh` + +## Notes + +### Convert Markdown to HTML + +We use [Lynx](https://lynx.invisible-island.net/) to convert Markdown to HTML. It creates a text file with the HTML content and adds the links as footnotes. + +You can either install `lynx` on your system or use the Docker image `alpine/lynx`. + +```bash +docker run --rm -it -e LC_ALL=POSIX -e LANG=POSIX alpine/lynx --dump URL > output.txt +``` + +Example for release notes: + +```bash +docker run --rm -it -e LC_ALL=POSIX -e LANG=POSIX alpine/lynx --dump https://relax-and-recover.org/documentation/release-notes-2-8 > release-notes-2-8.txt +``` + +To use it with Docker to convert from the local development server (*however note, that the links will also point to the local server*): + +```bash +docker run --rm -it -e LC_ALL=POSIX -e LANG=POSIX alpine/lynx --dump http://host.docker.internal:4000/documentation/release-notes-2-8 +``` diff --git a/_config.yml b/_config.yml index 911bafd..10e6731 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1 @@ -markdown: kramdown \ No newline at end of file +markdown: kramdown diff --git a/about/index.md b/about/index.md index ae8e8b5..3f1d0cb 100644 --- a/about/index.md +++ b/about/index.md @@ -3,6 +3,62 @@ layout: default title: About Relax-and-Recover --- +## Overview + +Relax-and-Recover (abbreviated ReaR) is the de facto standard disaster recovery framework on Linux. + +It is in particular used on enterprise Linux distributions like Red Hat Enterprise Linux (RHEL) +and SUSE Linux Enterprise Server (SLES). + +ReaR is a system administrator tool and framework to create a bootable disaster recovery system image +for bare metal disaster recovery with data backup restore on physical or virtual replacement hardware. + +For bare metal disaster recovery the ReaR recovery system is booted on pristine replacement hardware. +On replacement hardware first the storage setup/layout is recreated (disk partitioning, filesystems, mount points), +then a backup restore program is called to restore the data (system files) into the recreated storage, +and finally a boot loader is installed. + +System administrators use the ReaR framework to set up a disaster recovery procedure +as part of their disaster recovery policy (which complements their existing backup policy). + +ReaR complements backup and restore of data with bare metal disaster recovery. ReaR can also act as local backup software, +but ReaR is not a a backup management software. In many enterprise environmentments, data backup and restore happens via dedicated backup software which is integrated by ReaR and used to restore the data onto a replacement system as part of the automated disaster recovery procedure implemented by ReaR. + +ReaR has support for built-in backup methods using 'tar' and 'rsync' that are used for backup and restore. + +ReaR integrates supports the following 3rd party, also commercial, tools for restoring a backup. + +The complete list of backup methods (`BACKUP=...`) is: + +* `AVA` Dell EMC Avamar / EMC Avamar +* `BACULA` Bacula +* `BAREOS` [Bareos](https://docs.bareos.org/Appendix/DisasterRecoveryUsingBareos.html#linux) +* `BLOCKCLONE` block device cloning via `dd` +* `BORG` Borg Backup +* `CDM` Rubrik Cloud Data Management +* `DP` OpenText Data Protector +* `DUPLICITY` Duplicity / Duply +* `EXTERNAL` External custom restore method +* `FDRUPSTREAM` FDR/Upstream +* `GALAXY11` Commvault Galaxy 11 / Commvault Simpana +* `NBKDC` NovaStor DataCenter +* `NBU` Veritas NetBackup / Symantec NetBackup +* `NETFS` ReaR built-in backup and restore via `rsync` or `tar` to a network file system or to a locally attached backup disk (USB, eSATA, ...) +* `NFS4SERVER` NFS4 server to push data *to* the rescue system +* `NSR` Dell EMC NetWorker / EMC NetWorker / Legato NetWorker +* `OBDR` One Button Disaster Recovery via tape +* `PPDM` [Dell PowerProtect Data Manager](https://infohub.delltechnologies.com/en-us/t/simplifying-linux-bmr-for-powerprotect-data-manager-using-rear-relax-and-recover-disaster-recovery-solution/) +* `RBME` Rsync Backup Made Easy +* `REQUESTRESTORE` Request restore from a human operator +* `RSYNC` ReaR built-in backup using `rsync` via `rsync` or `ssh` protocol +* `SESAM` [SEP Sesam](https://wiki.sep.de/wiki/index.php/Bare_Metal_Recovery_Linux) +* `TSM` IBM Storage Protect / Tivoli Storage Manager / IBM Spectrum Protect +* `VEEAM` Veeam Backup + +ReaR integrates well with Disaster Recovery Linux Manager (DRLM) [drlm.org](https://drlm.org), which can act as a central management tool for ReaR deployments. + +## Features + Relax-and-Recover has a few interesting characteristics you may find useful when assessing it as a Disaster Recovery or Bare Metal Restore solution: @@ -21,8 +77,9 @@ when assessing it as a Disaster Recovery or Bare Metal Restore solution: * Two-step recovery, with optional guided menus * disaster recovery process targeted at operational teams * migration process offers flexibility and control + * fully unattended recovery possible for large scale deployments -* Bare metal recovery on dissimilar hardware +* Bare metal recovery on different hardware * support for physical-to-virtual (P2V), virtual-to-physical (V2P) * support for physical-to-physical (P2P) and virtual-to-virtual (V2V) * various virtualization technologies supported (KVM, Xen, VMware) @@ -51,26 +108,14 @@ when assessing it as a Disaster Recovery or Bare Metal Restore solution: * iSCSI * LUKS (encrypted partitions and filesystems) -* Supports various 3rd party backup technologies, incl. - * [CommVault Galaxy](https://www.commvault.com/) (Simpana) - * [Dell / EMC NetWorker](https://www.dell.com/en-us/dt/data-protection/data-protection-suite/networker-data-protection-software.htm) (Legato) - * EMC Avamar - * [Dell PowerProtect Data Manager](https://www.dell.com/en-us/dt/data-protection/powerprotect-data-manager.htm) - * HP DataProtector - * IBM Tivoli Storage Manager / IBM Spectrum Protect (TSM) - * FDR Upstream - * NovaStor DC - * Rubrik Cloud Data Management - * [SEP Sesam](https://www.sepsoftware.com/sep-sesam/disaster-recovery/) - * Symantec NetBackup - * [Veeam Backup](https://www.veeam.com/) - * [Bacula](http://www.bacula.org) - * [Bareos](http://www.bareos.org/en/HOWTO/articles/relax-and-recover-with-bareos.html) - * BorgBackup - * [duplicity](http://duplicity.nongnu.org) / [duply](http://duply.net) - * Rsync Backup Made Easy (rbme) - -* Supports various internal backup methods and restore methods +* Supports various 3rd party backup technologies + * use backup tool of your choice + * restore files from backup software, ReaR takes care of the rest and controls the entire process from bare metal boot to functioning new system + * integrates with many commercial backup software + * integrates with many Open Source backup software + * with some tools, ReaR can also store the rescue media with the backup software + +* Supports various built-in backup and restore methods * [tar](http://www.gnu.org/software/tar) * [rsync](http://rsync.samba.org) * restore via NFS4 Server running on rescue system @@ -85,13 +130,13 @@ when assessing it as a Disaster Recovery or Bare Metal Restore solution: * log files are moved to recovery image, and to recovered system (available in every step for debugging) * advanced debugging options to help trace scripts or develop new functionality -* Integration with monitoring (examples for Nagios/Opsview) +* Integration with monitoring + * examples for Nagios/Opsview * Integration with scheduler - _(e.g. let cron recreate and transfer your images upon disk layout changes)_ + * e.g. let cron recreate and transfer your images upon disk layout changes * Various best practices to assist recovery - * integrates with local bootloader _(in case it is still possible, you can restore from local disk through Grub)_ * automatic network and ssh configuration diff --git a/documentation/concept.md b/documentation/concept.md index 1424f36..23de32f 100644 --- a/documentation/concept.md +++ b/documentation/concept.md @@ -56,10 +56,10 @@ The configuration must define the *BACKUP* and *OUTPUT* methods. Some valid choi |CDROM | BACKUP | Copy files to ISO image | OK |NSR | BACKUP | Use Legato Networker | OK |TSM | BACKUP | Use Tivoli Storage Manager | OK - |DP | BACKUP | Use HP Data Protector | OK + |DP | BACKUP | Use OpenText Data Protector | OK |BACULA | BACKUP | Use opensource Bacula | OK |FDRUPSTREAM | BACKUP | Use FDR/Upstream | OK - | + | ... | BACKUP | (see default.conf for full list) | | | | | |ISO | OUTPUT | Write result to ISO9660 image | OK |CDROM | OUTPUT | Write result to CD/DVD | on request diff --git a/documentation/index.md b/documentation/index.md index 4efa97a..074d12f 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -1,6 +1,6 @@ --- layout: default -title: Relax-and-Recover documentation +title: Relax-and-Recover Documentation --- ## Getting started @@ -14,6 +14,7 @@ title: Relax-and-Recover documentation ## Release notes +- [Relax-and-Recover Release Notes 2.8](/documentation/release-notes-2-8) - [Relax-and-Recover Release Notes 2.7](/documentation/release-notes-2-7) - [Relax-and-Recover Release Notes 2.6](/documentation/release-notes-2-6) - [Relax-and-Recover Release Notes 2.5](/documentation/release-notes-2-5) diff --git a/documentation/release-notes-2-8.md b/documentation/release-notes-2-8.md index fc0a7ff..dbcfd55 100644 --- a/documentation/release-notes-2-8.md +++ b/documentation/release-notes-2-8.md @@ -1,26 +1,23 @@ --- layout: default -title: Relax-and-Recover Release Notes +title: Release Notes for Relax-and-Recover Version 2.8 --- +This document contains the latest release notes for the Open Source Software project Relax-and-Recover. -# Release Notes for Relax-and-Recover Version 2.8 +Relax-and-Recover website: [relax-and-recover.org](https://relax-and-recover.org/) -This document contains the latest release notes for the Free and Open Source Software project Relax-and-Recover. +GitHub project: [github.com/rear](https://github.com/rear) -Relax-and-Recover website: +For the release notes of previous Relax-and-Recover versions see the +Relax-and-Recover website release notes: [relax-and-recover.org/documentation](/documentation) -GitHub project: -For older Relax-and-Recover version release notes see the -Relax-and-Recover website release notes: - - -# Overview +## Overview Relax-and-Recover (abbreviated ReaR) is the de facto standard disaster recovery framework on Linux. -It is particular used on enterprise Linux distributions like Red Hat Enterprise Linux (RHEL) +It is in particular used on enterprise Linux distributions like Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES). ReaR is a system administrator tool and framework to create a bootable disaster recovery system image @@ -34,32 +31,43 @@ and finally a boot loader is installed. System administrators use the ReaR framework to set up a disaster recovery procedure as part of their disaster recovery policy (which complements their existing backup policy). -ReaR complements backup and restore of data -but ReaR is neither a backup software nor a backup management software. -Data backup and restore happens via dedicated backup software which is called by ReaR. - -ReaR has built-in support for some 'internal' backup programs like 'tar' and 'rsync'. - -ReaR integrates with various external (third-party) backup software solutions, for example: - -* IBM Storage Protect (TSM) / Tivoli Storage Manager / IBM Spectrum Protect -* Data Protector (DP) -* Veritas NetBackup (NBU) / Symantec NetBackup -* Commvault Simpana (GALAXY10) / Galaxy 10 -* Bacula (BACULA) -* Bareos (BAREOS) -* Rsync Backup Made Easy (RBME) -* Duplicity/Duply (DUPLICITY) -* Dell NetWorker (NSR) / EMC NetWorker / Legato NetWorker -* Dell EMC Avamar (AVA) / EMC Avamar -* SEP Sesam (SESAM) -* Borg (BORG) -* Rubrik Cloud Data Management (CDM) - -ReaR integrates with Disaster Recovery Linux Manager (DRLM) - - -# System and Software Requirements +ReaR complements backup and restore of data with bare metal disaster recovery. ReaR can also act as local backup software, +but ReaR is not a a backup management software. In many enterprise environmentments, data backup and restore happens via dedicated backup software which is integrated by ReaR and used to restore the data onto a replacement system as part of the automated disaster recovery procedure implemented by ReaR. + +ReaR has support for built-in backup methods using 'tar' and 'rsync' that are used for backup and restore. + +ReaR integrates supports the following 3rd party, also commercial, tools for restoring a backup. + +The complete list of backup methods (`BACKUP=...`) is: + +* `AVA` Dell EMC Avamar / EMC Avamar +* `BACULA` Bacula +* `BAREOS` [Bareos](https://docs.bareos.org/Appendix/DisasterRecoveryUsingBareos.html#linux) +* `BLOCKCLONE` block device cloning via `dd` +* `BORG` Borg Backup +* `CDM` Rubrik Cloud Data Management +* `DP` OpenText Data Protector +* `DUPLICITY` Duplicity / Duply +* `EXTERNAL` External custom restore method +* `FDRUPSTREAM` FDR/Upstream +* `GALAXY11` Commvault Galaxy 11 / Commvault Simpana +* `NBKDC` NovaStor DataCenter +* `NBU` Veritas NetBackup / Symantec NetBackup +* `NETFS` ReaR built-in backup and restore via `rsync` or `tar` to a network file system or to a locally attached backup disk (USB, eSATA, ...) +* `NFS4SERVER` NFS4 server to push data *to* the rescue system +* `NSR` Dell EMC NetWorker / EMC NetWorker / Legato NetWorker +* `OBDR` One Button Disaster Recovery via tape +* `PPDM` [Dell PowerProtect Data Manager](https://infohub.delltechnologies.com/en-us/t/simplifying-linux-bmr-for-powerprotect-data-manager-using-rear-relax-and-recover-disaster-recovery-solution/) +* `RBME` Rsync Backup Made Easy +* `REQUESTRESTORE` Request restore from a human operator +* `RSYNC` ReaR built-in backup using `rsync` via `rsync` or `ssh` protocol +* `SESAM` [SEP Sesam](https://wiki.sep.de/wiki/index.php/Bare_Metal_Recovery_Linux) +* `TSM` IBM Storage Protect / Tivoli Storage Manager / IBM Spectrum Protect +* `VEEAM` Veeam Backup + +ReaR integrates well with Disaster Recovery Linux Manager (DRLM) [drlm.org](https://drlm.org), which can act as a central management tool for ReaR deployments. + +## System and Software Requirements ReaR is written entirely in the native language for system administration: as shell (bash) scripts. The intent is that experienced users and system admins can adapt or extend the ReaR scripts @@ -72,27 +80,25 @@ The default backup software used by ReaR is standard GNU/tar. ReaR is known to work on x86 (32bit and 64bit) and ppc64le architectures. ReaR was also ported to ia64 and arm architectures, but these are rarely tested. - -# Support +## Support Relax-and-Recover (ReaR) is a Free and Open Source Software project under GPLv3 license. The creators of ReaR have spend many, many hours in development and support. We may give voluntary support, but only as work-life balance allows it. -We also provide support as a service (not free of charge). +Some of the maintainers also provide paid support as a commercial service. -ReaR has a long history (since 2006) and we cannot support all released versions. -If you have a problem we urge you to install the latest stable ReaR version -or the development version (available on GitHub) before submitting an issue. -We understand that it is not always possible to install the latest version on hundreds of systems +ReaR has a long history (since 2006) and we can therefore only support the latest release version. +If you have a problem, we urge you to install the latest stable ReaR version +or the snapshot (development) version available on GitHub before submitting an issue. +We understand that it is not always possible to install the latest version on hundreds of systems, so we are willing to support previous versions of ReaR when you buy a support contract. We cannot handle all those various support requests on a voluntary base and we give paid projects priority, therefore, we urge our customers to buy a support contract for one or more systems. -You buy time with the core developers. - -See the Relax-and-Recover website support +Buying a support contract actually buys time for the core developers to work on ReaR. +See the Relax-and-Recover website support [relax-and-recover.org/support](/support) ## Supported and Unsupported Operating Systems @@ -101,26 +107,25 @@ For example for ReaR 2.8 see +### New features, bigger enhancements, and possibly backward incompatible changes: -## New features, bigger enhancements, and possibly backward incompatible changes: +* New support for additional commercial backup software -* Initial VEEAM Bare Metal Recovery integration. + * Veeam Backup. -* Bareos integration was rewritten. + * Dell PowerProtect Data Manager. + + * CommvaultGalaxy 11 (Simpana). -* New portable mode --portable and OUTPUT=PORTABLE. +* Bareos integration was rewritten and updated. -* New -e/--expose-secrets option. +* New portable mode `--portable` and `OUTPUT=PORTABLE`, see for more information. -* New non-interactive mode. +* Improved handling and protecting of secrets in ReaR configuration variables. New `-e`/`--expose-secrets` option to show secrets in configuration variables. -* NFS4SERVER as new restore method. +* New non-interactive mode `-n`/`--non-interactive` to suppress all interactive questions and answers and facilitate truly unattended recovery automation. -* New OpalPBA AuthToken feature. +* `NFS4SERVER` as new restore method where the rescue systems starts an NFS4 server to push the data to the rescue system. -* Add support for Commvault Galaxy 11. +* New OpalPBA AuthToken feature. * Layout changes and fixes for S/390 DASDs (major code overhauling). -* Initial basic 'barrel' support, see - -* By default "rear recover" wipes disks that get completely recreated -via DISKS_TO_BE_WIPED="" in default.conf. +* Initial basic `barrel` support, see +* By default `rear recover` wipes disks that get completely recreated via `DISKS_TO_BE_WIPED=""` in default.conf. -## Details (mostly in chronological order - newest topmost): +### Details (mostly in chronological order - newest topmost): Only changes of the ReaR software and its documentation that could be of common interest are listed here. For example changes of ReaR GitHub infrastructure things (like GitHub workflows, actions, CI, and package building) @@ -227,9 +240,11 @@ or view the ReaR 2.8 changes at GitHub The following entries are basically excerpts of what the command -``` + +```sh git log --format="%ae %H %ad%n%s :%n%b%n" --graph | fmt -w 160 -u -t ``` + shows in a local git clone: diff --git a/index.md b/index.md index d5bf158..516ca47 100644 --- a/index.md +++ b/index.md @@ -10,7 +10,7 @@ Learn more about Relax-and-Recover from the selected usage scenarios below: - + @@ -25,7 +25,7 @@ Learn more about Relax-and-Recover from the selected usage scenarios below: @@ -43,6 +43,37 @@ Try Relax-and-Recover now. The [Quickstart guide](documentation/getting-started) Your environment not supported? Relax-and-Recover is modular and easy to extend. It is GPL licensed and we welcome all feedback and contributions. +## ReaR Backup Methods + +The complete list of backup methods (`BACKUP=...`) is: + +* `AVA` Dell EMC Avamar / EMC Avamar +* `BACULA` Bacula +* `BAREOS` [Bareos](https://docs.bareos.org/Appendix/DisasterRecoveryUsingBareos.html#linux) +* `BLOCKCLONE` block device cloning via `dd` +* `BORG` Borg Backup +* `CDM` Rubrik Cloud Data Management +* `DP` OpenText Data Protector +* `DUPLICITY` Duplicity / Duply +* `EXTERNAL` External custom restore method +* `FDRUPSTREAM` FDR/Upstream +* `GALAXY11` Commvault Galaxy 11 / Commvault Simpana +* `NBKDC` NovaStor DataCenter +* `NBU` Veritas NetBackup / Symantec NetBackup +* `NETFS` ReaR built-in backup and restore via `rsync` or `tar` to a network file system or to a locally attached backup disk (USB, eSATA, ...) +* `NFS4SERVER` NFS4 server to push data *to* the rescue system +* `NSR` Dell EMC NetWorker / EMC NetWorker / Legato NetWorker +* `OBDR` One Button Disaster Recovery via tape +* `PPDM` [Dell PowerProtect Data Manager](https://infohub.delltechnologies.com/en-us/t/simplifying-linux-bmr-for-powerprotect-data-manager-using-rear-relax-and-recover-disaster-recovery-solution/) +* `RBME` Rsync Backup Made Easy +* `REQUESTRESTORE` Request restore from a human operator +* `RSYNC` ReaR built-in backup using `rsync` via `rsync` or `ssh` protocol +* `SESAM` [SEP Sesam](https://wiki.sep.de/wiki/index.php/Bare_Metal_Recovery_Linux) +* `TSM` IBM Storage Protect / Tivoli Storage Manager / IBM Spectrum Protect +* `VEEAM` Veeam Backup + +## ReaR Concepts, Advanced Usage and Project History + To learn more about the Relax-and-Recover concepts, basic & advanced usage and project history watch this 45-minute introduction by Schlomo Schapiro, project founder and maintainer:
Home user Enterprise userSingle Computer / Home User Server Farm / Data Center / Enterprise User
Laptop Servers