Run Puppet on demand from the console
When you set up a job to run Puppet from the console, the orchestrator creates a job ID to track the job, shows you all nodes included in the job, and runs Puppet on the targeted nodes in the appropriate order. Puppet compiles a new catalog for each node included in the job.
- A list of one or more specific nodes.
- A node group.
- A Puppet Query Language (PQL) query defining a set of nodes.
Run Puppet on one or more specific nodes
An orchestrator job can target one or more specific nodes. This is useful if you want to run Puppet on a single node, a few specific nodes, nodes that are not in the same node group, or nodes that can't easily be identified by a single PQL query.
Make sure you have access to the nodes you want to target.
Make sure you have the permissions necessary to run jobs.
Run Puppet on a PQL query
An orchestrator job can target a set of nodes based on a PQL query. This is useful when you want to target a variable set of nodes that meet specific conditions, such as a particular operating system. When you supply a PQL query, the orchestrator runs the job on a list of nodes generated by the PQL query.
Make sure you have access to the nodes you want to target.
Make sure you have the permissions necessary to run jobs and PQL queries.
To run PQL queries, you need the View node data from PuppetDB permission.
Add custom PQL queries to the console
Add your own Puppet Query Language (PQL) queries to the console to quickly access them when running jobs.
Run Puppet on a node group
An orchestrator job can target all nodes in a specific node group.
Make sure you have access to the nodes you want to target.
Run jobs from other node lists
In addition to the Jobs page, you can run Puppet jobs on lists of nodes shown on the Status, Events, and some Node groups pages.
Make sure you have the permissions necessary to run jobs.
For information about creating jobs on the Jobs page, refer to Run Puppet on one or more specific nodes, Run Puppet on a PQL query, and Run Puppet on a node group.
Schedule a Puppet run
Schedule a job to deploy configuration changes at a particular date and time or on a recurring schedule.
Make sure you have access to the nodes you want to target.
Edit a scheduled job
You can view and edit a scheduled job if, for example, you want to change the selected run options or add nodes to the job.
- In the console, go to Jobs and switch to the Scheduled Puppet run tab.
- In the list of scheduled jobs, locate the job you want to edit and click the view icon.
- On the View scheduled job page, click in the upper right corner.
- Make your required changes and click Save changes.
Delete a scheduled job
You can delete a job that you've scheduled to run at a later time or at recurring intervals.
- In the console, go to Jobs and switch to the Scheduled Puppet Run tab.
- Locate the scheduled job you want to delete and click the trashcan icon.
- Confirm that you want to remove the scheduled job.
Stop an in-progress job
You can stop a job if, for example, you need to reconfigure a class or push a configuration change that the job needs. When you stop a Puppet job, in-progress jobs finish, and jobs that aren't started are canceled.
- In the console, go to Jobs, switch to the Puppet run tab, locate the job you want to stop, and click Stop.
- If you started the job on the command
line, press
CTRL + C
.