Skip to content
Open
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
2245173
Omitted non-containerization sections.
jberendz Jul 21, 2026
87e7e78
adjusting abstract to transport-modes-for-remote-execution
jberendz Jul 21, 2026
5b6115f
reordering tags for assembly
jberendz Jul 21, 2026
4619686
testing ifndef inside of ifeval
jberendz Jul 21, 2026
d6aba32
cleaning up ifndef brackets
jberendz Jul 21, 2026
de87d4d
troubleshooting nesting tags
jberendz Jul 21, 2026
fa17e99
troubleshooting nested ifeval/ifndefs
jberendz Jul 21, 2026
ac70c7f
Troubleshooting nested ifeval and inndef tags
jberendz Jul 22, 2026
709a3c3
Omitting Converting Hosts to RHEL section
jberendz Jul 22, 2026
08f3325
Including ifdef topics for easier review
jberendz Jul 23, 2026
20a3084
Update guides/common/modules/con_transport-modes-for-remote-execution…
jberendz Jul 23, 2026
e71b6de
Update guides/common/modules/con_transport-modes-for-remote-execution…
jberendz Jul 23, 2026
78524f1
Addressing build errors and review comments
jberendz Jul 23, 2026
c4b5dbc
fixing wrapper error
jberendz Jul 23, 2026
7c4c52c
attempting to nest abstract within ifdef
jberendz Jul 23, 2026
3531b74
reverting changes
jberendz Jul 23, 2026
5d6164c
fixing vale error
jberendz Jul 23, 2026
3a88fc9
removing vale error to escalate with sme
jberendz Jul 23, 2026
bea2802
addressing feedback
jberendz Jul 24, 2026
993f55e
reverting excluding assembly that breaks vale
jberendz Jul 27, 2026
717cb12
Update guides/doc-Managing_Hosts/master.adoc
jberendz Jul 28, 2026
2e0cdc0
cleanup
jberendz Jul 28, 2026
01482af
remove ifdef guard for bootstrap
jberendz Jul 28, 2026
eca4816
Adressing feedback
jberendz Jul 29, 2026
6918050
Fixing xref error for other docs
jberendz Jul 29, 2026
65e319e
Reverting changes on patching-hosts-through-errata
jberendz Jul 30, 2026
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
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@ ifdef::foreman-el,foreman-deb[]
include::modules/proc_installing-the-remote-execution-plugin.adoc[leveloffset=+2]
endif::[]

ifndef::containerized[]
ifdef::katello,orcharhino,satellite[]
include::modules/proc_configuring-a-host-to-use-the-pull-client.adoc[leveloffset=+2]
endif::[]
endif::[]

include::modules/proc_distributing-ssh-keys-for-remote-execution.adoc[leveloffset=+2]

Expand All @@ -36,7 +38,9 @@ include::modules/proc_configuring-the-global-smartproxy-remote-execution-setting

include::modules/proc_configuring-the-global-smartproxy-remote-execution-setting-by-using-cli.adoc[leveloffset=+2]

ifndef::containerized[]
include::modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-push-mode.adoc[leveloffset=+2]
endif::[]

ifeval::["{context}" == "managing-hosts"]
include::modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-pull-mode.adoc[leveloffset=+2]
Expand Down Expand Up @@ -76,6 +80,7 @@ include::modules/proc_configuring-a-template-to-distribute-ssh-keys-during-provi
:!parent-client-provisioning-template-type:
endif::[]

ifndef::containerized[]
include::modules/con_configuring-smart-proxy-and-hosts-to-authenticate-with-ssh-certificates.adoc[leveloffset=+1]

include::modules/proc_enabling-ssh-certificate-authentication-on-smart-proxy.adoc[leveloffset=+2]
Expand All @@ -97,6 +102,7 @@ include::modules/proc_configuring-a-keytab-for-kerberos-ticket-granting-tickets.
include::modules/proc_configuring-kerberos-authentication-for-remote-execution.adoc[leveloffset=+2]

