Skip to content

Reword external Smart Proxies to Smart Proxy Servers #3829

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

Jump to bottom
Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Reword external Smart Proxies to Smart Proxy Servers #3829

wants to merge 3 commits into from

Conversation

maximiliankolb
Copy link
Contributor

What changes are you introducing?

Use proper attribute for Smart Proxies and Smart Proxy Servers.

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

fixes #2774

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

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.14/Katello 4.16
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9; orcharhino 7.1 with Leapp)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • We do not accept PRs for Foreman older than 3.7.

@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 May 5, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented May 5, 2025 •
edited
Loading

The PR preview for 28e85ce is available at theforeman-foreman-documentation-preview-pr-3829.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

ekohl
ekohl reviewed May 6, 2025
View reviewed changes
guides/common/modules/proc_installing-smart-proxy-server.adoc Outdated
Copy link
Member

Choose a reason for hiding this comment

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

I'm looking at this procedure and it makes me question things. Perhaps out of scope, but can we make this a procedure just for foreman-{el,deb} and have a different procedure for Katello?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I can work on this in a follow-up PR. I saw the the actual content/origin of the anchor is part of guides/common/assembly_installing-capsule-server.adoc. No change for now.

@maximiliankolb maximiliankolb force-pushed the external_smart_proxies branch from 8f5410c to 73d9223 Compare May 6, 2025 11:57
ekohl
ekohl requested changes May 6, 2025
View reviewed changes
Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

I still see some cases

guides/common/modules/con_prerequisites-for-image-based-provisioning.adoc
5:Images that use the `finish` post-boot configuration scripts require a managed DHCP server, such as {Project}'s integrated {SmartProxy} or an external {SmartProxy}.
guides/common/modules/proc_enabling-openscap.adoc
5:To use the OpenSCAP plugin and content on external {SmartProxies}, you must enable OpenSCAP on each {SmartProxy}.

@pr-processor pr-processor bot added the Waiting on contributor Requires an action from the author label May 6, 2025
@maximiliankolb maximiliankolb force-pushed the external_smart_proxies branch from 73d9223 to 28e85ce Compare May 7, 2025 07:48
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels May 7, 2025
@maximiliankolb
Copy link
Contributor Author

I still see some cases

guides/common/modules/con_prerequisites-for-image-based-provisioning.adoc
5:Images that use the `finish` post-boot configuration scripts require a managed DHCP server, such as {Project}'s integrated {SmartProxy} or an external {SmartProxy}.
guides/common/modules/proc_enabling-openscap.adoc
5:To use the OpenSCAP plugin and content on external {SmartProxies}, you must enable OpenSCAP on each {SmartProxy}.
  • guides/common/modules/con_prerequisites-for-image-based-provisioning.adoc: Fixed.
  • I already have a branch prepared to rework installing foreman_openscap on Foreman Server and Smart Proxy Servers.

ekohl
ekohl approved these changes May 7, 2025
View reviewed changes
Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

Looks like a good improvement and looking forward to see the OpenSCAP improvements. I hope you'll refer more to our security compliance guide instead where https://docs.theforeman.org/nightly/Managing_Security_Compliance/index-katello.html#Installing_the_OpenSCAP_plugin_security-compliance already has instructions for both.

@maximiliankolb maximiliankolb added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ekohl ekohl ekohl approved these changes

Assignees
No one assigned
Labels
Needs style review Requires a review from docs style/grammar perspective 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.

Clarify terminology: SmartProxy/SmartProxyServer, Internal/External/Isolated
2 participants
@maximiliankolb @ekohl