/usr/share/doc/cdist/html/cdist-type.html is in cdist-doc 4.4.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>12. cdist type — cdist 4.4.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="cdist 4.4.1 documentation" href="index.html"/>
<link rel="next" title="13. cdist types" href="cdist-types.html"/>
<link rel="prev" title="11. Manifest" href="cdist-manifest.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> cdist
</a>
<div class="version">
4.4.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="cdist-intro.html">1. cdist - usable configuration management</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-why.html">2. Why should I use cdist?</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-os.html">3. Supported Operating Systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-install.html">4. How to install cdist</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-update.html">5. How to update cdist</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-support.html">6. Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-features.html">7. Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-quickstart.html">8. Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="man1/cdist.html">9. cdist(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-bootstrap.html">10. Bootstrap</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-manifest.html">11. Manifest</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">12. cdist type</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#description">12.1. Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="#synopsis">12.2. Synopsis</a></li>
<li class="toctree-l2"><a class="reference internal" href="#how-to-use-a-type">12.3. How to use a type</a></li>
<li class="toctree-l2"><a class="reference internal" href="#singleton-types">12.4. Singleton types</a></li>
<li class="toctree-l2"><a class="reference internal" href="#config-types">12.5. Config types</a></li>
<li class="toctree-l2"><a class="reference internal" href="#install-types">12.6. Install types</a></li>
<li class="toctree-l2"><a class="reference internal" href="#how-to-write-a-new-type">12.7. How to write a new type</a></li>
<li class="toctree-l2"><a class="reference internal" href="#defining-parameters">12.8. Defining parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="#using-parameters">12.9. Using parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="#input-from-stdin">12.10. Input from stdin</a></li>
<li class="toctree-l2"><a class="reference internal" href="#writing-the-manifest">12.11. Writing the manifest</a></li>
<li class="toctree-l2"><a class="reference internal" href="#singleton-one-instance-only">12.12. Singleton - one instance only</a></li>
<li class="toctree-l2"><a class="reference internal" href="#install-type-with-install-command">12.13. Install - type with install command</a></li>
<li class="toctree-l2"><a class="reference internal" href="#the-type-explorers">12.14. The type explorers</a></li>
<li class="toctree-l2"><a class="reference internal" href="#writing-the-gencode-script">12.15. Writing the gencode script</a></li>
<li class="toctree-l2"><a class="reference internal" href="#variable-access-from-the-generated-scripts">12.16. Variable access from the generated scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="#hints-for-typewriters">12.17. Hints for typewriters</a></li>
<li class="toctree-l2"><a class="reference internal" href="#how-to-include-a-type-into-upstream-cdist">12.18. How to include a type into upstream cdist</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cdist-types.html">13. cdist types</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-explorer.html">14. Explorer</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-messaging.html">15. Messaging</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-parallelization.html">16. Parallelization</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">17. Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">18. Best practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">19. Execution stages</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">20. Remote exec and copy commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">21. Hacking</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">22. Troubleshooting</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">cdist</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>12. cdist type</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cdist-type.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cdist-type">
<h1>12. cdist type<a class="headerlink" href="#cdist-type" title="Permalink to this headline">¶</a></h1>
<div class="section" id="description">
<h2>12.1. Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>Types are the main component of cdist and define functionality. If you
use cdist, you'll write a type for every functionality you would like
to use.</p>
</div>
<div class="section" id="synopsis">
<h2>12.2. Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__TYPE ID --parameter value <span class="o">[</span>--parameter value ...<span class="o">]</span>
__TYPE --parameter value <span class="o">[</span>--parameter value ...<span class="o">]</span> <span class="o">(</span><span class="k">for</span> singletons<span class="o">)</span>
</pre></div>
</div>
</div>
<div class="section" id="how-to-use-a-type">
<h2>12.3. How to use a type<a class="headerlink" href="#how-to-use-a-type" title="Permalink to this headline">¶</a></h2>
<p>You can use types from the initial manifest or the type manifest like a
normal shell command:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Creates empty file /etc/cdist-configured</span>
__file /etc/cdist-configured --type file
<span class="c1"># Ensure tree is installed</span>
__package tree --state installed
</pre></div>
</div>
<p>A list of supported types can be found in the <a class="reference external" href="cdist-reference.html">cdist reference</a> manpage.</p>
</div>
<div class="section" id="singleton-types">
<h2>12.4. Singleton types<a class="headerlink" href="#singleton-types" title="Permalink to this headline">¶</a></h2>
<p>If a type is flagged as a singleton, it may be used only
once per host. This is useful for types which can be used only once on a
system. Singleton types do not take an object name as argument.</p>
<p>Example:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># __issue type manages /etc/issue</span>
__issue
<span class="c1"># Probably your own type - singletons may use parameters</span>
__myfancysingleton --colour green
</pre></div>
</div>
</div>
<div class="section" id="config-types">
<h2>12.5. Config types<a class="headerlink" href="#config-types" title="Permalink to this headline">¶</a></h2>
<p>By default types are used with config command. These are types that are not
flagged by any known command flag. If a type is marked then it will be skipped
with config command.</p>
</div>
<div class="section" id="install-types">
<h2>12.6. Install types<a class="headerlink" href="#install-types" title="Permalink to this headline">¶</a></h2>
<p>If a type is flagged with 'install' flag then it is used only with install command.
With other commands, i.e. config, these types are skipped if used.</p>
</div>
<div class="section" id="how-to-write-a-new-type">
<h2>12.7. How to write a new type<a class="headerlink" href="#how-to-write-a-new-type" title="Permalink to this headline">¶</a></h2>
<p>A type consists of</p>
<ul class="simple">
<li>parameter (optional)</li>
<li>manifest (optional)</li>
<li>singleton (optional)</li>
<li>explorer (optional)</li>
<li>gencode (optional)</li>
</ul>
<p>Types are stored below cdist/conf/type/. Their name should always be prefixed with
two underscores (__) to prevent collisions with other executables in $PATH.</p>
<p>To implement a new type, create the directory <strong>cdist/conf/type/__NAME</strong>.</p>
</div>
<div class="section" id="defining-parameters">
<h2>12.8. Defining parameters<a class="headerlink" href="#defining-parameters" title="Permalink to this headline">¶</a></h2>
<p>Every type consists of required, optional and boolean parameters, which must
each be declared in a newline separated file in <strong>parameter/required</strong>,
<strong>parameter/required_multiple</strong>, <strong>parameter/optional</strong>,
<strong>parameter/optional_multiple</strong> and <strong>parameter/boolean</strong>.
Parameters which are allowed multiple times should be listed in
required_multiple or optional_multiple respectively. All other parameters
follow the standard unix behaviour "the last given wins".
If either is missing, the type will have no required, no optional, no boolean
or no parameters at all.</p>
<p>Default values for optional parameters can be predefined in
<strong>parameter/default/<name></strong>.</p>
<p>Example:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nb">echo</span> servername >> cdist/conf/type/__nginx_vhost/parameter/required
<span class="nb">echo</span> logdirectory >> cdist/conf/type/__nginx_vhost/parameter/optional
<span class="nb">echo</span> loglevel >> cdist/conf/type/__nginx_vhost/parameter/optional
mkdir cdist/conf/type/__nginx_vhost/parameter/default
<span class="nb">echo</span> warning > cdist/conf/type/__nginx_vhost/parameter/default/loglevel
<span class="nb">echo</span> server_alias >> cdist/conf/type/__nginx_vhost/parameter/optional_multiple
<span class="nb">echo</span> use_ssl >> cdist/conf/type/__nginx_vhost/parameter/boolean
</pre></div>
</div>
</div>
<div class="section" id="using-parameters">
<h2>12.9. Using parameters<a class="headerlink" href="#using-parameters" title="Permalink to this headline">¶</a></h2>
<p>The parameters given to a type can be accessed and used in all type scripts
(e.g manifest, gencode, explorer). Note that boolean parameters are
represented by file existence. File exists -> True,
file does not exist -> False</p>
<p>Example: (e.g. in cdist/conf/type/__nginx_vhost/manifest)</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># required parameter</span>
<span class="nv">servername</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/servername"</span><span class="k">)</span><span class="s2">"</span>
<span class="c1"># optional parameter</span>
<span class="k">if</span> <span class="o">[</span> -f <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/logdirectory"</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">logdirectory</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/logdirectory"</span><span class="k">)</span><span class="s2">"</span>
<span class="k">fi</span>
<span class="c1"># optional parameter with predefined default</span>
<span class="nv">loglevel</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/loglevel"</span><span class="k">)</span><span class="s2">"</span>
<span class="c1"># boolean parameter</span>
<span class="k">if</span> <span class="o">[</span> -f <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/use_ssl"</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="c1"># file exists -> True</span>
<span class="c1"># do some fancy ssl stuff</span>
<span class="k">fi</span>
<span class="c1"># parameter with multiple values</span>
<span class="k">if</span> <span class="o">[</span> -f <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/server_alias"</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="k">for</span> <span class="nb">alias</span> in <span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/server_alias"</span><span class="k">)</span><span class="p">;</span> <span class="k">do</span>
<span class="nb">echo</span> <span class="nv">$alias</span> > /some/where/useful
<span class="k">done</span>
<span class="k">fi</span>
</pre></div>
</div>
</div>
<div class="section" id="input-from-stdin">
<h2>12.10. Input from stdin<a class="headerlink" href="#input-from-stdin" title="Permalink to this headline">¶</a></h2>
<p>Every type can access what has been written on stdin when it has been called.
The result is saved into the <strong>stdin</strong> file in the object directory.</p>
<p>Example use of a type: (e.g. in cdist/conf/type/__archlinux_hostname)</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__file /etc/rc.conf --source - <span class="s"><< eof</span>
<span class="s">...</span>
<span class="s">HOSTNAME="$__target_host"</span>
<span class="s">...</span>
<span class="s">eof</span>
</pre></div>
</div>
<p>If you have not seen this syntax (<< eof) before, it may help you to read
about "here documents".</p>
<p>In the __file type, stdin is used as source for the file, if - is used for source:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/source"</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">source</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/source"</span><span class="k">)</span><span class="s2">"</span>
<span class="k">if</span> <span class="o">[</span> <span class="s2">"</span><span class="nv">$source</span><span class="s2">"</span> <span class="o">=</span> <span class="s2">"-"</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">source</span><span class="o">=</span><span class="s2">"</span><span class="nv">$__object</span><span class="s2">/stdin"</span>
<span class="k">fi</span>
....
</pre></div>
</div>
</div>
<div class="section" id="writing-the-manifest">
<h2>12.11. Writing the manifest<a class="headerlink" href="#writing-the-manifest" title="Permalink to this headline">¶</a></h2>
<p>In the manifest of a type you can use other types, so your type extends
their functionality. A good example is the __package type, which in
a shortened version looks like this:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="nv">os</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__global</span><span class="s2">/explorer/os"</span><span class="k">)</span><span class="s2">"</span>
<span class="k">case</span> <span class="s2">"</span><span class="nv">$os</span><span class="s2">"</span> in
archlinux<span class="o">)</span> <span class="nv">type</span><span class="o">=</span><span class="s2">"pacman"</span> <span class="p">;;</span>
debian<span class="p">|</span>ubuntu<span class="o">)</span> <span class="nv">type</span><span class="o">=</span><span class="s2">"apt"</span> <span class="p">;;</span>
gentoo<span class="o">)</span> <span class="nv">type</span><span class="o">=</span><span class="s2">"emerge"</span> <span class="p">;;</span>
*<span class="o">)</span>
<span class="nb">echo</span> <span class="s2">"Don't know how to manage packages on: </span><span class="nv">$os</span><span class="s2">"</span> ><span class="p">&</span>2
<span class="nb">exit</span> 1
<span class="p">;;</span>
<span class="k">esac</span>
__package_<span class="nv">$type</span> <span class="s2">"</span><span class="nv">$@</span><span class="s2">"</span>
</pre></div>
</div>
<p>As you can see, the type can reference different environment variables,
which are documented in <a class="reference external" href="cdist-reference.html">cdist reference</a>.</p>
<p>Always ensure the manifest is executable, otherwise cdist will not be able
to execute it. For more information about manifests see <a class="reference external" href="cdist-manifest.html">cdist manifest</a>.</p>
</div>
<div class="section" id="singleton-one-instance-only">
<h2>12.12. Singleton - one instance only<a class="headerlink" href="#singleton-one-instance-only" title="Permalink to this headline">¶</a></h2>
<p>If you want to ensure that a type can only be used once per target, you can
mark it as a singleton: Just create the (empty) file "singleton" in your type
directory:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>touch cdist/conf/type/__NAME/singleton
</pre></div>
</div>
<p>This will also change the way your type must be called:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>__YOURTYPE --parameter value
</pre></div>
</div>
<p>As you can see, the object ID is omitted, because it does not make any sense,
if your type can be used only once.</p>
</div>
<div class="section" id="install-type-with-install-command">
<h2>12.13. Install - type with install command<a class="headerlink" href="#install-type-with-install-command" title="Permalink to this headline">¶</a></h2>
<p>If you want a type to be used with install command, you must mark it as
install: create the (empty) file "install" in your type directory:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>touch cdist/conf/type/__install_NAME/install
</pre></div>
</div>
<p>With other commands, i.e. config, it will be skipped if used.</p>
</div>
<div class="section" id="the-type-explorers">
<h2>12.14. The type explorers<a class="headerlink" href="#the-type-explorers" title="Permalink to this headline">¶</a></h2>
<p>If a type needs to explore specific details, it can provide type specific
explorers, which will be executed on the target for every created object.</p>
<p>The explorers are stored under the "explorer" directory below the type.
It could for instance contain code to check the md5sum of a file on the
client, like this (shortened version from the type __file):</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/destination"</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">destination</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/destination"</span><span class="k">)</span><span class="s2">"</span>
<span class="k">else</span>
<span class="nv">destination</span><span class="o">=</span><span class="s2">"/</span><span class="nv">$__object_id</span><span class="s2">"</span>
<span class="k">fi</span>
<span class="k">if</span> <span class="o">[</span> -e <span class="s2">"</span><span class="nv">$destination</span><span class="s2">"</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
md5sum < <span class="s2">"</span><span class="nv">$destination</span><span class="s2">"</span>
<span class="k">fi</span>
</pre></div>
</div>
</div>
<div class="section" id="writing-the-gencode-script">
<h2>12.15. Writing the gencode script<a class="headerlink" href="#writing-the-gencode-script" title="Permalink to this headline">¶</a></h2>
<p>There are two gencode scripts: <strong>gencode-local</strong> and <strong>gencode-remote</strong>.
The output of gencode-local is executed locally, whereas
the output of gencode-remote is executed on the target.
The gencode scripts can make use of the parameters, the global explorers
and the type specific explorers.</p>
<p>If the gencode scripts encounters an error, it should print diagnostic
messages to stderr and exit non-zero. If you need to debug the gencode
script, you can write to stderr:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Debug output to stderr</span>
<span class="nb">echo</span> <span class="s2">"My fancy debug line"</span> ><span class="p">&</span>2
<span class="c1"># Output to be saved by cdist for execution on the target</span>
<span class="nb">echo</span> <span class="s2">"touch /etc/cdist-configured"</span>
</pre></div>
</div>
<p>Notice: if you use __remote_copy or __remote_exec directly in your scripts
then for IPv6 address with __remote_copy execution you should enclose IPv6
address in square brackets. The same applies to __remote_exec if it behaves
the same as ssh for some options where colon is a delimiter, as for -L ssh
option (see <strong>ssh</strong>(1) and <strong>scp</strong>(1)).</p>
</div>
<div class="section" id="variable-access-from-the-generated-scripts">
<h2>12.16. Variable access from the generated scripts<a class="headerlink" href="#variable-access-from-the-generated-scripts" title="Permalink to this headline">¶</a></h2>
<p>In the generated scripts, you have access to the following cdist variables</p>
<ul class="simple">
<li>__object</li>
<li>__object_id</li>
</ul>
<p>but only for read operations, means there is no back copy of this
files after the script execution.</p>
<p>So when you generate a script with the following content, it will work:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="o">[</span> -f <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/name"</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">name</span><span class="o">=</span><span class="s2">"</span><span class="k">$(</span>cat <span class="s2">"</span><span class="nv">$__object</span><span class="s2">/parameter/name"</span><span class="k">)</span><span class="s2">"</span>
<span class="k">else</span>
<span class="nv">name</span><span class="o">=</span><span class="s2">"</span><span class="nv">$__object_id</span><span class="s2">"</span>
<span class="k">fi</span>
</pre></div>
</div>
</div>
<div class="section" id="hints-for-typewriters">
<h2>12.17. Hints for typewriters<a class="headerlink" href="#hints-for-typewriters" title="Permalink to this headline">¶</a></h2>
<p>It must be assumed that the target is pretty dumb and thus does not have high
level tools like ruby installed. If a type requires specific tools to be present
on the target, there must be another type that provides this tool and the first
type should create an object of the specific type.</p>
<p>If your type wants to save temporary data, that may be used by other types
later on (for instance __file), you can save them in the subdirectory
"files" below $__object (but you must create it yourself).
cdist will not touch this directory.</p>
<p>If your type contains static files, it's also recommended to place them in
a folder named "files" within the type (again, because cdist guarantees to
never ever touch this folder).</p>
</div>
<div class="section" id="how-to-include-a-type-into-upstream-cdist">
<h2>12.18. How to include a type into upstream cdist<a class="headerlink" href="#how-to-include-a-type-into-upstream-cdist" title="Permalink to this headline">¶</a></h2>
<p>If you think your type may be useful for others, ensure it works with the
current master branch of cdist and have a look at <a class="reference external" href="cdist-hacker.html">cdist hacking</a> on
how to submit it.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cdist-types.html" class="btn btn-neutral float-right" title="13. cdist types" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="cdist-manifest.html" class="btn btn-neutral" title="11. Manifest" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright .
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'4.4.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|