Skip to content

Split remote execution into multiple assemblies #4753

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

Merged
aneta-petrova merged 8 commits into from
Apr 8, 2026
Merged

Split remote execution into multiple assemblies #4753

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
867e269
Split remote execution into multiple assemblies
aneta-petrova Apr 2, 2026
0904dbb
Apply suggestions from style review
aneta-petrova Apr 7, 2026
cd59a8b
Apply suggestions from code review
aneta-petrova Apr 7, 2026
bc7ca7b
Apply suggestion from @maximiliankolb
aneta-petrova Apr 7, 2026
7bde896
Change cron line syntax module's type
aneta-petrova Apr 7, 2026
207eff3
Apply feedback for additional assemblies
aneta-petrova Apr 7, 2026
94c6c0e
Fix Vale error
aneta-petrova Apr 7, 2026
53e7c86
Apply suggestion from @Lennonka
aneta-petrova Apr 8, 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
100 changes: 4 additions & 96 deletions guides/common/assembly_configuring-and-setting-up-remote-jobs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,104 +2,12 @@

include::modules/con_configuring-and-setting-up-remote-jobs.adoc[]

include::modules/con_remote-execution-in-project.adoc[leveloffset=+1]
include::assembly_remote-execution-overview.adoc[leveloffset=+1]

include::modules/con_remote-execution-workflow.adoc[leveloffset=+1]
include::assembly_getting-started-with-remote-execution.adoc[leveloffset=+1]

include::modules/con_permissions-for-remote-execution.adoc[leveloffset=+1]
include::assembly_configuring-remote-execution.adoc[leveloffset=+1]

include::modules/con_transport-modes-for-remote-execution.adoc[leveloffset=+1]

ifdef::foreman-el,foreman-deb[]
include::modules/proc_installing-the-remote-execution-plugin.adoc[leveloffset=+1]
endif::[]

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

include::modules/proc_creating-a-job-template-by-using-web-ui.adoc[leveloffset=+1]

include::modules/proc_creating-a-job-template-by-using-cli.adoc[leveloffset=+1]

include::modules/proc_importing-an-ansible-playbook-by-name.adoc[leveloffset=+1]

include::modules/proc_importing-all-available-ansible-playbooks.adoc[leveloffset=+1]

include::modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-web-ui.adoc[leveloffset=+1]

include::modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-cli.adoc[leveloffset=+1]

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

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

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

ifeval::["{context}" == "managing-hosts"]
include::modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-pull-mode.adoc[leveloffset=+1]
endif::[]

include::modules/proc_altering-the-privilege-elevation-method.adoc[leveloffset=+1]

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

include::modules/proc_adding-project-server-ssh-key-to-authorized-keys.adoc[leveloffset=+1]

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

include::modules/proc_adding-a-passphrase-to-ssh-key-used-for-remote-execution.adoc[leveloffset=+1]

include::modules/proc_using-the-api-to-obtain-ssh-keys-for-remote-execution.adoc[leveloffset=+1]

ifndef::orcharhino,satellite[]
:parent-client-provisioning-template-type: {client-provisioning-template-type}
:client-provisioning-template-type: Agama
include::modules/proc_configuring-a-template-to-distribute-ssh-keys-during-provisioning.adoc[leveloffset=+1]
:client-provisioning-template-type: {parent-client-provisioning-template-type}
:!parent-client-provisioning-template-type:
endif::[]

ifndef::orcharhino[]
:parent-client-provisioning-template-type: {client-provisioning-template-type}
:client-provisioning-template-type: Kickstart
endif::[]
include::modules/proc_configuring-a-template-to-distribute-ssh-keys-during-provisioning.adoc[leveloffset=+1]
ifndef::orcharhino[]
:client-provisioning-template-type: {parent-client-provisioning-template-type}
:!parent-client-provisioning-template-type:
endif::[]

ifndef::orcharhino,satellite[]
:parent-client-provisioning-template-type: {client-provisioning-template-type}
:client-provisioning-template-type: Preseed
include::modules/proc_configuring-a-template-to-distribute-ssh-keys-during-provisioning.adoc[leveloffset=+1]
:client-provisioning-template-type: {parent-client-provisioning-template-type}
:!parent-client-provisioning-template-type:
endif::[]

include::assembly_configuring-smart-proxy-and-hosts-to-authenticate-with-ssh-certificates.adoc[leveloffset=+1]

