Skip to content

Update restore docs for foremanctl#4997

Open
aneta-petrova wants to merge 10 commits into
theforeman:masterfrom
aneta-petrova:foremanctl-restore
Open

Update restore docs for foremanctl#4997
aneta-petrova wants to merge 10 commits into
theforeman:masterfrom
aneta-petrova:foremanctl-restore

Conversation

@aneta-petrova

@aneta-petrova aneta-petrova commented Jun 30, 2026

Copy link
Copy Markdown
Member

What changes are you introducing?

  • Including restore documentation for containerized guide versions. Or rather the docs parts which describe what's ready for containerization -- meaning restoring offline backups.
  • Renaming the assembly heading and updating assembly intro to talk about "restoring Foreman" rather than "restoring Foreman Server/Proxy" because right now, only the server can be backed up & restored
  • Updating the exposed docs parts for foremanctl

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

theforeman/foremanctl#549

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

N/A

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.19/Katello 4.21
  • Foreman 3.18/Katello 4.20 (Satellite 6.19)
  • Foreman 3.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6, 7.7, and 7.8)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
  • We do not accept PRs for Foreman older than 3.14.

@github-actions github-actions Bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Jun 30, 2026
@github-actions

github-actions Bot commented Jun 30, 2026 •
edited
Loading

Copy link
Copy Markdown

The PR preview for 868e41d is available at theforeman-foreman-documentation-preview-pr-4997.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@aneta-petrova

aneta-petrova commented Jun 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

Hi @Chyenne8, can you please review this docs PR for foremanctl restore?

The PR uses conditionals to define which changes affect containerized foremanctl documentation (ifdef::containerized[]). The resulting preview of the containerized guide is https://theforeman-foreman-documentation-preview-pr-4997.surge.sh/nightly/Administering_Project/index-satellite.html#restoring-satellite-from-backup. To put it simply, the ideal end result is restore documentation that covers everything that foremanctl currently supports when it comes to restoring, but not more :) So we're using ifdef::containerized[] to include just the parts that are relevant for containerization.

If I'm not mistaken, foremanctl currently supports full offline backups only. This means that the containerized guide preview shows only the full backup procedure. Please let me know if the changes correspond to what you're working on in theforeman/foremanctl#549

ianballou
ianballou reviewed Jul 7, 2026
View reviewed changes
Comment thread guides/common/modules/proc_restoring-from-a-full-backup.adoc
Comment thread guides/common/modules/proc_restoring-from-a-full-backup.adoc Outdated
aneta-petrova
aneta-petrova commented Jul 8, 2026
View reviewed changes
Comment thread guides/common/modules/proc_estimating-the-size-of-a-backup.adoc Outdated
aneta-petrova
aneta-petrova commented Jul 8, 2026
View reviewed changes
Comment thread guides/common/modules/proc_estimating-the-size-of-a-backup.adoc Outdated
@aneta-petrova

aneta-petrova commented Jul 8, 2026

Copy link
Copy Markdown
Member Author

Hi @ianballou and/or @sjha4, I applied the suggested changes, can you please re-review? (The diff is larger because some of the foremanctl changes made me change the pre-foremanctl lines for consistency as wel, but the pre-foremanctl changes are non-technical in nature and IMO you can ignore them.)

ianballou
ianballou reviewed Jul 8, 2026
View reviewed changes

@ianballou ianballou left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks, this is looking good to me. Just one change suggested:

Comment thread guides/common/modules/proc_estimating-the-size-of-a-backup.adoc
[options="nowrap", subs="+quotes,attributes"]
----
# du -sh {postgresql-data-dir} /var/lib/pulp
# du -sh {postgresql-data-dir}

@ianballou ianballou Jul 8, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

+1, the postgres data directory is mounted outside the container.

Comment thread guides/common/modules/proc_estimating-the-size-of-a-backup.adoc Outdated
@aneta-petrova @ianballou
Update guides/common/modules/proc_estimating-the-size-of-a-backup.adoc
868e41d 
Co-authored-by: Ian Ballou <ianballou67@gmail.com>
@aneta-petrova aneta-petrova added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Jul 9, 2026
@aneta-petrova

aneta-petrova commented Jul 9, 2026

Copy link
Copy Markdown
Member Author

Hello dear writers, can someone please review this PR for style?

@aneta-petrova aneta-petrova added tech review done No issues from the technical perspective and removed style review done No issues from docs style/grammar perspective Needs tech review Requires a review from the technical perspective labels Jul 9, 2026
@aneta-petrova aneta-petrova added the Needs style review Requires a review from docs style/grammar perspective label Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ianballou ianballou ianballou left review comments
+2 more reviewers
@sjha4 sjha4 sjha4 left review comments
@Chyenne8 Chyenne8 Chyenne8 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing tech review done No issues from the technical perspective

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@aneta-petrova @ianballou @sjha4 @Chyenne8