Razor tasks describe a process or collection of actions that are performed when Razor provisions machines. Tasks can be used to designate an operating system or other software to install, where to get it, and the configuration details for the installation.
You specify the tasks you want to run in policies.
Supported tasks that are included with Razor
Copies of supported tasks that you customize as needed
Tasks that you create from scratch
|coreOS||1||Enables deployment of clusters.|
|microkernel||System task. Boots the Razor microkernel.|
|noop||System task. Boots a system locally.|
|Red Hat||6, 7|
|SUSE Linux Enterprise Server||11, 12|
|VMware ESXi||5.5, 6|
|Windows||2008 R2, 2012 R2, 8 Pro, 2016|
/opt/puppetlabs/server/apps/razor-server/share/razor-server/tasks) to the custom task directory (
/etc/puppetlabs/razor-server/tasks) before modifying the task.
Tasks are stored in the file system. The
task_path class parameter of the
pe_razor module determines where Razor looks for tasks.
The parameter can include a colon-separated list of paths. Relative paths in that list are taken to be relative to the top-level Razor directory. For example, setting
/opt/puppet/share/razor-server/tasks:/home/me/task:tasks makes Razor search for tasks in these three directories in order.
By default, there are two directories that store tasks:
/opt/puppetlabs/server/apps/razor-server/share/razor-server/tasksstores default tasks shipped with the product.
/etc/puppetlabs/razor-server/tasksstores custom tasks.
Tasks can include the following metadata in the task's YAML file. This file is called
metadata.yaml and exists in
NAME is the task name. Therefore, the task name looks like this:
--- description: HUMAN READABLE DESCRIPTION os: OS NAME os_version: OS_VERSION_NUMBER base: TASK_NAME boot_sequence: 1: boot_templ1 2: boot_templ2 default: boot_local
boot_sequence are required. The
base key allows you to derive one task from another by reusing some of the
base metadata and templates. If the derived task has metadata that's different from the metadata in
base, the derived metadata overrides the base task's metadata.
boot_sequence hash indicates which templates to use when a node using this task boots. In the example above, a node will first boot using
boot_templ1, then using
boot_templ2. For every subsequent boot, the node will use
Task templates are ERB templates and are searched in all the directories in the
task_path configuration setting.
Templates can use the following helpers to generate URLs that point back to the server; all of the URLs respond to a
GET request, even the ones that make changes on the server.
task: Includes attributes such as
node: Includes attributes such as
facts.Tip: You can use
node.hw_hash['fact_boot_type'] == "efi"to evaluate whether a node booted via UEFI.
repo: Includes attributes such as
file_url(TEMPLATE, RAW): The URL that will retrieve
TEMPLATE.erb(after evaluation) from the current node's task. By default, the file is interpolated (
RAW=false). If the file doesn't need to be interpolated, specify
repo_url(PATH): The URL to the file at
PATHin the current repo.
repo_file_contents(PATH): The contents of the file at
PATHinside the repo. This is an empty string if the file does not exist.
repo_file?(PATH): Whether a file exists at the given path. This is
nilif the file does not exist.
log_url(MESSAGE, SEVERITY): The URL that will log
MESSAGEin the current node's log.
node_url: The URL for the current node.
store_url(VARS): The URL that will store the values in the hash
VARSin the node. Currently only changing the node's IP address is supported. Use
store_url("ip" => "192.168.0.1")for that.
stage_done_url: The URL that tells the server that this stage of the boot sequence is finished, and that the next boot sequence should begin upon reboot.
broker_install_url: A URL from which the install script for the node's broker can be retrieved. You can see an example in the script, os_complete.erb, which is used by most tasks.
Each boot (except for the default boot) must culminate in something akin to
curl <%= stage_done_url %> before the node reboots. Omitting this causes the node to reboot with the same boot template over and over again.
The task must indicate to the Razor server that it has successfully completed by doing a
GET request against
stage_done_url("finished"), for example using
wget. This marks the node
installed in the Razor database.
You use these helpers by causing your script to perform an
HTTP GET against the generated URL. This might mean that you pass an argument like
ks=<%= file_url("kickstart")%> when booting a kernel, or that you put
curl <%= log_url("Things work great") %> in a shell script.