Skip to content

Commit 124aab5

Browse files
Fix REX provider type (#4434)
* Fix REX provider type ** Package Action: foreman_remote_execution -> app/views/templates/script/package_action.erb ** Power Action: foreman_remote_execution -> app/views/templates/script/power_action.erb ** Puppet Run Once: foreman_puppet -> app/views/templates/script/puppet_run_once.erb ** Service Action: foreman_remote_execution -> app/views/templates/script/service_action.erb * Salt: No change in "guides/common/modules/proc_running-salt.adoc" but looked into this issue via PR 219 in foreman_salt. (Untested but verified that the templates are currently called "Salt Run function - SSH default". * Clicking "Run Puppet once" in WebUI really causes REX to start a job that uses the "Puppet Run Once - Script Default" template. Tested on Foreman 3.16 * Use canceled in favor of cancelled "guides/common/modules/con_host-substatus-overview.adoc" remains unchanged because the wording seems to come from the WebUI. This makes vale happy. Fixes #4415 (Rename REX provider) Fixes #4192 (Rename Puppet Run Once template) (cherry picked from commit dfad7d7)
1 parent 27b1a95 commit 124aab5

5 files changed

+9
-9
lines changed

guides/common/modules/proc_decreasing-performance-impact-of-the-pull-based-rex-transport.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This also depends on actual job workload, as some jobs are causing additional lo
1515
To avoid this, configure your {ProjectServer} and {SmartProxyServer} with the following parameters:
1616

1717
* MQTT Time To Live {endash} Time interval in seconds given to the host to pick up the job before considering the job undelivered
18-
* MQTT Resend Interval {endash} Time interval in seconds at which the notification should be re-sent to the host until the job is picked up or cancelled
18+
* MQTT Resend Interval {endash} Time interval in seconds at which the notification should be re-sent to the host until the job is picked up or canceled
1919
* MQTT Rate Limit {endash} Number of jobs that are allowed to run at the same time.
2020
You can limit the concurrency of remote execution by tuning the rate limit which means you are going to put more load on {Project}.
2121

guides/common/modules/proc_including-power-actions-in-templates.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ This procedure prevents {Project} from interpreting the disconnect exception upo
1212
+
1313
[source, ruby]
1414
----
15-
<%= render_template("Power Action - SSH Default", :action => "restart") %>
15+
<%= render_template("Power Action - Script Default", :action => "restart") %>
1616
----

guides/common/modules/proc_running-puppet-once-using-ssh.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ Assign the proper job template to the _Run Puppet Once_ feature to run Puppet on
1010
. Edit remote execution settings on {Project}:
1111
.. In the {ProjectWebUI}, navigate to *Administer* > *Remote Execution Features*.
1212
.. Select the `puppet_run_host` remote execution feature.
13-
.. Assign the `Run Puppet Once {endash} SSH Default` job template.
14-
. To run Puppet on hosts, execute a remote job and select category `Puppet` and template `Run Puppet Once - SSH Default`.
13+
.. Assign the `Puppet Run Once {endash} Script Default` job template.
14+
. To run Puppet on hosts, execute a remote job and select category `Puppet` and template `Puppet Run Once - Script Default`.
1515
Alternatively, click *Run Puppet Once* in the *Schedule Remote Job* drop down menu on the host details page.

guides/common/modules/ref_customizing-job-templates.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ The following template combines default templates to install and start the *ngin
1111

1212
[source, ruby]
1313
----
14-
<%= render_template 'Package Action - SSH Default', :action => 'install', :package => 'nginx' %>
15-
<%= render_template 'Service Action - SSH Default', :action => 'start', :service_name => 'nginx' %>
14+
<%= render_template 'Package Action - Script Default', :action => 'install', :package => 'nginx' %>
15+
<%= render_template 'Service Action - Script Default', :action => 'start', :service_name => 'nginx' %>
1616
----
1717

1818
The above template specifies parameter values for the rendered template directly.
@@ -21,7 +21,7 @@ For example, you can use the following syntax:
2121

2222
[source, ruby]
2323
----
24-
<%= render_template 'Package Action - SSH Default', :action => 'install', :package => input("package") %>
24+
<%= render_template 'Package Action - Script Default', :action => 'install', :package => input("package") %>
2525
----
2626

2727
With the above template, you have to import the parameter definition from the rendered template.

guides/common/modules/ref_remote-execution-settings.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ Restart of the `dynflowd/{project-context}-tasks` service is required.
4747
You can override this per host by setting the `remote_execution_cleanup_working_dirs` parameter.
4848
| *Cockpit URL* | | Where to find the Cockpit instance for the Web Console button.
4949
By default, no button is shown.
50-
| *Form Job Template* | Run Command - SSH Default | Choose a job template that is pre-selected in job invocation form.
50+
| *Form Job Template* | Run Command - Script Default | Choose a job template that is pre-selected in job invocation form.
5151
| *Job Invocation Report Template* | Jobs - Invocation report template | Select a report template used for generating a report for a particular remote execution job.
5252
| *Time to pickup* | 86400 | Time in seconds within which the host has to pick up a job.
53-
If the job is not picked up within this limit, the job will be cancelled.
53+
If the job is not picked up within this limit, the job will be canceled.
5454
Applies only to pull-mqtt based jobs.
5555
Defaults to one day.
5656
|====

0 commit comments

Comments
 (0)