include::modules/proc_setting-the-job-rate-limit-on-smartproxy.adoc[leveloffset=+2]
endif::[]

include::modules/con_customizing-remote-jobs.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,15 @@
= Transport modes for remote execution

[role="_abstract"]
ifdef::containerized[]

Check failure on line 7 in guides/common/modules/con_transport-modes-for-remote-execution.adoc

View workflow job for this annotation

GitHub Actions / lint style

[vale] reported by reviewdog 🐶 [foreman-documentation.AbstractLength] Abstract must be between 50 and 300 characters (currently 457 characters). Raw Output: {"message": "[foreman-documentation.AbstractLength] Abstract must be between 50 and 300 characters (currently 457 characters).", "location": {"path": "guides/common/modules/con_transport-modes-for-remote-execution.adoc", "range": {"start": {"line": 7, "column": 1}}}, "severity": "ERROR"}
{Project} uses push-based (SSH) transport for remote job execution.
Push-based transport scales better for larger deployments.
endif::[]
ifndef::containerized[]
You can configure {Project} to use push-based (SSH) or pull-based (MQTT) transport for remote job execution.
Each {SmartProxy} uses one mode.
Choose push for slightly better scalability in larger deployments or pull if your organization restricts the ports needed for SSH.
Choose push for better scalability in larger deployments or pull if your organization restricts the ports needed for SSH.
endif::[]

Push-based transport::
On {SmartProxies} in `ssh` mode, remote execution uses the SSH service to transport job details.
Expand All @@ -17,6 +23,7 @@
+
This transport mode supports both Script and Ansible providers.

ifndef::containerized[]
Pull-based transport::
On {SmartProxies} in `pull-mqtt` mode, remote execution uses Message Queueing Telemetry Transport (MQTT) to initiate the job execution it receives from {ProjectServer}.
The host subscribes to the MQTT broker on {SmartProxy} for job notifications by using the `yggdrasil` pull client.
Expand All @@ -35,3 +42,4 @@
# {foreman-installer} --foreman-proxy-plugin-remote-execution-script-mode ssh
----
====
endif::[]
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ You can use Hammer CLI to review and install installable errata on hosts so that

.Prerequisites
* Requirements for errata installation on hosts are met.
ifdef::containerized[]
Comment thread
jberendz marked this conversation as resolved.
Outdated
For more information, see xref:prerequisites-for-installing-errata-on-hosts[].
endif::[]

.Procedure
. List all errata:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ include::snip_technology-preview.adoc[]

.Prerequisites
* Requirements for errata installation on hosts are met.
ifdef::containerized[]
For more information, see xref:prerequisites-for-installing-errata-on-hosts[].
endif::[]
* The MCP server for {Project} is deployed and configured to allow remote execution jobs for errata installation.
For more information, see {ManagingHostsDocURL}deploying-the-mcp-server-for-{project-context}[Deploying the MCP server for {Project}] in _{ManagingHostsDocTitle}_.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ You can use the {ProjectWebUI} to review and install installable errata on hosts

.Prerequisites
* Requirements for errata installation on hosts are met.
ifdef::containerized[]
For more information, see xref:prerequisites-for-installing-errata-on-hosts[].
endif::[]

.Procedure
. In the {ProjectWebUI}, navigate to *Content* > *Content Types* > *Errata*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ You can install errata on all hosts in a host collection in one action using rem

.Prerequisites
* Requirements for errata installation on hosts are met.
ifdef::containerized[]
For more information, see xref:prerequisites-for-installing-errata-on-hosts[].
endif::[]

.Procedure
. In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*.
Expand All @@ -18,5 +20,7 @@ For more information, see xref:prerequisites-for-installing-errata-on-hosts[].
Alternatively, select the drop-down icon to the right of the button to select a method to use.
Selecting the *via remote execution {endash} customize first* menu entry takes you to the *Job invocation* page where you can customize the action.

