Skip to content

Include Smart Proxy backup and restore in containerized - #5237

Merged
aneta-petrova merged 8 commits into
theforeman:masterfrom
aneta-petrova:foremanctl-backup-proxy
Aug 26, 2026
Merged

Include Smart Proxy backup and restore in containerized#5237
aneta-petrova merged 8 commits into
theforeman:masterfrom
aneta-petrova:foremanctl-backup-proxy

Conversation

@aneta-petrova

@aneta-petrova aneta-petrova commented Aug 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

What changes are you introducing?

Including documentation on Smart Proxy backup and restore in containerized builds

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

The functionality is being added.

theforeman/foremanctl#684

https://redhat.atlassian.net/browse/SAT-45936

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 5.0/Katello 5.0
  • Foreman 3.19/Katello 4.21
  • Foreman 3.18/Katello 4.20 (Satellite 6.19; orcharhino 7.9)
  • 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 commented Aug 21, 2026 •
edited
Loading

Copy link
Copy Markdown

The PR preview for d3b9000 is available at theforeman-foreman-documentation-preview-pr-5237.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@aneta-petrova
aneta-petrova force-pushed the foremanctl-backup-proxy branch 2 times, most recently from 791d212 to d260dd3 Compare August 21, 2026 13:08
sjha4
sjha4 reviewed Aug 21, 2026
View reviewed changes
Comment thread guides/common/modules/con_directories-created-during-backups.adoc
@aneta-petrova
aneta-petrova force-pushed the foremanctl-backup-proxy branch 2 times, most recently from b8f82d7 to 9231d46 Compare August 24, 2026 08:00
@aneta-petrova
aneta-petrova force-pushed the foremanctl-backup-proxy branch from 1f9a6c6 to a99281b Compare August 24, 2026 08:30
@aneta-petrova
aneta-petrova force-pushed the foremanctl-backup-proxy branch from a99281b to 3b62669 Compare August 24, 2026 08:38
@aneta-petrova
aneta-petrova marked this pull request as ready for review August 24, 2026 08:50
@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 Aug 24, 2026
@aneta-petrova

aneta-petrova commented Aug 24, 2026

Copy link
Copy Markdown
Member Author

Hi @sjha4, can you please review? This PR adds information about proxy backup and restore, to extend what we previously merged for server backup and restore. (Incremental backups are still excluded, as are online backups.)

@aneta-petrova

aneta-petrova commented Aug 24, 2026

Copy link
Copy Markdown
Member Author

I'm not sure how complete of a picture the diff gives about what's being added to the docs, so for reviewers' convenience, these are the chapters to look at:

maximiliankolb
maximiliankolb approved these changes Aug 25, 2026
View reviewed changes

@maximiliankolb maximiliankolb 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.

style-wise LGTM

Comment thread guides/common/modules/proc_performing-an-offline-backup-without-pulp-content.adoc
@maximiliankolb maximiliankolb 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 Aug 25, 2026
sjha4
sjha4 approved these changes Aug 25, 2026
View reviewed changes

@sjha4 sjha4 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.

The content is good here. Ack 👍🏼

@maximiliankolb maximiliankolb added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels Aug 25, 2026
qcjames53
qcjames53 suggested changes Aug 25, 2026
View reviewed changes

@qcjames53 qcjames53 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.

I had one process issue. Ignoring that, the full backup and restore steps worked on a single-environment foremanctl proxy (single-environment due to obsah issues). --skip-pulp-content, --force, and --validate all seemed to work. Corrupting the backup and running --validate showed failure.

I'm worried I overlooked a few ifdefs. For future reference, is there a way to view these docs PRs "compiled"?

Comment thread guides/common/modules/con_directories-created-during-backups.adoc
Comment thread guides/common/modules/proc_restoring-from-a-full-backup.adoc Outdated
@pr-processor pr-processor Bot added the Waiting on contributor Requires an action from the author label Aug 25, 2026
@pr-processor pr-processor Bot added Needs re-review and removed Waiting on contributor Requires an action from the author Needs re-review labels Aug 26, 2026
@aneta-petrova

aneta-petrova commented Aug 26, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

I'm worried I overlooked a few ifdefs. For future reference, is there a way to view these docs PRs "compiled"?

There is! :) The first link in a PR, posted by the github-actions bot, contains links to previews of all HTML builds affected by the PR. Is this what you were looking for? The previews are updated automatically with each change in the PR.

@qcjames53

qcjames53 commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Yes! Thank you!

@aneta-petrova aneta-petrova added testing done No issues from the functional perspective and removed Needs testing Requires functional testing labels Aug 26, 2026
@aneta-petrova
aneta-petrova merged commit 365e0c3 into theforeman:master Aug 26, 2026
12 checks passed
@aneta-petrova
aneta-petrova deleted the foremanctl-backup-proxy branch August 26, 2026 13:35
aneta-petrova added a commit that referenced this pull request Aug 26, 2026
@aneta-petrova
Include Smart Proxy backup and restore in containerized (#5237)
7dd4348 
(cherry picked from commit 365e0c3)
@aneta-petrova

aneta-petrova commented Aug 26, 2026

Copy link
Copy Markdown
Member Author

Merged to "master" and cherry-picked:

f215850..7dd4348 5.0 -> 5.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maximiliankolb maximiliankolb maximiliankolb approved these changes
+2 more reviewers
@qcjames53 qcjames53 qcjames53 requested changes
@sjha4 sjha4 sjha4 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@aneta-petrova @qcjames53 @maximiliankolb @sjha4