Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Schlomo prepare for 2 8 release #22

Merged
merged 8 commits into from
Dec 17, 2024
Merged

Schlomo prepare for 2 8 release #22

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dba20e7
WIP
schlomo Dec 10, 2024
3b3a103
update docs to markdown and to clearly list the supported backup tools
schlomo Dec 11, 2024
b13326d
fix links
schlomo Dec 11, 2024
efc9152
Explain about unsupported BTRFS and Fedora features
schlomo Dec 13, 2024
e5d8b9d
pitch for paid contributions
schlomo Dec 13, 2024
1d1e5d1
Force ASCII rendering for lynx dump
schlomo Dec 17, 2024
14fc45f
add oracleasm to known non-features
schlomo Dec 17, 2024
df73da8
Rename HP Data Protector to OpenText Data Protector
schlomo Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 alpine/lynx --dump URL > output.txt
```

Example for release notes:

```bash
docker run --rm -it alpine/lynx --dump https://relax-and-recover.org/documentation/release-notes-2-8 > release-notes-2-8.txt
Copy link
Member

Choose a reason for hiding this comment

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

This does not ensure in general that
the generated release-notes-2-8.txt is ASCII, cf.
https://github.com/rear/rear/wiki/Coding-Style#character-encoding

E.g. on my openSUSE Leap 15.5 workstation

$ lynx --dump https://relax-and-recover.org/documentation/release-notes-2-8 >release-notes-2-8.txt

$ file release-notes-2-8.txt
release-notes-2-8.txt: UTF-8 Unicode text

$ locale
LANG=en_US.UTF-8
LC_CTYPE="en_US.UTF-8"
LC_NUMERIC="en_US.UTF-8"
LC_TIME="en_US.UTF-8"
LC_COLLATE="en_US.UTF-8"
LC_MONETARY="en_US.UTF-8"
LC_MESSAGES="en_US.UTF-8"
LC_PAPER="en_US.UTF-8"
LC_NAME="en_US.UTF-8"
LC_ADDRESS="en_US.UTF-8"
LC_TELEPHONE="en_US.UTF-8"
LC_MEASUREMENT="en_US.UTF-8"
LC_IDENTIFICATION="en_US.UTF-8"
LC_ALL=

To ensure the generated release-notes-2-8.txt is ASCII
one must run lynx in POSIX locale:

$ export LC_ALL=POSIX
$ export LANG=POSIX

$ lynx --dump https://relax-and-recover.org/documentation/release-notes-2-8 >release-notes-2-8.txt

$ file release-notes-2-8.txt
release-notes-2-8.txt: ASCII text

Copy link
Member

@jsmeix jsmeix Dec 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

By the way:
Also with lynx the generated release-notes-2-8.txt
has the unwanted header and footer like

   [1]Relax-and-Recover
     * [2]Home
     * [3]Features
     * [4]Documentation
     * [5]Downloads
     * [6]Support
     * [7]Development
     * [8]Events

and

   [20]
   
  If you like Relax-and-Recover please consider sponsorship

with the current online
https://relax-and-recover.org/documentation/release-notes-2-8
(i.e. without the changes in this pull request), cf.
rear/rear#3238 (comment)

```

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 alpine/lynx --dump http://host.docker.internal:4000/documentation/release-notes-2-8
```
2 changes: 1 addition & 1 deletion _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
markdown: kramdown
markdown: kramdown
93 changes: 69 additions & 24 deletions about/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 recovery system.

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` HP 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:

Expand All @@ -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)
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
3 changes: 2 additions & 1 deletion documentation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: Relax-and-Recover documentation
title: Relax-and-Recover Documentation
---

## Getting started
Expand All @@ -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)
Expand Down
Loading