include::modules/proc_configuring-a-keytab-for-kerberos-ticket-granting-tickets.adoc[leveloffset=+1]

include::modules/proc_configuring-kerberos-authentication-for-remote-execution.adoc[leveloffset=+1]

include::modules/proc_customizing-job-templates.adoc[leveloffset=+1]

include::modules/proc_executing-a-remote-job-by-using-web-ui.adoc[leveloffset=+1]

include::modules/proc_executing-a-remote-job-by-using-cli.adoc[leveloffset=+1]
include::assembly_customizing-remote-jobs.adoc[leveloffset=+1]

include::modules/ref_advanced-settings-in-the-job-wizard.adoc[leveloffset=+1]

include::modules/con_using-extended-cron-lines.adoc[leveloffset=+1]

include::modules/proc_scheduling-a-recurring-ansible-job-for-a-host.adoc[leveloffset=+1]

include::modules/proc_scheduling-a-recurring-ansible-job-for-a-host-group.adoc[leveloffset=+1]

ifdef::katello,orcharhino,satellite[]
include::modules/proc_using-ansible-provider-for-package-and-errata-actions.adoc[leveloffset=+1]
endif::[]

include::modules/proc_setting-the-job-rate-limit-on-smartproxy.adoc[leveloffset=+1]
63 changes: 63 additions & 0 deletions guides/common/assembly_configuring-remote-execution.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
:_mod-docs-content-type: ASSEMBLY

Check warning on line 1 in guides/common/assembly_configuring-remote-execution.adoc

View workflow job for this annotation

GitHub Actions / lint DITA 

[vale] reported by reviewdog 🐶
[AsciiDocDITA.ShortDescription] Assign [role="_abstract"] to a paragraph to use it as <shortdesc> in DITA.

