• Release notes
  • Setting up Pipelines for Applications
  • Applications and application groups
  • Application tutorials
  • Builds
  • Environments
  • Deployments
  • Deployment tutorials
  • Manifest
  • Releases
  • Jobs
  • Docker
  • Servers
  • Agent and CLI
  • Application pipelines
  • Dashboards
  • Users and groups
  • Integrations
  • Notifications
  • API

Working with jobs

Sections

Create a job

Create a new job in the Pipelines web UI.

  1. In the web UI navigation bar, click Jobs. On the Jobs page, click Create New Job.
  2. Enter a Job Name and optional description for your new job.
  3. In the Job terminal box, enter shell commands for the job to run.
  4. (Optional.) In the AfterJobSuccess terminal box, enter shell commands you wish to run if the job succeeds.
  5. (Optional.) In the AfterJobFailure terminal box, enter shell commands you wish to run if the job fails.
  6. In the Job Hardware section, select whether the job should run on your hardware or on shared hardware.
  7. If using shared hardware, select an Image to run your job in from the choices provided.
  8. (Optional.) In the Environment Variables text box, specify applicable environment variables as key-value pairs.
  9. Click Create Job.

Your job is now ready to be dispatched manually or added to a pipeline.

Dispatch a job

After you’ve created a job, you can run it manually, otherwise known as dispatching the job.

When dispatching a job, you can change the job’s values for that job run. The job will revert to its saved job template values on future runs.

When you want to dispatch a job, use the dispatch job pane in the Pipelines web UI.

Before you begin: Make sure you have created a job.

  1. In the web UI navigation bar, click Jobs.
  2. In the list of jobs, locate the name of the job you want to dispatch, then click the Dispatch Job icon to the right of the job's name.
  3. (Optional.) If needed, you can adjust any of the values for this specific job dispatch. These values will be reset to the saved job template on next job dispatch.
  4. Click Dispatch Job.

When your job’s run is complete, you’ll see either a success message or an error message explaining any run failures.

Editing a job

After you’ve created a job, you can easily make changes by using the job editing pane in the Pipelines web UI.

If you wish to make changes to a job that will apply for only a single job run, see the Dispatching a job section.

  1. In the web UI navigation bar, click Jobs.
  2. In the list of jobs, locate the name of the job you wish to edit, then click the Edit Job icon to the right of the job's name.
  3. Make the needed changes.
  4. When you're finished editing, click Save Job.

Add a job to a pipeline

To deploy a job automatically, add it to an app pipeline in the Pipelines web UI.

Before you begin: Make sure you have created a job.

  1. In the web UI navigation bar, click Applications.
  2. In the list of applications, locate and click the name of the application you want to add the job to.
  3. In the App Pipeline pane at the right of the screen, decide where you want to add the job to the pipeline. As appropriate, click Add Target in an existing step, or click Add Step.
  4. In the Control Room panel, click Existing Job and select the job you wish to add to the pipeline, then click Add Target.

You’ve successfully added the job to your pipeline. For information on configuring auto-deployment of the job, see Enabling Auto Deploy.

View job history and run logs

Learn more about a job’s run history by viewing summary job history tables and run logs.

To view a job’s run history and individual run logs, use the Puppet Pipelines for Applications web UI.

  1. In the web UI navigation bar, click Jobs.
  2. In the list of jobs, locate the name of the job you wish to learn more about, then click the View Job History icon to the right of the job's name. A summary of the job's recent runs appears in the Job History pane.
  3. To view a job's details and run log, open the Job Details page by clicking an entry in the Job History list.
    You can view and download the job run's log from the Job Details page.
How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.