Project

General

Profile

TemplateWriting » History » Version 91

Sean O'Keeffe, 07/06/2016 09:12 AM

1 25 Paul Kelly
{{toc}}
2 26 Paul Kelly
3 1 Justin Sherrill
h1. Templates
4
5
6
7 16 Justin Sherrill
The following functions and macros can be used within templates.  These are guaranteed to work via the safemode rendering, to ensure a template can do nothing harmful. With safemode disabled other macros may work, but are not supported at this time.
8 15 Justin Sherrill
9 30 Martin Hovmöller
To enable safemode, set "safemode_render" to "true" in Settings -> Foreman settings.  Safemode rendering prevents templates from reading and writing files on the file system or modifying application data within foreman.  
10 1 Justin Sherrill
11
12 8 Justin Sherrill
h2. Accessing Templates
13 1 Justin Sherrill
14 10 Justin Sherrill
There are two ways to render a template, based on a single host, or based on a Hostgroup.  The host or hostgroup provides all the details with which to render the template.  
15 1 Justin Sherrill
16 10 Justin Sherrill
17 8 Justin Sherrill
h3. Host-based Rendering
18
19 13 Justin Sherrill
Only a single template of each type may be rendered for a system.  Foreman determines which template to use following these rules:
20 1 Justin Sherrill
21 13 Justin Sherrill
1. Only the templates of the appropriate kind and associated with the hosts operating system are considered
22
2. If a template has a hostgroup/environment combination that matches that of the host, use this template else
23
3. If a template is associated with the environment of the host, use this template, else
24
4. Use the first template found associated with the operating system associated with the host.
25 1 Justin Sherrill
26 13 Justin Sherrill
So essentially, the hostgroup/environment combination is used first, then just the environment, and finally just the operating system of the host.
27
28
29 1 Justin Sherrill
To access a template of a certain type simply use this url:
30
31 13 Justin Sherrill
@/unattended/KIND_NAME@
32 1 Justin Sherrill
33 13 Justin Sherrill
For example:    @/unattended/provision@
34 12 Justin Sherrill
would render the provisioning template.  The host will be based on the IP Address it is accessed from.  To spoof a template simply access the url in this manner:
35
36 13 Justin Sherrill
@/unattended/provision?spoof=192.168.0.1@
37 12 Justin Sherrill
38 70 Dominic Cleal
where 192.168.0.1 is the ip address of the system you want to spoof. This allows you to view a template for a particular system from anywhere.
39 1 Justin Sherrill
40 17 Justin Sherrill
h3. Hostgroup-based rendering
41 9 Justin Sherrill
42 70 Dominic Cleal
Allows any template to be rendered for any host group.  When rendering using a hostgroup, @host is actually the hostgroup instead of a defined host. The default values for the hostgroup are used for templated values.  This means if a value is not set in the hostgroup, you may get an error when rendering the template.  To access a template using a Hostgroup to render, simply use this URL:
43 8 Justin Sherrill
44
/unattended/template/Template Name/Hostgroup Name
45 1 Justin Sherrill
46
For example, a hostgroup of name Finance, and a template named WebServerKickstart could be rendered using the url:
47 8 Justin Sherrill
48
/unattended/template/WebServerKickstart/Finance
49 70 Dominic Cleal
50
When building the default PXE template (from the Provisioning Templates page), any host group with the operating system, installation media and architecture set, plus provisioning templates with the host group set on the Associations tab will be listed at the bottom of the menu.
51 1 Justin Sherrill
52 33 Ohad Levy
h3.  PXE Menus
53 10 Justin Sherrill
54 84 Marek Hulán
PXE Menus can be deployed to smart proxies from the Provisioning Templates list page (/templates/provisioning_templates).  All provisioning templates will be added with each of their hostgroup combinations (see above).  For example if the template "WebServerKickstart" is associated to the Hostgroup1/Production, Hostgroup2/Production, and Hostgroup2/Testing combinations, the template would only be added twice.  Once for WebServerKickstart-Hostgroup1 and WebServerKickstart-Hostgroup2.
55 1 Justin Sherrill
56 84 Marek Hulán
Note that you can use only macros that are not host specific since this global PXE template is not specific to one host.
57
58 8 Justin Sherrill
h2. Writing templates
59 17 Justin Sherrill
60
Templates can be written using common ERB style templating.  Here's an example on using a variable/function:
61
62 81 Franklin Piat
<pre>
63 46 Tomas Edwardsson
@rootpw --iscrypted <%= root_pass %>@
64 81 Franklin Piat
</pre>
65 17 Justin Sherrill
66
Using a simple conditional:
67
68 81 Franklin Piat
<pre>
69 46 Tomas Edwardsson
@<%= "selinux --disabled\n" if @osver != 3 -%>@
70 81 Franklin Piat
</pre>
71
72 17 Justin Sherrill
This would include a line to disable selinux if the operating system version is not 3 (since Selinux isn't supported on RHEL 3)
73
74
Another way to do conditional (with if/elsif/else):
75
76 18 Justin Sherrill
<pre>
77 46 Tomas Edwardsson
<% if @osver == 5 -%>
78 17 Justin Sherrill
 echo "uses yum"
79 46 Tomas Edwardsson
<% elsif @osver == 4 -%>
80 17 Justin Sherrill
 echo "uses up2date
81 46 Tomas Edwardsson
<% else -%>
82 17 Justin Sherrill
 echo "I'm not sure"
83 46 Tomas Edwardsson
<% end -%>
84 18 Justin Sherrill
</pre>
85 8 Justin Sherrill
86 1 Justin Sherrill
h2. Functions and macros:
87
88 84 Marek Hulán
h3. Generic macros
89
90
You should be able to use these macros in any template (Partition tables and Provisioning templates of all kinds)
91
92 1 Justin Sherrill
|_.Name|_.Description|_.Example|
93 84 Marek Hulán
|indent(n)|Indents the block of code by n spaces, useful when using snippet which are not indented | <pre><code class="ruby"><%= indent 4 do
94
    snippet 'subscription_manager_registration'
95
end %></code></pre>|
96
|foreman_server_fqdn| FQDN of Foreman server derived from _foreman_url_ Setting, Foreman 1.12+ | # Template generated at <%= foreman_server_fqdn %> |
97
|foreman_server_url| Full URL of Foreman server equal to value of _foreman_url_ Setting, Foreman 1.12+ | curl <%= foreman_server_url %>/my_plugin_api |
98
|foreman_url(kind)| Provides the full URL to a host-rendered template of the given kind, based on _unattended_url_ Setting with fallback to current request headers | foreman_url("provision") =>  http://HOST/unattended/provision |
99 1 Justin Sherrill
|snippet(name)   | Renders the specified snippet | |
100 84 Marek Hulán
|snippets(file)   | Renders the specified snippet found in DB, tries to load it from unattended/snippets/$file directory from hard drive it it's not found in DB | |
101
|snippet_if_exists(name)   | Renders the specified snippet, skip it if it can't be found by name | |
102
103
104
h3. Host specific macros
105
106
These macros can be used only when the template is rendered for specific host.
107
108
|_.Name|_.Description|_.Example|
109
|grub_pass  |The GRUB password wrapped in md5pass argument | grub_pass # => --md5pass=#{@host.grub_pass} |
110
|_media_path_ | not used anywhere in built in templates, candidate for removing in Foreman 1.13 | media_path # => /media |
111
|root_pass  |The root password configured for the system| |
112
|ks_console |A string assembled using the port and baud of the host which can be added to a kernel line | ks_console # => console=ttyS1,9600 |
113
114
h3. Variables and snippets
115
116
|_.Name|_.Description|_.Example|
117 87 a d^2
|@host.model | The name of the value assigned in Hardware Models. | <notextile><% if @host.model.to_s == 'vmware' %> .. <% end -%></notextile>,  <notextile><% if @host.model.to_s == 'xen' %> .. <% end -%></notextile>|
118 46 Tomas Edwardsson
|@host.name                |The (full) name of the host| |
119 39 Ben Hagen
|@host.shortname           |The (short) name of the host| |
120 71 Lukas Zapletal
|@host.certname            |The SSL certificate name of the host| |
121 1 Justin Sherrill
|@host.domain           |The domain of the host| |
122 81 Franklin Piat
|@host.ip                |The IP address of the host| |
123 1 Justin Sherrill
|@host.hostgroup       |The hostgroup of the host| <notextile><% if @host.hostgroup.to_s == "Base/Application Servers" -%>...<% end -%></notextile>|
124
|@host.mac                |The HW address of the host| |
125 81 Franklin Piat
|@host.diskLayout     |The disklayout of the host (could come from the operating system)| |
126 59 Arnold Bechtoldt
|@host.ptable        |The disklayout name | <notextile><% if @host.ptable.name == 'Kickstart RHEL default' %> .. <% end %></notextile> |
127 1 Justin Sherrill
|@host.puppetmaster   |The puppetmaster the host should use | |
128
|@host.environment  |The environment the host should use | |
129 34 Frank Sweetser
|@host.location    |The location of the host | |
130 82 Dominic Cleal
|@host.architecture   |The arch of the host (i.e. x86_64)| |
131 79 Franklin Piat
|@host.medium |The assigned OS installation medium (1.10.2+)|
132 81 Franklin Piat
|@host.operatingsystem.name|The operating system name| |
133 1 Justin Sherrill
|@host.operatingsystem.major |The major version of the OS| <notextile><% if @host.operatingsystem.major.to_i < 7 %> .. <% end %></notextile> |
134
|@host.operatingsystem.minor |The minor version of the OS| <notextile><% if @host.operatingsystem.minor.to_i > 2 %> .. <% end %></notextile> |
135 81 Franklin Piat
|@host.operatingsystem.family |The OS Family (I.e. Redhat, Debian, etc.)||
136 77 Maurice Mouw
|@host.os.medium_uri(@host) |The url for provisioning (path configured in installation media)|<%= @host.os.medium_uri(@host) %> => http://mirror.os.org/os/|
137 84 Marek Hulán
|@host.param_false?(name) | returns false if host parameter of a given name evaluates to false (e.g. 0, 'no', false, 'false', 'f', off, nil) |<%= @host.param_true?('enable-puppetlabs-repo') %> => true|
138
|@host.param_true?(name) | returns true if host parameter of a given name evaluates to true (e.g. 1, 'yes', true, 'true', 't', on) |<%= @host.param_true?('enable-puppetlabs-repo') %> => true|
139 42 Trey Dockendorf
|@host.subnet.mask |The subnet mask of the host||
140
|@host.subnet.gateway |The gateway of the host||
141
|@host.subnet.dns_primary |The primary DNS of the host||
142 1 Justin Sherrill
|@host.subnet.dns_secondary |The secondary DNS of the host||
143 82 Dominic Cleal
|@host.subnet.dhcp|Boolean that render true if a dhcp proxy is configured for this host|<notextile><% if @host.subnet.dhcp %> .. <% else %> .. <% end %></notextile>|
144
|@host.url_for_boot(:kernel) |Full url to the kernel associated with this host.|Not recommended, as it doesn't interpolate variables, prefer boot_files_uri|
145
|@host.url_for_boot(:initrd) |Full url to the initrd image associated with this host|Not recommended, as it doesn't interpolate variables|
146 44 Siert Z.
|@host.operatingsystem.boot_files_uri(@host.medium,@host.architecture) | Full URL to the kernel and initrd, returns an array (1.10.2+) |
147
|@host.sp_name|The name of the BMC interface ||
148
|@host.sp_ip|The IP address of the BMC interface ||
149
|@host.sp_mac|The HW address of the BMC interface ||
150 73 Marek Hulán
|@host.sp_subnet|Subnet of the BMC network ||
151 74 Marek Hulán
|@host.interfaces| Contains an array of all available host interfaces including primary (see networking notes below for changes between Foreman versions) ||
152
|@host.primary_interface| Returns host's primary interface (1.8+) |it existed in 1.7, returning primary_interface identifier based on imported facts, 1.8+ it returns interface object |
153 73 Marek Hulán
|@host.provision_interface| Returns host's provision interface (1.8+) | returns interface object, see notes below for more details |
154
|@host.bond_interfaces| Contains an array of all bonds (1.7+) ||
155 1 Justin Sherrill
|@host.managed_interfaces| Limit the array to managed (non-BMC nor Bond) interfaces only which are set to be managed (1.7+) ||
156
|@host.interfaces_with_identifier(['eth0', 'eth1']) | Returns array of interfaces with given identifier (1.7+)||
157
|@host.interfaces.managed| Limit the array to managed (non-BMC nor Bond) interfaces only (only works if safemode_render=false) ||
158
|@host.interfaces.bmc| Limit the array to BMC (non-managed) interfaces only (only works if safemode_render=false) ||
159 73 Marek Hulán
|@host.interfaces.size| Number of additional interfaces (either type interface or bmc) (only works if safemode_render=false) |size=1 means a host has two interfaces on 1.7, one interface on 1.8+|
160 72 Dominic Cleal
|@host.interfaces.empty|If true host does not have ant interface (only works if safemode_render=false) ||
161
|@host.facts| Contains a hash of facts from Facter/Ohai etc. (1.7.2+) ||
162 88 Dominic Cleal
|@host.facts['ipaddress']| Accessing the 'ipaddress' fact for the host, use @::@ as a separator to access structured facts (1.7.2+) ||
163 66 Dominic Cleal
|@host.facts_hash| Contains a hash of facts from Facter/Ohai etc. (only works if safemode_render=false) ||
164 81 Franklin Piat
|@host.facts_hash['ipaddress']| Accessing the 'ipaddress' fact for the host (only works if safemode_render=false) ||
165
|@host.image_build?| Returns true if the host is provisioned using an image (1.5+)| <notextile><% if @host.image_build? %></notextile> |
166
|@host.pxe_build?| Returns true if the host is provisioned using the network/PXE (1.5+)| <notextile><% if @host.pxe_build? %></notextile> |
167
|@provisioning_type|Equal to 'host' or 'hostgroup' depending on type of provisioning (1.6+)| <notextile><% if @provisioning_type == 'hostgroup' %></notextile> |
168 1 Justin Sherrill
|@static|Boolean value to determine if the network configuration is static or dynamic|Use <notextile><%= @static ? "static" : "dynamic" %></notextile> in templates|
169
|@template_name|Name of the template being rendered (1.7+)| <%= @template_name %> |
170
171 55 Stefan Lasiewski
*NOTE*: For *PXELinux* templates in 0.4 or older _only_ leave off the '@host.' from the above as it is currently generated slightly different from everything else. 
172 53 Dominic Cleal
173 1 Justin Sherrill
*NOTE*: The interface array can be parsed this way: <pre><% @host.interfaces.each do |i| %> key is <%= i.ip %> <% end %></pre>. To print information for the first interface in the array, try something like: <pre><% myinterface = @host.interfaces.first %> IP: <%= myinterface.ip %> Netmask: <%= myinterface.subnet.mask %> Gateway: <%= myinterface.subnet.gateway %></pre>
174
175
*NOTE*: Some variables can't be accessed while safemode is enabled.  Disable via safemode_render in _More > Settings_, though be aware this enables arbitrary code to be added to templates.  Some are being whitelisted via #2948.
176 57 Benjamin Papillon
177 1 Justin Sherrill
*NOTE*: You may need to add "&static=yes" to the foreman_url to use the @static parameter in templates (see [[KickstartStatic]]).
178
179 74 Marek Hulán
*NOTE*: A lot of networking functions changed their meaning between 1.7 and 1.8 releases. In 1.7, primary interface used to be part of host object so it was not part of '@host.interfaces'. Also it could be detected by '@host.has_primary_interface?' which was removed in 1.8. For more advanced example of using networking functions, see kickstart_networking_setup.erb provisioning template snippet.
180
181
*NOTE*: If you get interface object as a returning value of some function (e.g. primary_interface or interfaces.first) it is evaluated to its DNS name by default. You can easily get to other attributes of such interface, e.g. @host.primary_interface.identifier or @host.primary_interface.mac. Valid attributes include: "managed?", "subnet" (returns subnet object), "virtual?", "physical?", "mac", "ip", "identifier", "attached_to", "link", "tag", "domain" (returns domain object), "vlanid", "bond_options", "attached_devices", "mode", "attached_devices_identifiers", "primary", "provision", "alias?", "inheriting_mac" (if it's virtual it inherits the mac from attached_to device)
182 21 Justin Sherrill
183 85 Sean O'Keeffe
h3. Katello only Variables and snippets
184
185
|_.Name|_.Description|_.Example|
186
|@host.info['parameters']['lifecycle_environment'] |The lifecycle environment of the host| |
187 91 Sean O'Keeffe
|Katello::ActivationKey.find_by_name(@host.info['parameters']['kt_activation_keys']).host_collections</>[1]['name'] | The first host collection in the activation key the host is using. (only works if safemode_render=false) | Katello::ActivationKey.find_by_name(@host.info['parameters']['kt_activation_keys').host_collections.select {</>|host_collection</>| host_collection['name'] == 'MY_HOST_COLLECTION_NAME' } |
188 1 Justin Sherrill
189
h3. Kickstart only variables (Only available for provision templates and "RedHat" Family operating systems):
190 21 Justin Sherrill
191
|_.Name|_.Description|_.Example|
192
|@osver |The OS Major Version (Same as @host.operatingsystem.major)||
193 46 Tomas Edwardsson
|@arch | The architecture (same as @host.architecture.name)  ||
194
|@mediapath | The full kickstart line to provide the url command.|@mediapath => http://file.example.com/RHEL-5-Server/U5/x86_64/os/|
195 1 Justin Sherrill
|@epel |A command which will automatically install the correct version of the epel-release rpm.  Use full in a %post script.|@epel => "su -c 'rpm -Uvh http://download.fedora.redhat.com/pub/epel/5/x86_64/epel-release-5-4.noarch.rpm'"|
196 21 Justin Sherrill
|@dynamic |true if the parition table being used is a %pre script (has #Dynamic as the first line of the table)|<% if @dynamic -%>|
197 6 Justin Sherrill
198 1 Justin Sherrill
h3. Preseed attributes (Only available for provision templates and "Debian" Family operating systems)::
199
200
|_.Name|_.Description|_.Example|
201 27 Alexander Rusa
|@preseed_path |||
202
|@preseed_server |||
203
204 35 David M.
h3. Host- or Hostgroup parameters
205
206 45 Mikael Fridh
@host.params['parameter_name']
207 75 Dominic Cleal
208
If you need to test if a parameter contains a boolean true/false value, there are two helpers that will help:
209
210
    @host.param_true?('parameter_name')
211
@host.param_false?('parameter_name')
212
213
These check the parameter is a true/false/on/off/1/0 string.
214 36 Adrian Bridgett
215 41 Ohad Levy
Hint: For Foreman older than 1.0 you have to disable Safemode-Rendering in More->Settings.
216
217
h3. Compute Resource Specific functions
218
219 36 Adrian Bridgett
see [[Compute Resources#Templates]]
220
221
h3. Settings
222
223
Setting.setting_name
224 1 Justin Sherrill
225 78 Stephen Benjamin
You will need to disable Safemode-Rendering in More->Settings.
226
227
h2. Ruby methods
228
229
The most common methods on Ruby's core classes should be allowed (split, gsub, to_i, blank?, etc).  A full list is in the Safemode Gem: https://github.com/svenfuchs/safemode/blob/master/lib/safemode/core_jails.rb#L33
230
231
To avoid turning off safemode, consider alternative ways of writing your ruby code. For example this would not work in the default Jail:
232
233
<pre>
234
@host.ip.rpartition('.')[-1]
235
</pre>
236
237
238
But this does:
239
240
<pre>
241
@host.ip.split('.').last
242 83 Paul Armstrong
</pre>
243
244
h2. Troubleshooting
245
246
Kickstart/preseed files are all generated dynamically based on the setting of each host in Foreman, things like partition tables and root password can be unique per server.
247
248
If you are having issues with a system building from a template or a system is unable to retrieve a template you can see the kickstart/preseed template result using your browser. If your system failed to retrieve the kickstart file it may be due to the fact that the template build failed. 
249
250
Use the spoof parameter by pointing your browser to a url similar to:
251
252
<pre>
253
http://foreman/unattended/provision?spoof=123.321.123.321
254
</pre>
255
256
* 123.321.123.321 is the hosts IP Address (the one you want to build).
257
* usually you want to see the page source, the browser might display the file in html which will result in hard to read output.
258 1 Justin Sherrill
* the completed template will be displayed or any errors that were encountered while the template was being built.