Skip to content

Update ReaR documentation#1871

Merged
BareosBot merged 8 commits intobareos:masterfrom
joergsteffens:dev/joergs/master/rear
Jul 12, 2024
Merged

Update ReaR documentation#1871
BareosBot merged 8 commits intobareos:masterfrom
joergsteffens:dev/joergs/master/rear

Conversation

@joergsteffens
Copy link
Member

@joergsteffens joergsteffens commented Jun 28, 2024

Updates the ReaR documentation. Bareos >= 22 requires a ReaR > 2.7, which is currently only available as snapshot package.

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General
  • Is the PR title usable as CHANGELOG entry?
  • Purpose of the PR is understood
  • Commit descriptions are understandable and well formatted
  • Required backport PRs have been created
  • Correct milestone is set
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR

@joergsteffens joergsteffens self-assigned this Jun 28, 2024
@joergsteffens joergsteffens force-pushed the dev/joergs/master/rear branch 3 times, most recently from 96bc7e2 to b0ead18 Compare June 29, 2024 22:19
@joergsteffens joergsteffens marked this pull request as ready for review June 29, 2024 22:20
@arogge arogge requested a review from sduehr July 2, 2024 10:24
@joergsteffens joergsteffens force-pushed the dev/joergs/master/rear branch from b0ead18 to 23715a2 Compare July 2, 2024 13:21
Schedule ACL = *all*
Storage ACL = *all*
Where ACL = *all*
}
Copy link
Member Author

Choose a reason for hiding this comment

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

This console definition can be simplified, as soon as #1875 is merged.

Copy link

@schlomo schlomo left a comment

Choose a reason for hiding this comment

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

Thanks for the update, LGTM


.. note::

The rescue image is created from the running system.
Copy link

Choose a reason for hiding this comment

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

Maybe add the info that it also contains the Bareos client and related configuration to perform the restore?

Copy link
Member Author

Choose a reason for hiding this comment

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

added.

Instead you configure a :config:option:`dir/console` for every Bareos client using ReaR,
limiting the access to only one system and the required console commands:

.. code-block:: bareosconfig
Copy link

Choose a reason for hiding this comment

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

This feels very cumbersome if you have lots of clients... If there is a way to make this more simple and still secure then maybe would be good to mention it.

Copy link
Member Author

Choose a reason for hiding this comment

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

There are two ways we address this:

  1. when Fix multiple ACL handling bugs #1875 get merged, it still require one console per client, but using a rear profile, in can be reduced to just a few settings
  2. we like to add a mode, where the rescue image only contain the bareos-fd, not the bconsole. This got the limitation, that the restore must be triggered from the server, but simplifies the client a lot. Also using bconsole on the server is the typical use-case.

Copy link
Member Author

Choose a reason for hiding this comment

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

Once this is done, we can extend the documentation to reflect that.

root@host:~# rear recover
Console {
Name = "bareosclient-console"
Password = "secret"
Copy link

Choose a reason for hiding this comment

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

Maybe hint that this needs to be protected with filesystem ACL and that ReaR will take it along and that the rescue image should be treated as a credential?

Copy link
Member Author

Choose a reason for hiding this comment

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

done

Run Script {
Runs When = Before
Runs On Client = yes
Command = "/usr/local/sbin/update-rear-rescue.sh %l"
Copy link

Choose a reason for hiding this comment

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

Maybe mention that the admin needs to put the file there himself, or is this distributed by Bareos automatically?

Copy link
Member Author

Choose a reason for hiding this comment

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

done

Ideally the |bconsole| is configured in a way that it can only access this client,
see :ref:`section-named-console-for-rear`.

To configure the Bareos backend, ReaR uses the variables
Copy link

Choose a reason for hiding this comment

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

Not sure if you have this, but it might be worth explaining that the fileset used for ReaR should be a full backup of all files and not a partial data-only backup.

Copy link
Member Author

Choose a reason for hiding this comment

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

This has only be mentioned in the introduction, but making it more explicit is probably better. Added it now.

@joergsteffens joergsteffens force-pushed the dev/joergs/master/rear branch from 34ea551 to d32b24d Compare July 11, 2024 13:48
Copy link
Member

@sduehr sduehr left a comment

Choose a reason for hiding this comment

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

Thanks a lot, only suggested some typo/wording fixes.

@joergsteffens joergsteffens requested a review from sduehr July 12, 2024 18:38
@sduehr sduehr added this to the 24.0.0 milestone Jul 12, 2024
Copy link
Member

@sduehr sduehr left a comment

Choose a reason for hiding this comment

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

Thanks a lot, looks good now.

@joergsteffens joergsteffens force-pushed the dev/joergs/master/rear branch 2 times, most recently from 7dcd940 to a90071a Compare July 12, 2024 21:11
This was referenced Jul 12, 2024
joergsteffens and others added 8 commits July 12, 2024 22:52
Bareos build now always requires OpenSSL.
Co-authored-by: sduehr <stephan.duehr@bareos.com>
As bareos#1875 and its backports (down
to bareos-21) have been merged, we could simplify the ReaR configuration
by using a standard Profile.
@BareosBot BareosBot force-pushed the dev/joergs/master/rear branch from a5bbc09 to 29dc315 Compare July 12, 2024 22:52
@BareosBot BareosBot merged commit 718eba5 into bareos:master Jul 12, 2024
@joergsteffens joergsteffens deleted the dev/joergs/master/rear branch September 25, 2024 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants