Skip to content

Update backup documentation for foremanctl #4850

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

Draft
aneta-petrova wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update backup documentation for foremanctl #4850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 16 additions & 4 deletions guides/common/modules/con_directories-created-during-backups.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,23 @@
[role="_abstract"]
{Project} organizes backups in time-stamped subdirectories, which helps you identify and select the correct backup when restoring your system.

The `{foreman-maintain} backup` command creates a time-stamped subdirectory in the backup directory that you specify.
The `{foreman-maintain} backup` command does not overwrite backups, therefore you must select the correct directory or subdirectory when restoring from a backup or an incremental backup.
The `{foreman-maintain} backup` command stops and restarts services as required.
The
ifdef::containerized[`foremanctl backup`]
ifndef::containerized[`{foreman-maintain} backup`]
command creates a time-stamped subdirectory in the backup directory that you specify.
The
ifdef::containerized[`foremanctl backup`]
ifndef::containerized[`{foreman-maintain} backup`]
command does not overwrite backups, therefore you must select the correct directory or subdirectory when restoring from a backup or an incremental backup.
The
ifdef::containerized[`foremanctl backup`]
ifndef::containerized[`{foreman-maintain} backup`]
command stops and restarts services as required.

When you run the `{foreman-maintain} backup offline` command, the following default backup directories are created:
When you run the
ifdef::containerized[`foremanctl backup offline`]
ifndef::containerized[`{foreman-maintain} backup offline`]
command, the following default backup directories are created:

* `{project-context}-backup` on {Project}
* `foreman-proxy-backup` on {SmartProxy}
Expand Down
16 changes: 16 additions & 0 deletions guides/common/modules/proc_performing-a-full-backup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,29 @@ Ensure no other tasks are scheduled for the same time as the backup.
.Procedure
. Back up your {ProjectServer}:
+
ifdef::containerized[]
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
# foremanctl backup offline _/var/{project-context}-backup_
----
endif::[]
ifndef::containerized[]
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
# {foreman-maintain} backup offline _/var/{project-context}-backup_
----
endif::[]
. Back up your {SmartProxyServer}:
+
ifdef::containerized[]
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
# foremanctl backup offline _/var/foreman-proxy-backup_
----
endif::[]
ifndef::containerized[]
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
# {foreman-maintain} backup offline _/var/foreman-proxy-backup_
----
endif::[]
5 changes: 5 additions & 0 deletions guides/common/modules/ref_available-backup-methods.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,12 @@ For more details, read help information for the offline backup:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
ifdef::containerized[]
# foremanctl backup offline --help
endif::[]
ifndef::containerized[]
# {foreman-maintain} backup offline --help
endif::[]
----

Online backup::
Expand Down
5 changes: 4 additions & 1 deletion .../ref_example-of-a-weekly-full-backup-followed-by-daily-incremental-backups.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,7 @@ fi
exit 0
----

Note that the `{foreman-maintain} backup` command requires `/sbin` and `/usr/sbin` directories to be in `PATH` and the `--assumeyes` option is used to skip the confirmation prompt.
Note that the
ifdef::containerized[`foremanctl backup`]
ifndef::containerized[`{foreman-maintain} backup`]
command requires `/sbin` and `/usr/sbin` directories to be in `PATH` and the `--assumeyes` option is used to skip the confirmation prompt.
Loading