Raw Output:
{"message": "[AsciiDocDITA.ShortDescription] Assign [role=\"_abstract\"] to a paragraph to use it as \u003cshortdesc\u003e in DITA.", "location": {"path": "guides/common/assembly_configuring-remote-execution.adoc", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in guides/common/assembly_configuring-remote-execution.adoc

View workflow job for this annotation

GitHub Actions / lint DITA 

[vale] reported by reviewdog 🐶
[AsciiDocDITA.DocumentTitle] The document title (a level 0 heading) is missing.

Raw Output:
{"message": "[AsciiDocDITA.DocumentTitle] The document title (a level 0 heading) is missing.", "location": {"path": "guides/common/assembly_configuring-remote-execution.adoc", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

include::modules/con_configuring-remote-execution.adoc[]

include::modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-web-ui.adoc[leveloffset=+1]

include::modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-cli.adoc[leveloffset=+1]

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

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

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

ifeval::["{context}" == "managing-hosts"]
include::modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-pull-mode.adoc[leveloffset=+1]
endif::[]

include::modules/proc_altering-the-privilege-elevation-method.adoc[leveloffset=+1]

include::modules/proc_adding-project-server-ssh-key-to-authorized-keys.adoc[leveloffset=+1]

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

include::modules/proc_adding-a-passphrase-to-ssh-key-used-for-remote-execution.adoc[leveloffset=+1]

include::modules/proc_using-the-api-to-obtain-ssh-keys-for-remote-execution.adoc[leveloffset=+1]

ifndef::orcharhino,satellite[]
:parent-client-provisioning-template-type: {client-provisioning-template-type}
:client-provisioning-template-type: Agama
include::modules/proc_configuring-a-template-to-distribute-ssh-keys-during-provisioning.adoc[leveloffset=+1]
:client-provisioning-template-type: {parent-client-provisioning-template-type}
:!parent-client-provisioning-template-type:
endif::[]

ifndef::orcharhino[]
:parent-client-provisioning-template-type: {client-provisioning-template-type}
:client-provisioning-template-type: Kickstart
endif::[]
include::modules/proc_configuring-a-template-to-distribute-ssh-keys-during-provisioning.adoc[leveloffset=+1]
ifndef::orcharhino[]
:client-provisioning-template-type: {parent-client-provisioning-template-type}
:!parent-client-provisioning-template-type:
endif::[]

ifndef::orcharhino,satellite[]
:parent-client-provisioning-template-type: {client-provisioning-template-type}
:client-provisioning-template-type: Preseed
include::modules/proc_configuring-a-template-to-distribute-ssh-keys-during-provisioning.adoc[leveloffset=+1]
:client-provisioning-template-type: {parent-client-provisioning-template-type}
:!parent-client-provisioning-template-type:
endif::[]

include::assembly_configuring-smart-proxy-and-hosts-to-authenticate-with-ssh-certificates.adoc[leveloffset=+1]

include::modules/proc_configuring-a-keytab-for-kerberos-ticket-granting-tickets.adoc[leveloffset=+1]

include::modules/proc_configuring-kerberos-authentication-for-remote-execution.adoc[leveloffset=+1]

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

include::modules/con_using-extended-cron-lines.adoc[leveloffset=+1]
21 changes: 21 additions & 0 deletions guides/common/assembly_customizing-remote-jobs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:_mod-docs-content-type: ASSEMBLY

Check warning on line 1 in guides/common/assembly_customizing-remote-jobs.adoc

View workflow job for this annotation

GitHub Actions / lint DITA 

[vale] reported by reviewdog 🐶
[AsciiDocDITA.ShortDescription] Assign [role="_abstract"] to a paragraph to use it as <shortdesc> in DITA.

Raw Output:
{"message": "[AsciiDocDITA.ShortDescription] Assign [role=\"_abstract\"] to a paragraph to use it as \u003cshortdesc\u003e in DITA.", "location": {"path": "guides/common/assembly_customizing-remote-jobs.adoc", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in guides/common/assembly_customizing-remote-jobs.adoc

View workflow job for this annotation

GitHub Actions / lint DITA 

[vale] reported by reviewdog 🐶
[AsciiDocDITA.DocumentTitle] The document title (a level 0 heading) is missing.

Raw Output:
{"message": "[AsciiDocDITA.DocumentTitle] The document title (a level 0 heading) is missing.", "location": {"path": "guides/common/assembly_customizing-remote-jobs.adoc", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

include::modules/con_customizing-remote-jobs.adoc[]

include::modules/proc_creating-a-job-template-by-using-web-ui.adoc[leveloffset=+1]

include::modules/proc_creating-a-job-template-by-using-cli.adoc[leveloffset=+1]

include::modules/proc_importing-an-ansible-playbook-by-name.adoc[leveloffset=+1]

include::modules/proc_importing-all-available-ansible-playbooks.adoc[leveloffset=+1]

include::modules/proc_customizing-job-templates.adoc[leveloffset=+1]

include::modules/proc_scheduling-a-recurring-ansible-job-for-a-host.adoc[leveloffset=+1]

include::modules/proc_scheduling-a-recurring-ansible-job-for-a-host-group.adoc[leveloffset=+1]

ifdef::katello,orcharhino,satellite[]
include::modules/proc_using-ansible-provider-for-package-and-errata-actions.adoc[leveloffset=+1]
endif::[]
19 changes: 19 additions & 0 deletions guides/common/assembly_getting-started-with-remote-execution.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:_mod-docs-content-type: ASSEMBLY

Check warning on line 1 in guides/common/assembly_getting-started-with-remote-execution.adoc

View workflow job for this annotation

GitHub Actions / lint DITA 

[vale] reported by reviewdog 🐶
[AsciiDocDITA.DocumentTitle] The document title (a level 0 heading) is missing.

Raw Output:
{"message": "[AsciiDocDITA.DocumentTitle] The document title (a level 0 heading) is missing.", "location": {"path": "guides/common/assembly_getting-started-with-remote-execution.adoc", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in guides/common/assembly_getting-started-with-remote-execution.adoc

View workflow job for this annotation

GitHub Actions / lint DITA 

[vale] reported by reviewdog 🐶
[AsciiDocDITA.ShortDescription] Assign [role="_abstract"] to a paragraph to use it as <shortdesc> in DITA.

Raw Output:
{"message": "[AsciiDocDITA.ShortDescription] Assign [role=\"_abstract\"] to a paragraph to use it as \u003cshortdesc\u003e in DITA.", "location": {"path": "guides/common/assembly_getting-started-with-remote-execution.adoc", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

include::modules/con_getting-started-with-remote-execution.adoc[]

include::modules/con_permissions-for-remote-execution.adoc[leveloffset=+1]

ifdef::foreman-el,foreman-deb[]
include::modules/proc_installing-the-remote-execution-plugin.adoc[leveloffset=+1]
endif::[]

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

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

include::modules/proc_executing-a-remote-job-by-using-web-ui.adoc[leveloffset=+1]

include::modules/proc_executing-a-remote-job-by-using-cli.adoc[leveloffset=+1]
9 changes: 9 additions & 0 deletions guides/common/assembly_remote-execution-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:_mod-docs-content-type: ASSEMBLY

Check warning on line 1 in guides/common/assembly_remote-execution-overview.adoc

View workflow job for this annotation

GitHub Actions / lint DITA 

[vale] reported by reviewdog 🐶
[AsciiDocDITA.ShortDescription] Assign [role="_abstract"] to a paragraph to use it as <shortdesc> in DITA.

Raw Output:
{"message": "[AsciiDocDITA.ShortDescription] Assign [role=\"_abstract\"] to a paragraph to use it as \u003cshortdesc\u003e in DITA.", "location": {"path": "guides/common/assembly_remote-execution-overview.adoc", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in guides/common/assembly_remote-execution-overview.adoc

View workflow job for this annotation

GitHub Actions / lint DITA 

[vale] reported by reviewdog 🐶
[AsciiDocDITA.DocumentTitle] The document title (a level 0 heading) is missing.

Raw Output:
{"message": "[AsciiDocDITA.DocumentTitle] The document title (a level 0 heading) is missing.", "location": {"path": "guides/common/assembly_remote-execution-overview.adoc", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

include::modules/con_remote-execution-overview.adoc[]

include::modules/con_remote-execution-in-project.adoc[leveloffset=+1]

include::modules/con_remote-execution-workflow.adoc[leveloffset=+1]
Copy link
Copy Markdown
Contributor

@Lennonka Lennonka Apr 2, 2026

Choose a reason for hiding this comment

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

Can we reserve the term "workflow" for user workflows and call this a "process"?

Copy link
Copy Markdown
Contributor

@maximiliankolb maximiliankolb Apr 7, 2026

Choose a reason for hiding this comment

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

I like this question. I do not have an answer/+1/-1.

Copy link
Copy Markdown
Member Author

@aneta-petrova aneta-petrova Apr 7, 2026

Choose a reason for hiding this comment

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

I think I know what you mean with 'workflow' but also don't think 'process' would be right here. Is it okay if I leave this as is? This is not something I'm changing in this PR, the heading already exists.

Copy link
Copy Markdown
Contributor

@Lennonka Lennonka Apr 8, 2026

Choose a reason for hiding this comment

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

Sure, it's okay.


include::modules/con_transport-modes-for-remote-execution.adoc[leveloffset=+1]
8 changes: 8 additions & 0 deletions guides/common/modules/con_configuring-remote-execution.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:_mod-docs-content-type: CONCEPT

[id="configuring-remote-execution_{context}"]
= Configuring remote execution

[role="_abstract"]
You can configure remote execution in a number of ways to control how remote jobs run on your hosts.

Check failure on line 7 in guides/common/modules/con_configuring-remote-execution.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[RedHat.TermsErrors] Use 'several' rather than 'a number of'.

Raw Output:
{"message": "[RedHat.TermsErrors] Use 'several' rather than 'a number of'.", "location": {"path": "guides/common/modules/con_configuring-remote-execution.adoc", "range": {"start": {"line": 7, "column": 39}}}, "severity": "ERROR"}
This helps you configure the remote execution process to run in a way that fits your needs.
8 changes: 8 additions & 0 deletions guides/common/modules/con_customizing-remote-jobs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:_mod-docs-content-type: CONCEPT

[id="customizing-remote-jobs"]
= Customizing remote jobs

[role="_abstract"]
You can customize remote jobs in {Project} to fit your needs.
For example, you can create and customize job templates or you can import Ansible playbooks to use in your remote jobs.
7 changes: 7 additions & 0 deletions guides/common/modules/con_getting-started-with-remote-execution.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:_mod-docs-content-type: CONCEPT

[id="getting-started-with-remote-execution"]
= Getting started with remote execution

[role="_abstract"]
To run your first remote job, ensure that your user account has the required permissions and your hosts are configured to run remote jobs.
8 changes: 8 additions & 0 deletions guides/common/modules/con_remote-execution-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:_mod-docs-content-type: CONCEPT

[id="remote-execution-overview"]
= Remote execution overview

[role="_abstract"]
With remote execution in {Project}, you can run commands on hosts from {SmartProxies} by using shell scripts or Ansible roles and playbooks.
Multiple transport modes and job providers are available so that you can pick the one that fits your network.
Loading