Skip to main content

Courier

You can use the Courier user interface (UI) to view and create Courier jobs within Chef 360 Platform UI. You can create jobs with multiple actions.

Courier Jobs

You can see all jobs in the Courier Jobs page. The All Jobs table shows:

  • Courier Job Name: The name of the Courier Job.
  • Job ID: A unique Job ID. For example: ae31d082-94cc-4158-8609-b2b477ac89d5.
  • Job Created On: The date the job was created.
  • Status: Whether the job is active or inactive.
  • Last Job Instance: The date when the job was last run.
  • Last Job Instance Status: The result of the previous job run (whether it was a Success or Failure).
  • Job Schedule: Schedule of the job.
  • All Node Distribution Group: A View button that shows the Node Collection, Batch size, Batch Type, Timeout, and Success Criteria.

Create a Courier job

To create a new Courier job, follow these steps:

  1. Select Create Courier Job.

  2. Enter the node query in the text box and select +Add Nodes. You can now view the node details in the node collection section.

  3. Fill out the mandatory sections like Batch Size, Unit, and Batch Type for the node and select Next.

  4. Enter the details of the Job Run (the actions you want to execute) in the text boxes. Select the interpreter and the command you want to run as part of the job run details. Once you have added the details, select Next.

  5. Enter the Job Name and the Description.

  6. On the summary page, review the node selection and the job run. Then, select “Save Job.”

View a Courier job

To view a Courier job, select the job. The page shows the job details, including the Job Summary, Description, Node Groups, and Actions. Select View on the Jobs table to view the full job summary.

The Job Details page also shows All Job Instances. The All Job Instances table shows the Job Instance, Date, Status, Start Time, Run Time, No of Nodes, and Status Break Down.

View a job instance

To view a Job instance, select the instance. The page shows all the Job runs of the instance. The table shows the Node ID, Run Status, Platform and Version, Run Time, and Last Executed Step. Select a job run to view the full job run summary. Select Download to download the log file of the running instances.

Terminate a job

To terminate a job, follow these steps on the job’s page:

  1. Select Terminate Job on the job you want to terminate.

  2. In the pop-up window, select Terminate to remove the Courier job.

When the job is terminated, the job table gets updated.

Thank you for your feedback!

×