Templates

Templates form a part of orcharhino’s provisioning setup.

Templates are used to generate the scripts used during the installation of new hosts. They make heavy use of parameterisation, such that general templates can be turned into installation scripts for particular hosts by substituting the appropriate parameters.

In addition to provisioning, templates are also used by orcharhino’s remote execution features.

orcharhino provides several different types of templates:

Ensure to associate the templates with the operating system entry.

In general, a clean install of orcharhino will come with any required templates and it is neither expected nor recommended that orcharhino users manually edit any templates. Locked templates should not be changed, otherwise they will not be updated any more. Use the clone function instead. Note, however, that cloned or self-created templates are not updated during an orcharhino update.

In case you know what you are doing, and template editing is desirable, the web interface provides extensive tools to do so, including inbuilt documentation on template syntax.

Viewing a Template

Viewing a template is essentially the same as editing a template.

Editing a Template

The template page can be reached by clicking on the name of a template in a list of templates (either on the partition tables page, the provisioning templates page, or the job templates page).

The template page exists both to display information on some template, as well as to edit it. It is organized into several tabs:

Hosts > Partition tables >> name of a template

Tabs of the partition table template page

Hosts > Provisioning templates >> name of a template

Tabs of the provisioning template page

Hosts > Job templates >> name of a template

Tabs of the job template page

The help tab displays the inbuilt documentation on template syntax as shown below.

Template Syntax

Templates are written in the eRuby templating language. You can use job templates, partition tables, provisioning templates, and report templates as valid examples and introduction to the ERB syntax.

Navigate to https://orcharhino.example.com/templates_doc to view the built-in template documentation. It shows available classes, including their properties and methods. For example, the Host Managed class has architecture as one of its properties and capabilities as one of its methods.

The following screenshot shows part of the Help tab when editing a template:

The built-in template help

Refer to the report templates guide for more information on how to write report templates.