Update backup documentation for foremanctl#4850
Draft
aneta-petrova wants to merge 1 commit into
Draft
Conversation
github-actions
Bot
added
Needs tech review
aneta-petrova
removed
Needs tech review
aneta-petrova
commented
May 18, 2026
| When you run the `{foreman-maintain} backup offline` command, the following default backup directories are created: | ||
| When you run the | ||
| ifdef::foremanctl[`foremanctl backup offline`] | ||
| ifndef::foremanctl[`{foreman-maintain} backup offline`] |
Member
Author
There was a problem hiding this comment.
Based on theforeman/foremanctl#507, it looks like backup offline is going away as a separate command and a plain backup will handle the offline backups, with backup online still being available as an alternative.
aneta-petrova
force-pushed
the
foremanctl-backup-restore
branch
from
f90b224 to
2f9ff86
Compare
aneta-petrova
force-pushed
the
foremanctl-backup-restore
branch
from
2f9ff86 to
04a382e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes are you introducing?
Updating backup documentation to use foremanctl rather than foreman-maintain.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
The
foremanctl backupcommand will replaceforeman-maintain backup.TBD: The other backup scenarios.
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
This PR depends on #4846, which is why I cherry-picked the changes from the other PR so that I could start the foremanctl part already.
Contributor checklists
Please cherry-pick my commits into: