Courier Runner skill override settings

The Courier Runner skill interprets and executes Chef Courier jobs.

Role requirements

To create or modify skill override settings, you must use a profile with the node-manager role.

Update the Courier Runner skill override settings

To update the skill settings for the Courier Runner, follow these steps:

Create a JSON file that contains the Courier Runner override settings:

{
  "skillName":"courier-runner",
  "settings":[
    {
      "name":"credentials_api_key",
      "value":""
    },
    {
      "name":"credentials_api_secret",
      "value":""
    },
    {
      "name":"shell_interpreter",
      "value":"chef-platform/shell-interpreter"
    },
    {
      "name":"restart_interpreter",
      "value":"chef-platform/restart-interpreter"
    },
    {
      "name":"inspec_interpreter",
      "value":"chef-platform/inspec-interpreter"
    },
    {
      "name":"chef_client_interpreter",
      "value":"chef-platform/chef-client-interpreter"
    },
    {
      "name":"log_dir",
      "value":"/hab/svc/courier-runner/logs"
    },
    {
      "name":"log_format",
      "value":"json"
    },
    {
      "name":"log_level",
      "value":"debug"
    },
    {
      "name":"log_output",
      "value":"file"
    },
    {
      "name":"max_size",
      "value":"100MB"
    },
    {
      "name":"retention_days",
      "value":"7"
    },
    {
      "name":"is_log_retention",
      "value":"true"
    },
    {
      "name":"queue_provider",
      "value":"0"
    },
    {
      "name":"reporter_authentication_type",
      "value":"basic"
    },
    {
      "name":"reporter_dir",
      "value":"/hab/svc/courier-runner/data"
    },
    {
      "name":"reporter_host_url",
      "value":""
    },
    {
      "name":"reporter_interval_in_sec",
      "value":"3"
    },
    {
      "name":"reporter_name",
      "value":"server"
    },
    {
      "name":"reporter_retry_interval_in_sec",
      "value":"4"
    },
    {
      "name":"reporter_total_retry_duration_in_min",
      "value":"2"
    }
  ]
}

Update the JSON file using the following setting descriptions:
log_dir
Directory where log files are stored.
Default value: "/hab/svc/courier-runner/logs"
log_format
Log format
Default value: "json"
log_level
Logging level ("debug", "info", "warn", "error")
Default value: "info"
log_output
Where logs are written ("std" for standard output, or "file" for file paths).
Default value: "file"
queue_provider
Queue identifier.
Default value: "0"
reporter_authentication_type
Reporter authentication method.
Default value: "basic"
reporter_dir
Working directory for reporter operations.
Default value: "/hab/svc/courier-runner/data"
reporter_interval_in_sec
How often (in seconds) to send reports.
Default value: "5"
reporter_name
The name of the reporter that logs are sent to.
Default value: "server" for Chef 360 Platform
reporter_retry_interval_in_sec
Wait time between retry attempts.
Default value: "4"
reporter_total_retry_duration_in_min
Maximum time to keep retrying failed reports in minutes.
Default value: "2"
max_size
Maximum size limit for individual log files before rotation.
Default: "100MB"
retention_days
Number of days to retain log files before deletion.
Default: "7"
is_log_retention
Enables or disables automatic log file retention and cleanup.
Default: "true"

Get the override settings ID with the find-all-settings command:

chef-node-management-cli management setting find-all-settings \
  --profile <PROFILE_NAME>

Update the Courier Runner’s override settings:

chef-node-management-cli management setting update-skillSettings \
  --skillName courier-runner \
  --settingId <SETTING_ID> \
  --body-file <JSON_FILE_PATH> \
  --profile <NODE_MANAGER_PROFILE_NAME>

Optional: After you’ve updated the override settings, you have to assign them to a node cohort before the settings are updated on nodes. To update a cohort with these settings, use the cohort assign-setting command:
```
chef-node-management-cli management cohort assign-setting \
  --settingId <settingId> \
  --cohortId <COHORT_ID> \
  --profile <NODE_MANAGER_PROFILE_NAME>
```

Courier Runner skill override settings

Role requirements

Update the Courier Runner skill override settings

More information