ifdef::containerized[]
.Additional resources
* xref:patching-hosts-through-errata[]
endif::[]
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ A description template for the job.
Timeout to kill::
Time in seconds from the start of the job after which the job should be killed if it is not finished already.

ifndef::containerized[]
Time to pickup::
Time in seconds after which the job is canceled if it is not picked up by a client.
This setting only applies to hosts using `pull-mqtt` transport.
endif::[]

Password::
Is used if SSH authentication method is a password instead of the SSH key.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ endif::[]
ifdef::satellite[]
* {EL} 7 with the https://www.redhat.com/en/resources/els-datasheet[ELS Add-On]
ifdef::managing-hosts[]
ifndef::containerized[]
* You can register the following hosts for converting to RHEL:
** CentOS Linux 7
** Oracle Linux 7 and 8
endif::[]
endif::[]
endif::[]
ifndef::orcharhino,satellite[]
* Fedora
* {SLES}
Expand Down
14 changes: 12 additions & 2 deletions guides/doc-Managing_Hosts/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ include::common/modules/ref_guide-not-ready.adoc[leveloffset=+1]
endif::[]
endif::[]

ifndef::containerized[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
Expand All @@ -38,21 +37,27 @@ include::common/assembly_registering-hosts-to-project.adoc[leveloffset=+1]
ifdef::katello,orcharhino,satellite[]
include::common/assembly_restarting-applications-on-hosts-through-tracer.adoc[leveloffset=+1]

ifndef::containerized[]
include::common/assembly_using-custom-ssl-certificate-for-hosts.adoc[leveloffset=+1]
endif::[]

include::common/assembly_refreshing-self-signed-ca-certificate-on-hosts.adoc[leveloffset=+1]
endif::[]

include::common/assembly_configuring-network-interfaces.adoc[leveloffset=+1]

// We do not package foreman_leapp for Foreman on Debian/Ubuntu
ifndef::containerized[]
ifndef::foreman-deb[]
include::common/modules/proc_upgrading-hosts-to-next-major-release.adoc[leveloffset=+1]
endif::[]
endif::[]

ifndef::containerized[]
ifdef::katello,orcharhino,satellite[]
include::common/assembly_converting-hosts-to-rhel.adoc[leveloffset=+1]
endif::[]
endif::[]

include::common/assembly_host-management-and-monitoring-by-using-cockpit.adoc[leveloffset=+1]

Expand Down Expand Up @@ -83,25 +88,31 @@ include::common/assembly_configuring-and-setting-up-remote-jobs.adoc[leveloffset
ifdef::katello,satellite,orcharhino[]
include::common/assembly_managing-packages.adoc[leveloffset=+1]

ifndef::containerized[]
include::common/assembly_installing-flatpak-applications-on-hosts.adoc[leveloffset=+1]
endif::[]

ifdef::katello,orcharhino[]
include::common/assembly_consuming-python-content-on-hosts.adoc[leveloffset=+1]
endif::[]

include::common/assembly_consuming-custom-file-type-content-on-hosts.adoc[leveloffset=+1]

ifdef::containerized[]
include::common/assembly_patching-hosts-through-errata.adoc[leveloffset=+1]
endif::[]
endif::[]

ifdef::katello,orcharhino,satellite[]
include::common/assembly_package-mode-and-image-mode-hosts.adoc[leveloffset=+1]
endif::[]

:numbered!:

ifndef::containerized[]
[appendix]
include::common/modules/proc_troubleshooting-remote-jobs-timing-out-after-yggdrasil-update.adoc[leveloffset=+1]
endif::[]

[appendix]
include::common/assembly_template-writing-reference.adoc[leveloffset=+1]
Expand All @@ -115,4 +126,3 @@ include::common/modules/ref_host-parameter-hierarchy.adoc[leveloffset=+1]
ifndef::orcharhino,satellite[]
include::common/ribbons.adoc[]
endif::[]
endif::[]
Loading